AutoCloseable
@Generated("software.amazon.awssdk:codegen") public interface OpsWorksAsyncClient extends AutoCloseable
builder()
method.
Welcome to the AWS OpsWorks Stacks API Reference. This guide provides descriptions, syntax, and usage examples for AWS OpsWorks Stacks actions and data types, including common parameters and error codes.
AWS OpsWorks Stacks is an application management service that provides an integrated experience for overseeing the complete application lifecycle. For information about this product, go to the AWS OpsWorks details page.
SDKs and CLI
The most common way to use the AWS OpsWorks Stacks API is by using the AWS Command Line Interface (CLI) or by using one of the AWS SDKs to implement applications in your preferred language. For more information, see:
Endpoints
AWS OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Stacks can only be accessed or managed within the endpoint in which they are created.
opsworks.us-east-1.amazonaws.com
opsworks.us-east-2.amazonaws.com
opsworks.us-west-1.amazonaws.com
opsworks.us-west-2.amazonaws.com
opsworks.eu-west-1.amazonaws.com
opsworks.eu-west-2.amazonaws.com
opsworks.eu-central-1.amazonaws.com
opsworks.ap-northeast-1.amazonaws.com
opsworks.ap-northeast-2.amazonaws.com
opsworks.ap-south-1.amazonaws.com
opsworks.ap-southeast-1.amazonaws.com
opsworks.ap-southeast-2.amazonaws.com
opsworks.sa-east-1.amazonaws.com
Chef Versions
When you call CreateStack, CloneStack, or UpdateStack we recommend you use the
ConfigurationManager
parameter to specify the Chef version. The recommended and default value for Linux
stacks is currently 12. Windows stacks use Chef 12.2. For more information, see Chef Versions.
You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We recommend migrating your existing Linux stacks to Chef 12 as soon as possible.
Modifier and Type | Method | Description |
---|---|---|
default CompletableFuture<AssignInstanceResponse> |
assignInstance(AssignInstanceRequest assignInstanceRequest) |
Assign a registered instance to a layer.
|
default CompletableFuture<AssignVolumeResponse> |
assignVolume(AssignVolumeRequest assignVolumeRequest) |
Assigns one of the stack's registered Amazon EBS volumes to a specified instance.
|
default CompletableFuture<AssociateElasticIpResponse> |
associateElasticIp(AssociateElasticIpRequest associateElasticIpRequest) |
Associates one of the stack's registered Elastic IP addresses with a specified instance.
|
default CompletableFuture<AttachElasticLoadBalancerResponse> |
attachElasticLoadBalancer(AttachElasticLoadBalancerRequest attachElasticLoadBalancerRequest) |
Attaches an Elastic Load Balancing load balancer to a specified layer.
|
static OpsWorksAsyncClientBuilder |
builder() |
Create a builder that can be used to configure and create a
OpsWorksAsyncClient . |
default CompletableFuture<CloneStackResponse> |
cloneStack(CloneStackRequest cloneStackRequest) |
Creates a clone of a specified stack.
|
static OpsWorksAsyncClient |
create() |
Create a
OpsWorksAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CompletableFuture<CreateAppResponse> |
createApp(CreateAppRequest createAppRequest) |
Creates an app for a specified stack.
|
default CompletableFuture<CreateDeploymentResponse> |
createDeployment(CreateDeploymentRequest createDeploymentRequest) |
Runs deployment or stack commands.
|
default CompletableFuture<CreateInstanceResponse> |
createInstance(CreateInstanceRequest createInstanceRequest) |
Creates an instance in a specified stack.
|
default CompletableFuture<CreateLayerResponse> |
createLayer(CreateLayerRequest createLayerRequest) |
Creates a layer.
|
default CompletableFuture<CreateStackResponse> |
createStack(CreateStackRequest createStackRequest) |
Creates a new stack.
|
default CompletableFuture<CreateUserProfileResponse> |
createUserProfile(CreateUserProfileRequest createUserProfileRequest) |
Creates a new user profile.
|
default CompletableFuture<DeleteAppResponse> |
deleteApp(DeleteAppRequest deleteAppRequest) |
Deletes a specified app.
|
default CompletableFuture<DeleteInstanceResponse> |
deleteInstance(DeleteInstanceRequest deleteInstanceRequest) |
Deletes a specified instance, which terminates the associated Amazon EC2 instance.
|
default CompletableFuture<DeleteLayerResponse> |
deleteLayer(DeleteLayerRequest deleteLayerRequest) |
Deletes a specified layer.
|
default CompletableFuture<DeleteStackResponse> |
deleteStack(DeleteStackRequest deleteStackRequest) |
Deletes a specified stack.
|
default CompletableFuture<DeleteUserProfileResponse> |
deleteUserProfile(DeleteUserProfileRequest deleteUserProfileRequest) |
Deletes a user profile.
|
default CompletableFuture<DeregisterEcsClusterResponse> |
deregisterEcsCluster(DeregisterEcsClusterRequest deregisterEcsClusterRequest) |
Deregisters a specified Amazon ECS cluster from a stack.
|
default CompletableFuture<DeregisterElasticIpResponse> |
deregisterElasticIp(DeregisterElasticIpRequest deregisterElasticIpRequest) |
Deregisters a specified Elastic IP address.
|
default CompletableFuture<DeregisterInstanceResponse> |
deregisterInstance(DeregisterInstanceRequest deregisterInstanceRequest) |
Deregister a registered Amazon EC2 or on-premises instance.
|
default CompletableFuture<DeregisterRdsDbInstanceResponse> |
deregisterRdsDbInstance(DeregisterRdsDbInstanceRequest deregisterRdsDbInstanceRequest) |
Deregisters an Amazon RDS instance.
|
default CompletableFuture<DeregisterVolumeResponse> |
deregisterVolume(DeregisterVolumeRequest deregisterVolumeRequest) |
Deregisters an Amazon EBS volume.
|
default CompletableFuture<DescribeAgentVersionsResponse> |
describeAgentVersions(DescribeAgentVersionsRequest describeAgentVersionsRequest) |
Describes the available AWS OpsWorks Stacks agent versions.
|
default CompletableFuture<DescribeAppsResponse> |
describeApps(DescribeAppsRequest describeAppsRequest) |
Requests a description of a specified set of apps.
|
default CompletableFuture<DescribeCommandsResponse> |
describeCommands(DescribeCommandsRequest describeCommandsRequest) |
Describes the results of specified commands.
|
default CompletableFuture<DescribeDeploymentsResponse> |
describeDeployments(DescribeDeploymentsRequest describeDeploymentsRequest) |
Requests a description of a specified set of deployments.
|
default CompletableFuture<DescribeEcsClustersResponse> |
describeEcsClusters(DescribeEcsClustersRequest describeEcsClustersRequest) |
Describes Amazon ECS clusters that are registered with a stack.
|
default CompletableFuture<DescribeElasticIpsResponse> |
describeElasticIps(DescribeElasticIpsRequest describeElasticIpsRequest) |
Describes Elastic IP
addresses.
|
default CompletableFuture<DescribeElasticLoadBalancersResponse> |
describeElasticLoadBalancers(DescribeElasticLoadBalancersRequest describeElasticLoadBalancersRequest) |
Describes a stack's Elastic Load Balancing instances.
|
default CompletableFuture<DescribeInstancesResponse> |
describeInstances(DescribeInstancesRequest describeInstancesRequest) |
Requests a description of a set of instances.
|
default CompletableFuture<DescribeLayersResponse> |
describeLayers(DescribeLayersRequest describeLayersRequest) |
Requests a description of one or more layers in a specified stack.
|
default CompletableFuture<DescribeLoadBasedAutoScalingResponse> |
describeLoadBasedAutoScaling(DescribeLoadBasedAutoScalingRequest describeLoadBasedAutoScalingRequest) |
Describes load-based auto scaling configurations for specified layers.
|
default CompletableFuture<DescribeMyUserProfileResponse> |
describeMyUserProfile(DescribeMyUserProfileRequest describeMyUserProfileRequest) |
Describes a user's SSH information.
|
default CompletableFuture<DescribePermissionsResponse> |
describePermissions(DescribePermissionsRequest describePermissionsRequest) |
Describes the permissions for a specified stack.
|
default CompletableFuture<DescribeRaidArraysResponse> |
describeRaidArrays(DescribeRaidArraysRequest describeRaidArraysRequest) |
Describe an instance's RAID arrays.
|
default CompletableFuture<DescribeRdsDbInstancesResponse> |
describeRdsDbInstances(DescribeRdsDbInstancesRequest describeRdsDbInstancesRequest) |
Describes Amazon RDS instances.
|
default CompletableFuture<DescribeServiceErrorsResponse> |
describeServiceErrors(DescribeServiceErrorsRequest describeServiceErrorsRequest) |
Describes AWS OpsWorks Stacks service errors.
|
default CompletableFuture<DescribeStackProvisioningParametersResponse> |
describeStackProvisioningParameters(DescribeStackProvisioningParametersRequest describeStackProvisioningParametersRequest) |
Requests a description of a stack's provisioning parameters.
|
default CompletableFuture<DescribeStacksResponse> |
describeStacks(DescribeStacksRequest describeStacksRequest) |
Requests a description of one or more stacks.
|
default CompletableFuture<DescribeStackSummaryResponse> |
describeStackSummary(DescribeStackSummaryRequest describeStackSummaryRequest) |
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 . |
default CompletableFuture<DescribeTimeBasedAutoScalingResponse> |
describeTimeBasedAutoScaling(DescribeTimeBasedAutoScalingRequest describeTimeBasedAutoScalingRequest) |
Describes time-based auto scaling configurations for specified instances.
|
default CompletableFuture<DescribeUserProfilesResponse> |
describeUserProfiles(DescribeUserProfilesRequest describeUserProfilesRequest) |
Describe specified users.
|
default CompletableFuture<DescribeVolumesResponse> |
describeVolumes(DescribeVolumesRequest describeVolumesRequest) |
Describes an instance's Amazon EBS volumes.
|
default CompletableFuture<DetachElasticLoadBalancerResponse> |
detachElasticLoadBalancer(DetachElasticLoadBalancerRequest detachElasticLoadBalancerRequest) |
Detaches a specified Elastic Load Balancing instance from its layer.
|
default CompletableFuture<DisassociateElasticIpResponse> |
disassociateElasticIp(DisassociateElasticIpRequest disassociateElasticIpRequest) |
Disassociates an Elastic IP address from its instance.
|
default CompletableFuture<GetHostnameSuggestionResponse> |
getHostnameSuggestion(GetHostnameSuggestionRequest getHostnameSuggestionRequest) |
Gets a generated host name for the specified layer, based on the current host name theme.
|
default CompletableFuture<GrantAccessResponse> |
grantAccess(GrantAccessRequest grantAccessRequest) |
|
default CompletableFuture<ListTagsResponse> |
listTags(ListTagsRequest listTagsRequest) |
Returns a list of tags that are applied to the specified stack or layer.
|
default CompletableFuture<RebootInstanceResponse> |
rebootInstance(RebootInstanceRequest rebootInstanceRequest) |
Reboots a specified instance.
|
default CompletableFuture<RegisterEcsClusterResponse> |
registerEcsCluster(RegisterEcsClusterRequest registerEcsClusterRequest) |
Registers a specified Amazon ECS cluster with a stack.
|
default CompletableFuture<RegisterElasticIpResponse> |
registerElasticIp(RegisterElasticIpRequest registerElasticIpRequest) |
Registers an Elastic IP address with a specified stack.
|
default CompletableFuture<RegisterInstanceResponse> |
registerInstance(RegisterInstanceRequest registerInstanceRequest) |
Registers instances that were created outside of AWS OpsWorks Stacks with a specified stack.
|
default CompletableFuture<RegisterRdsDbInstanceResponse> |
registerRdsDbInstance(RegisterRdsDbInstanceRequest registerRdsDbInstanceRequest) |
Registers an Amazon RDS instance with a stack.
|
default CompletableFuture<RegisterVolumeResponse> |
registerVolume(RegisterVolumeRequest registerVolumeRequest) |
Registers an Amazon EBS volume with a specified stack.
|
default CompletableFuture<SetLoadBasedAutoScalingResponse> |
setLoadBasedAutoScaling(SetLoadBasedAutoScalingRequest setLoadBasedAutoScalingRequest) |
Specify the load-based auto scaling configuration for a specified layer.
|
default CompletableFuture<SetPermissionResponse> |
setPermission(SetPermissionRequest setPermissionRequest) |
Specifies a user's permissions.
|
default CompletableFuture<SetTimeBasedAutoScalingResponse> |
setTimeBasedAutoScaling(SetTimeBasedAutoScalingRequest setTimeBasedAutoScalingRequest) |
Specify the time-based auto scaling configuration for a specified instance.
|
default CompletableFuture<StartInstanceResponse> |
startInstance(StartInstanceRequest startInstanceRequest) |
Starts a specified instance.
|
default CompletableFuture<StartStackResponse> |
startStack(StartStackRequest startStackRequest) |
Starts a stack's instances.
|
default CompletableFuture<StopInstanceResponse> |
stopInstance(StopInstanceRequest stopInstanceRequest) |
Stops a specified instance.
|
default CompletableFuture<StopStackResponse> |
stopStack(StopStackRequest stopStackRequest) |
Stops a specified stack.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest) |
Apply cost-allocation tags to a specified stack or layer in AWS OpsWorks Stacks.
|
default CompletableFuture<UnassignInstanceResponse> |
unassignInstance(UnassignInstanceRequest unassignInstanceRequest) |
Unassigns a registered instance from all of it's layers.
|
default CompletableFuture<UnassignVolumeResponse> |
unassignVolume(UnassignVolumeRequest unassignVolumeRequest) |
Unassigns an assigned Amazon EBS volume.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest) |
Removes tags from a specified stack or layer.
|
default CompletableFuture<UpdateAppResponse> |
updateApp(UpdateAppRequest updateAppRequest) |
Updates a specified app.
|
default CompletableFuture<UpdateElasticIpResponse> |
updateElasticIp(UpdateElasticIpRequest updateElasticIpRequest) |
Updates a registered Elastic IP address's name.
|
default CompletableFuture<UpdateInstanceResponse> |
updateInstance(UpdateInstanceRequest updateInstanceRequest) |
Updates a specified instance.
|
default CompletableFuture<UpdateLayerResponse> |
updateLayer(UpdateLayerRequest updateLayerRequest) |
Updates a specified layer.
|
default CompletableFuture<UpdateMyUserProfileResponse> |
updateMyUserProfile(UpdateMyUserProfileRequest updateMyUserProfileRequest) |
Updates a user's SSH public key.
|
default CompletableFuture<UpdateRdsDbInstanceResponse> |
updateRdsDbInstance(UpdateRdsDbInstanceRequest updateRdsDbInstanceRequest) |
Updates an Amazon RDS instance.
|
default CompletableFuture<UpdateStackResponse> |
updateStack(UpdateStackRequest updateStackRequest) |
Updates a specified stack.
|
default CompletableFuture<UpdateUserProfileResponse> |
updateUserProfile(UpdateUserProfileRequest updateUserProfileRequest) |
Updates a specified user profile.
|
default CompletableFuture<UpdateVolumeResponse> |
updateVolume(UpdateVolumeRequest updateVolumeRequest) |
Updates an Amazon EBS volume's name or mount point.
|
close
static OpsWorksAsyncClient create()
OpsWorksAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static OpsWorksAsyncClientBuilder builder()
OpsWorksAsyncClient
.default CompletableFuture<AssignInstanceResponse> assignInstance(AssignInstanceRequest assignInstanceRequest)
Assign 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 AWS OpsWorks Stacks.
Required Permissions: To use this action, an AWS 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.
assignInstanceRequest
- default CompletableFuture<AssignVolumeResponse> assignVolume(AssignVolumeRequest assignVolumeRequest)
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.
assignVolumeRequest
- default CompletableFuture<AssociateElasticIpResponse> associateElasticIp(AssociateElasticIpRequest associateElasticIpRequest)
Associates 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.
associateElasticIpRequest
- default CompletableFuture<AttachElasticLoadBalancerResponse> attachElasticLoadBalancer(AttachElasticLoadBalancerRequest attachElasticLoadBalancerRequest)
Attaches an Elastic Load Balancing load balancer to a specified layer. AWS OpsWorks Stacks does not support Application Load Balancer. You can only use Classic Load Balancer with AWS 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 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.
attachElasticLoadBalancerRequest
- default CompletableFuture<CloneStackResponse> cloneStack(CloneStackRequest cloneStackRequest)
Creates 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 on user permissions, see Managing User Permissions.
cloneStackRequest
- default CompletableFuture<CreateAppResponse> createApp(CreateAppRequest createAppRequest)
Creates 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.
createAppRequest
- default CompletableFuture<CreateDeploymentResponse> createDeployment(CreateDeploymentRequest createDeploymentRequest)
Runs 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.
createDeploymentRequest
- default CompletableFuture<CreateInstanceResponse> createInstance(CreateInstanceRequest createInstanceRequest)
Creates 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.
createInstanceRequest
- default CompletableFuture<CreateLayerResponse> createLayer(CreateLayerRequest createLayerRequest)
Creates 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.
createLayerRequest
- default CompletableFuture<CreateStackResponse> createStack(CreateStackRequest createStackRequest)
Creates 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 on user permissions, see Managing User Permissions.
createStackRequest
- default CompletableFuture<CreateUserProfileResponse> createUserProfile(CreateUserProfileRequest createUserProfileRequest)
Creates 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 on user permissions, see Managing User Permissions.
createUserProfileRequest
- default CompletableFuture<DeleteAppResponse> deleteApp(DeleteAppRequest deleteAppRequest)
Deletes 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.
deleteAppRequest
- default CompletableFuture<DeleteInstanceResponse> deleteInstance(DeleteInstanceRequest deleteInstanceRequest)
Deletes 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.
deleteInstanceRequest
- default CompletableFuture<DeleteLayerResponse> deleteLayer(DeleteLayerRequest deleteLayerRequest)
Deletes 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.
deleteLayerRequest
- default CompletableFuture<DeleteStackResponse> deleteStack(DeleteStackRequest deleteStackRequest)
Deletes 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.
deleteStackRequest
- default CompletableFuture<DeleteUserProfileResponse> deleteUserProfile(DeleteUserProfileRequest deleteUserProfileRequest)
Deletes a user profile.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
deleteUserProfileRequest
- default CompletableFuture<DeregisterEcsClusterResponse> deregisterEcsCluster(DeregisterEcsClusterRequest deregisterEcsClusterRequest)
Deregisters 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 http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html.
deregisterEcsClusterRequest
- default CompletableFuture<DeregisterElasticIpResponse> deregisterElasticIp(DeregisterElasticIpRequest deregisterElasticIpRequest)
Deregisters a specified Elastic IP address. The address 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.
deregisterElasticIpRequest
- default CompletableFuture<DeregisterInstanceResponse> deregisterInstance(DeregisterInstanceRequest deregisterInstanceRequest)
Deregister a registered Amazon EC2 or on-premises instance. This action removes the instance from the stack and returns it to your control. This action can not be used with instances that were created with AWS 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 on user permissions, see Managing User Permissions.
deregisterInstanceRequest
- default CompletableFuture<DeregisterRdsDbInstanceResponse> deregisterRdsDbInstance(DeregisterRdsDbInstanceRequest deregisterRdsDbInstanceRequest)
Deregisters 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.
deregisterRdsDbInstanceRequest
- default CompletableFuture<DeregisterVolumeResponse> deregisterVolume(DeregisterVolumeRequest deregisterVolumeRequest)
Deregisters 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.
deregisterVolumeRequest
- default CompletableFuture<DescribeAgentVersionsResponse> describeAgentVersions(DescribeAgentVersionsRequest describeAgentVersionsRequest)
Describes the available AWS 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.
describeAgentVersionsRequest
- default CompletableFuture<DescribeAppsResponse> describeApps(DescribeAppsRequest describeAppsRequest)
Requests 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 on user permissions, see Managing User Permissions.
describeAppsRequest
- default CompletableFuture<DescribeCommandsResponse> describeCommands(DescribeCommandsRequest describeCommandsRequest)
Describes 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 on user permissions, see Managing User Permissions.
describeCommandsRequest
- default CompletableFuture<DescribeDeploymentsResponse> describeDeployments(DescribeDeploymentsRequest describeDeploymentsRequest)
Requests 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 on user permissions, see Managing User Permissions.
describeDeploymentsRequest
- default CompletableFuture<DescribeEcsClustersResponse> describeEcsClusters(DescribeEcsClustersRequest describeEcsClustersRequest)
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, AWS 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 on user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
describeEcsClustersRequest
- default CompletableFuture<DescribeElasticIpsResponse> describeElasticIps(DescribeElasticIpsRequest describeElasticIpsRequest)
Describes 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 on user permissions, see Managing User Permissions.
describeElasticIpsRequest
- default CompletableFuture<DescribeElasticLoadBalancersResponse> describeElasticLoadBalancers(DescribeElasticLoadBalancersRequest describeElasticLoadBalancersRequest)
Describes 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 on user permissions, see Managing User Permissions.
describeElasticLoadBalancersRequest
- default CompletableFuture<DescribeInstancesResponse> describeInstances(DescribeInstancesRequest describeInstancesRequest)
Requests 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 on user permissions, see Managing User Permissions.
describeInstancesRequest
- default CompletableFuture<DescribeLayersResponse> describeLayers(DescribeLayersRequest describeLayersRequest)
Requests 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 on user permissions, see Managing User Permissions.
describeLayersRequest
- default CompletableFuture<DescribeLoadBasedAutoScalingResponse> describeLoadBasedAutoScaling(DescribeLoadBasedAutoScalingRequest describeLoadBasedAutoScalingRequest)
Describes 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 on user permissions, see Managing User Permissions.
describeLoadBasedAutoScalingRequest
- default CompletableFuture<DescribeMyUserProfileResponse> describeMyUserProfile(DescribeMyUserProfileRequest describeMyUserProfileRequest)
Describes 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 on user permissions, see Managing User Permissions.
describeMyUserProfileRequest
- default CompletableFuture<DescribePermissionsResponse> describePermissions(DescribePermissionsRequest describePermissionsRequest)
Describes 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.
describePermissionsRequest
- default CompletableFuture<DescribeRaidArraysResponse> describeRaidArrays(DescribeRaidArraysRequest describeRaidArraysRequest)
Describe 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 on user permissions, see Managing User Permissions.
describeRaidArraysRequest
- default CompletableFuture<DescribeRdsDbInstancesResponse> describeRdsDbInstances(DescribeRdsDbInstancesRequest describeRdsDbInstancesRequest)
Describes 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 on user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
describeRdsDbInstancesRequest
- default CompletableFuture<DescribeServiceErrorsResponse> describeServiceErrors(DescribeServiceErrorsRequest describeServiceErrorsRequest)
Describes AWS 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 on user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
describeServiceErrorsRequest
- default CompletableFuture<DescribeStackProvisioningParametersResponse> describeStackProvisioningParameters(DescribeStackProvisioningParametersRequest describeStackProvisioningParametersRequest)
Requests 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 on user permissions, see Managing User Permissions.
describeStackProvisioningParametersRequest
- default CompletableFuture<DescribeStackSummaryResponse> describeStackSummary(DescribeStackSummaryRequest describeStackSummaryRequest)
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 on user permissions, see Managing User Permissions.
describeStackSummaryRequest
- default CompletableFuture<DescribeStacksResponse> describeStacks(DescribeStacksRequest describeStacksRequest)
Requests 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 on user permissions, see Managing User Permissions.
describeStacksRequest
- default CompletableFuture<DescribeTimeBasedAutoScalingResponse> describeTimeBasedAutoScaling(DescribeTimeBasedAutoScalingRequest describeTimeBasedAutoScalingRequest)
Describes 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 on user permissions, see Managing User Permissions.
describeTimeBasedAutoScalingRequest
- default CompletableFuture<DescribeUserProfilesResponse> describeUserProfiles(DescribeUserProfilesRequest describeUserProfilesRequest)
Describe specified users.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
describeUserProfilesRequest
- default CompletableFuture<DescribeVolumesResponse> describeVolumes(DescribeVolumesRequest describeVolumesRequest)
Describes 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 on user permissions, see Managing User Permissions.
describeVolumesRequest
- default CompletableFuture<DetachElasticLoadBalancerResponse> detachElasticLoadBalancer(DetachElasticLoadBalancerRequest detachElasticLoadBalancerRequest)
Detaches 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.
detachElasticLoadBalancerRequest
- default CompletableFuture<DisassociateElasticIpResponse> disassociateElasticIp(DisassociateElasticIpRequest disassociateElasticIpRequest)
Disassociates 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.
disassociateElasticIpRequest
- default CompletableFuture<GetHostnameSuggestionResponse> getHostnameSuggestion(GetHostnameSuggestionRequest getHostnameSuggestionRequest)
Gets 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.
getHostnameSuggestionRequest
- default CompletableFuture<GrantAccessResponse> grantAccess(GrantAccessRequest grantAccessRequest)
This action can be used only with Windows stacks.
Grants RDP access to a Windows instance for a specified time period.
grantAccessRequest
- default CompletableFuture<ListTagsResponse> listTags(ListTagsRequest listTagsRequest)
Returns a list of tags that are applied to the specified stack or layer.
listTagsRequest
- default CompletableFuture<RebootInstanceResponse> rebootInstance(RebootInstanceRequest rebootInstanceRequest)
Reboots 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.
rebootInstanceRequest
- default CompletableFuture<RegisterEcsClusterResponse> registerEcsCluster(RegisterEcsClusterRequest registerEcsClusterRequest)
Registers 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.
registerEcsClusterRequest
- default CompletableFuture<RegisterElasticIpResponse> registerElasticIp(RegisterElasticIpRequest registerElasticIpRequest)
Registers 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.
registerElasticIpRequest
- default CompletableFuture<RegisterInstanceResponse> registerInstance(RegisterInstanceRequest registerInstanceRequest)
Registers instances that were created outside of AWS 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 AWS OpsWorks Stacks agent on the instance, and registering the instance with the stack.
RegisterInstance
handles only the second step. You should instead use the AWS CLI
register
command, which performs the entire registration operation. For more information, see Registering an
Instance with an AWS 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.
registerInstanceRequest
- default CompletableFuture<RegisterRdsDbInstanceResponse> registerRdsDbInstance(RegisterRdsDbInstanceRequest registerRdsDbInstanceRequest)
Registers 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.
registerRdsDbInstanceRequest
- default CompletableFuture<RegisterVolumeResponse> registerVolume(RegisterVolumeRequest registerVolumeRequest)
Registers 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.
registerVolumeRequest
- default CompletableFuture<SetLoadBasedAutoScalingResponse> setLoadBasedAutoScaling(SetLoadBasedAutoScalingRequest setLoadBasedAutoScalingRequest)
Specify 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.
setLoadBasedAutoScalingRequest
- default CompletableFuture<SetPermissionResponse> setPermission(SetPermissionRequest setPermissionRequest)
Specifies 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.
setPermissionRequest
- default CompletableFuture<SetTimeBasedAutoScalingResponse> setTimeBasedAutoScaling(SetTimeBasedAutoScalingRequest setTimeBasedAutoScalingRequest)
Specify 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.
setTimeBasedAutoScalingRequest
- default CompletableFuture<StartInstanceResponse> startInstance(StartInstanceRequest startInstanceRequest)
Starts 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.
startInstanceRequest
- default CompletableFuture<StartStackResponse> startStack(StartStackRequest startStackRequest)
Starts 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.
startStackRequest
- default CompletableFuture<StopInstanceResponse> stopInstance(StopInstanceRequest stopInstanceRequest)
Stops 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.
stopInstanceRequest
- default CompletableFuture<StopStackResponse> stopStack(StopStackRequest stopStackRequest)
Stops 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.
stopStackRequest
- default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Apply cost-allocation tags to a specified stack or layer in AWS OpsWorks Stacks. For more information about how tagging works, see Tags in the AWS OpsWorks User Guide.
tagResourceRequest
- default CompletableFuture<UnassignInstanceResponse> unassignInstance(UnassignInstanceRequest unassignInstanceRequest)
Unassigns a registered instance from all of it's layers. 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 AWS 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 on user permissions, see Managing User Permissions.
unassignInstanceRequest
- default CompletableFuture<UnassignVolumeResponse> unassignVolume(UnassignVolumeRequest unassignVolumeRequest)
Unassigns 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.
unassignVolumeRequest
- default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from a specified stack or layer.
untagResourceRequest
- default CompletableFuture<UpdateAppResponse> updateApp(UpdateAppRequest updateAppRequest)
Updates 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.
updateAppRequest
- default CompletableFuture<UpdateElasticIpResponse> updateElasticIp(UpdateElasticIpRequest updateElasticIpRequest)
Updates 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.
updateElasticIpRequest
- default CompletableFuture<UpdateInstanceResponse> updateInstance(UpdateInstanceRequest updateInstanceRequest)
Updates 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.
updateInstanceRequest
- default CompletableFuture<UpdateLayerResponse> updateLayer(UpdateLayerRequest updateLayerRequest)
Updates 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.
updateLayerRequest
- default CompletableFuture<UpdateMyUserProfileResponse> updateMyUserProfile(UpdateMyUserProfileRequest updateMyUserProfileRequest)
Updates 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 on user permissions, see Managing User Permissions.
updateMyUserProfileRequest
- default CompletableFuture<UpdateRdsDbInstanceResponse> updateRdsDbInstance(UpdateRdsDbInstanceRequest updateRdsDbInstanceRequest)
Updates 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.
updateRdsDbInstanceRequest
- default CompletableFuture<UpdateStackResponse> updateStack(UpdateStackRequest updateStackRequest)
Updates 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.
updateStackRequest
- default CompletableFuture<UpdateUserProfileResponse> updateUserProfile(UpdateUserProfileRequest updateUserProfileRequest)
Updates 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 on user permissions, see Managing User Permissions.
updateUserProfileRequest
- default CompletableFuture<UpdateVolumeResponse> updateVolume(UpdateVolumeRequest updateVolumeRequest)
Updates 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.
updateVolumeRequest
- Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.