Interface OpsWorksClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,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.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptiondefault AssignInstanceResponse
assignInstance
(Consumer<AssignInstanceRequest.Builder> assignInstanceRequest) Assign a registered instance to a layer.default AssignInstanceResponse
assignInstance
(AssignInstanceRequest assignInstanceRequest) Assign a registered instance to a layer.default AssignVolumeResponse
assignVolume
(Consumer<AssignVolumeRequest.Builder> assignVolumeRequest) Assigns one of the stack's registered Amazon EBS volumes to a specified instance.default AssignVolumeResponse
assignVolume
(AssignVolumeRequest assignVolumeRequest) Assigns one of the stack's registered Amazon EBS volumes to a specified instance.default AssociateElasticIpResponse
associateElasticIp
(Consumer<AssociateElasticIpRequest.Builder> associateElasticIpRequest) Associates one of the stack's registered Elastic IP addresses with a specified instance.default AssociateElasticIpResponse
associateElasticIp
(AssociateElasticIpRequest associateElasticIpRequest) Associates one of the stack's registered Elastic IP addresses with a specified instance.attachElasticLoadBalancer
(Consumer<AttachElasticLoadBalancerRequest.Builder> attachElasticLoadBalancerRequest) Attaches an Elastic Load Balancing load balancer to a specified layer.attachElasticLoadBalancer
(AttachElasticLoadBalancerRequest attachElasticLoadBalancerRequest) Attaches an Elastic Load Balancing load balancer to a specified layer.static OpsWorksClientBuilder
builder()
Create a builder that can be used to configure and create aOpsWorksClient
.default CloneStackResponse
cloneStack
(Consumer<CloneStackRequest.Builder> cloneStackRequest) Creates a clone of a specified stack.default CloneStackResponse
cloneStack
(CloneStackRequest cloneStackRequest) Creates a clone of a specified stack.static OpsWorksClient
create()
Create aOpsWorksClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateAppResponse
createApp
(Consumer<CreateAppRequest.Builder> createAppRequest) Creates an app for a specified stack.default CreateAppResponse
createApp
(CreateAppRequest createAppRequest) Creates an app for a specified stack.default CreateDeploymentResponse
createDeployment
(Consumer<CreateDeploymentRequest.Builder> createDeploymentRequest) Runs deployment or stack commands.default CreateDeploymentResponse
createDeployment
(CreateDeploymentRequest createDeploymentRequest) Runs deployment or stack commands.default CreateInstanceResponse
createInstance
(Consumer<CreateInstanceRequest.Builder> createInstanceRequest) Creates an instance in a specified stack.default CreateInstanceResponse
createInstance
(CreateInstanceRequest createInstanceRequest) Creates an instance in a specified stack.default CreateLayerResponse
createLayer
(Consumer<CreateLayerRequest.Builder> createLayerRequest) Creates a layer.default CreateLayerResponse
createLayer
(CreateLayerRequest createLayerRequest) Creates a layer.default CreateStackResponse
createStack
(Consumer<CreateStackRequest.Builder> createStackRequest) Creates a new stack.default CreateStackResponse
createStack
(CreateStackRequest createStackRequest) Creates a new stack.default CreateUserProfileResponse
createUserProfile
(Consumer<CreateUserProfileRequest.Builder> createUserProfileRequest) Creates a new user profile.default CreateUserProfileResponse
createUserProfile
(CreateUserProfileRequest createUserProfileRequest) Creates a new user profile.default DeleteAppResponse
deleteApp
(Consumer<DeleteAppRequest.Builder> deleteAppRequest) Deletes a specified app.default DeleteAppResponse
deleteApp
(DeleteAppRequest deleteAppRequest) Deletes a specified app.default DeleteInstanceResponse
deleteInstance
(Consumer<DeleteInstanceRequest.Builder> deleteInstanceRequest) Deletes a specified instance, which terminates the associated Amazon EC2 instance.default DeleteInstanceResponse
deleteInstance
(DeleteInstanceRequest deleteInstanceRequest) Deletes a specified instance, which terminates the associated Amazon EC2 instance.default DeleteLayerResponse
deleteLayer
(Consumer<DeleteLayerRequest.Builder> deleteLayerRequest) Deletes a specified layer.default DeleteLayerResponse
deleteLayer
(DeleteLayerRequest deleteLayerRequest) Deletes a specified layer.default DeleteStackResponse
deleteStack
(Consumer<DeleteStackRequest.Builder> deleteStackRequest) Deletes a specified stack.default DeleteStackResponse
deleteStack
(DeleteStackRequest deleteStackRequest) Deletes a specified stack.default DeleteUserProfileResponse
deleteUserProfile
(Consumer<DeleteUserProfileRequest.Builder> deleteUserProfileRequest) Deletes a user profile.default DeleteUserProfileResponse
deleteUserProfile
(DeleteUserProfileRequest deleteUserProfileRequest) Deletes a user profile.default DeregisterEcsClusterResponse
deregisterEcsCluster
(Consumer<DeregisterEcsClusterRequest.Builder> deregisterEcsClusterRequest) Deregisters a specified Amazon ECS cluster from a stack.default DeregisterEcsClusterResponse
deregisterEcsCluster
(DeregisterEcsClusterRequest deregisterEcsClusterRequest) Deregisters a specified Amazon ECS cluster from a stack.default DeregisterElasticIpResponse
deregisterElasticIp
(Consumer<DeregisterElasticIpRequest.Builder> deregisterElasticIpRequest) Deregisters a specified Elastic IP address.default DeregisterElasticIpResponse
deregisterElasticIp
(DeregisterElasticIpRequest deregisterElasticIpRequest) Deregisters a specified Elastic IP address.default DeregisterInstanceResponse
deregisterInstance
(Consumer<DeregisterInstanceRequest.Builder> deregisterInstanceRequest) Deregister a registered Amazon EC2 or on-premises instance.default DeregisterInstanceResponse
deregisterInstance
(DeregisterInstanceRequest deregisterInstanceRequest) Deregister a registered Amazon EC2 or on-premises instance.default DeregisterRdsDbInstanceResponse
deregisterRdsDbInstance
(Consumer<DeregisterRdsDbInstanceRequest.Builder> deregisterRdsDbInstanceRequest) Deregisters an Amazon RDS instance.default DeregisterRdsDbInstanceResponse
deregisterRdsDbInstance
(DeregisterRdsDbInstanceRequest deregisterRdsDbInstanceRequest) Deregisters an Amazon RDS instance.default DeregisterVolumeResponse
deregisterVolume
(Consumer<DeregisterVolumeRequest.Builder> deregisterVolumeRequest) Deregisters an Amazon EBS volume.default DeregisterVolumeResponse
deregisterVolume
(DeregisterVolumeRequest deregisterVolumeRequest) Deregisters an Amazon EBS volume.default DescribeAgentVersionsResponse
describeAgentVersions
(Consumer<DescribeAgentVersionsRequest.Builder> describeAgentVersionsRequest) Describes the available AWS OpsWorks Stacks agent versions.default DescribeAgentVersionsResponse
describeAgentVersions
(DescribeAgentVersionsRequest describeAgentVersionsRequest) Describes the available AWS OpsWorks Stacks agent versions.default DescribeAppsResponse
describeApps
(Consumer<DescribeAppsRequest.Builder> describeAppsRequest) Requests a description of a specified set of apps.default DescribeAppsResponse
describeApps
(DescribeAppsRequest describeAppsRequest) Requests a description of a specified set of apps.default DescribeCommandsResponse
describeCommands
(Consumer<DescribeCommandsRequest.Builder> describeCommandsRequest) Describes the results of specified commands.default DescribeCommandsResponse
describeCommands
(DescribeCommandsRequest describeCommandsRequest) Describes the results of specified commands.default DescribeDeploymentsResponse
describeDeployments
(Consumer<DescribeDeploymentsRequest.Builder> describeDeploymentsRequest) Requests a description of a specified set of deployments.default DescribeDeploymentsResponse
describeDeployments
(DescribeDeploymentsRequest describeDeploymentsRequest) Requests a description of a specified set of deployments.default DescribeEcsClustersResponse
describeEcsClusters
(Consumer<DescribeEcsClustersRequest.Builder> describeEcsClustersRequest) Describes Amazon ECS clusters that are registered with a stack.default DescribeEcsClustersResponse
describeEcsClusters
(DescribeEcsClustersRequest describeEcsClustersRequest) Describes Amazon ECS clusters that are registered with a stack.default DescribeEcsClustersIterable
describeEcsClustersPaginator
(Consumer<DescribeEcsClustersRequest.Builder> describeEcsClustersRequest) This is a variant ofdescribeEcsClusters(software.amazon.awssdk.services.opsworks.model.DescribeEcsClustersRequest)
operation.default DescribeEcsClustersIterable
describeEcsClustersPaginator
(DescribeEcsClustersRequest describeEcsClustersRequest) This is a variant ofdescribeEcsClusters(software.amazon.awssdk.services.opsworks.model.DescribeEcsClustersRequest)
operation.default DescribeElasticIpsResponse
describeElasticIps
(Consumer<DescribeElasticIpsRequest.Builder> describeElasticIpsRequest) Describes Elastic IP addresses.default DescribeElasticIpsResponse
describeElasticIps
(DescribeElasticIpsRequest describeElasticIpsRequest) Describes Elastic IP addresses.describeElasticLoadBalancers
(Consumer<DescribeElasticLoadBalancersRequest.Builder> describeElasticLoadBalancersRequest) Describes a stack's Elastic Load Balancing instances.describeElasticLoadBalancers
(DescribeElasticLoadBalancersRequest describeElasticLoadBalancersRequest) Describes a stack's Elastic Load Balancing instances.default DescribeInstancesResponse
describeInstances
(Consumer<DescribeInstancesRequest.Builder> describeInstancesRequest) Requests a description of a set of instances.default DescribeInstancesResponse
describeInstances
(DescribeInstancesRequest describeInstancesRequest) Requests a description of a set of instances.default DescribeLayersResponse
describeLayers
(Consumer<DescribeLayersRequest.Builder> describeLayersRequest) Requests a description of one or more layers in a specified stack.default DescribeLayersResponse
describeLayers
(DescribeLayersRequest describeLayersRequest) Requests a description of one or more layers in a specified stack.describeLoadBasedAutoScaling
(Consumer<DescribeLoadBasedAutoScalingRequest.Builder> describeLoadBasedAutoScalingRequest) Describes load-based auto scaling configurations for specified layers.describeLoadBasedAutoScaling
(DescribeLoadBasedAutoScalingRequest describeLoadBasedAutoScalingRequest) Describes load-based auto scaling configurations for specified layers.default DescribeMyUserProfileResponse
Describes a user's SSH information.default DescribeMyUserProfileResponse
describeMyUserProfile
(Consumer<DescribeMyUserProfileRequest.Builder> describeMyUserProfileRequest) Describes a user's SSH information.default DescribeMyUserProfileResponse
describeMyUserProfile
(DescribeMyUserProfileRequest describeMyUserProfileRequest) Describes a user's SSH information.default DescribeOperatingSystemsResponse
Describes the operating systems that are supported by AWS OpsWorks Stacks.default DescribeOperatingSystemsResponse
describeOperatingSystems
(Consumer<DescribeOperatingSystemsRequest.Builder> describeOperatingSystemsRequest) Describes the operating systems that are supported by AWS OpsWorks Stacks.default DescribeOperatingSystemsResponse
describeOperatingSystems
(DescribeOperatingSystemsRequest describeOperatingSystemsRequest) Describes the operating systems that are supported by AWS OpsWorks Stacks.default DescribePermissionsResponse
describePermissions
(Consumer<DescribePermissionsRequest.Builder> describePermissionsRequest) Describes the permissions for a specified stack.default DescribePermissionsResponse
describePermissions
(DescribePermissionsRequest describePermissionsRequest) Describes the permissions for a specified stack.default DescribeRaidArraysResponse
describeRaidArrays
(Consumer<DescribeRaidArraysRequest.Builder> describeRaidArraysRequest) Describe an instance's RAID arrays.default DescribeRaidArraysResponse
describeRaidArrays
(DescribeRaidArraysRequest describeRaidArraysRequest) Describe an instance's RAID arrays.default DescribeRdsDbInstancesResponse
describeRdsDbInstances
(Consumer<DescribeRdsDbInstancesRequest.Builder> describeRdsDbInstancesRequest) Describes Amazon RDS instances.default DescribeRdsDbInstancesResponse
describeRdsDbInstances
(DescribeRdsDbInstancesRequest describeRdsDbInstancesRequest) Describes Amazon RDS instances.default DescribeServiceErrorsResponse
Describes AWS OpsWorks Stacks service errors.default DescribeServiceErrorsResponse
describeServiceErrors
(Consumer<DescribeServiceErrorsRequest.Builder> describeServiceErrorsRequest) Describes AWS OpsWorks Stacks service errors.default DescribeServiceErrorsResponse
describeServiceErrors
(DescribeServiceErrorsRequest describeServiceErrorsRequest) Describes AWS OpsWorks Stacks service errors.describeStackProvisioningParameters
(Consumer<DescribeStackProvisioningParametersRequest.Builder> describeStackProvisioningParametersRequest) Requests a description of a stack's provisioning parameters.describeStackProvisioningParameters
(DescribeStackProvisioningParametersRequest describeStackProvisioningParametersRequest) Requests a description of a stack's provisioning parameters.default DescribeStacksResponse
Requests a description of one or more stacks.default DescribeStacksResponse
describeStacks
(Consumer<DescribeStacksRequest.Builder> describeStacksRequest) Requests a description of one or more stacks.default DescribeStacksResponse
describeStacks
(DescribeStacksRequest describeStacksRequest) Requests a description of one or more stacks.default 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 asrunning_setup
oronline
.default DescribeStackSummaryResponse
describeStackSummary
(DescribeStackSummaryRequest describeStackSummaryRequest) Describes the number of layers and apps in a specified stack, and the number of instances in each state, such asrunning_setup
oronline
.describeTimeBasedAutoScaling
(Consumer<DescribeTimeBasedAutoScalingRequest.Builder> describeTimeBasedAutoScalingRequest) Describes time-based auto scaling configurations for specified instances.describeTimeBasedAutoScaling
(DescribeTimeBasedAutoScalingRequest describeTimeBasedAutoScalingRequest) Describes time-based auto scaling configurations for specified instances.default DescribeUserProfilesResponse
Describe specified users.default DescribeUserProfilesResponse
describeUserProfiles
(Consumer<DescribeUserProfilesRequest.Builder> describeUserProfilesRequest) Describe specified users.default DescribeUserProfilesResponse
describeUserProfiles
(DescribeUserProfilesRequest describeUserProfilesRequest) Describe specified users.default DescribeVolumesResponse
describeVolumes
(Consumer<DescribeVolumesRequest.Builder> describeVolumesRequest) Describes an instance's Amazon EBS volumes.default DescribeVolumesResponse
describeVolumes
(DescribeVolumesRequest describeVolumesRequest) Describes an instance's Amazon EBS volumes.detachElasticLoadBalancer
(Consumer<DetachElasticLoadBalancerRequest.Builder> detachElasticLoadBalancerRequest) Detaches a specified Elastic Load Balancing instance from its layer.detachElasticLoadBalancer
(DetachElasticLoadBalancerRequest detachElasticLoadBalancerRequest) Detaches a specified Elastic Load Balancing instance from its layer.default DisassociateElasticIpResponse
disassociateElasticIp
(Consumer<DisassociateElasticIpRequest.Builder> disassociateElasticIpRequest) Disassociates an Elastic IP address from its instance.default DisassociateElasticIpResponse
disassociateElasticIp
(DisassociateElasticIpRequest disassociateElasticIpRequest) Disassociates an Elastic IP address from its instance.default GetHostnameSuggestionResponse
getHostnameSuggestion
(Consumer<GetHostnameSuggestionRequest.Builder> getHostnameSuggestionRequest) Gets a generated host name for the specified layer, based on the current host name theme.default GetHostnameSuggestionResponse
getHostnameSuggestion
(GetHostnameSuggestionRequest getHostnameSuggestionRequest) Gets a generated host name for the specified layer, based on the current host name theme.default GrantAccessResponse
grantAccess
(Consumer<GrantAccessRequest.Builder> grantAccessRequest) default GrantAccessResponse
grantAccess
(GrantAccessRequest grantAccessRequest) default ListTagsResponse
listTags
(Consumer<ListTagsRequest.Builder> listTagsRequest) Returns a list of tags that are applied to the specified stack or layer.default ListTagsResponse
listTags
(ListTagsRequest listTagsRequest) Returns a list of tags that are applied to the specified stack or layer.default RebootInstanceResponse
rebootInstance
(Consumer<RebootInstanceRequest.Builder> rebootInstanceRequest) Reboots a specified instance.default RebootInstanceResponse
rebootInstance
(RebootInstanceRequest rebootInstanceRequest) Reboots a specified instance.default RegisterEcsClusterResponse
registerEcsCluster
(Consumer<RegisterEcsClusterRequest.Builder> registerEcsClusterRequest) Registers a specified Amazon ECS cluster with a stack.default RegisterEcsClusterResponse
registerEcsCluster
(RegisterEcsClusterRequest registerEcsClusterRequest) Registers a specified Amazon ECS cluster with a stack.default RegisterElasticIpResponse
registerElasticIp
(Consumer<RegisterElasticIpRequest.Builder> registerElasticIpRequest) Registers an Elastic IP address with a specified stack.default RegisterElasticIpResponse
registerElasticIp
(RegisterElasticIpRequest registerElasticIpRequest) Registers an Elastic IP address with a specified stack.default RegisterInstanceResponse
registerInstance
(Consumer<RegisterInstanceRequest.Builder> registerInstanceRequest) Registers instances that were created outside of AWS OpsWorks Stacks with a specified stack.default RegisterInstanceResponse
registerInstance
(RegisterInstanceRequest registerInstanceRequest) Registers instances that were created outside of AWS OpsWorks Stacks with a specified stack.default RegisterRdsDbInstanceResponse
registerRdsDbInstance
(Consumer<RegisterRdsDbInstanceRequest.Builder> registerRdsDbInstanceRequest) Registers an Amazon RDS instance with a stack.default RegisterRdsDbInstanceResponse
registerRdsDbInstance
(RegisterRdsDbInstanceRequest registerRdsDbInstanceRequest) Registers an Amazon RDS instance with a stack.default RegisterVolumeResponse
registerVolume
(Consumer<RegisterVolumeRequest.Builder> registerVolumeRequest) Registers an Amazon EBS volume with a specified stack.default RegisterVolumeResponse
registerVolume
(RegisterVolumeRequest registerVolumeRequest) Registers an Amazon EBS volume with a specified stack.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default SetLoadBasedAutoScalingResponse
setLoadBasedAutoScaling
(Consumer<SetLoadBasedAutoScalingRequest.Builder> setLoadBasedAutoScalingRequest) Specify the load-based auto scaling configuration for a specified layer.default SetLoadBasedAutoScalingResponse
setLoadBasedAutoScaling
(SetLoadBasedAutoScalingRequest setLoadBasedAutoScalingRequest) Specify the load-based auto scaling configuration for a specified layer.default SetPermissionResponse
setPermission
(Consumer<SetPermissionRequest.Builder> setPermissionRequest) Specifies a user's permissions.default SetPermissionResponse
setPermission
(SetPermissionRequest setPermissionRequest) Specifies a user's permissions.default SetTimeBasedAutoScalingResponse
setTimeBasedAutoScaling
(Consumer<SetTimeBasedAutoScalingRequest.Builder> setTimeBasedAutoScalingRequest) Specify the time-based auto scaling configuration for a specified instance.default SetTimeBasedAutoScalingResponse
setTimeBasedAutoScaling
(SetTimeBasedAutoScalingRequest setTimeBasedAutoScalingRequest) Specify the time-based auto scaling configuration for a specified instance.default StartInstanceResponse
startInstance
(Consumer<StartInstanceRequest.Builder> startInstanceRequest) Starts a specified instance.default StartInstanceResponse
startInstance
(StartInstanceRequest startInstanceRequest) Starts a specified instance.default StartStackResponse
startStack
(Consumer<StartStackRequest.Builder> startStackRequest) Starts a stack's instances.default StartStackResponse
startStack
(StartStackRequest startStackRequest) Starts a stack's instances.default StopInstanceResponse
stopInstance
(Consumer<StopInstanceRequest.Builder> stopInstanceRequest) Stops a specified instance.default StopInstanceResponse
stopInstance
(StopInstanceRequest stopInstanceRequest) Stops a specified instance.default StopStackResponse
stopStack
(Consumer<StopStackRequest.Builder> stopStackRequest) Stops a specified stack.default StopStackResponse
stopStack
(StopStackRequest stopStackRequest) Stops a specified stack.default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Apply cost-allocation tags to a specified stack or layer in AWS OpsWorks Stacks.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Apply cost-allocation tags to a specified stack or layer in AWS OpsWorks Stacks.default UnassignInstanceResponse
unassignInstance
(Consumer<UnassignInstanceRequest.Builder> unassignInstanceRequest) Unassigns a registered instance from all layers that are using the instance.default UnassignInstanceResponse
unassignInstance
(UnassignInstanceRequest unassignInstanceRequest) Unassigns a registered instance from all layers that are using the instance.default UnassignVolumeResponse
unassignVolume
(Consumer<UnassignVolumeRequest.Builder> unassignVolumeRequest) Unassigns an assigned Amazon EBS volume.default UnassignVolumeResponse
unassignVolume
(UnassignVolumeRequest unassignVolumeRequest) Unassigns an assigned Amazon EBS volume.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from a specified stack or layer.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes tags from a specified stack or layer.default UpdateAppResponse
updateApp
(Consumer<UpdateAppRequest.Builder> updateAppRequest) Updates a specified app.default UpdateAppResponse
updateApp
(UpdateAppRequest updateAppRequest) Updates a specified app.default UpdateElasticIpResponse
updateElasticIp
(Consumer<UpdateElasticIpRequest.Builder> updateElasticIpRequest) Updates a registered Elastic IP address's name.default UpdateElasticIpResponse
updateElasticIp
(UpdateElasticIpRequest updateElasticIpRequest) Updates a registered Elastic IP address's name.default UpdateInstanceResponse
updateInstance
(Consumer<UpdateInstanceRequest.Builder> updateInstanceRequest) Updates a specified instance.default UpdateInstanceResponse
updateInstance
(UpdateInstanceRequest updateInstanceRequest) Updates a specified instance.default UpdateLayerResponse
updateLayer
(Consumer<UpdateLayerRequest.Builder> updateLayerRequest) Updates a specified layer.default UpdateLayerResponse
updateLayer
(UpdateLayerRequest updateLayerRequest) Updates a specified layer.default UpdateMyUserProfileResponse
updateMyUserProfile
(Consumer<UpdateMyUserProfileRequest.Builder> updateMyUserProfileRequest) Updates a user's SSH public key.default UpdateMyUserProfileResponse
updateMyUserProfile
(UpdateMyUserProfileRequest updateMyUserProfileRequest) Updates a user's SSH public key.default UpdateRdsDbInstanceResponse
updateRdsDbInstance
(Consumer<UpdateRdsDbInstanceRequest.Builder> updateRdsDbInstanceRequest) Updates an Amazon RDS instance.default UpdateRdsDbInstanceResponse
updateRdsDbInstance
(UpdateRdsDbInstanceRequest updateRdsDbInstanceRequest) Updates an Amazon RDS instance.default UpdateStackResponse
updateStack
(Consumer<UpdateStackRequest.Builder> updateStackRequest) Updates a specified stack.default UpdateStackResponse
updateStack
(UpdateStackRequest updateStackRequest) Updates a specified stack.default UpdateUserProfileResponse
updateUserProfile
(Consumer<UpdateUserProfileRequest.Builder> updateUserProfileRequest) Updates a specified user profile.default UpdateUserProfileResponse
updateUserProfile
(UpdateUserProfileRequest updateUserProfileRequest) Updates a specified user profile.default UpdateVolumeResponse
updateVolume
(Consumer<UpdateVolumeRequest.Builder> updateVolumeRequest) Updates an Amazon EBS volume's name or mount point.default UpdateVolumeResponse
updateVolume
(UpdateVolumeRequest updateVolumeRequest) Updates an Amazon EBS volume's name or mount point.default OpsWorksWaiter
waiter()
Create an instance ofOpsWorksWaiter
using this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
assignInstance
default AssignInstanceResponse assignInstance(AssignInstanceRequest assignInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
assignInstanceRequest
-- Returns:
- Result of the AssignInstance operation returned by the service.
- See Also:
-
-
assignInstance
default AssignInstanceResponse assignInstance(Consumer<AssignInstanceRequest.Builder> assignInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaAssignInstanceRequest.builder()
- Parameters:
assignInstanceRequest
- AConsumer
that will call methods onAssignInstanceRequest.Builder
to create a request.- Returns:
- Result of the AssignInstance operation returned by the service.
- See Also:
-
-
assignVolume
default AssignVolumeResponse assignVolume(AssignVolumeRequest assignVolumeRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
assignVolumeRequest
-- Returns:
- Result of the AssignVolume operation returned by the service.
- See Also:
-
assignVolume
default AssignVolumeResponse assignVolume(Consumer<AssignVolumeRequest.Builder> assignVolumeRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaAssignVolumeRequest.builder()
- Parameters:
assignVolumeRequest
- AConsumer
that will call methods onAssignVolumeRequest.Builder
to create a request.- Returns:
- Result of the AssignVolume operation returned by the service.
- See Also:
-
associateElasticIp
default AssociateElasticIpResponse associateElasticIp(AssociateElasticIpRequest associateElasticIpRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
associateElasticIpRequest
-- Returns:
- Result of the AssociateElasticIp operation returned by the service.
- See Also:
-
associateElasticIp
default AssociateElasticIpResponse associateElasticIp(Consumer<AssociateElasticIpRequest.Builder> associateElasticIpRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaAssociateElasticIpRequest.builder()
- Parameters:
associateElasticIpRequest
- AConsumer
that will call methods onAssociateElasticIpRequest.Builder
to create a request.- Returns:
- Result of the AssociateElasticIp operation returned by the service.
- See Also:
-
attachElasticLoadBalancer
default AttachElasticLoadBalancerResponse attachElasticLoadBalancer(AttachElasticLoadBalancerRequest attachElasticLoadBalancerRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
attachElasticLoadBalancerRequest
-- Returns:
- Result of the AttachElasticLoadBalancer operation returned by the service.
- See Also:
-
attachElasticLoadBalancer
default AttachElasticLoadBalancerResponse attachElasticLoadBalancer(Consumer<AttachElasticLoadBalancerRequest.Builder> attachElasticLoadBalancerRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaAttachElasticLoadBalancerRequest.builder()
- Parameters:
attachElasticLoadBalancerRequest
- AConsumer
that will call methods onAttachElasticLoadBalancerRequest.Builder
to create a request.- Returns:
- Result of the AttachElasticLoadBalancer operation returned by the service.
- See Also:
-
cloneStack
default CloneStackResponse cloneStack(CloneStackRequest cloneStackRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
cloneStackRequest
-- Returns:
- Result of the CloneStack operation returned by the service.
- See Also:
-
cloneStack
default CloneStackResponse cloneStack(Consumer<CloneStackRequest.Builder> cloneStackRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaCloneStackRequest.builder()
- Parameters:
cloneStackRequest
- AConsumer
that will call methods onCloneStackRequest.Builder
to create a request.- Returns:
- Result of the CloneStack operation returned by the service.
- See Also:
-
createApp
default CreateAppResponse createApp(CreateAppRequest createAppRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
createAppRequest
-- Returns:
- Result of the CreateApp operation returned by the service.
- See Also:
-
createApp
default CreateAppResponse createApp(Consumer<CreateAppRequest.Builder> createAppRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaCreateAppRequest.builder()
- Parameters:
createAppRequest
- AConsumer
that will call methods onCreateAppRequest.Builder
to create a request.- Returns:
- Result of the CreateApp operation returned by the service.
- See Also:
-
createDeployment
default CreateDeploymentResponse createDeployment(CreateDeploymentRequest createDeploymentRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
createDeploymentRequest
-- Returns:
- Result of the CreateDeployment operation returned by the service.
- See Also:
-
createDeployment
default CreateDeploymentResponse createDeployment(Consumer<CreateDeploymentRequest.Builder> createDeploymentRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaCreateDeploymentRequest.builder()
- Parameters:
createDeploymentRequest
- AConsumer
that will call methods onCreateDeploymentRequest.Builder
to create a request.- Returns:
- Result of the CreateDeployment operation returned by the service.
- See Also:
-
createInstance
default CreateInstanceResponse createInstance(CreateInstanceRequest createInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
createInstanceRequest
-- Returns:
- Result of the CreateInstance operation returned by the service.
- See Also:
-
createInstance
default CreateInstanceResponse createInstance(Consumer<CreateInstanceRequest.Builder> createInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaCreateInstanceRequest.builder()
- Parameters:
createInstanceRequest
- AConsumer
that will call methods onCreateInstanceRequest.Builder
to create a request.- Returns:
- Result of the CreateInstance operation returned by the service.
- See Also:
-
createLayer
default CreateLayerResponse createLayer(CreateLayerRequest createLayerRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
createLayerRequest
-- Returns:
- Result of the CreateLayer operation returned by the service.
- See Also:
-
createLayer
default CreateLayerResponse createLayer(Consumer<CreateLayerRequest.Builder> createLayerRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaCreateLayerRequest.builder()
- Parameters:
createLayerRequest
- AConsumer
that will call methods onCreateLayerRequest.Builder
to create a request.- Returns:
- Result of the CreateLayer operation returned by the service.
- See Also:
-
createStack
default CreateStackResponse createStack(CreateStackRequest createStackRequest) throws ValidationException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
createStackRequest
-- Returns:
- Result of the CreateStack operation returned by the service.
- See Also:
-
createStack
default CreateStackResponse createStack(Consumer<CreateStackRequest.Builder> createStackRequest) throws ValidationException, AwsServiceException, SdkClientException, OpsWorksException 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 viaCreateStackRequest.builder()
- Parameters:
createStackRequest
- AConsumer
that will call methods onCreateStackRequest.Builder
to create a request.- Returns:
- Result of the CreateStack operation returned by the service.
- See Also:
-
createUserProfile
default CreateUserProfileResponse createUserProfile(CreateUserProfileRequest createUserProfileRequest) throws ValidationException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
createUserProfileRequest
-- Returns:
- Result of the CreateUserProfile operation returned by the service.
- See Also:
-
createUserProfile
default CreateUserProfileResponse createUserProfile(Consumer<CreateUserProfileRequest.Builder> createUserProfileRequest) throws ValidationException, AwsServiceException, SdkClientException, OpsWorksException 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 viaCreateUserProfileRequest.builder()
- Parameters:
createUserProfileRequest
- AConsumer
that will call methods onCreateUserProfileRequest.Builder
to create a request.- Returns:
- Result of the CreateUserProfile operation returned by the service.
- See Also:
-
deleteApp
default DeleteAppResponse deleteApp(DeleteAppRequest deleteAppRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
deleteAppRequest
-- Returns:
- Result of the DeleteApp operation returned by the service.
- See Also:
-
deleteApp
default DeleteAppResponse deleteApp(Consumer<DeleteAppRequest.Builder> deleteAppRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaDeleteAppRequest.builder()
- Parameters:
deleteAppRequest
- AConsumer
that will call methods onDeleteAppRequest.Builder
to create a request.- Returns:
- Result of the DeleteApp operation returned by the service.
- See Also:
-
deleteInstance
default DeleteInstanceResponse deleteInstance(DeleteInstanceRequest deleteInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
deleteInstanceRequest
-- Returns:
- Result of the DeleteInstance operation returned by the service.
- See Also:
-
deleteInstance
default DeleteInstanceResponse deleteInstance(Consumer<DeleteInstanceRequest.Builder> deleteInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaDeleteInstanceRequest.builder()
- Parameters:
deleteInstanceRequest
- AConsumer
that will call methods onDeleteInstanceRequest.Builder
to create a request.- Returns:
- Result of the DeleteInstance operation returned by the service.
- See Also:
-
deleteLayer
default DeleteLayerResponse deleteLayer(DeleteLayerRequest deleteLayerRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
deleteLayerRequest
-- Returns:
- Result of the DeleteLayer operation returned by the service.
- See Also:
-
deleteLayer
default DeleteLayerResponse deleteLayer(Consumer<DeleteLayerRequest.Builder> deleteLayerRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaDeleteLayerRequest.builder()
- Parameters:
deleteLayerRequest
- AConsumer
that will call methods onDeleteLayerRequest.Builder
to create a request.- Returns:
- Result of the DeleteLayer operation returned by the service.
- See Also:
-
deleteStack
default DeleteStackResponse deleteStack(DeleteStackRequest deleteStackRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
deleteStackRequest
-- Returns:
- Result of the DeleteStack operation returned by the service.
- See Also:
-
deleteStack
default DeleteStackResponse deleteStack(Consumer<DeleteStackRequest.Builder> deleteStackRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaDeleteStackRequest.builder()
- Parameters:
deleteStackRequest
- AConsumer
that will call methods onDeleteStackRequest.Builder
to create a request.- Returns:
- Result of the DeleteStack operation returned by the service.
- See Also:
-
deleteUserProfile
default DeleteUserProfileResponse deleteUserProfile(DeleteUserProfileRequest deleteUserProfileRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
deleteUserProfileRequest
-- Returns:
- Result of the DeleteUserProfile operation returned by the service.
- See Also:
-
deleteUserProfile
default DeleteUserProfileResponse deleteUserProfile(Consumer<DeleteUserProfileRequest.Builder> deleteUserProfileRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaDeleteUserProfileRequest.builder()
- Parameters:
deleteUserProfileRequest
- AConsumer
that will call methods onDeleteUserProfileRequest.Builder
to create a request.- Returns:
- Result of the DeleteUserProfile operation returned by the service.
- See Also:
-
deregisterEcsCluster
default DeregisterEcsClusterResponse deregisterEcsCluster(DeregisterEcsClusterRequest deregisterEcsClusterRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
deregisterEcsClusterRequest
-- Returns:
- Result of the DeregisterEcsCluster operation returned by the service.
- See Also:
-
deregisterEcsCluster
default DeregisterEcsClusterResponse deregisterEcsCluster(Consumer<DeregisterEcsClusterRequest.Builder> deregisterEcsClusterRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaDeregisterEcsClusterRequest.builder()
- Parameters:
deregisterEcsClusterRequest
- AConsumer
that will call methods onDeregisterEcsClusterRequest.Builder
to create a request.- Returns:
- Result of the DeregisterEcsCluster operation returned by the service.
- See Also:
-
deregisterElasticIp
default DeregisterElasticIpResponse deregisterElasticIp(DeregisterElasticIpRequest deregisterElasticIpRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
deregisterElasticIpRequest
-- Returns:
- Result of the DeregisterElasticIp operation returned by the service.
- See Also:
-
deregisterElasticIp
default DeregisterElasticIpResponse deregisterElasticIp(Consumer<DeregisterElasticIpRequest.Builder> deregisterElasticIpRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaDeregisterElasticIpRequest.builder()
- Parameters:
deregisterElasticIpRequest
- AConsumer
that will call methods onDeregisterElasticIpRequest.Builder
to create a request.- Returns:
- Result of the DeregisterElasticIp operation returned by the service.
- See Also:
-
deregisterInstance
default DeregisterInstanceResponse deregisterInstance(DeregisterInstanceRequest deregisterInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
deregisterInstanceRequest
-- Returns:
- Result of the DeregisterInstance operation returned by the service.
- See Also:
-
deregisterInstance
default DeregisterInstanceResponse deregisterInstance(Consumer<DeregisterInstanceRequest.Builder> deregisterInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaDeregisterInstanceRequest.builder()
- Parameters:
deregisterInstanceRequest
- AConsumer
that will call methods onDeregisterInstanceRequest.Builder
to create a request.- Returns:
- Result of the DeregisterInstance operation returned by the service.
- See Also:
-
deregisterRdsDbInstance
default DeregisterRdsDbInstanceResponse deregisterRdsDbInstance(DeregisterRdsDbInstanceRequest deregisterRdsDbInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
deregisterRdsDbInstanceRequest
-- Returns:
- Result of the DeregisterRdsDbInstance operation returned by the service.
- See Also:
-
deregisterRdsDbInstance
default DeregisterRdsDbInstanceResponse deregisterRdsDbInstance(Consumer<DeregisterRdsDbInstanceRequest.Builder> deregisterRdsDbInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaDeregisterRdsDbInstanceRequest.builder()
- Parameters:
deregisterRdsDbInstanceRequest
- AConsumer
that will call methods onDeregisterRdsDbInstanceRequest.Builder
to create a request.- Returns:
- Result of the DeregisterRdsDbInstance operation returned by the service.
- See Also:
-
deregisterVolume
default DeregisterVolumeResponse deregisterVolume(DeregisterVolumeRequest deregisterVolumeRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
deregisterVolumeRequest
-- Returns:
- Result of the DeregisterVolume operation returned by the service.
- See Also:
-
deregisterVolume
default DeregisterVolumeResponse deregisterVolume(Consumer<DeregisterVolumeRequest.Builder> deregisterVolumeRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaDeregisterVolumeRequest.builder()
- Parameters:
deregisterVolumeRequest
- AConsumer
that will call methods onDeregisterVolumeRequest.Builder
to create a request.- Returns:
- Result of the DeregisterVolume operation returned by the service.
- See Also:
-
describeAgentVersions
default DescribeAgentVersionsResponse describeAgentVersions(DescribeAgentVersionsRequest describeAgentVersionsRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.- Parameters:
describeAgentVersionsRequest
-- Returns:
- Result of the DescribeAgentVersions operation returned by the service.
- See Also:
-
describeAgentVersions
default DescribeAgentVersionsResponse describeAgentVersions(Consumer<DescribeAgentVersionsRequest.Builder> describeAgentVersionsRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaDescribeAgentVersionsRequest.builder()
- Parameters:
describeAgentVersionsRequest
- AConsumer
that will call methods onDescribeAgentVersionsRequest.Builder
to create a request.- Returns:
- Result of the DescribeAgentVersions operation returned by the service.
- See Also:
-
describeApps
default DescribeAppsResponse describeApps(DescribeAppsRequest describeAppsRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
describeAppsRequest
-- Returns:
- Result of the DescribeApps operation returned by the service.
- See Also:
-
describeApps
default DescribeAppsResponse describeApps(Consumer<DescribeAppsRequest.Builder> describeAppsRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaDescribeAppsRequest.builder()
- Parameters:
describeAppsRequest
- AConsumer
that will call methods onDescribeAppsRequest.Builder
to create a request.- Returns:
- Result of the DescribeApps operation returned by the service.
- See Also:
-
describeCommands
default DescribeCommandsResponse describeCommands(DescribeCommandsRequest describeCommandsRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
describeCommandsRequest
-- Returns:
- Result of the DescribeCommands operation returned by the service.
- See Also:
-
describeCommands
default DescribeCommandsResponse describeCommands(Consumer<DescribeCommandsRequest.Builder> describeCommandsRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaDescribeCommandsRequest.builder()
- Parameters:
describeCommandsRequest
- AConsumer
that will call methods onDescribeCommandsRequest.Builder
to create a request.- Returns:
- Result of the DescribeCommands operation returned by the service.
- See Also:
-
describeDeployments
default DescribeDeploymentsResponse describeDeployments(DescribeDeploymentsRequest describeDeploymentsRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
describeDeploymentsRequest
-- Returns:
- Result of the DescribeDeployments operation returned by the service.
- See Also:
-
describeDeployments
default DescribeDeploymentsResponse describeDeployments(Consumer<DescribeDeploymentsRequest.Builder> describeDeploymentsRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaDescribeDeploymentsRequest.builder()
- Parameters:
describeDeploymentsRequest
- AConsumer
that will call methods onDescribeDeploymentsRequest.Builder
to create a request.- Returns:
- Result of the DescribeDeployments operation returned by the service.
- See Also:
-
describeEcsClusters
default DescribeEcsClustersResponse describeEcsClusters(DescribeEcsClustersRequest describeEcsClustersRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID, you can use the
MaxResults
andNextToken
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.
- Parameters:
describeEcsClustersRequest
-- Returns:
- Result of the DescribeEcsClusters operation returned by the service.
- See Also:
-
describeEcsClusters
default DescribeEcsClustersResponse describeEcsClusters(Consumer<DescribeEcsClustersRequest.Builder> describeEcsClustersRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID, you can use the
MaxResults
andNextToken
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 viaDescribeEcsClustersRequest.builder()
- Parameters:
describeEcsClustersRequest
- AConsumer
that will call methods onDescribeEcsClustersRequest.Builder
to create a request.- Returns:
- Result of the DescribeEcsClusters operation returned by the service.
- See Also:
-
describeEcsClustersPaginator
default DescribeEcsClustersIterable describeEcsClustersPaginator(DescribeEcsClustersRequest describeEcsClustersRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException This is a variant of
describeEcsClusters(software.amazon.awssdk.services.opsworks.model.DescribeEcsClustersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.opsworks.paginators.DescribeEcsClustersIterable responses = client.describeEcsClustersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.opsworks.paginators.DescribeEcsClustersIterable responses = client .describeEcsClustersPaginator(request); for (software.amazon.awssdk.services.opsworks.model.DescribeEcsClustersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.opsworks.paginators.DescribeEcsClustersIterable responses = client.describeEcsClustersPaginator(request); responses.iterator().forEachRemaining(....);
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.- Parameters:
describeEcsClustersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEcsClustersPaginator
default DescribeEcsClustersIterable describeEcsClustersPaginator(Consumer<DescribeEcsClustersRequest.Builder> describeEcsClustersRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException This is a variant of
describeEcsClusters(software.amazon.awssdk.services.opsworks.model.DescribeEcsClustersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.opsworks.paginators.DescribeEcsClustersIterable responses = client.describeEcsClustersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.opsworks.paginators.DescribeEcsClustersIterable responses = client .describeEcsClustersPaginator(request); for (software.amazon.awssdk.services.opsworks.model.DescribeEcsClustersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.opsworks.paginators.DescribeEcsClustersIterable responses = client.describeEcsClustersPaginator(request); responses.iterator().forEachRemaining(....);
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 viaDescribeEcsClustersRequest.builder()
- Parameters:
describeEcsClustersRequest
- AConsumer
that will call methods onDescribeEcsClustersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeElasticIps
default DescribeElasticIpsResponse describeElasticIps(DescribeElasticIpsRequest describeElasticIpsRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
describeElasticIpsRequest
-- Returns:
- Result of the DescribeElasticIps operation returned by the service.
- See Also:
-
describeElasticIps
default DescribeElasticIpsResponse describeElasticIps(Consumer<DescribeElasticIpsRequest.Builder> describeElasticIpsRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaDescribeElasticIpsRequest.builder()
- Parameters:
describeElasticIpsRequest
- AConsumer
that will call methods onDescribeElasticIpsRequest.Builder
to create a request.- Returns:
- Result of the DescribeElasticIps operation returned by the service.
- See Also:
-
describeElasticLoadBalancers
default DescribeElasticLoadBalancersResponse describeElasticLoadBalancers(DescribeElasticLoadBalancersRequest describeElasticLoadBalancersRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
describeElasticLoadBalancersRequest
-- Returns:
- Result of the DescribeElasticLoadBalancers operation returned by the service.
- See Also:
-
describeElasticLoadBalancers
default DescribeElasticLoadBalancersResponse describeElasticLoadBalancers(Consumer<DescribeElasticLoadBalancersRequest.Builder> describeElasticLoadBalancersRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaDescribeElasticLoadBalancersRequest.builder()
- Parameters:
describeElasticLoadBalancersRequest
- AConsumer
that will call methods onDescribeElasticLoadBalancersRequest.Builder
to create a request.- Returns:
- Result of the DescribeElasticLoadBalancers operation returned by the service.
- See Also:
-
describeInstances
default DescribeInstancesResponse describeInstances(DescribeInstancesRequest describeInstancesRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
describeInstancesRequest
-- Returns:
- Result of the DescribeInstances operation returned by the service.
- See Also:
-
describeInstances
default DescribeInstancesResponse describeInstances(Consumer<DescribeInstancesRequest.Builder> describeInstancesRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaDescribeInstancesRequest.builder()
- Parameters:
describeInstancesRequest
- AConsumer
that will call methods onDescribeInstancesRequest.Builder
to create a request.- Returns:
- Result of the DescribeInstances operation returned by the service.
- See Also:
-
describeLayers
default DescribeLayersResponse describeLayers(DescribeLayersRequest describeLayersRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
describeLayersRequest
-- Returns:
- Result of the DescribeLayers operation returned by the service.
- See Also:
-
describeLayers
default DescribeLayersResponse describeLayers(Consumer<DescribeLayersRequest.Builder> describeLayersRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaDescribeLayersRequest.builder()
- Parameters:
describeLayersRequest
- AConsumer
that will call methods onDescribeLayersRequest.Builder
to create a request.- Returns:
- Result of the DescribeLayers operation returned by the service.
- See Also:
-
describeLoadBasedAutoScaling
default DescribeLoadBasedAutoScalingResponse describeLoadBasedAutoScaling(DescribeLoadBasedAutoScalingRequest describeLoadBasedAutoScalingRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
describeLoadBasedAutoScalingRequest
-- Returns:
- Result of the DescribeLoadBasedAutoScaling operation returned by the service.
- See Also:
-
describeLoadBasedAutoScaling
default DescribeLoadBasedAutoScalingResponse describeLoadBasedAutoScaling(Consumer<DescribeLoadBasedAutoScalingRequest.Builder> describeLoadBasedAutoScalingRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaDescribeLoadBasedAutoScalingRequest.builder()
- Parameters:
describeLoadBasedAutoScalingRequest
- AConsumer
that will call methods onDescribeLoadBasedAutoScalingRequest.Builder
to create a request.- Returns:
- Result of the DescribeLoadBasedAutoScaling operation returned by the service.
- See Also:
-
describeMyUserProfile
default DescribeMyUserProfileResponse describeMyUserProfile(DescribeMyUserProfileRequest describeMyUserProfileRequest) throws AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
describeMyUserProfileRequest
-- Returns:
- Result of the DescribeMyUserProfile operation returned by the service.
- See Also:
-
describeMyUserProfile
default DescribeMyUserProfileResponse describeMyUserProfile(Consumer<DescribeMyUserProfileRequest.Builder> describeMyUserProfileRequest) throws AwsServiceException, SdkClientException, OpsWorksException 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 viaDescribeMyUserProfileRequest.builder()
- Parameters:
describeMyUserProfileRequest
- AConsumer
that will call methods onDescribeMyUserProfileRequest.Builder
to create a request.- Returns:
- Result of the DescribeMyUserProfile operation returned by the service.
- See Also:
-
describeMyUserProfile
default DescribeMyUserProfileResponse describeMyUserProfile() throws AwsServiceException, SdkClientException, OpsWorksExceptionDescribes 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.
- Returns:
- Result of the DescribeMyUserProfile operation returned by the service.
- See Also:
-
describeOperatingSystems
default DescribeOperatingSystemsResponse describeOperatingSystems(DescribeOperatingSystemsRequest describeOperatingSystemsRequest) throws AwsServiceException, SdkClientException, OpsWorksException Describes the operating systems that are supported by AWS OpsWorks Stacks.
- Parameters:
describeOperatingSystemsRequest
-- Returns:
- Result of the DescribeOperatingSystems operation returned by the service.
- See Also:
-
describeOperatingSystems
default DescribeOperatingSystemsResponse describeOperatingSystems(Consumer<DescribeOperatingSystemsRequest.Builder> describeOperatingSystemsRequest) throws AwsServiceException, SdkClientException, OpsWorksException 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 viaDescribeOperatingSystemsRequest.builder()
- Parameters:
describeOperatingSystemsRequest
- AConsumer
that will call methods onDescribeOperatingSystemsRequest.Builder
to create a request.- Returns:
- Result of the DescribeOperatingSystems operation returned by the service.
- See Also:
-
describeOperatingSystems
default DescribeOperatingSystemsResponse describeOperatingSystems() throws AwsServiceException, SdkClientException, OpsWorksExceptionDescribes the operating systems that are supported by AWS OpsWorks Stacks.
- Returns:
- Result of the DescribeOperatingSystems operation returned by the service.
- See Also:
-
describePermissions
default DescribePermissionsResponse describePermissions(DescribePermissionsRequest describePermissionsRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
describePermissionsRequest
-- Returns:
- Result of the DescribePermissions operation returned by the service.
- See Also:
-
describePermissions
default DescribePermissionsResponse describePermissions(Consumer<DescribePermissionsRequest.Builder> describePermissionsRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaDescribePermissionsRequest.builder()
- Parameters:
describePermissionsRequest
- AConsumer
that will call methods onDescribePermissionsRequest.Builder
to create a request.- Returns:
- Result of the DescribePermissions operation returned by the service.
- See Also:
-
describeRaidArrays
default DescribeRaidArraysResponse describeRaidArrays(DescribeRaidArraysRequest describeRaidArraysRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
describeRaidArraysRequest
-- Returns:
- Result of the DescribeRaidArrays operation returned by the service.
- See Also:
-
describeRaidArrays
default DescribeRaidArraysResponse describeRaidArrays(Consumer<DescribeRaidArraysRequest.Builder> describeRaidArraysRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaDescribeRaidArraysRequest.builder()
- Parameters:
describeRaidArraysRequest
- AConsumer
that will call methods onDescribeRaidArraysRequest.Builder
to create a request.- Returns:
- Result of the DescribeRaidArrays operation returned by the service.
- See Also:
-
describeRdsDbInstances
default DescribeRdsDbInstancesResponse describeRdsDbInstances(DescribeRdsDbInstancesRequest describeRdsDbInstancesRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
describeRdsDbInstancesRequest
-- Returns:
- Result of the DescribeRdsDbInstances operation returned by the service.
- See Also:
-
describeRdsDbInstances
default DescribeRdsDbInstancesResponse describeRdsDbInstances(Consumer<DescribeRdsDbInstancesRequest.Builder> describeRdsDbInstancesRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaDescribeRdsDbInstancesRequest.builder()
- Parameters:
describeRdsDbInstancesRequest
- AConsumer
that will call methods onDescribeRdsDbInstancesRequest.Builder
to create a request.- Returns:
- Result of the DescribeRdsDbInstances operation returned by the service.
- See Also:
-
describeServiceErrors
default DescribeServiceErrorsResponse describeServiceErrors(DescribeServiceErrorsRequest describeServiceErrorsRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
describeServiceErrorsRequest
-- Returns:
- Result of the DescribeServiceErrors operation returned by the service.
- See Also:
-
describeServiceErrors
default DescribeServiceErrorsResponse describeServiceErrors(Consumer<DescribeServiceErrorsRequest.Builder> describeServiceErrorsRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaDescribeServiceErrorsRequest.builder()
- Parameters:
describeServiceErrorsRequest
- AConsumer
that will call methods onDescribeServiceErrorsRequest.Builder
to create a request.- Returns:
- Result of the DescribeServiceErrors operation returned by the service.
- See Also:
-
describeServiceErrors
default DescribeServiceErrorsResponse describeServiceErrors() throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksExceptionDescribes 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.
- Returns:
- Result of the DescribeServiceErrors operation returned by the service.
- See Also:
-
describeStackProvisioningParameters
default DescribeStackProvisioningParametersResponse describeStackProvisioningParameters(DescribeStackProvisioningParametersRequest describeStackProvisioningParametersRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
describeStackProvisioningParametersRequest
-- Returns:
- Result of the DescribeStackProvisioningParameters operation returned by the service.
- See Also:
-
describeStackProvisioningParameters
default DescribeStackProvisioningParametersResponse describeStackProvisioningParameters(Consumer<DescribeStackProvisioningParametersRequest.Builder> describeStackProvisioningParametersRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaDescribeStackProvisioningParametersRequest.builder()
- Parameters:
describeStackProvisioningParametersRequest
- AConsumer
that will call methods onDescribeStackProvisioningParametersRequest.Builder
to create a request.- Returns:
- Result of the DescribeStackProvisioningParameters operation returned by the service.
- See Also:
-
describeStackSummary
default DescribeStackSummaryResponse describeStackSummary(DescribeStackSummaryRequest describeStackSummaryRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as
running_setup
oronline
.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.
- Parameters:
describeStackSummaryRequest
-- Returns:
- Result of the DescribeStackSummary operation returned by the service.
- See Also:
-
describeStackSummary
default DescribeStackSummaryResponse describeStackSummary(Consumer<DescribeStackSummaryRequest.Builder> describeStackSummaryRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as
running_setup
oronline
.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 viaDescribeStackSummaryRequest.builder()
- Parameters:
describeStackSummaryRequest
- AConsumer
that will call methods onDescribeStackSummaryRequest.Builder
to create a request.- Returns:
- Result of the DescribeStackSummary operation returned by the service.
- See Also:
-
describeStacks
default DescribeStacksResponse describeStacks(DescribeStacksRequest describeStacksRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
describeStacksRequest
-- Returns:
- Result of the DescribeStacks operation returned by the service.
- See Also:
-
describeStacks
default DescribeStacksResponse describeStacks(Consumer<DescribeStacksRequest.Builder> describeStacksRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaDescribeStacksRequest.builder()
- Parameters:
describeStacksRequest
- AConsumer
that will call methods onDescribeStacksRequest.Builder
to create a request.- Returns:
- Result of the DescribeStacks operation returned by the service.
- See Also:
-
describeStacks
default DescribeStacksResponse describeStacks() throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksExceptionRequests 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.
- Returns:
- Result of the DescribeStacks operation returned by the service.
- See Also:
-
describeTimeBasedAutoScaling
default DescribeTimeBasedAutoScalingResponse describeTimeBasedAutoScaling(DescribeTimeBasedAutoScalingRequest describeTimeBasedAutoScalingRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
describeTimeBasedAutoScalingRequest
-- Returns:
- Result of the DescribeTimeBasedAutoScaling operation returned by the service.
- See Also:
-
describeTimeBasedAutoScaling
default DescribeTimeBasedAutoScalingResponse describeTimeBasedAutoScaling(Consumer<DescribeTimeBasedAutoScalingRequest.Builder> describeTimeBasedAutoScalingRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaDescribeTimeBasedAutoScalingRequest.builder()
- Parameters:
describeTimeBasedAutoScalingRequest
- AConsumer
that will call methods onDescribeTimeBasedAutoScalingRequest.Builder
to create a request.- Returns:
- Result of the DescribeTimeBasedAutoScaling operation returned by the service.
- See Also:
-
describeUserProfiles
default DescribeUserProfilesResponse describeUserProfiles(DescribeUserProfilesRequest describeUserProfilesRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
describeUserProfilesRequest
-- Returns:
- Result of the DescribeUserProfiles operation returned by the service.
- See Also:
-
describeUserProfiles
default DescribeUserProfilesResponse describeUserProfiles(Consumer<DescribeUserProfilesRequest.Builder> describeUserProfilesRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaDescribeUserProfilesRequest.builder()
- Parameters:
describeUserProfilesRequest
- AConsumer
that will call methods onDescribeUserProfilesRequest.Builder
to create a request.- Returns:
- Result of the DescribeUserProfiles operation returned by the service.
- See Also:
-
describeUserProfiles
default DescribeUserProfilesResponse describeUserProfiles() throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksExceptionDescribe 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.
- Returns:
- Result of the DescribeUserProfiles operation returned by the service.
- See Also:
-
describeVolumes
default DescribeVolumesResponse describeVolumes(DescribeVolumesRequest describeVolumesRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
describeVolumesRequest
-- Returns:
- Result of the DescribeVolumes operation returned by the service.
- See Also:
-
describeVolumes
default DescribeVolumesResponse describeVolumes(Consumer<DescribeVolumesRequest.Builder> describeVolumesRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaDescribeVolumesRequest.builder()
- Parameters:
describeVolumesRequest
- AConsumer
that will call methods onDescribeVolumesRequest.Builder
to create a request.- Returns:
- Result of the DescribeVolumes operation returned by the service.
- See Also:
-
detachElasticLoadBalancer
default DetachElasticLoadBalancerResponse detachElasticLoadBalancer(DetachElasticLoadBalancerRequest detachElasticLoadBalancerRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
detachElasticLoadBalancerRequest
-- Returns:
- Result of the DetachElasticLoadBalancer operation returned by the service.
- See Also:
-
detachElasticLoadBalancer
default DetachElasticLoadBalancerResponse detachElasticLoadBalancer(Consumer<DetachElasticLoadBalancerRequest.Builder> detachElasticLoadBalancerRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaDetachElasticLoadBalancerRequest.builder()
- Parameters:
detachElasticLoadBalancerRequest
- AConsumer
that will call methods onDetachElasticLoadBalancerRequest.Builder
to create a request.- Returns:
- Result of the DetachElasticLoadBalancer operation returned by the service.
- See Also:
-
disassociateElasticIp
default DisassociateElasticIpResponse disassociateElasticIp(DisassociateElasticIpRequest disassociateElasticIpRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
disassociateElasticIpRequest
-- Returns:
- Result of the DisassociateElasticIp operation returned by the service.
- See Also:
-
disassociateElasticIp
default DisassociateElasticIpResponse disassociateElasticIp(Consumer<DisassociateElasticIpRequest.Builder> disassociateElasticIpRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaDisassociateElasticIpRequest.builder()
- Parameters:
disassociateElasticIpRequest
- AConsumer
that will call methods onDisassociateElasticIpRequest.Builder
to create a request.- Returns:
- Result of the DisassociateElasticIp operation returned by the service.
- See Also:
-
getHostnameSuggestion
default GetHostnameSuggestionResponse getHostnameSuggestion(GetHostnameSuggestionRequest getHostnameSuggestionRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
getHostnameSuggestionRequest
-- Returns:
- Result of the GetHostnameSuggestion operation returned by the service.
- See Also:
-
getHostnameSuggestion
default GetHostnameSuggestionResponse getHostnameSuggestion(Consumer<GetHostnameSuggestionRequest.Builder> getHostnameSuggestionRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaGetHostnameSuggestionRequest.builder()
- Parameters:
getHostnameSuggestionRequest
- AConsumer
that will call methods onGetHostnameSuggestionRequest.Builder
to create a request.- Returns:
- Result of the GetHostnameSuggestion operation returned by the service.
- See Also:
-
grantAccess
default GrantAccessResponse grantAccess(GrantAccessRequest grantAccessRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException This action can be used only with Windows stacks.
Grants RDP access to a Windows instance for a specified time period.
- Parameters:
grantAccessRequest
-- Returns:
- Result of the GrantAccess operation returned by the service.
- See Also:
-
grantAccess
default GrantAccessResponse grantAccess(Consumer<GrantAccessRequest.Builder> grantAccessRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaGrantAccessRequest.builder()
- Parameters:
grantAccessRequest
- AConsumer
that will call methods onGrantAccessRequest.Builder
to create a request.- Returns:
- Result of the GrantAccess operation returned by the service.
- See Also:
-
listTags
default ListTagsResponse listTags(ListTagsRequest listTagsRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException Returns a list of tags that are applied to the specified stack or layer.
- Parameters:
listTagsRequest
-- Returns:
- Result of the ListTags operation returned by the service.
- See Also:
-
listTags
default ListTagsResponse listTags(Consumer<ListTagsRequest.Builder> listTagsRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaListTagsRequest.builder()
- Parameters:
listTagsRequest
- AConsumer
that will call methods onListTagsRequest.Builder
to create a request.- Returns:
- Result of the ListTags operation returned by the service.
- See Also:
-
rebootInstance
default RebootInstanceResponse rebootInstance(RebootInstanceRequest rebootInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
rebootInstanceRequest
-- Returns:
- Result of the RebootInstance operation returned by the service.
- See Also:
-
rebootInstance
default RebootInstanceResponse rebootInstance(Consumer<RebootInstanceRequest.Builder> rebootInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaRebootInstanceRequest.builder()
- Parameters:
rebootInstanceRequest
- AConsumer
that will call methods onRebootInstanceRequest.Builder
to create a request.- Returns:
- Result of the RebootInstance operation returned by the service.
- See Also:
-
registerEcsCluster
default RegisterEcsClusterResponse registerEcsCluster(RegisterEcsClusterRequest registerEcsClusterRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
registerEcsClusterRequest
-- Returns:
- Result of the RegisterEcsCluster operation returned by the service.
- See Also:
-
registerEcsCluster
default RegisterEcsClusterResponse registerEcsCluster(Consumer<RegisterEcsClusterRequest.Builder> registerEcsClusterRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaRegisterEcsClusterRequest.builder()
- Parameters:
registerEcsClusterRequest
- AConsumer
that will call methods onRegisterEcsClusterRequest.Builder
to create a request.- Returns:
- Result of the RegisterEcsCluster operation returned by the service.
- See Also:
-
registerElasticIp
default RegisterElasticIpResponse registerElasticIp(RegisterElasticIpRequest registerElasticIpRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
registerElasticIpRequest
-- Returns:
- Result of the RegisterElasticIp operation returned by the service.
- See Also:
-
registerElasticIp
default RegisterElasticIpResponse registerElasticIp(Consumer<RegisterElasticIpRequest.Builder> registerElasticIpRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaRegisterElasticIpRequest.builder()
- Parameters:
registerElasticIpRequest
- AConsumer
that will call methods onRegisterElasticIpRequest.Builder
to create a request.- Returns:
- Result of the RegisterElasticIp operation returned by the service.
- See Also:
-
registerInstance
default RegisterInstanceResponse registerInstance(RegisterInstanceRequest registerInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 CLIregister
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.
- Parameters:
registerInstanceRequest
-- Returns:
- Result of the RegisterInstance operation returned by the service.
- See Also:
-
registerInstance
default RegisterInstanceResponse registerInstance(Consumer<RegisterInstanceRequest.Builder> registerInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 CLIregister
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 viaRegisterInstanceRequest.builder()
- Parameters:
registerInstanceRequest
- AConsumer
that will call methods onRegisterInstanceRequest.Builder
to create a request.- Returns:
- Result of the RegisterInstance operation returned by the service.
- See Also:
-
registerRdsDbInstance
default RegisterRdsDbInstanceResponse registerRdsDbInstance(RegisterRdsDbInstanceRequest registerRdsDbInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
registerRdsDbInstanceRequest
-- Returns:
- Result of the RegisterRdsDbInstance operation returned by the service.
- See Also:
-
registerRdsDbInstance
default RegisterRdsDbInstanceResponse registerRdsDbInstance(Consumer<RegisterRdsDbInstanceRequest.Builder> registerRdsDbInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaRegisterRdsDbInstanceRequest.builder()
- Parameters:
registerRdsDbInstanceRequest
- AConsumer
that will call methods onRegisterRdsDbInstanceRequest.Builder
to create a request.- Returns:
- Result of the RegisterRdsDbInstance operation returned by the service.
- See Also:
-
registerVolume
default RegisterVolumeResponse registerVolume(RegisterVolumeRequest registerVolumeRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
registerVolumeRequest
-- Returns:
- Result of the RegisterVolume operation returned by the service.
- See Also:
-
registerVolume
default RegisterVolumeResponse registerVolume(Consumer<RegisterVolumeRequest.Builder> registerVolumeRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaRegisterVolumeRequest.builder()
- Parameters:
registerVolumeRequest
- AConsumer
that will call methods onRegisterVolumeRequest.Builder
to create a request.- Returns:
- Result of the RegisterVolume operation returned by the service.
- See Also:
-
setLoadBasedAutoScaling
default SetLoadBasedAutoScalingResponse setLoadBasedAutoScaling(SetLoadBasedAutoScalingRequest setLoadBasedAutoScalingRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
setLoadBasedAutoScalingRequest
-- Returns:
- Result of the SetLoadBasedAutoScaling operation returned by the service.
- See Also:
-
setLoadBasedAutoScaling
default SetLoadBasedAutoScalingResponse setLoadBasedAutoScaling(Consumer<SetLoadBasedAutoScalingRequest.Builder> setLoadBasedAutoScalingRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaSetLoadBasedAutoScalingRequest.builder()
- Parameters:
setLoadBasedAutoScalingRequest
- AConsumer
that will call methods onSetLoadBasedAutoScalingRequest.Builder
to create a request.- Returns:
- Result of the SetLoadBasedAutoScaling operation returned by the service.
- See Also:
-
setPermission
default SetPermissionResponse setPermission(SetPermissionRequest setPermissionRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
setPermissionRequest
-- Returns:
- Result of the SetPermission operation returned by the service.
- See Also:
-
setPermission
default SetPermissionResponse setPermission(Consumer<SetPermissionRequest.Builder> setPermissionRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaSetPermissionRequest.builder()
- Parameters:
setPermissionRequest
- AConsumer
that will call methods onSetPermissionRequest.Builder
to create a request.- Returns:
- Result of the SetPermission operation returned by the service.
- See Also:
-
setTimeBasedAutoScaling
default SetTimeBasedAutoScalingResponse setTimeBasedAutoScaling(SetTimeBasedAutoScalingRequest setTimeBasedAutoScalingRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
setTimeBasedAutoScalingRequest
-- Returns:
- Result of the SetTimeBasedAutoScaling operation returned by the service.
- See Also:
-
setTimeBasedAutoScaling
default SetTimeBasedAutoScalingResponse setTimeBasedAutoScaling(Consumer<SetTimeBasedAutoScalingRequest.Builder> setTimeBasedAutoScalingRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaSetTimeBasedAutoScalingRequest.builder()
- Parameters:
setTimeBasedAutoScalingRequest
- AConsumer
that will call methods onSetTimeBasedAutoScalingRequest.Builder
to create a request.- Returns:
- Result of the SetTimeBasedAutoScaling operation returned by the service.
- See Also:
-
startInstance
default StartInstanceResponse startInstance(StartInstanceRequest startInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
startInstanceRequest
-- Returns:
- Result of the StartInstance operation returned by the service.
- See Also:
-
startInstance
default StartInstanceResponse startInstance(Consumer<StartInstanceRequest.Builder> startInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaStartInstanceRequest.builder()
- Parameters:
startInstanceRequest
- AConsumer
that will call methods onStartInstanceRequest.Builder
to create a request.- Returns:
- Result of the StartInstance operation returned by the service.
- See Also:
-
startStack
default StartStackResponse startStack(StartStackRequest startStackRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
startStackRequest
-- Returns:
- Result of the StartStack operation returned by the service.
- See Also:
-
startStack
default StartStackResponse startStack(Consumer<StartStackRequest.Builder> startStackRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaStartStackRequest.builder()
- Parameters:
startStackRequest
- AConsumer
that will call methods onStartStackRequest.Builder
to create a request.- Returns:
- Result of the StartStack operation returned by the service.
- See Also:
-
stopInstance
default StopInstanceResponse stopInstance(StopInstanceRequest stopInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
stopInstanceRequest
-- Returns:
- Result of the StopInstance operation returned by the service.
- See Also:
-
stopInstance
default StopInstanceResponse stopInstance(Consumer<StopInstanceRequest.Builder> stopInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaStopInstanceRequest.builder()
- Parameters:
stopInstanceRequest
- AConsumer
that will call methods onStopInstanceRequest.Builder
to create a request.- Returns:
- Result of the StopInstance operation returned by the service.
- See Also:
-
stopStack
default StopStackResponse stopStack(StopStackRequest stopStackRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
stopStackRequest
-- Returns:
- Result of the StopStack operation returned by the service.
- See Also:
-
stopStack
default StopStackResponse stopStack(Consumer<StopStackRequest.Builder> stopStackRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaStopStackRequest.builder()
- Parameters:
stopStackRequest
- AConsumer
that will call methods onStopStackRequest.Builder
to create a request.- Returns:
- Result of the StopStack operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
unassignInstance
default UnassignInstanceResponse unassignInstance(UnassignInstanceRequest unassignInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
unassignInstanceRequest
-- Returns:
- Result of the UnassignInstance operation returned by the service.
- See Also:
-
unassignInstance
default UnassignInstanceResponse unassignInstance(Consumer<UnassignInstanceRequest.Builder> unassignInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaUnassignInstanceRequest.builder()
- Parameters:
unassignInstanceRequest
- AConsumer
that will call methods onUnassignInstanceRequest.Builder
to create a request.- Returns:
- Result of the UnassignInstance operation returned by the service.
- See Also:
-
unassignVolume
default UnassignVolumeResponse unassignVolume(UnassignVolumeRequest unassignVolumeRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
unassignVolumeRequest
-- Returns:
- Result of the UnassignVolume operation returned by the service.
- See Also:
-
unassignVolume
default UnassignVolumeResponse unassignVolume(Consumer<UnassignVolumeRequest.Builder> unassignVolumeRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaUnassignVolumeRequest.builder()
- Parameters:
unassignVolumeRequest
- AConsumer
that will call methods onUnassignVolumeRequest.Builder
to create a request.- Returns:
- Result of the UnassignVolume operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException Removes tags from a specified stack or layer.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateApp
default UpdateAppResponse updateApp(UpdateAppRequest updateAppRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
updateAppRequest
-- Returns:
- Result of the UpdateApp operation returned by the service.
- See Also:
-
updateApp
default UpdateAppResponse updateApp(Consumer<UpdateAppRequest.Builder> updateAppRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaUpdateAppRequest.builder()
- Parameters:
updateAppRequest
- AConsumer
that will call methods onUpdateAppRequest.Builder
to create a request.- Returns:
- Result of the UpdateApp operation returned by the service.
- See Also:
-
updateElasticIp
default UpdateElasticIpResponse updateElasticIp(UpdateElasticIpRequest updateElasticIpRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
updateElasticIpRequest
-- Returns:
- Result of the UpdateElasticIp operation returned by the service.
- See Also:
-
updateElasticIp
default UpdateElasticIpResponse updateElasticIp(Consumer<UpdateElasticIpRequest.Builder> updateElasticIpRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaUpdateElasticIpRequest.builder()
- Parameters:
updateElasticIpRequest
- AConsumer
that will call methods onUpdateElasticIpRequest.Builder
to create a request.- Returns:
- Result of the UpdateElasticIp operation returned by the service.
- See Also:
-
updateInstance
default UpdateInstanceResponse updateInstance(UpdateInstanceRequest updateInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
updateInstanceRequest
-- Returns:
- Result of the UpdateInstance operation returned by the service.
- See Also:
-
updateInstance
default UpdateInstanceResponse updateInstance(Consumer<UpdateInstanceRequest.Builder> updateInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaUpdateInstanceRequest.builder()
- Parameters:
updateInstanceRequest
- AConsumer
that will call methods onUpdateInstanceRequest.Builder
to create a request.- Returns:
- Result of the UpdateInstance operation returned by the service.
- See Also:
-
updateLayer
default UpdateLayerResponse updateLayer(UpdateLayerRequest updateLayerRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
updateLayerRequest
-- Returns:
- Result of the UpdateLayer operation returned by the service.
- See Also:
-
updateLayer
default UpdateLayerResponse updateLayer(Consumer<UpdateLayerRequest.Builder> updateLayerRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaUpdateLayerRequest.builder()
- Parameters:
updateLayerRequest
- AConsumer
that will call methods onUpdateLayerRequest.Builder
to create a request.- Returns:
- Result of the UpdateLayer operation returned by the service.
- See Also:
-
updateMyUserProfile
default UpdateMyUserProfileResponse updateMyUserProfile(UpdateMyUserProfileRequest updateMyUserProfileRequest) throws ValidationException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
updateMyUserProfileRequest
-- Returns:
- Result of the UpdateMyUserProfile operation returned by the service.
- See Also:
-
updateMyUserProfile
default UpdateMyUserProfileResponse updateMyUserProfile(Consumer<UpdateMyUserProfileRequest.Builder> updateMyUserProfileRequest) throws ValidationException, AwsServiceException, SdkClientException, OpsWorksException 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 viaUpdateMyUserProfileRequest.builder()
- Parameters:
updateMyUserProfileRequest
- AConsumer
that will call methods onUpdateMyUserProfileRequest.Builder
to create a request.- Returns:
- Result of the UpdateMyUserProfile operation returned by the service.
- See Also:
-
updateRdsDbInstance
default UpdateRdsDbInstanceResponse updateRdsDbInstance(UpdateRdsDbInstanceRequest updateRdsDbInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
updateRdsDbInstanceRequest
-- Returns:
- Result of the UpdateRdsDbInstance operation returned by the service.
- See Also:
-
updateRdsDbInstance
default UpdateRdsDbInstanceResponse updateRdsDbInstance(Consumer<UpdateRdsDbInstanceRequest.Builder> updateRdsDbInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaUpdateRdsDbInstanceRequest.builder()
- Parameters:
updateRdsDbInstanceRequest
- AConsumer
that will call methods onUpdateRdsDbInstanceRequest.Builder
to create a request.- Returns:
- Result of the UpdateRdsDbInstance operation returned by the service.
- See Also:
-
updateStack
default UpdateStackResponse updateStack(UpdateStackRequest updateStackRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
updateStackRequest
-- Returns:
- Result of the UpdateStack operation returned by the service.
- See Also:
-
updateStack
default UpdateStackResponse updateStack(Consumer<UpdateStackRequest.Builder> updateStackRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaUpdateStackRequest.builder()
- Parameters:
updateStackRequest
- AConsumer
that will call methods onUpdateStackRequest.Builder
to create a request.- Returns:
- Result of the UpdateStack operation returned by the service.
- See Also:
-
updateUserProfile
default UpdateUserProfileResponse updateUserProfile(UpdateUserProfileRequest updateUserProfileRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
updateUserProfileRequest
-- Returns:
- Result of the UpdateUserProfile operation returned by the service.
- See Also:
-
updateUserProfile
default UpdateUserProfileResponse updateUserProfile(Consumer<UpdateUserProfileRequest.Builder> updateUserProfileRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaUpdateUserProfileRequest.builder()
- Parameters:
updateUserProfileRequest
- AConsumer
that will call methods onUpdateUserProfileRequest.Builder
to create a request.- Returns:
- Result of the UpdateUserProfile operation returned by the service.
- See Also:
-
updateVolume
default UpdateVolumeResponse updateVolume(UpdateVolumeRequest updateVolumeRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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.
- Parameters:
updateVolumeRequest
-- Returns:
- Result of the UpdateVolume operation returned by the service.
- See Also:
-
updateVolume
default UpdateVolumeResponse updateVolume(Consumer<UpdateVolumeRequest.Builder> updateVolumeRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException 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 viaUpdateVolumeRequest.builder()
- Parameters:
updateVolumeRequest
- AConsumer
that will call methods onUpdateVolumeRequest.Builder
to create a request.- Returns:
- Result of the UpdateVolume operation returned by the service.
- See Also:
-
waiter
Create an instance ofOpsWorksWaiter
using this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
OpsWorksWaiter
-
create
Create aOpsWorksClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aOpsWorksClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-