@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSOpsWorks extends Object implements AWSOpsWorks
AWSOpsWorks. Convenient method forms pass through to the corresponding overload
that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
AssignInstanceResult |
assignInstance(AssignInstanceRequest request)
Assign a registered instance to a layer.
|
AssignVolumeResult |
assignVolume(AssignVolumeRequest request)
Assigns one of the stack's registered Amazon EBS volumes to a specified instance.
|
AssociateElasticIpResult |
associateElasticIp(AssociateElasticIpRequest request)
Associates one of the stack's registered Elastic IP addresses with a specified instance.
|
AttachElasticLoadBalancerResult |
attachElasticLoadBalancer(AttachElasticLoadBalancerRequest request)
Attaches an Elastic Load Balancing load balancer to a specified layer.
|
CloneStackResult |
cloneStack(CloneStackRequest request)
Creates a clone of a specified stack.
|
CreateAppResult |
createApp(CreateAppRequest request)
Creates an app for a specified stack.
|
CreateDeploymentResult |
createDeployment(CreateDeploymentRequest request)
Runs deployment or stack commands.
|
CreateInstanceResult |
createInstance(CreateInstanceRequest request)
Creates an instance in a specified stack.
|
CreateLayerResult |
createLayer(CreateLayerRequest request)
Creates a layer.
|
CreateStackResult |
createStack(CreateStackRequest request)
Creates a new stack.
|
CreateUserProfileResult |
createUserProfile(CreateUserProfileRequest request)
Creates a new user profile.
|
DeleteAppResult |
deleteApp(DeleteAppRequest request)
Deletes a specified app.
|
DeleteInstanceResult |
deleteInstance(DeleteInstanceRequest request)
Deletes a specified instance, which terminates the associated Amazon EC2 instance.
|
DeleteLayerResult |
deleteLayer(DeleteLayerRequest request)
Deletes a specified layer.
|
DeleteStackResult |
deleteStack(DeleteStackRequest request)
Deletes a specified stack.
|
DeleteUserProfileResult |
deleteUserProfile(DeleteUserProfileRequest request)
Deletes a user profile.
|
DeregisterEcsClusterResult |
deregisterEcsCluster(DeregisterEcsClusterRequest request)
Deregisters a specified Amazon ECS cluster from a stack.
|
DeregisterElasticIpResult |
deregisterElasticIp(DeregisterElasticIpRequest request)
Deregisters a specified Elastic IP address.
|
DeregisterInstanceResult |
deregisterInstance(DeregisterInstanceRequest request)
Deregister an instance from OpsWorks Stacks.
|
DeregisterRdsDbInstanceResult |
deregisterRdsDbInstance(DeregisterRdsDbInstanceRequest request)
Deregisters an Amazon RDS instance.
|
DeregisterVolumeResult |
deregisterVolume(DeregisterVolumeRequest request)
Deregisters an Amazon EBS volume.
|
DescribeAgentVersionsResult |
describeAgentVersions(DescribeAgentVersionsRequest request)
Describes the available OpsWorks Stacks agent versions.
|
DescribeAppsResult |
describeApps(DescribeAppsRequest request)
Requests a description of a specified set of apps.
|
DescribeCommandsResult |
describeCommands(DescribeCommandsRequest request)
Describes the results of specified commands.
|
DescribeDeploymentsResult |
describeDeployments(DescribeDeploymentsRequest request)
Requests a description of a specified set of deployments.
|
DescribeEcsClustersResult |
describeEcsClusters(DescribeEcsClustersRequest request)
Describes Amazon ECS clusters that are registered with a stack.
|
DescribeElasticIpsResult |
describeElasticIps(DescribeElasticIpsRequest request)
Describes Elastic IP
addresses.
|
DescribeElasticLoadBalancersResult |
describeElasticLoadBalancers(DescribeElasticLoadBalancersRequest request)
Describes a stack's Elastic Load Balancing instances.
|
DescribeInstancesResult |
describeInstances(DescribeInstancesRequest request)
Requests a description of a set of instances.
|
DescribeLayersResult |
describeLayers(DescribeLayersRequest request)
Requests a description of one or more layers in a specified stack.
|
DescribeLoadBasedAutoScalingResult |
describeLoadBasedAutoScaling(DescribeLoadBasedAutoScalingRequest request)
Describes load-based auto scaling configurations for specified layers.
|
DescribeMyUserProfileResult |
describeMyUserProfile(DescribeMyUserProfileRequest request)
Describes a user's SSH information.
|
DescribeOperatingSystemsResult |
describeOperatingSystems(DescribeOperatingSystemsRequest request)
Describes the operating systems that are supported by OpsWorks Stacks.
|
DescribePermissionsResult |
describePermissions(DescribePermissionsRequest request)
Describes the permissions for a specified stack.
|
DescribeRaidArraysResult |
describeRaidArrays(DescribeRaidArraysRequest request)
Describe an instance's RAID arrays.
|
DescribeRdsDbInstancesResult |
describeRdsDbInstances(DescribeRdsDbInstancesRequest request)
Describes Amazon RDS instances.
|
DescribeServiceErrorsResult |
describeServiceErrors(DescribeServiceErrorsRequest request)
Describes OpsWorks Stacks service errors.
|
DescribeStackProvisioningParametersResult |
describeStackProvisioningParameters(DescribeStackProvisioningParametersRequest request)
Requests a description of a stack's provisioning parameters.
|
DescribeStacksResult |
describeStacks(DescribeStacksRequest request)
Requests a description of one or more stacks.
|
DescribeStackSummaryResult |
describeStackSummary(DescribeStackSummaryRequest request)
Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as
running_setup or online. |
DescribeTimeBasedAutoScalingResult |
describeTimeBasedAutoScaling(DescribeTimeBasedAutoScalingRequest request)
Describes time-based auto scaling configurations for specified instances.
|
DescribeUserProfilesResult |
describeUserProfiles(DescribeUserProfilesRequest request)
Describe specified users.
|
DescribeVolumesResult |
describeVolumes(DescribeVolumesRequest request)
Describes an instance's Amazon EBS volumes.
|
DetachElasticLoadBalancerResult |
detachElasticLoadBalancer(DetachElasticLoadBalancerRequest request)
Detaches a specified Elastic Load Balancing instance from its layer.
|
DisassociateElasticIpResult |
disassociateElasticIp(DisassociateElasticIpRequest request)
Disassociates an Elastic IP address from its instance.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetHostnameSuggestionResult |
getHostnameSuggestion(GetHostnameSuggestionRequest request)
Gets a generated host name for the specified layer, based on the current host name theme.
|
GrantAccessResult |
grantAccess(GrantAccessRequest request)
|
ListTagsResult |
listTags(ListTagsRequest request)
Returns a list of tags that are applied to the specified stack or layer.
|
RebootInstanceResult |
rebootInstance(RebootInstanceRequest request)
Reboots a specified instance.
|
RegisterEcsClusterResult |
registerEcsCluster(RegisterEcsClusterRequest request)
Registers a specified Amazon ECS cluster with a stack.
|
RegisterElasticIpResult |
registerElasticIp(RegisterElasticIpRequest request)
Registers an Elastic IP address with a specified stack.
|
RegisterInstanceResult |
registerInstance(RegisterInstanceRequest request)
Registers instances that were created outside of OpsWorks Stacks with a specified stack.
|
RegisterRdsDbInstanceResult |
registerRdsDbInstance(RegisterRdsDbInstanceRequest request)
Registers an Amazon RDS instance with a stack.
|
RegisterVolumeResult |
registerVolume(RegisterVolumeRequest request)
Registers an Amazon EBS volume with a specified stack.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("https://opsworks.us-east-1.amazonaws.com").
|
SetLoadBasedAutoScalingResult |
setLoadBasedAutoScaling(SetLoadBasedAutoScalingRequest request)
Specify the load-based auto scaling configuration for a specified layer.
|
SetPermissionResult |
setPermission(SetPermissionRequest request)
Specifies a user's permissions.
|
void |
setRegion(Region region)
An alternative to
AWSOpsWorks.setEndpoint(String), sets the regional endpoint for this client's service
calls. |
SetTimeBasedAutoScalingResult |
setTimeBasedAutoScaling(SetTimeBasedAutoScalingRequest request)
Specify the time-based auto scaling configuration for a specified instance.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartInstanceResult |
startInstance(StartInstanceRequest request)
Starts a specified instance.
|
StartStackResult |
startStack(StartStackRequest request)
Starts a stack's instances.
|
StopInstanceResult |
stopInstance(StopInstanceRequest request)
Stops a specified instance.
|
StopStackResult |
stopStack(StopStackRequest request)
Stops a specified stack.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Apply cost-allocation tags to a specified stack or layer in OpsWorks Stacks.
|
UnassignInstanceResult |
unassignInstance(UnassignInstanceRequest request)
Unassigns a registered instance from all layers that are using the instance.
|
UnassignVolumeResult |
unassignVolume(UnassignVolumeRequest request)
Unassigns an assigned Amazon EBS volume.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes tags from a specified stack or layer.
|
UpdateAppResult |
updateApp(UpdateAppRequest request)
Updates a specified app.
|
UpdateElasticIpResult |
updateElasticIp(UpdateElasticIpRequest request)
Updates a registered Elastic IP address's name.
|
UpdateInstanceResult |
updateInstance(UpdateInstanceRequest request)
Updates a specified instance.
|
UpdateLayerResult |
updateLayer(UpdateLayerRequest request)
Updates a specified layer.
|
UpdateMyUserProfileResult |
updateMyUserProfile(UpdateMyUserProfileRequest request)
Updates a user's SSH public key.
|
UpdateRdsDbInstanceResult |
updateRdsDbInstance(UpdateRdsDbInstanceRequest request)
Updates an Amazon RDS instance.
|
UpdateStackResult |
updateStack(UpdateStackRequest request)
Updates a specified stack.
|
UpdateUserProfileResult |
updateUserProfile(UpdateUserProfileRequest request)
Updates a specified user profile.
|
UpdateVolumeResult |
updateVolume(UpdateVolumeRequest request)
Updates an Amazon EBS volume's name or mount point.
|
AWSOpsWorksWaiters |
waiters() |
public void setEndpoint(String endpoint)
AWSOpsWorks
Callers can pass in just the endpoint (ex: "opsworks.us-east-1.amazonaws.com") or a full URL, including the
protocol (ex: "https://opsworks.us-east-1.amazonaws.com"). If the protocol is not specified here, the default
protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint in interface AWSOpsWorksendpoint - The endpoint (ex: "opsworks.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"https://opsworks.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will
communicate with.public void setRegion(Region region)
AWSOpsWorksAWSOpsWorks.setEndpoint(String), sets the regional endpoint for this client's service
calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion in interface AWSOpsWorksregion - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)public AssignInstanceResult assignInstance(AssignInstanceRequest request)
AWSOpsWorksAssign a registered instance to a layer.
You can assign registered on-premises instances to any layer type.
You can assign registered Amazon EC2 instances only to custom layers.
You cannot use this action with instances that were created with OpsWorks Stacks.
Required Permissions: To use this action, an Identity and Access Management (IAM) user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
assignInstance in interface AWSOpsWorkspublic AssignVolumeResult assignVolume(AssignVolumeRequest request)
AWSOpsWorks
Assigns one of the stack's registered Amazon EBS volumes to a specified instance. The volume must first be
registered with the stack by calling RegisterVolume. After you register the volume, you must call
UpdateVolume to specify a mount point before calling AssignVolume. For more information, see
Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
assignVolume in interface AWSOpsWorkspublic AssociateElasticIpResult associateElasticIp(AssociateElasticIpRequest request)
AWSOpsWorksAssociates one of the stack's registered Elastic IP addresses with a specified instance. The address must first be registered with the stack by calling RegisterElasticIp. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
associateElasticIp in interface AWSOpsWorkspublic AttachElasticLoadBalancerResult attachElasticLoadBalancer(AttachElasticLoadBalancerRequest request)
AWSOpsWorksAttaches an Elastic Load Balancing load balancer to a specified layer. OpsWorks Stacks does not support Application Load Balancer. You can only use Classic Load Balancer with OpsWorks Stacks. For more information, see Elastic Load Balancing.
You must create the Elastic Load Balancing instance separately, by using the Elastic Load Balancing console, API, or CLI. For more information, see the Elastic Load Balancing Developer Guide.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
attachElasticLoadBalancer in interface AWSOpsWorkspublic CloneStackResult cloneStack(CloneStackRequest request)
AWSOpsWorksCreates a clone of a specified stack. For more information, see Clone a Stack. By default, all parameters are set to the values used by the parent stack.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
cloneStack in interface AWSOpsWorkspublic CreateAppResult createApp(CreateAppRequest request)
AWSOpsWorksCreates an app for a specified stack. For more information, see Creating Apps.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
createApp in interface AWSOpsWorkspublic CreateDeploymentResult createDeployment(CreateDeploymentRequest request)
AWSOpsWorksRuns deployment or stack commands. For more information, see Deploying Apps and Run Stack Commands.
Required Permissions: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
createDeployment in interface AWSOpsWorkspublic CreateInstanceResult createInstance(CreateInstanceRequest request)
AWSOpsWorksCreates an instance in a specified stack. For more information, see Adding an Instance to a Layer.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
createInstance in interface AWSOpsWorkspublic CreateLayerResult createLayer(CreateLayerRequest request)
AWSOpsWorksCreates a layer. For more information, see How to Create a Layer.
You should use CreateLayer for noncustom layer types such as PHP App Server only if the stack does not have an existing layer of that type. A stack can have at most one instance of each noncustom layer; if you attempt to create a second instance, CreateLayer fails. A stack can have an arbitrary number of custom layers, so you can call CreateLayer as many times as you like for that layer type.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
createLayer in interface AWSOpsWorkspublic CreateStackResult createStack(CreateStackRequest request)
AWSOpsWorksCreates a new stack. For more information, see Create a New Stack.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
createStack in interface AWSOpsWorkspublic CreateUserProfileResult createUserProfile(CreateUserProfileRequest request)
AWSOpsWorksCreates a new user profile.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
createUserProfile in interface AWSOpsWorkspublic DeleteAppResult deleteApp(DeleteAppRequest request)
AWSOpsWorksDeletes a specified app.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
deleteApp in interface AWSOpsWorkspublic DeleteInstanceResult deleteInstance(DeleteInstanceRequest request)
AWSOpsWorksDeletes a specified instance, which terminates the associated Amazon EC2 instance. You must stop an instance before you can delete it.
For more information, see Deleting Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
deleteInstance in interface AWSOpsWorkspublic DeleteLayerResult deleteLayer(DeleteLayerRequest request)
AWSOpsWorksDeletes a specified layer. You must first stop and then delete all associated instances or unassign registered instances. For more information, see How to Delete a Layer.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
deleteLayer in interface AWSOpsWorkspublic DeleteStackResult deleteStack(DeleteStackRequest request)
AWSOpsWorksDeletes a specified stack. You must first delete all instances, layers, and apps or deregister registered instances. For more information, see Shut Down a Stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
deleteStack in interface AWSOpsWorkspublic DeleteUserProfileResult deleteUserProfile(DeleteUserProfileRequest request)
AWSOpsWorksDeletes a user profile.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
deleteUserProfile in interface AWSOpsWorkspublic DeregisterEcsClusterResult deregisterEcsCluster(DeregisterEcsClusterRequest request)
AWSOpsWorksDeregisters a specified Amazon ECS cluster from a stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html.
deregisterEcsCluster in interface AWSOpsWorkspublic DeregisterElasticIpResult deregisterElasticIp(DeregisterElasticIpRequest request)
AWSOpsWorksDeregisters a specified Elastic IP address. The address can be registered by another stack after it is deregistered. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
deregisterElasticIp in interface AWSOpsWorkspublic DeregisterInstanceResult deregisterInstance(DeregisterInstanceRequest request)
AWSOpsWorksDeregister an instance from OpsWorks Stacks. The instance can be a registered instance (Amazon EC2 or on-premises) or an instance created with OpsWorks. This action removes the instance from the stack and returns it to your control.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
deregisterInstance in interface AWSOpsWorkspublic DeregisterRdsDbInstanceResult deregisterRdsDbInstance(DeregisterRdsDbInstanceRequest request)
AWSOpsWorksDeregisters an Amazon RDS instance.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
deregisterRdsDbInstance in interface AWSOpsWorkspublic DeregisterVolumeResult deregisterVolume(DeregisterVolumeRequest request)
AWSOpsWorksDeregisters an Amazon EBS volume. The volume can then be registered by another stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
deregisterVolume in interface AWSOpsWorkspublic DescribeAgentVersionsResult describeAgentVersions(DescribeAgentVersionsRequest request)
AWSOpsWorks
Describes the available OpsWorks Stacks agent versions. You must specify a stack ID or a configuration manager.
DescribeAgentVersions returns a list of available agent versions for the specified stack or
configuration manager.
describeAgentVersions in interface AWSOpsWorkspublic DescribeAppsResult describeApps(DescribeAppsRequest request)
AWSOpsWorksRequests a description of a specified set of apps.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
describeApps in interface AWSOpsWorkspublic DescribeCommandsResult describeCommands(DescribeCommandsRequest request)
AWSOpsWorksDescribes the results of specified commands.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
describeCommands in interface AWSOpsWorkspublic DescribeDeploymentsResult describeDeployments(DescribeDeploymentsRequest request)
AWSOpsWorksRequests a description of a specified set of deployments.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
describeDeployments in interface AWSOpsWorkspublic DescribeEcsClustersResult describeEcsClusters(DescribeEcsClustersRequest request)
AWSOpsWorks
Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID, you can use the
MaxResults and NextToken parameters to paginate the response. However, OpsWorks Stacks
currently supports only one cluster per layer, so the result set has a maximum of one element.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permission. For more information about user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
describeEcsClusters in interface AWSOpsWorkspublic DescribeElasticIpsResult describeElasticIps(DescribeElasticIpsRequest request)
AWSOpsWorksDescribes Elastic IP addresses.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
describeElasticIps in interface AWSOpsWorkspublic DescribeElasticLoadBalancersResult describeElasticLoadBalancers(DescribeElasticLoadBalancersRequest request)
AWSOpsWorksDescribes a stack's Elastic Load Balancing instances.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
describeElasticLoadBalancers in interface AWSOpsWorkspublic DescribeInstancesResult describeInstances(DescribeInstancesRequest request)
AWSOpsWorksRequests a description of a set of instances.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
describeInstances in interface AWSOpsWorkspublic DescribeLayersResult describeLayers(DescribeLayersRequest request)
AWSOpsWorksRequests a description of one or more layers in a specified stack.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
describeLayers in interface AWSOpsWorkspublic DescribeLoadBasedAutoScalingResult describeLoadBasedAutoScaling(DescribeLoadBasedAutoScalingRequest request)
AWSOpsWorksDescribes load-based auto scaling configurations for specified layers.
You must specify at least one of the parameters.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
describeLoadBasedAutoScaling in interface AWSOpsWorkspublic DescribeMyUserProfileResult describeMyUserProfile(DescribeMyUserProfileRequest request)
AWSOpsWorksDescribes a user's SSH information.
Required Permissions: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
describeMyUserProfile in interface AWSOpsWorkspublic DescribeOperatingSystemsResult describeOperatingSystems(DescribeOperatingSystemsRequest request)
AWSOpsWorksDescribes the operating systems that are supported by OpsWorks Stacks.
describeOperatingSystems in interface AWSOpsWorkspublic DescribePermissionsResult describePermissions(DescribePermissionsRequest request)
AWSOpsWorksDescribes the permissions for a specified stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
describePermissions in interface AWSOpsWorkspublic DescribeRaidArraysResult describeRaidArrays(DescribeRaidArraysRequest request)
AWSOpsWorksDescribe an instance's RAID arrays.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
describeRaidArrays in interface AWSOpsWorkspublic DescribeRdsDbInstancesResult describeRdsDbInstances(DescribeRdsDbInstancesRequest request)
AWSOpsWorksDescribes Amazon RDS instances.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
describeRdsDbInstances in interface AWSOpsWorkspublic DescribeServiceErrorsResult describeServiceErrors(DescribeServiceErrorsRequest request)
AWSOpsWorksDescribes OpsWorks Stacks service errors.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
describeServiceErrors in interface AWSOpsWorkspublic DescribeStackProvisioningParametersResult describeStackProvisioningParameters(DescribeStackProvisioningParametersRequest request)
AWSOpsWorksRequests a description of a stack's provisioning parameters.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
describeStackProvisioningParameters in interface AWSOpsWorkspublic DescribeStackSummaryResult describeStackSummary(DescribeStackSummaryRequest request)
AWSOpsWorks
Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as
running_setup or online.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
describeStackSummary in interface AWSOpsWorkspublic DescribeStacksResult describeStacks(DescribeStacksRequest request)
AWSOpsWorksRequests a description of one or more stacks.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
describeStacks in interface AWSOpsWorkspublic DescribeTimeBasedAutoScalingResult describeTimeBasedAutoScaling(DescribeTimeBasedAutoScalingRequest request)
AWSOpsWorksDescribes time-based auto scaling configurations for specified instances.
You must specify at least one of the parameters.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
describeTimeBasedAutoScaling in interface AWSOpsWorkspublic DescribeUserProfilesResult describeUserProfiles(DescribeUserProfilesRequest request)
AWSOpsWorksDescribe specified users.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
describeUserProfiles in interface AWSOpsWorkspublic DescribeVolumesResult describeVolumes(DescribeVolumesRequest request)
AWSOpsWorksDescribes an instance's Amazon EBS volumes.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
describeVolumes in interface AWSOpsWorkspublic DetachElasticLoadBalancerResult detachElasticLoadBalancer(DetachElasticLoadBalancerRequest request)
AWSOpsWorksDetaches a specified Elastic Load Balancing instance from its layer.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
detachElasticLoadBalancer in interface AWSOpsWorkspublic DisassociateElasticIpResult disassociateElasticIp(DisassociateElasticIpRequest request)
AWSOpsWorksDisassociates an Elastic IP address from its instance. The address remains registered with the stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
disassociateElasticIp in interface AWSOpsWorkspublic GetHostnameSuggestionResult getHostnameSuggestion(GetHostnameSuggestionRequest request)
AWSOpsWorksGets a generated host name for the specified layer, based on the current host name theme.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
getHostnameSuggestion in interface AWSOpsWorkspublic GrantAccessResult grantAccess(GrantAccessRequest request)
AWSOpsWorksThis action can be used only with Windows stacks.
Grants RDP access to a Windows instance for a specified time period.
grantAccess in interface AWSOpsWorkspublic ListTagsResult listTags(ListTagsRequest request)
AWSOpsWorksReturns a list of tags that are applied to the specified stack or layer.
listTags in interface AWSOpsWorkspublic RebootInstanceResult rebootInstance(RebootInstanceRequest request)
AWSOpsWorksReboots a specified instance. For more information, see Starting, Stopping, and Rebooting Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
rebootInstance in interface AWSOpsWorkspublic RegisterEcsClusterResult registerEcsCluster(RegisterEcsClusterRequest request)
AWSOpsWorksRegisters a specified Amazon ECS cluster with a stack. You can register only one cluster with a stack. A cluster can be registered with only one stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
registerEcsCluster in interface AWSOpsWorkspublic RegisterElasticIpResult registerElasticIp(RegisterElasticIpRequest request)
AWSOpsWorksRegisters an Elastic IP address with a specified stack. An address can be registered with only one stack at a time. If the address is already registered, you must first deregister it by calling DeregisterElasticIp. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
registerElasticIp in interface AWSOpsWorkspublic RegisterInstanceResult registerInstance(RegisterInstanceRequest request)
AWSOpsWorksRegisters instances that were created outside of OpsWorks Stacks with a specified stack.
We do not recommend using this action to register instances. The complete registration operation includes two
tasks: installing the OpsWorks Stacks agent on the instance, and registering the instance with the stack.
RegisterInstance handles only the second step. You should instead use the CLI register
command, which performs the entire registration operation. For more information, see Registering an
Instance with an OpsWorks Stacks Stack.
Registered instances have the same requirements as instances that are created by using the CreateInstance API. For example, registered instances must be running a supported Linux-based operating system, and they must have a supported instance type. For more information about requirements for instances that you want to register, see Preparing the Instance.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
registerInstance in interface AWSOpsWorkspublic RegisterRdsDbInstanceResult registerRdsDbInstance(RegisterRdsDbInstanceRequest request)
AWSOpsWorksRegisters an Amazon RDS instance with a stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
registerRdsDbInstance in interface AWSOpsWorkspublic RegisterVolumeResult registerVolume(RegisterVolumeRequest request)
AWSOpsWorksRegisters an Amazon EBS volume with a specified stack. A volume can be registered with only one stack at a time. If the volume is already registered, you must first deregister it by calling DeregisterVolume. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
registerVolume in interface AWSOpsWorkspublic SetLoadBasedAutoScalingResult setLoadBasedAutoScaling(SetLoadBasedAutoScalingRequest request)
AWSOpsWorksSpecify the load-based auto scaling configuration for a specified layer. For more information, see Managing Load with Time-based and Load-based Instances.
To use load-based auto scaling, you must create a set of load-based auto scaling instances. Load-based auto scaling operates only on the instances from that set, so you must ensure that you have created enough instances to handle the maximum anticipated load.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
setLoadBasedAutoScaling in interface AWSOpsWorkspublic SetPermissionResult setPermission(SetPermissionRequest request)
AWSOpsWorksSpecifies a user's permissions. For more information, see Security and Permissions.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
setPermission in interface AWSOpsWorkspublic SetTimeBasedAutoScalingResult setTimeBasedAutoScaling(SetTimeBasedAutoScalingRequest request)
AWSOpsWorksSpecify the time-based auto scaling configuration for a specified instance. For more information, see Managing Load with Time-based and Load-based Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
setTimeBasedAutoScaling in interface AWSOpsWorkspublic StartInstanceResult startInstance(StartInstanceRequest request)
AWSOpsWorksStarts a specified instance. For more information, see Starting, Stopping, and Rebooting Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
startInstance in interface AWSOpsWorkspublic StartStackResult startStack(StartStackRequest request)
AWSOpsWorksStarts a stack's instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
startStack in interface AWSOpsWorkspublic StopInstanceResult stopInstance(StopInstanceRequest request)
AWSOpsWorksStops a specified instance. When you stop a standard instance, the data disappears and must be reinstalled when you restart the instance. You can stop an Amazon EBS-backed instance without losing data. For more information, see Starting, Stopping, and Rebooting Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
stopInstance in interface AWSOpsWorkspublic StopStackResult stopStack(StopStackRequest request)
AWSOpsWorksStops a specified stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
stopStack in interface AWSOpsWorkspublic TagResourceResult tagResource(TagResourceRequest request)
AWSOpsWorksApply cost-allocation tags to a specified stack or layer in OpsWorks Stacks. For more information about how tagging works, see Tags in the OpsWorks User Guide.
tagResource in interface AWSOpsWorkspublic UnassignInstanceResult unassignInstance(UnassignInstanceRequest request)
AWSOpsWorksUnassigns a registered instance from all layers that are using the instance. The instance remains in the stack as an unassigned instance, and can be assigned to another layer as needed. You cannot use this action with instances that were created with OpsWorks Stacks.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
unassignInstance in interface AWSOpsWorkspublic UnassignVolumeResult unassignVolume(UnassignVolumeRequest request)
AWSOpsWorksUnassigns an assigned Amazon EBS volume. The volume remains registered with the stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
unassignVolume in interface AWSOpsWorkspublic UntagResourceResult untagResource(UntagResourceRequest request)
AWSOpsWorksRemoves tags from a specified stack or layer.
untagResource in interface AWSOpsWorkspublic UpdateAppResult updateApp(UpdateAppRequest request)
AWSOpsWorksUpdates a specified app.
Required Permissions: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
updateApp in interface AWSOpsWorkspublic UpdateElasticIpResult updateElasticIp(UpdateElasticIpRequest request)
AWSOpsWorksUpdates a registered Elastic IP address's name. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
updateElasticIp in interface AWSOpsWorkspublic UpdateInstanceResult updateInstance(UpdateInstanceRequest request)
AWSOpsWorksUpdates a specified instance.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
updateInstance in interface AWSOpsWorkspublic UpdateLayerResult updateLayer(UpdateLayerRequest request)
AWSOpsWorksUpdates a specified layer.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
updateLayer in interface AWSOpsWorkspublic UpdateMyUserProfileResult updateMyUserProfile(UpdateMyUserProfileRequest request)
AWSOpsWorksUpdates a user's SSH public key.
Required Permissions: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
updateMyUserProfile in interface AWSOpsWorkspublic UpdateRdsDbInstanceResult updateRdsDbInstance(UpdateRdsDbInstanceRequest request)
AWSOpsWorksUpdates an Amazon RDS instance.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
updateRdsDbInstance in interface AWSOpsWorkspublic UpdateStackResult updateStack(UpdateStackRequest request)
AWSOpsWorksUpdates a specified stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
updateStack in interface AWSOpsWorkspublic UpdateUserProfileResult updateUserProfile(UpdateUserProfileRequest request)
AWSOpsWorksUpdates a specified user profile.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
updateUserProfile in interface AWSOpsWorkspublic UpdateVolumeResult updateVolume(UpdateVolumeRequest request)
AWSOpsWorksUpdates an Amazon EBS volume's name or mount point. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
updateVolume in interface AWSOpsWorkspublic void shutdown()
AWSOpsWorksshutdown in interface AWSOpsWorkspublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSOpsWorksResponse metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata in interface AWSOpsWorksrequest - The originally executed request.public AWSOpsWorksWaiters waiters()
waiters in interface AWSOpsWorks