@Generated(value="software.amazon.awssdk:codegen") public interface OpsWorksAsyncClient extends SdkClient
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.ca-central-1.amazonaws.com (API only; not available in the AWS console)
opsworks.eu-west-1.amazonaws.com
opsworks.eu-west-2.amazonaws.com
opsworks.eu-west-3.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 | Field and Description |
---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider . |
static String |
SERVICE_NAME |
serviceName
close
static final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider
.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<AssignInstanceResponse> assignInstance(Consumer<AssignInstanceRequest.Builder> 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.
This is a convenience which creates an instance of the AssignInstanceRequest.Builder
avoiding the need to
create one manually via AssignInstanceRequest.builder()
assignInstanceRequest
- A Consumer
that will call methods on AssignInstanceRequest.Builder
to create a request.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<AssignVolumeResponse> assignVolume(Consumer<AssignVolumeRequest.Builder> 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.
This is a convenience which creates an instance of the AssignVolumeRequest.Builder
avoiding the need to
create one manually via AssignVolumeRequest.builder()
assignVolumeRequest
- A Consumer
that will call methods on AssignVolumeRequest.Builder
to create a request.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<AssociateElasticIpResponse> associateElasticIp(Consumer<AssociateElasticIpRequest.Builder> 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.
This is a convenience which creates an instance of the AssociateElasticIpRequest.Builder
avoiding the
need to create one manually via AssociateElasticIpRequest.builder()
associateElasticIpRequest
- A Consumer
that will call methods on AssociateElasticIpRequest.Builder
to create a
request.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<AttachElasticLoadBalancerResponse> attachElasticLoadBalancer(Consumer<AttachElasticLoadBalancerRequest.Builder> 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.
This is a convenience which creates an instance of the AttachElasticLoadBalancerRequest.Builder
avoiding
the need to create one manually via AttachElasticLoadBalancerRequest.builder()
attachElasticLoadBalancerRequest
- A Consumer
that will call methods on AttachElasticLoadBalancerRequest.Builder
to create a
request.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 about user permissions, see Managing User Permissions.
cloneStackRequest
- default CompletableFuture<CloneStackResponse> cloneStack(Consumer<CloneStackRequest.Builder> 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 about user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the CloneStackRequest.Builder
avoiding the need to
create one manually via CloneStackRequest.builder()
cloneStackRequest
- A Consumer
that will call methods on CloneStackRequest.Builder
to create a request.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<CreateAppResponse> createApp(Consumer<CreateAppRequest.Builder> 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.
This is a convenience which creates an instance of the CreateAppRequest.Builder
avoiding the need to
create one manually via CreateAppRequest.builder()
createAppRequest
- A Consumer
that will call methods on CreateAppRequest.Builder
to create a request.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<CreateDeploymentResponse> createDeployment(Consumer<CreateDeploymentRequest.Builder> 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.
This is a convenience which creates an instance of the CreateDeploymentRequest.Builder
avoiding the need
to create one manually via CreateDeploymentRequest.builder()
createDeploymentRequest
- A Consumer
that will call methods on CreateDeploymentRequest.Builder
to create a request.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<CreateInstanceResponse> createInstance(Consumer<CreateInstanceRequest.Builder> 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.
This is a convenience which creates an instance of the CreateInstanceRequest.Builder
avoiding the need to
create one manually via CreateInstanceRequest.builder()
createInstanceRequest
- A Consumer
that will call methods on CreateInstanceRequest.Builder
to create a request.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<CreateLayerResponse> createLayer(Consumer<CreateLayerRequest.Builder> 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.
This is a convenience which creates an instance of the CreateLayerRequest.Builder
avoiding the need to
create one manually via CreateLayerRequest.builder()
createLayerRequest
- A Consumer
that will call methods on CreateLayerRequest.Builder
to create a request.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 about user permissions, see Managing User Permissions.
createStackRequest
- default CompletableFuture<CreateStackResponse> createStack(Consumer<CreateStackRequest.Builder> 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 about user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the CreateStackRequest.Builder
avoiding the need to
create one manually via CreateStackRequest.builder()
createStackRequest
- A Consumer
that will call methods on CreateStackRequest.Builder
to create a request.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 about user permissions, see Managing User Permissions.
createUserProfileRequest
- default CompletableFuture<CreateUserProfileResponse> createUserProfile(Consumer<CreateUserProfileRequest.Builder> 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 about user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the CreateUserProfileRequest.Builder
avoiding the need
to create one manually via CreateUserProfileRequest.builder()
createUserProfileRequest
- A Consumer
that will call methods on CreateUserProfileRequest.Builder
to create a request.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<DeleteAppResponse> deleteApp(Consumer<DeleteAppRequest.Builder> 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.
This is a convenience which creates an instance of the DeleteAppRequest.Builder
avoiding the need to
create one manually via DeleteAppRequest.builder()
deleteAppRequest
- A Consumer
that will call methods on DeleteAppRequest.Builder
to create a request.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<DeleteInstanceResponse> deleteInstance(Consumer<DeleteInstanceRequest.Builder> 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.
This is a convenience which creates an instance of the DeleteInstanceRequest.Builder
avoiding the need to
create one manually via DeleteInstanceRequest.builder()
deleteInstanceRequest
- A Consumer
that will call methods on DeleteInstanceRequest.Builder
to create a request.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<DeleteLayerResponse> deleteLayer(Consumer<DeleteLayerRequest.Builder> 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.
This is a convenience which creates an instance of the DeleteLayerRequest.Builder
avoiding the need to
create one manually via DeleteLayerRequest.builder()
deleteLayerRequest
- A Consumer
that will call methods on DeleteLayerRequest.Builder
to create a request.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<DeleteStackResponse> deleteStack(Consumer<DeleteStackRequest.Builder> 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.
This is a convenience which creates an instance of the DeleteStackRequest.Builder
avoiding the need to
create one manually via DeleteStackRequest.builder()
deleteStackRequest
- A Consumer
that will call methods on DeleteStackRequest.Builder
to create a request.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 about user permissions, see Managing User Permissions.
deleteUserProfileRequest
- default CompletableFuture<DeleteUserProfileResponse> deleteUserProfile(Consumer<DeleteUserProfileRequest.Builder> 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 about user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the DeleteUserProfileRequest.Builder
avoiding the need
to create one manually via DeleteUserProfileRequest.builder()
deleteUserProfileRequest
- A Consumer
that will call methods on DeleteUserProfileRequest.Builder
to create a request.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 https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html.
deregisterEcsClusterRequest
- default CompletableFuture<DeregisterEcsClusterResponse> deregisterEcsCluster(Consumer<DeregisterEcsClusterRequest.Builder> 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 https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html.
This is a convenience which creates an instance of the DeregisterEcsClusterRequest.Builder
avoiding the
need to create one manually via DeregisterEcsClusterRequest.builder()
deregisterEcsClusterRequest
- A Consumer
that will call methods on DeregisterEcsClusterRequest.Builder
to create a
request.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<DeregisterElasticIpResponse> deregisterElasticIp(Consumer<DeregisterElasticIpRequest.Builder> 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.
This is a convenience which creates an instance of the DeregisterElasticIpRequest.Builder
avoiding the
need to create one manually via DeregisterElasticIpRequest.builder()
deregisterElasticIpRequest
- A Consumer
that will call methods on DeregisterElasticIpRequest.Builder
to create a
request.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 cannot 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<DeregisterInstanceResponse> deregisterInstance(Consumer<DeregisterInstanceRequest.Builder> 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 cannot 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.
This is a convenience which creates an instance of the DeregisterInstanceRequest.Builder
avoiding the
need to create one manually via DeregisterInstanceRequest.builder()
deregisterInstanceRequest
- A Consumer
that will call methods on DeregisterInstanceRequest.Builder
to create a
request.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<DeregisterRdsDbInstanceResponse> deregisterRdsDbInstance(Consumer<DeregisterRdsDbInstanceRequest.Builder> 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.
This is a convenience which creates an instance of the DeregisterRdsDbInstanceRequest.Builder
avoiding
the need to create one manually via DeregisterRdsDbInstanceRequest.builder()
deregisterRdsDbInstanceRequest
- A Consumer
that will call methods on DeregisterRdsDbInstanceRequest.Builder
to create a
request.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<DeregisterVolumeResponse> deregisterVolume(Consumer<DeregisterVolumeRequest.Builder> 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.
This is a convenience which creates an instance of the DeregisterVolumeRequest.Builder
avoiding the need
to create one manually via DeregisterVolumeRequest.builder()
deregisterVolumeRequest
- A Consumer
that will call methods on DeregisterVolumeRequest.Builder
to create a request.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<DescribeAgentVersionsResponse> describeAgentVersions(Consumer<DescribeAgentVersionsRequest.Builder> 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.
This is a convenience which creates an instance of the DescribeAgentVersionsRequest.Builder
avoiding the
need to create one manually via DescribeAgentVersionsRequest.builder()
describeAgentVersionsRequest
- A Consumer
that will call methods on DescribeAgentVersionsRequest.Builder
to create a
request.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 about user permissions, see Managing User Permissions.
describeAppsRequest
- default CompletableFuture<DescribeAppsResponse> describeApps(Consumer<DescribeAppsRequest.Builder> 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 about user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the DescribeAppsRequest.Builder
avoiding the need to
create one manually via DescribeAppsRequest.builder()
describeAppsRequest
- A Consumer
that will call methods on DescribeAppsRequest.Builder
to create a request.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 about user permissions, see Managing User Permissions.
describeCommandsRequest
- default CompletableFuture<DescribeCommandsResponse> describeCommands(Consumer<DescribeCommandsRequest.Builder> 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 about user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the DescribeCommandsRequest.Builder
avoiding the need
to create one manually via DescribeCommandsRequest.builder()
describeCommandsRequest
- A Consumer
that will call methods on DescribeCommandsRequest.Builder
to create a request.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 about user permissions, see Managing User Permissions.
describeDeploymentsRequest
- default CompletableFuture<DescribeDeploymentsResponse> describeDeployments(Consumer<DescribeDeploymentsRequest.Builder> 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 about user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the DescribeDeploymentsRequest.Builder
avoiding the
need to create one manually via DescribeDeploymentsRequest.builder()
describeDeploymentsRequest
- A Consumer
that will call methods on DescribeDeploymentsRequest.Builder
to create a
request.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 about user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
describeEcsClustersRequest
- default CompletableFuture<DescribeEcsClustersResponse> describeEcsClusters(Consumer<DescribeEcsClustersRequest.Builder> 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 about user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
This is a convenience which creates an instance of the DescribeEcsClustersRequest.Builder
avoiding the
need to create one manually via DescribeEcsClustersRequest.builder()
describeEcsClustersRequest
- A Consumer
that will call methods on DescribeEcsClustersRequest.Builder
to create a
request.default DescribeEcsClustersPublisher describeEcsClustersPaginator(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 about user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
This is a variant of
describeEcsClusters(software.amazon.awssdk.services.opsworks.model.DescribeEcsClustersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.opsworks.paginators.DescribeEcsClustersPublisher publisher = client.describeEcsClustersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.opsworks.paginators.DescribeEcsClustersPublisher publisher = client.describeEcsClustersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opsworks.model.DescribeEcsClustersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.opsworks.model.DescribeEcsClustersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEcsClusters(software.amazon.awssdk.services.opsworks.model.DescribeEcsClustersRequest)
operation.
describeEcsClustersRequest
- default DescribeEcsClustersPublisher describeEcsClustersPaginator(Consumer<DescribeEcsClustersRequest.Builder> 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 about user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
This is a variant of
describeEcsClusters(software.amazon.awssdk.services.opsworks.model.DescribeEcsClustersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.opsworks.paginators.DescribeEcsClustersPublisher publisher = client.describeEcsClustersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.opsworks.paginators.DescribeEcsClustersPublisher publisher = client.describeEcsClustersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opsworks.model.DescribeEcsClustersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.opsworks.model.DescribeEcsClustersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEcsClusters(software.amazon.awssdk.services.opsworks.model.DescribeEcsClustersRequest)
operation.
This is a convenience which creates an instance of the DescribeEcsClustersRequest.Builder
avoiding the
need to create one manually via DescribeEcsClustersRequest.builder()
describeEcsClustersRequest
- A Consumer
that will call methods on DescribeEcsClustersRequest.Builder
to create a
request.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 about user permissions, see Managing User Permissions.
describeElasticIpsRequest
- default CompletableFuture<DescribeElasticIpsResponse> describeElasticIps(Consumer<DescribeElasticIpsRequest.Builder> 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 about user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the DescribeElasticIpsRequest.Builder
avoiding the
need to create one manually via DescribeElasticIpsRequest.builder()
describeElasticIpsRequest
- A Consumer
that will call methods on DescribeElasticIpsRequest.Builder
to create a
request.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 about user permissions, see Managing User Permissions.
describeElasticLoadBalancersRequest
- default CompletableFuture<DescribeElasticLoadBalancersResponse> describeElasticLoadBalancers(Consumer<DescribeElasticLoadBalancersRequest.Builder> 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 about user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the DescribeElasticLoadBalancersRequest.Builder
avoiding the need to create one manually via DescribeElasticLoadBalancersRequest.builder()
describeElasticLoadBalancersRequest
- A Consumer
that will call methods on DescribeElasticLoadBalancersRequest.Builder
to create
a request.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 about user permissions, see Managing User Permissions.
describeInstancesRequest
- default CompletableFuture<DescribeInstancesResponse> describeInstances(Consumer<DescribeInstancesRequest.Builder> 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 about user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the DescribeInstancesRequest.Builder
avoiding the need
to create one manually via DescribeInstancesRequest.builder()
describeInstancesRequest
- A Consumer
that will call methods on DescribeInstancesRequest.Builder
to create a request.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 about user permissions, see Managing User Permissions.
describeLayersRequest
- default CompletableFuture<DescribeLayersResponse> describeLayers(Consumer<DescribeLayersRequest.Builder> 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 about user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the DescribeLayersRequest.Builder
avoiding the need to
create one manually via DescribeLayersRequest.builder()
describeLayersRequest
- A Consumer
that will call methods on DescribeLayersRequest.Builder
to create a request.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 about user permissions, see Managing User Permissions.
describeLoadBasedAutoScalingRequest
- default CompletableFuture<DescribeLoadBasedAutoScalingResponse> describeLoadBasedAutoScaling(Consumer<DescribeLoadBasedAutoScalingRequest.Builder> 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 about user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the DescribeLoadBasedAutoScalingRequest.Builder
avoiding the need to create one manually via DescribeLoadBasedAutoScalingRequest.builder()
describeLoadBasedAutoScalingRequest
- A Consumer
that will call methods on DescribeLoadBasedAutoScalingRequest.Builder
to create
a request.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 about user permissions, see Managing User Permissions.
describeMyUserProfileRequest
- default CompletableFuture<DescribeMyUserProfileResponse> describeMyUserProfile(Consumer<DescribeMyUserProfileRequest.Builder> 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 about user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the DescribeMyUserProfileRequest.Builder
avoiding the
need to create one manually via DescribeMyUserProfileRequest.builder()
describeMyUserProfileRequest
- A Consumer
that will call methods on DescribeMyUserProfileRequest.Builder
to create a
request.default CompletableFuture<DescribeMyUserProfileResponse> describeMyUserProfile()
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 about user permissions, see Managing User Permissions.
default CompletableFuture<DescribeOperatingSystemsResponse> describeOperatingSystems(DescribeOperatingSystemsRequest describeOperatingSystemsRequest)
Describes the operating systems that are supported by AWS OpsWorks Stacks.
describeOperatingSystemsRequest
- default CompletableFuture<DescribeOperatingSystemsResponse> describeOperatingSystems(Consumer<DescribeOperatingSystemsRequest.Builder> describeOperatingSystemsRequest)
Describes the operating systems that are supported by AWS OpsWorks Stacks.
This is a convenience which creates an instance of the DescribeOperatingSystemsRequest.Builder
avoiding
the need to create one manually via DescribeOperatingSystemsRequest.builder()
describeOperatingSystemsRequest
- A Consumer
that will call methods on DescribeOperatingSystemsRequest.Builder
to create a
request.default CompletableFuture<DescribeOperatingSystemsResponse> describeOperatingSystems()
Describes the operating systems that are supported by AWS OpsWorks Stacks.
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<DescribePermissionsResponse> describePermissions(Consumer<DescribePermissionsRequest.Builder> 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.
This is a convenience which creates an instance of the DescribePermissionsRequest.Builder
avoiding the
need to create one manually via DescribePermissionsRequest.builder()
describePermissionsRequest
- A Consumer
that will call methods on DescribePermissionsRequest.Builder
to create a
request.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 about user permissions, see Managing User Permissions.
describeRaidArraysRequest
- default CompletableFuture<DescribeRaidArraysResponse> describeRaidArrays(Consumer<DescribeRaidArraysRequest.Builder> 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 about user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the DescribeRaidArraysRequest.Builder
avoiding the
need to create one manually via DescribeRaidArraysRequest.builder()
describeRaidArraysRequest
- A Consumer
that will call methods on DescribeRaidArraysRequest.Builder
to create a
request.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 about user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
describeRdsDbInstancesRequest
- default CompletableFuture<DescribeRdsDbInstancesResponse> describeRdsDbInstances(Consumer<DescribeRdsDbInstancesRequest.Builder> 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 about user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
This is a convenience which creates an instance of the DescribeRdsDbInstancesRequest.Builder
avoiding the
need to create one manually via DescribeRdsDbInstancesRequest.builder()
describeRdsDbInstancesRequest
- A Consumer
that will call methods on DescribeRdsDbInstancesRequest.Builder
to create a
request.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 about user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
describeServiceErrorsRequest
- default CompletableFuture<DescribeServiceErrorsResponse> describeServiceErrors(Consumer<DescribeServiceErrorsRequest.Builder> 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 about user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
This is a convenience which creates an instance of the DescribeServiceErrorsRequest.Builder
avoiding the
need to create one manually via DescribeServiceErrorsRequest.builder()
describeServiceErrorsRequest
- A Consumer
that will call methods on DescribeServiceErrorsRequest.Builder
to create a
request.default CompletableFuture<DescribeServiceErrorsResponse> describeServiceErrors()
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 about user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
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 about user permissions, see Managing User Permissions.
describeStackProvisioningParametersRequest
- default CompletableFuture<DescribeStackProvisioningParametersResponse> describeStackProvisioningParameters(Consumer<DescribeStackProvisioningParametersRequest.Builder> 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 about user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the DescribeStackProvisioningParametersRequest.Builder
avoiding the need to create one manually via DescribeStackProvisioningParametersRequest.builder()
describeStackProvisioningParametersRequest
- A Consumer
that will call methods on DescribeStackProvisioningParametersRequest.Builder
to
create a request.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 about user permissions, see Managing User Permissions.
describeStackSummaryRequest
- default CompletableFuture<DescribeStackSummaryResponse> describeStackSummary(Consumer<DescribeStackSummaryRequest.Builder> 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 about user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the DescribeStackSummaryRequest.Builder
avoiding the
need to create one manually via DescribeStackSummaryRequest.builder()
describeStackSummaryRequest
- A Consumer
that will call methods on DescribeStackSummaryRequest.Builder
to create a
request.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 about user permissions, see Managing User Permissions.
describeStacksRequest
- default CompletableFuture<DescribeStacksResponse> describeStacks(Consumer<DescribeStacksRequest.Builder> 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 about user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the DescribeStacksRequest.Builder
avoiding the need to
create one manually via DescribeStacksRequest.builder()
describeStacksRequest
- A Consumer
that will call methods on DescribeStacksRequest.Builder
to create a request.default CompletableFuture<DescribeStacksResponse> describeStacks()
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 about user permissions, see Managing User Permissions.
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 about user permissions, see Managing User Permissions.
describeTimeBasedAutoScalingRequest
- default CompletableFuture<DescribeTimeBasedAutoScalingResponse> describeTimeBasedAutoScaling(Consumer<DescribeTimeBasedAutoScalingRequest.Builder> 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 about user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the DescribeTimeBasedAutoScalingRequest.Builder
avoiding the need to create one manually via DescribeTimeBasedAutoScalingRequest.builder()
describeTimeBasedAutoScalingRequest
- A Consumer
that will call methods on DescribeTimeBasedAutoScalingRequest.Builder
to create
a request.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 about user permissions, see Managing User Permissions.
describeUserProfilesRequest
- default CompletableFuture<DescribeUserProfilesResponse> describeUserProfiles(Consumer<DescribeUserProfilesRequest.Builder> 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 about user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the DescribeUserProfilesRequest.Builder
avoiding the
need to create one manually via DescribeUserProfilesRequest.builder()
describeUserProfilesRequest
- A Consumer
that will call methods on DescribeUserProfilesRequest.Builder
to create a
request.default CompletableFuture<DescribeUserProfilesResponse> describeUserProfiles()
Describe 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.
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 about user permissions, see Managing User Permissions.
describeVolumesRequest
- default CompletableFuture<DescribeVolumesResponse> describeVolumes(Consumer<DescribeVolumesRequest.Builder> 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 about user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the DescribeVolumesRequest.Builder
avoiding the need
to create one manually via DescribeVolumesRequest.builder()
describeVolumesRequest
- A Consumer
that will call methods on DescribeVolumesRequest.Builder
to create a request.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<DetachElasticLoadBalancerResponse> detachElasticLoadBalancer(Consumer<DetachElasticLoadBalancerRequest.Builder> 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.
This is a convenience which creates an instance of the DetachElasticLoadBalancerRequest.Builder
avoiding
the need to create one manually via DetachElasticLoadBalancerRequest.builder()
detachElasticLoadBalancerRequest
- A Consumer
that will call methods on DetachElasticLoadBalancerRequest.Builder
to create a
request.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<DisassociateElasticIpResponse> disassociateElasticIp(Consumer<DisassociateElasticIpRequest.Builder> 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.
This is a convenience which creates an instance of the DisassociateElasticIpRequest.Builder
avoiding the
need to create one manually via DisassociateElasticIpRequest.builder()
disassociateElasticIpRequest
- A Consumer
that will call methods on DisassociateElasticIpRequest.Builder
to create a
request.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<GetHostnameSuggestionResponse> getHostnameSuggestion(Consumer<GetHostnameSuggestionRequest.Builder> 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.
This is a convenience which creates an instance of the GetHostnameSuggestionRequest.Builder
avoiding the
need to create one manually via GetHostnameSuggestionRequest.builder()
getHostnameSuggestionRequest
- A Consumer
that will call methods on GetHostnameSuggestionRequest.Builder
to create a
request.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<GrantAccessResponse> grantAccess(Consumer<GrantAccessRequest.Builder> grantAccessRequest)
This action can be used only with Windows stacks.
Grants RDP access to a Windows instance for a specified time period.
This is a convenience which creates an instance of the GrantAccessRequest.Builder
avoiding the need to
create one manually via GrantAccessRequest.builder()
grantAccessRequest
- A Consumer
that will call methods on GrantAccessRequest.Builder
to create a request.default CompletableFuture<ListTagsResponse> listTags(ListTagsRequest listTagsRequest)
Returns a list of tags that are applied to the specified stack or layer.
listTagsRequest
- default CompletableFuture<ListTagsResponse> listTags(Consumer<ListTagsRequest.Builder> listTagsRequest)
Returns a list of tags that are applied to the specified stack or layer.
This is a convenience which creates an instance of the ListTagsRequest.Builder
avoiding the need to
create one manually via ListTagsRequest.builder()
listTagsRequest
- A Consumer
that will call methods on ListTagsRequest.Builder
to create a request.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<RebootInstanceResponse> rebootInstance(Consumer<RebootInstanceRequest.Builder> 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.
This is a convenience which creates an instance of the RebootInstanceRequest.Builder
avoiding the need to
create one manually via RebootInstanceRequest.builder()
rebootInstanceRequest
- A Consumer
that will call methods on RebootInstanceRequest.Builder
to create a request.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<RegisterEcsClusterResponse> registerEcsCluster(Consumer<RegisterEcsClusterRequest.Builder> 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.
This is a convenience which creates an instance of the RegisterEcsClusterRequest.Builder
avoiding the
need to create one manually via RegisterEcsClusterRequest.builder()
registerEcsClusterRequest
- A Consumer
that will call methods on RegisterEcsClusterRequest.Builder
to create a
request.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<RegisterElasticIpResponse> registerElasticIp(Consumer<RegisterElasticIpRequest.Builder> 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.
This is a convenience which creates an instance of the RegisterElasticIpRequest.Builder
avoiding the need
to create one manually via RegisterElasticIpRequest.builder()
registerElasticIpRequest
- A Consumer
that will call methods on RegisterElasticIpRequest.Builder
to create a request.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<RegisterInstanceResponse> registerInstance(Consumer<RegisterInstanceRequest.Builder> 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.
This is a convenience which creates an instance of the RegisterInstanceRequest.Builder
avoiding the need
to create one manually via RegisterInstanceRequest.builder()
registerInstanceRequest
- A Consumer
that will call methods on RegisterInstanceRequest.Builder
to create a request.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<RegisterRdsDbInstanceResponse> registerRdsDbInstance(Consumer<RegisterRdsDbInstanceRequest.Builder> 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.
This is a convenience which creates an instance of the RegisterRdsDbInstanceRequest.Builder
avoiding the
need to create one manually via RegisterRdsDbInstanceRequest.builder()
registerRdsDbInstanceRequest
- A Consumer
that will call methods on RegisterRdsDbInstanceRequest.Builder
to create a
request.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<RegisterVolumeResponse> registerVolume(Consumer<RegisterVolumeRequest.Builder> 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.
This is a convenience which creates an instance of the RegisterVolumeRequest.Builder
avoiding the need to
create one manually via RegisterVolumeRequest.builder()
registerVolumeRequest
- A Consumer
that will call methods on RegisterVolumeRequest.Builder
to create a request.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<SetLoadBasedAutoScalingResponse> setLoadBasedAutoScaling(Consumer<SetLoadBasedAutoScalingRequest.Builder> 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.
This is a convenience which creates an instance of the SetLoadBasedAutoScalingRequest.Builder
avoiding
the need to create one manually via SetLoadBasedAutoScalingRequest.builder()
setLoadBasedAutoScalingRequest
- A Consumer
that will call methods on SetLoadBasedAutoScalingRequest.Builder
to create a
request.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<SetPermissionResponse> setPermission(Consumer<SetPermissionRequest.Builder> 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.
This is a convenience which creates an instance of the SetPermissionRequest.Builder
avoiding the need to
create one manually via SetPermissionRequest.builder()
setPermissionRequest
- A Consumer
that will call methods on SetPermissionRequest.Builder
to create a request.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<SetTimeBasedAutoScalingResponse> setTimeBasedAutoScaling(Consumer<SetTimeBasedAutoScalingRequest.Builder> 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.
This is a convenience which creates an instance of the SetTimeBasedAutoScalingRequest.Builder
avoiding
the need to create one manually via SetTimeBasedAutoScalingRequest.builder()
setTimeBasedAutoScalingRequest
- A Consumer
that will call methods on SetTimeBasedAutoScalingRequest.Builder
to create a
request.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<StartInstanceResponse> startInstance(Consumer<StartInstanceRequest.Builder> 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.
This is a convenience which creates an instance of the StartInstanceRequest.Builder
avoiding the need to
create one manually via StartInstanceRequest.builder()
startInstanceRequest
- A Consumer
that will call methods on StartInstanceRequest.Builder
to create a request.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<StartStackResponse> startStack(Consumer<StartStackRequest.Builder> 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.
This is a convenience which creates an instance of the StartStackRequest.Builder
avoiding the need to
create one manually via StartStackRequest.builder()
startStackRequest
- A Consumer
that will call methods on StartStackRequest.Builder
to create a request.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<StopInstanceResponse> stopInstance(Consumer<StopInstanceRequest.Builder> 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.
This is a convenience which creates an instance of the StopInstanceRequest.Builder
avoiding the need to
create one manually via StopInstanceRequest.builder()
stopInstanceRequest
- A Consumer
that will call methods on StopInstanceRequest.Builder
to create a request.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<StopStackResponse> stopStack(Consumer<StopStackRequest.Builder> 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.
This is a convenience which creates an instance of the StopStackRequest.Builder
avoiding the need to
create one manually via StopStackRequest.builder()
stopStackRequest
- A Consumer
that will call methods on StopStackRequest.Builder
to create a request.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<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> 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.
This is a convenience which creates an instance of the TagResourceRequest.Builder
avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest
- A Consumer
that will call methods on TagResourceRequest.Builder
to create a request.default CompletableFuture<UnassignInstanceResponse> unassignInstance(UnassignInstanceRequest unassignInstanceRequest)
Unassigns 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 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 about user permissions, see Managing User Permissions.
unassignInstanceRequest
- default CompletableFuture<UnassignInstanceResponse> unassignInstance(Consumer<UnassignInstanceRequest.Builder> unassignInstanceRequest)
Unassigns 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 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 about user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the UnassignInstanceRequest.Builder
avoiding the need
to create one manually via UnassignInstanceRequest.builder()
unassignInstanceRequest
- A Consumer
that will call methods on UnassignInstanceRequest.Builder
to create a request.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<UnassignVolumeResponse> unassignVolume(Consumer<UnassignVolumeRequest.Builder> 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.
This is a convenience which creates an instance of the UnassignVolumeRequest.Builder
avoiding the need to
create one manually via UnassignVolumeRequest.builder()
unassignVolumeRequest
- A Consumer
that will call methods on UnassignVolumeRequest.Builder
to create a request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from a specified stack or layer.
untagResourceRequest
- default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from a specified stack or layer.
This is a convenience which creates an instance of the UntagResourceRequest.Builder
avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest
- A Consumer
that will call methods on UntagResourceRequest.Builder
to create a request.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<UpdateAppResponse> updateApp(Consumer<UpdateAppRequest.Builder> 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.
This is a convenience which creates an instance of the UpdateAppRequest.Builder
avoiding the need to
create one manually via UpdateAppRequest.builder()
updateAppRequest
- A Consumer
that will call methods on UpdateAppRequest.Builder
to create a request.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<UpdateElasticIpResponse> updateElasticIp(Consumer<UpdateElasticIpRequest.Builder> 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.
This is a convenience which creates an instance of the UpdateElasticIpRequest.Builder
avoiding the need
to create one manually via UpdateElasticIpRequest.builder()
updateElasticIpRequest
- A Consumer
that will call methods on UpdateElasticIpRequest.Builder
to create a request.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<UpdateInstanceResponse> updateInstance(Consumer<UpdateInstanceRequest.Builder> 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.
This is a convenience which creates an instance of the UpdateInstanceRequest.Builder
avoiding the need to
create one manually via UpdateInstanceRequest.builder()
updateInstanceRequest
- A Consumer
that will call methods on UpdateInstanceRequest.Builder
to create a request.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<UpdateLayerResponse> updateLayer(Consumer<UpdateLayerRequest.Builder> 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.
This is a convenience which creates an instance of the UpdateLayerRequest.Builder
avoiding the need to
create one manually via UpdateLayerRequest.builder()
updateLayerRequest
- A Consumer
that will call methods on UpdateLayerRequest.Builder
to create a request.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 about user permissions, see Managing User Permissions.
updateMyUserProfileRequest
- default CompletableFuture<UpdateMyUserProfileResponse> updateMyUserProfile(Consumer<UpdateMyUserProfileRequest.Builder> 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 about user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the UpdateMyUserProfileRequest.Builder
avoiding the
need to create one manually via UpdateMyUserProfileRequest.builder()
updateMyUserProfileRequest
- A Consumer
that will call methods on UpdateMyUserProfileRequest.Builder
to create a
request.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<UpdateRdsDbInstanceResponse> updateRdsDbInstance(Consumer<UpdateRdsDbInstanceRequest.Builder> 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.
This is a convenience which creates an instance of the UpdateRdsDbInstanceRequest.Builder
avoiding the
need to create one manually via UpdateRdsDbInstanceRequest.builder()
updateRdsDbInstanceRequest
- A Consumer
that will call methods on UpdateRdsDbInstanceRequest.Builder
to create a
request.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<UpdateStackResponse> updateStack(Consumer<UpdateStackRequest.Builder> 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.
This is a convenience which creates an instance of the UpdateStackRequest.Builder
avoiding the need to
create one manually via UpdateStackRequest.builder()
updateStackRequest
- A Consumer
that will call methods on UpdateStackRequest.Builder
to create a request.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 about user permissions, see Managing User Permissions.
updateUserProfileRequest
- default CompletableFuture<UpdateUserProfileResponse> updateUserProfile(Consumer<UpdateUserProfileRequest.Builder> 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 about user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the UpdateUserProfileRequest.Builder
avoiding the need
to create one manually via UpdateUserProfileRequest.builder()
updateUserProfileRequest
- A Consumer
that will call methods on UpdateUserProfileRequest.Builder
to create a request.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
- default CompletableFuture<UpdateVolumeResponse> updateVolume(Consumer<UpdateVolumeRequest.Builder> 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.
This is a convenience which creates an instance of the UpdateVolumeRequest.Builder
avoiding the need to
create one manually via UpdateVolumeRequest.builder()
updateVolumeRequest
- A Consumer
that will call methods on UpdateVolumeRequest.Builder
to create a request.default OpsWorksAsyncWaiter waiter()
OpsWorksAsyncWaiter
using this client.
Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
OpsWorksAsyncWaiter