Interface OpsWorksCmClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
AWS OpsWorks for configuration management (CM) is a service that runs and manages configuration management servers. You can use AWS OpsWorks CM to create and manage AWS OpsWorks for Chef Automate and AWS OpsWorks for Puppet Enterprise servers, and add or remove nodes for the servers to manage.
Glossary of terms
-
Server: A configuration management server that can be highly-available. The configuration management server runs on an Amazon Elastic Compute Cloud (EC2) instance, and may use various other AWS services, such as Amazon Relational Database Service (RDS) and Elastic Load Balancing. A server is a generic abstraction over the configuration manager that you want to use, much like Amazon RDS. In AWS OpsWorks CM, you do not start or stop servers. After you create servers, they continue to run until they are deleted.
-
Engine: The engine is the specific configuration manager that you want to use. Valid values in this release include
ChefAutomate
andPuppet
. -
Backup: This is an application-level backup of the data that the configuration manager stores. AWS OpsWorks CM creates an S3 bucket for backups when you launch the first server. A backup maintains a snapshot of a server's configuration-related attributes at the time the backup starts.
-
Events: Events are always related to a server. Events are written during server creation, when health checks run, when backups are created, when system maintenance is performed, etc. When you delete a server, the server's events are also deleted.
-
Account attributes: Every account has attributes that are assigned in the AWS OpsWorks CM database. These attributes store information about configuration limits (servers, backups, etc.) and your customer account.
Endpoints
AWS OpsWorks CM supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Your servers can only be accessed or managed within the endpoint in which they are created.
-
opsworks-cm.us-east-1.amazonaws.com
-
opsworks-cm.us-east-2.amazonaws.com
-
opsworks-cm.us-west-1.amazonaws.com
-
opsworks-cm.us-west-2.amazonaws.com
-
opsworks-cm.ap-northeast-1.amazonaws.com
-
opsworks-cm.ap-southeast-1.amazonaws.com
-
opsworks-cm.ap-southeast-2.amazonaws.com
-
opsworks-cm.eu-central-1.amazonaws.com
-
opsworks-cm.eu-west-1.amazonaws.com
For more information, see AWS OpsWorks endpoints and quotas in the AWS General Reference.
Throttling limits
All API operations allow for five requests per second with a burst of 10 requests per second.
-
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 AssociateNodeResponse
associateNode
(Consumer<AssociateNodeRequest.Builder> associateNodeRequest) Associates a new node with the server.default AssociateNodeResponse
associateNode
(AssociateNodeRequest associateNodeRequest) Associates a new node with the server.static OpsWorksCmClientBuilder
builder()
Create a builder that can be used to configure and create aOpsWorksCmClient
.static OpsWorksCmClient
create()
Create aOpsWorksCmClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateBackupResponse
createBackup
(Consumer<CreateBackupRequest.Builder> createBackupRequest) Creates an application-level backup of a server.default CreateBackupResponse
createBackup
(CreateBackupRequest createBackupRequest) Creates an application-level backup of a server.default CreateServerResponse
createServer
(Consumer<CreateServerRequest.Builder> createServerRequest) Creates and immedately starts a new server.default CreateServerResponse
createServer
(CreateServerRequest createServerRequest) Creates and immedately starts a new server.default DeleteBackupResponse
deleteBackup
(Consumer<DeleteBackupRequest.Builder> deleteBackupRequest) Deletes a backup.default DeleteBackupResponse
deleteBackup
(DeleteBackupRequest deleteBackupRequest) Deletes a backup.default DeleteServerResponse
deleteServer
(Consumer<DeleteServerRequest.Builder> deleteServerRequest) Deletes the server and the underlying AWS CloudFormation stacks (including the server's EC2 instance).default DeleteServerResponse
deleteServer
(DeleteServerRequest deleteServerRequest) Deletes the server and the underlying AWS CloudFormation stacks (including the server's EC2 instance).Describes your OpsWorks-CM account attributes.describeAccountAttributes
(Consumer<DescribeAccountAttributesRequest.Builder> describeAccountAttributesRequest) Describes your OpsWorks-CM account attributes.describeAccountAttributes
(DescribeAccountAttributesRequest describeAccountAttributesRequest) Describes your OpsWorks-CM account attributes.default DescribeBackupsResponse
Describes backups.default DescribeBackupsResponse
describeBackups
(Consumer<DescribeBackupsRequest.Builder> describeBackupsRequest) Describes backups.default DescribeBackupsResponse
describeBackups
(DescribeBackupsRequest describeBackupsRequest) Describes backups.default DescribeBackupsIterable
This is a variant ofdescribeBackups(software.amazon.awssdk.services.opsworkscm.model.DescribeBackupsRequest)
operation.default DescribeBackupsIterable
describeBackupsPaginator
(Consumer<DescribeBackupsRequest.Builder> describeBackupsRequest) This is a variant ofdescribeBackups(software.amazon.awssdk.services.opsworkscm.model.DescribeBackupsRequest)
operation.default DescribeBackupsIterable
describeBackupsPaginator
(DescribeBackupsRequest describeBackupsRequest) This is a variant ofdescribeBackups(software.amazon.awssdk.services.opsworkscm.model.DescribeBackupsRequest)
operation.default DescribeEventsResponse
describeEvents
(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) Describes events for a specified server.default DescribeEventsResponse
describeEvents
(DescribeEventsRequest describeEventsRequest) Describes events for a specified server.default DescribeEventsIterable
describeEventsPaginator
(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) This is a variant ofdescribeEvents(software.amazon.awssdk.services.opsworkscm.model.DescribeEventsRequest)
operation.default DescribeEventsIterable
describeEventsPaginator
(DescribeEventsRequest describeEventsRequest) This is a variant ofdescribeEvents(software.amazon.awssdk.services.opsworkscm.model.DescribeEventsRequest)
operation.describeNodeAssociationStatus
(Consumer<DescribeNodeAssociationStatusRequest.Builder> describeNodeAssociationStatusRequest) Returns the current status of an existing association or disassociation request.describeNodeAssociationStatus
(DescribeNodeAssociationStatusRequest describeNodeAssociationStatusRequest) Returns the current status of an existing association or disassociation request.default DescribeServersResponse
Lists all configuration management servers that are identified with your account.default DescribeServersResponse
describeServers
(Consumer<DescribeServersRequest.Builder> describeServersRequest) Lists all configuration management servers that are identified with your account.default DescribeServersResponse
describeServers
(DescribeServersRequest describeServersRequest) Lists all configuration management servers that are identified with your account.default DescribeServersIterable
This is a variant ofdescribeServers(software.amazon.awssdk.services.opsworkscm.model.DescribeServersRequest)
operation.default DescribeServersIterable
describeServersPaginator
(Consumer<DescribeServersRequest.Builder> describeServersRequest) This is a variant ofdescribeServers(software.amazon.awssdk.services.opsworkscm.model.DescribeServersRequest)
operation.default DescribeServersIterable
describeServersPaginator
(DescribeServersRequest describeServersRequest) This is a variant ofdescribeServers(software.amazon.awssdk.services.opsworkscm.model.DescribeServersRequest)
operation.default DisassociateNodeResponse
disassociateNode
(Consumer<DisassociateNodeRequest.Builder> disassociateNodeRequest) Disassociates a node from an AWS OpsWorks CM server, and removes the node from the server's managed nodes.default DisassociateNodeResponse
disassociateNode
(DisassociateNodeRequest disassociateNodeRequest) Disassociates a node from an AWS OpsWorks CM server, and removes the node from the server's managed nodes.exportServerEngineAttribute
(Consumer<ExportServerEngineAttributeRequest.Builder> exportServerEngineAttributeRequest) Exports a specified server engine attribute as a base64-encoded string.exportServerEngineAttribute
(ExportServerEngineAttributeRequest exportServerEngineAttributeRequest) Exports a specified server engine attribute as a base64-encoded string.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Returns a list of tags that are applied to the specified AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise servers or backups.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of tags that are applied to the specified AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise servers or backups.default ListTagsForResourceIterable
listTagsForResourcePaginator
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) This is a variant oflistTagsForResource(software.amazon.awssdk.services.opsworkscm.model.ListTagsForResourceRequest)
operation.default ListTagsForResourceIterable
listTagsForResourcePaginator
(ListTagsForResourceRequest listTagsForResourceRequest) This is a variant oflistTagsForResource(software.amazon.awssdk.services.opsworkscm.model.ListTagsForResourceRequest)
operation.default RestoreServerResponse
restoreServer
(Consumer<RestoreServerRequest.Builder> restoreServerRequest) Restores a backup to a server that is in aCONNECTION_LOST
,HEALTHY
,RUNNING
,UNHEALTHY
, orTERMINATED
state.default RestoreServerResponse
restoreServer
(RestoreServerRequest restoreServerRequest) Restores a backup to a server that is in aCONNECTION_LOST
,HEALTHY
,RUNNING
,UNHEALTHY
, orTERMINATED
state.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default StartMaintenanceResponse
startMaintenance
(Consumer<StartMaintenanceRequest.Builder> startMaintenanceRequest) Manually starts server maintenance.default StartMaintenanceResponse
startMaintenance
(StartMaintenanceRequest startMaintenanceRequest) Manually starts server maintenance.default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Applies tags to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server, or to server backups.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Applies tags to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server, or to server backups.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes specified tags from an AWS OpsWorks-CM server or backup.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes specified tags from an AWS OpsWorks-CM server or backup.default UpdateServerResponse
updateServer
(Consumer<UpdateServerRequest.Builder> updateServerRequest) Updates settings for a server.default UpdateServerResponse
updateServer
(UpdateServerRequest updateServerRequest) Updates settings for a server.updateServerEngineAttributes
(Consumer<UpdateServerEngineAttributesRequest.Builder> updateServerEngineAttributesRequest) Updates engine-specific attributes on a specified server.updateServerEngineAttributes
(UpdateServerEngineAttributesRequest updateServerEngineAttributesRequest) Updates engine-specific attributes on a specified server.default OpsWorksCmWaiter
waiter()
Create an instance ofOpsWorksCmWaiter
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
-
associateNode
default AssociateNodeResponse associateNode(AssociateNodeRequest associateNodeRequest) throws InvalidStateException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpsWorksCmException Associates a new node with the server. For more information about how to disassociate a node, see DisassociateNode.
On a Chef server: This command is an alternative to
knife bootstrap
.Example (Chef):
aws opsworks-cm associate-node --server-name MyServer --node-name MyManagedNode --engine-attributes "Name=CHEF_ORGANIZATION,Value=default" "Name=CHEF_NODE_PUBLIC_KEY,Value=public-key-pem"
On a Puppet server, this command is an alternative to the
puppet cert sign
command that signs a Puppet node CSR.Example (Puppet):
aws opsworks-cm associate-node --server-name MyServer --node-name MyManagedNode --engine-attributes "Name=PUPPET_NODE_CSR,Value=csr-pem"
A node can can only be associated with servers that are in a
HEALTHY
state. Otherwise, anInvalidStateException
is thrown. AResourceNotFoundException
is thrown when the server does not exist. AValidationException
is raised when parameters of the request are not valid. The AssociateNode API call can be integrated into Auto Scaling configurations, AWS Cloudformation templates, or the user data of a server's instance.- Parameters:
associateNodeRequest
-- Returns:
- Result of the AssociateNode operation returned by the service.
- See Also:
-
associateNode
default AssociateNodeResponse associateNode(Consumer<AssociateNodeRequest.Builder> associateNodeRequest) throws InvalidStateException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpsWorksCmException Associates a new node with the server. For more information about how to disassociate a node, see DisassociateNode.
On a Chef server: This command is an alternative to
knife bootstrap
.Example (Chef):
aws opsworks-cm associate-node --server-name MyServer --node-name MyManagedNode --engine-attributes "Name=CHEF_ORGANIZATION,Value=default" "Name=CHEF_NODE_PUBLIC_KEY,Value=public-key-pem"
On a Puppet server, this command is an alternative to the
puppet cert sign
command that signs a Puppet node CSR.Example (Puppet):
aws opsworks-cm associate-node --server-name MyServer --node-name MyManagedNode --engine-attributes "Name=PUPPET_NODE_CSR,Value=csr-pem"
A node can can only be associated with servers that are in a
HEALTHY
state. Otherwise, anInvalidStateException
is thrown. AResourceNotFoundException
is thrown when the server does not exist. AValidationException
is raised when parameters of the request are not valid. The AssociateNode API call can be integrated into Auto Scaling configurations, AWS Cloudformation templates, or the user data of a server's instance.
This is a convenience which creates an instance of the
AssociateNodeRequest.Builder
avoiding the need to create one manually viaAssociateNodeRequest.builder()
- Parameters:
associateNodeRequest
- AConsumer
that will call methods onAssociateNodeRequest.Builder
to create a request.- Returns:
- Result of the AssociateNode operation returned by the service.
- See Also:
-
createBackup
default CreateBackupResponse createBackup(CreateBackupRequest createBackupRequest) throws InvalidStateException, LimitExceededException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpsWorksCmException Creates an application-level backup of a server. While the server is in the
BACKING_UP
state, the server cannot be changed, and no additional backup can be created.Backups can be created for servers in
RUNNING
,HEALTHY
, andUNHEALTHY
states. By default, you can create a maximum of 50 manual backups.This operation is asynchronous.
A
LimitExceededException
is thrown when the maximum number of manual backups is reached. AnInvalidStateException
is thrown when the server is not in any of the following states: RUNNING, HEALTHY, or UNHEALTHY. AResourceNotFoundException
is thrown when the server is not found. AValidationException
is thrown when parameters of the request are not valid.- Parameters:
createBackupRequest
-- Returns:
- Result of the CreateBackup operation returned by the service.
- See Also:
-
createBackup
default CreateBackupResponse createBackup(Consumer<CreateBackupRequest.Builder> createBackupRequest) throws InvalidStateException, LimitExceededException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpsWorksCmException Creates an application-level backup of a server. While the server is in the
BACKING_UP
state, the server cannot be changed, and no additional backup can be created.Backups can be created for servers in
RUNNING
,HEALTHY
, andUNHEALTHY
states. By default, you can create a maximum of 50 manual backups.This operation is asynchronous.
A
LimitExceededException
is thrown when the maximum number of manual backups is reached. AnInvalidStateException
is thrown when the server is not in any of the following states: RUNNING, HEALTHY, or UNHEALTHY. AResourceNotFoundException
is thrown when the server is not found. AValidationException
is thrown when parameters of the request are not valid.
This is a convenience which creates an instance of the
CreateBackupRequest.Builder
avoiding the need to create one manually viaCreateBackupRequest.builder()
- Parameters:
createBackupRequest
- AConsumer
that will call methods onCreateBackupRequest.Builder
to create a request.- Returns:
- Result of the CreateBackup operation returned by the service.
- See Also:
-
createServer
default CreateServerResponse createServer(CreateServerRequest createServerRequest) throws LimitExceededException, ResourceAlreadyExistsException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpsWorksCmException Creates and immedately starts a new server. The server is ready to use when it is in the
HEALTHY
state. By default, you can create a maximum of 10 servers.This operation is asynchronous.
A
LimitExceededException
is thrown when you have created the maximum number of servers (10). AResourceAlreadyExistsException
is thrown when a server with the same name already exists in the account. AResourceNotFoundException
is thrown when you specify a backup ID that is not valid or is for a backup that does not exist. AValidationException
is thrown when parameters of the request are not valid.If you do not specify a security group by adding the
SecurityGroupIds
parameter, AWS OpsWorks creates a new security group.Chef Automate: The default security group opens the Chef server to the world on TCP port 443. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is also open to the world on TCP port 22.
Puppet Enterprise: The default security group opens TCP ports 22, 443, 4433, 8140, 8142, 8143, and 8170. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is also open to the world on TCP port 22.
By default, your server is accessible from any IP address. We recommend that you update your security group rules to allow access from known IP addresses and address ranges only. To edit security group rules, open Security Groups in the navigation pane of the EC2 management console.
To specify your own domain for a server, and provide your own self-signed or CA-signed certificate and private key, specify values for
CustomDomain
,CustomCertificate
, andCustomPrivateKey
.- Parameters:
createServerRequest
-- Returns:
- Result of the CreateServer operation returned by the service.
- See Also:
-
createServer
default CreateServerResponse createServer(Consumer<CreateServerRequest.Builder> createServerRequest) throws LimitExceededException, ResourceAlreadyExistsException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpsWorksCmException Creates and immedately starts a new server. The server is ready to use when it is in the
HEALTHY
state. By default, you can create a maximum of 10 servers.This operation is asynchronous.
A
LimitExceededException
is thrown when you have created the maximum number of servers (10). AResourceAlreadyExistsException
is thrown when a server with the same name already exists in the account. AResourceNotFoundException
is thrown when you specify a backup ID that is not valid or is for a backup that does not exist. AValidationException
is thrown when parameters of the request are not valid.If you do not specify a security group by adding the
SecurityGroupIds
parameter, AWS OpsWorks creates a new security group.Chef Automate: The default security group opens the Chef server to the world on TCP port 443. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is also open to the world on TCP port 22.
Puppet Enterprise: The default security group opens TCP ports 22, 443, 4433, 8140, 8142, 8143, and 8170. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is also open to the world on TCP port 22.
By default, your server is accessible from any IP address. We recommend that you update your security group rules to allow access from known IP addresses and address ranges only. To edit security group rules, open Security Groups in the navigation pane of the EC2 management console.
To specify your own domain for a server, and provide your own self-signed or CA-signed certificate and private key, specify values for
CustomDomain
,CustomCertificate
, andCustomPrivateKey
.
This is a convenience which creates an instance of the
CreateServerRequest.Builder
avoiding the need to create one manually viaCreateServerRequest.builder()
- Parameters:
createServerRequest
- AConsumer
that will call methods onCreateServerRequest.Builder
to create a request.- Returns:
- Result of the CreateServer operation returned by the service.
- See Also:
-
deleteBackup
default DeleteBackupResponse deleteBackup(DeleteBackupRequest deleteBackupRequest) throws InvalidStateException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpsWorksCmException Deletes a backup. You can delete both manual and automated backups. This operation is asynchronous.
An
InvalidStateException
is thrown when a backup deletion is already in progress. AResourceNotFoundException
is thrown when the backup does not exist. AValidationException
is thrown when parameters of the request are not valid.- Parameters:
deleteBackupRequest
-- Returns:
- Result of the DeleteBackup operation returned by the service.
- See Also:
-
deleteBackup
default DeleteBackupResponse deleteBackup(Consumer<DeleteBackupRequest.Builder> deleteBackupRequest) throws InvalidStateException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpsWorksCmException Deletes a backup. You can delete both manual and automated backups. This operation is asynchronous.
An
InvalidStateException
is thrown when a backup deletion is already in progress. AResourceNotFoundException
is thrown when the backup does not exist. AValidationException
is thrown when parameters of the request are not valid.
This is a convenience which creates an instance of the
DeleteBackupRequest.Builder
avoiding the need to create one manually viaDeleteBackupRequest.builder()
- Parameters:
deleteBackupRequest
- AConsumer
that will call methods onDeleteBackupRequest.Builder
to create a request.- Returns:
- Result of the DeleteBackup operation returned by the service.
- See Also:
-
deleteServer
default DeleteServerResponse deleteServer(DeleteServerRequest deleteServerRequest) throws InvalidStateException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpsWorksCmException Deletes the server and the underlying AWS CloudFormation stacks (including the server's EC2 instance). When you run this command, the server state is updated to
DELETING
. After the server is deleted, it is no longer returned byDescribeServer
requests. If the AWS CloudFormation stack cannot be deleted, the server cannot be deleted.This operation is asynchronous.
An
InvalidStateException
is thrown when a server deletion is already in progress. AResourceNotFoundException
is thrown when the server does not exist. AValidationException
is raised when parameters of the request are not valid.- Parameters:
deleteServerRequest
-- Returns:
- Result of the DeleteServer operation returned by the service.
- See Also:
-
deleteServer
default DeleteServerResponse deleteServer(Consumer<DeleteServerRequest.Builder> deleteServerRequest) throws InvalidStateException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpsWorksCmException Deletes the server and the underlying AWS CloudFormation stacks (including the server's EC2 instance). When you run this command, the server state is updated to
DELETING
. After the server is deleted, it is no longer returned byDescribeServer
requests. If the AWS CloudFormation stack cannot be deleted, the server cannot be deleted.This operation is asynchronous.
An
InvalidStateException
is thrown when a server deletion is already in progress. AResourceNotFoundException
is thrown when the server does not exist. AValidationException
is raised when parameters of the request are not valid.
This is a convenience which creates an instance of the
DeleteServerRequest.Builder
avoiding the need to create one manually viaDeleteServerRequest.builder()
- Parameters:
deleteServerRequest
- AConsumer
that will call methods onDeleteServerRequest.Builder
to create a request.- Returns:
- Result of the DeleteServer operation returned by the service.
- See Also:
-
describeAccountAttributes
default DescribeAccountAttributesResponse describeAccountAttributes(DescribeAccountAttributesRequest describeAccountAttributesRequest) throws AwsServiceException, SdkClientException, OpsWorksCmException Describes your OpsWorks-CM account attributes.
This operation is synchronous.
- Parameters:
describeAccountAttributesRequest
-- Returns:
- Result of the DescribeAccountAttributes operation returned by the service.
- See Also:
-
describeAccountAttributes
default DescribeAccountAttributesResponse describeAccountAttributes(Consumer<DescribeAccountAttributesRequest.Builder> describeAccountAttributesRequest) throws AwsServiceException, SdkClientException, OpsWorksCmException Describes your OpsWorks-CM account attributes.
This operation is synchronous.
This is a convenience which creates an instance of the
DescribeAccountAttributesRequest.Builder
avoiding the need to create one manually viaDescribeAccountAttributesRequest.builder()
- Parameters:
describeAccountAttributesRequest
- AConsumer
that will call methods onDescribeAccountAttributesRequest.Builder
to create a request.- Returns:
- Result of the DescribeAccountAttributes operation returned by the service.
- See Also:
-
describeAccountAttributes
default DescribeAccountAttributesResponse describeAccountAttributes() throws AwsServiceException, SdkClientException, OpsWorksCmExceptionDescribes your OpsWorks-CM account attributes.
This operation is synchronous.
- Returns:
- Result of the DescribeAccountAttributes operation returned by the service.
- See Also:
-
describeBackups
default DescribeBackupsResponse describeBackups(DescribeBackupsRequest describeBackupsRequest) throws ValidationException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, OpsWorksCmException Describes backups. The results are ordered by time, with newest backups first. If you do not specify a BackupId or ServerName, the command returns all backups.
This operation is synchronous.
A
ResourceNotFoundException
is thrown when the backup does not exist. AValidationException
is raised when parameters of the request are not valid.- Parameters:
describeBackupsRequest
-- Returns:
- Result of the DescribeBackups operation returned by the service.
- See Also:
-
describeBackups
default DescribeBackupsResponse describeBackups(Consumer<DescribeBackupsRequest.Builder> describeBackupsRequest) throws ValidationException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, OpsWorksCmException Describes backups. The results are ordered by time, with newest backups first. If you do not specify a BackupId or ServerName, the command returns all backups.
This operation is synchronous.
A
ResourceNotFoundException
is thrown when the backup does not exist. AValidationException
is raised when parameters of the request are not valid.
This is a convenience which creates an instance of the
DescribeBackupsRequest.Builder
avoiding the need to create one manually viaDescribeBackupsRequest.builder()
- Parameters:
describeBackupsRequest
- AConsumer
that will call methods onDescribeBackupsRequest.Builder
to create a request.- Returns:
- Result of the DescribeBackups operation returned by the service.
- See Also:
-
describeBackups
default DescribeBackupsResponse describeBackups() throws ValidationException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, OpsWorksCmExceptionDescribes backups. The results are ordered by time, with newest backups first. If you do not specify a BackupId or ServerName, the command returns all backups.
This operation is synchronous.
A
ResourceNotFoundException
is thrown when the backup does not exist. AValidationException
is raised when parameters of the request are not valid.- Returns:
- Result of the DescribeBackups operation returned by the service.
- See Also:
-
describeBackupsPaginator
default DescribeBackupsIterable describeBackupsPaginator() throws ValidationException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, OpsWorksCmExceptionThis is a variant of
describeBackups(software.amazon.awssdk.services.opsworkscm.model.DescribeBackupsRequest)
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.opsworkscm.paginators.DescribeBackupsIterable responses = client.describeBackupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.opsworkscm.paginators.DescribeBackupsIterable responses = client .describeBackupsPaginator(request); for (software.amazon.awssdk.services.opsworkscm.model.DescribeBackupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.opsworkscm.paginators.DescribeBackupsIterable responses = client.describeBackupsPaginator(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
describeBackups(software.amazon.awssdk.services.opsworkscm.model.DescribeBackupsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeBackupsPaginator
default DescribeBackupsIterable describeBackupsPaginator(DescribeBackupsRequest describeBackupsRequest) throws ValidationException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, OpsWorksCmException This is a variant of
describeBackups(software.amazon.awssdk.services.opsworkscm.model.DescribeBackupsRequest)
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.opsworkscm.paginators.DescribeBackupsIterable responses = client.describeBackupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.opsworkscm.paginators.DescribeBackupsIterable responses = client .describeBackupsPaginator(request); for (software.amazon.awssdk.services.opsworkscm.model.DescribeBackupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.opsworkscm.paginators.DescribeBackupsIterable responses = client.describeBackupsPaginator(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
describeBackups(software.amazon.awssdk.services.opsworkscm.model.DescribeBackupsRequest)
operation.- Parameters:
describeBackupsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeBackupsPaginator
default DescribeBackupsIterable describeBackupsPaginator(Consumer<DescribeBackupsRequest.Builder> describeBackupsRequest) throws ValidationException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, OpsWorksCmException This is a variant of
describeBackups(software.amazon.awssdk.services.opsworkscm.model.DescribeBackupsRequest)
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.opsworkscm.paginators.DescribeBackupsIterable responses = client.describeBackupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.opsworkscm.paginators.DescribeBackupsIterable responses = client .describeBackupsPaginator(request); for (software.amazon.awssdk.services.opsworkscm.model.DescribeBackupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.opsworkscm.paginators.DescribeBackupsIterable responses = client.describeBackupsPaginator(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
describeBackups(software.amazon.awssdk.services.opsworkscm.model.DescribeBackupsRequest)
operation.
This is a convenience which creates an instance of the
DescribeBackupsRequest.Builder
avoiding the need to create one manually viaDescribeBackupsRequest.builder()
- Parameters:
describeBackupsRequest
- AConsumer
that will call methods onDescribeBackupsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEvents
default DescribeEventsResponse describeEvents(DescribeEventsRequest describeEventsRequest) throws ValidationException, InvalidNextTokenException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksCmException Describes events for a specified server. Results are ordered by time, with newest events first.
This operation is synchronous.
A
ResourceNotFoundException
is thrown when the server does not exist. AValidationException
is raised when parameters of the request are not valid.- Parameters:
describeEventsRequest
-- Returns:
- Result of the DescribeEvents operation returned by the service.
- See Also:
-
describeEvents
default DescribeEventsResponse describeEvents(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) throws ValidationException, InvalidNextTokenException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksCmException Describes events for a specified server. Results are ordered by time, with newest events first.
This operation is synchronous.
A
ResourceNotFoundException
is thrown when the server does not exist. AValidationException
is raised when parameters of the request are not valid.
This is a convenience which creates an instance of the
DescribeEventsRequest.Builder
avoiding the need to create one manually viaDescribeEventsRequest.builder()
- Parameters:
describeEventsRequest
- AConsumer
that will call methods onDescribeEventsRequest.Builder
to create a request.- Returns:
- Result of the DescribeEvents operation returned by the service.
- See Also:
-
describeEventsPaginator
default DescribeEventsIterable describeEventsPaginator(DescribeEventsRequest describeEventsRequest) throws ValidationException, InvalidNextTokenException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksCmException This is a variant of
describeEvents(software.amazon.awssdk.services.opsworkscm.model.DescribeEventsRequest)
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.opsworkscm.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.opsworkscm.paginators.DescribeEventsIterable responses = client .describeEventsPaginator(request); for (software.amazon.awssdk.services.opsworkscm.model.DescribeEventsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.opsworkscm.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(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
describeEvents(software.amazon.awssdk.services.opsworkscm.model.DescribeEventsRequest)
operation.- Parameters:
describeEventsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEventsPaginator
default DescribeEventsIterable describeEventsPaginator(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) throws ValidationException, InvalidNextTokenException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksCmException This is a variant of
describeEvents(software.amazon.awssdk.services.opsworkscm.model.DescribeEventsRequest)
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.opsworkscm.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.opsworkscm.paginators.DescribeEventsIterable responses = client .describeEventsPaginator(request); for (software.amazon.awssdk.services.opsworkscm.model.DescribeEventsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.opsworkscm.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(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
describeEvents(software.amazon.awssdk.services.opsworkscm.model.DescribeEventsRequest)
operation.
This is a convenience which creates an instance of the
DescribeEventsRequest.Builder
avoiding the need to create one manually viaDescribeEventsRequest.builder()
- Parameters:
describeEventsRequest
- AConsumer
that will call methods onDescribeEventsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeNodeAssociationStatus
default DescribeNodeAssociationStatusResponse describeNodeAssociationStatus(DescribeNodeAssociationStatusRequest describeNodeAssociationStatusRequest) throws ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpsWorksCmException Returns the current status of an existing association or disassociation request.
A
ResourceNotFoundException
is thrown when no recent association or disassociation request with the specified token is found, or when the server does not exist. AValidationException
is raised when parameters of the request are not valid.- Parameters:
describeNodeAssociationStatusRequest
-- Returns:
- Result of the DescribeNodeAssociationStatus operation returned by the service.
- See Also:
-
describeNodeAssociationStatus
default DescribeNodeAssociationStatusResponse describeNodeAssociationStatus(Consumer<DescribeNodeAssociationStatusRequest.Builder> describeNodeAssociationStatusRequest) throws ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpsWorksCmException Returns the current status of an existing association or disassociation request.
A
ResourceNotFoundException
is thrown when no recent association or disassociation request with the specified token is found, or when the server does not exist. AValidationException
is raised when parameters of the request are not valid.
This is a convenience which creates an instance of the
DescribeNodeAssociationStatusRequest.Builder
avoiding the need to create one manually viaDescribeNodeAssociationStatusRequest.builder()
- Parameters:
describeNodeAssociationStatusRequest
- AConsumer
that will call methods onDescribeNodeAssociationStatusRequest.Builder
to create a request.- Returns:
- Result of the DescribeNodeAssociationStatus operation returned by the service.
- See Also:
-
describeServers
default DescribeServersResponse describeServers(DescribeServersRequest describeServersRequest) throws ValidationException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, OpsWorksCmException Lists all configuration management servers that are identified with your account. Only the stored results from Amazon DynamoDB are returned. AWS OpsWorks CM does not query other services.
This operation is synchronous.
A
ResourceNotFoundException
is thrown when the server does not exist. AValidationException
is raised when parameters of the request are not valid.- Parameters:
describeServersRequest
-- Returns:
- Result of the DescribeServers operation returned by the service.
- See Also:
-
describeServers
default DescribeServersResponse describeServers(Consumer<DescribeServersRequest.Builder> describeServersRequest) throws ValidationException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, OpsWorksCmException Lists all configuration management servers that are identified with your account. Only the stored results from Amazon DynamoDB are returned. AWS OpsWorks CM does not query other services.
This operation is synchronous.
A
ResourceNotFoundException
is thrown when the server does not exist. AValidationException
is raised when parameters of the request are not valid.
This is a convenience which creates an instance of the
DescribeServersRequest.Builder
avoiding the need to create one manually viaDescribeServersRequest.builder()
- Parameters:
describeServersRequest
- AConsumer
that will call methods onDescribeServersRequest.Builder
to create a request.- Returns:
- Result of the DescribeServers operation returned by the service.
- See Also:
-
describeServers
default DescribeServersResponse describeServers() throws ValidationException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, OpsWorksCmExceptionLists all configuration management servers that are identified with your account. Only the stored results from Amazon DynamoDB are returned. AWS OpsWorks CM does not query other services.
This operation is synchronous.
A
ResourceNotFoundException
is thrown when the server does not exist. AValidationException
is raised when parameters of the request are not valid.- Returns:
- Result of the DescribeServers operation returned by the service.
- See Also:
-
describeServersPaginator
default DescribeServersIterable describeServersPaginator() throws ValidationException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, OpsWorksCmExceptionThis is a variant of
describeServers(software.amazon.awssdk.services.opsworkscm.model.DescribeServersRequest)
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.opsworkscm.paginators.DescribeServersIterable responses = client.describeServersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.opsworkscm.paginators.DescribeServersIterable responses = client .describeServersPaginator(request); for (software.amazon.awssdk.services.opsworkscm.model.DescribeServersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.opsworkscm.paginators.DescribeServersIterable responses = client.describeServersPaginator(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
describeServers(software.amazon.awssdk.services.opsworkscm.model.DescribeServersRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeServersPaginator
default DescribeServersIterable describeServersPaginator(DescribeServersRequest describeServersRequest) throws ValidationException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, OpsWorksCmException This is a variant of
describeServers(software.amazon.awssdk.services.opsworkscm.model.DescribeServersRequest)
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.opsworkscm.paginators.DescribeServersIterable responses = client.describeServersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.opsworkscm.paginators.DescribeServersIterable responses = client .describeServersPaginator(request); for (software.amazon.awssdk.services.opsworkscm.model.DescribeServersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.opsworkscm.paginators.DescribeServersIterable responses = client.describeServersPaginator(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
describeServers(software.amazon.awssdk.services.opsworkscm.model.DescribeServersRequest)
operation.- Parameters:
describeServersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeServersPaginator
default DescribeServersIterable describeServersPaginator(Consumer<DescribeServersRequest.Builder> describeServersRequest) throws ValidationException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, OpsWorksCmException This is a variant of
describeServers(software.amazon.awssdk.services.opsworkscm.model.DescribeServersRequest)
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.opsworkscm.paginators.DescribeServersIterable responses = client.describeServersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.opsworkscm.paginators.DescribeServersIterable responses = client .describeServersPaginator(request); for (software.amazon.awssdk.services.opsworkscm.model.DescribeServersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.opsworkscm.paginators.DescribeServersIterable responses = client.describeServersPaginator(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
describeServers(software.amazon.awssdk.services.opsworkscm.model.DescribeServersRequest)
operation.
This is a convenience which creates an instance of the
DescribeServersRequest.Builder
avoiding the need to create one manually viaDescribeServersRequest.builder()
- Parameters:
describeServersRequest
- AConsumer
that will call methods onDescribeServersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
disassociateNode
default DisassociateNodeResponse disassociateNode(DisassociateNodeRequest disassociateNodeRequest) throws InvalidStateException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpsWorksCmException Disassociates a node from an AWS OpsWorks CM server, and removes the node from the server's managed nodes. After a node is disassociated, the node key pair is no longer valid for accessing the configuration manager's API. For more information about how to associate a node, see AssociateNode.
A node can can only be disassociated from a server that is in a
HEALTHY
state. Otherwise, anInvalidStateException
is thrown. AResourceNotFoundException
is thrown when the server does not exist. AValidationException
is raised when parameters of the request are not valid.- Parameters:
disassociateNodeRequest
-- Returns:
- Result of the DisassociateNode operation returned by the service.
- See Also:
-
disassociateNode
default DisassociateNodeResponse disassociateNode(Consumer<DisassociateNodeRequest.Builder> disassociateNodeRequest) throws InvalidStateException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpsWorksCmException Disassociates a node from an AWS OpsWorks CM server, and removes the node from the server's managed nodes. After a node is disassociated, the node key pair is no longer valid for accessing the configuration manager's API. For more information about how to associate a node, see AssociateNode.
A node can can only be disassociated from a server that is in a
HEALTHY
state. Otherwise, anInvalidStateException
is thrown. AResourceNotFoundException
is thrown when the server does not exist. AValidationException
is raised when parameters of the request are not valid.
This is a convenience which creates an instance of the
DisassociateNodeRequest.Builder
avoiding the need to create one manually viaDisassociateNodeRequest.builder()
- Parameters:
disassociateNodeRequest
- AConsumer
that will call methods onDisassociateNodeRequest.Builder
to create a request.- Returns:
- Result of the DisassociateNode operation returned by the service.
- See Also:
-
exportServerEngineAttribute
default ExportServerEngineAttributeResponse exportServerEngineAttribute(ExportServerEngineAttributeRequest exportServerEngineAttributeRequest) throws ValidationException, ResourceNotFoundException, InvalidStateException, AwsServiceException, SdkClientException, OpsWorksCmException Exports a specified server engine attribute as a base64-encoded string. For example, you can export user data that you can use in EC2 to associate nodes with a server.
This operation is synchronous.
A
ValidationException
is raised when parameters of the request are not valid. AResourceNotFoundException
is thrown when the server does not exist. AnInvalidStateException
is thrown when the server is in any of the following states: CREATING, TERMINATED, FAILED or DELETING.- Parameters:
exportServerEngineAttributeRequest
-- Returns:
- Result of the ExportServerEngineAttribute operation returned by the service.
- See Also:
-
exportServerEngineAttribute
default ExportServerEngineAttributeResponse exportServerEngineAttribute(Consumer<ExportServerEngineAttributeRequest.Builder> exportServerEngineAttributeRequest) throws ValidationException, ResourceNotFoundException, InvalidStateException, AwsServiceException, SdkClientException, OpsWorksCmException Exports a specified server engine attribute as a base64-encoded string. For example, you can export user data that you can use in EC2 to associate nodes with a server.
This operation is synchronous.
A
ValidationException
is raised when parameters of the request are not valid. AResourceNotFoundException
is thrown when the server does not exist. AnInvalidStateException
is thrown when the server is in any of the following states: CREATING, TERMINATED, FAILED or DELETING.
This is a convenience which creates an instance of the
ExportServerEngineAttributeRequest.Builder
avoiding the need to create one manually viaExportServerEngineAttributeRequest.builder()
- Parameters:
exportServerEngineAttributeRequest
- AConsumer
that will call methods onExportServerEngineAttributeRequest.Builder
to create a request.- Returns:
- Result of the ExportServerEngineAttribute operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpsWorksCmException Returns a list of tags that are applied to the specified AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise servers or backups.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpsWorksCmException Returns a list of tags that are applied to the specified AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise servers or backups.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResourcePaginator
default ListTagsForResourceIterable listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpsWorksCmException This is a variant of
listTagsForResource(software.amazon.awssdk.services.opsworkscm.model.ListTagsForResourceRequest)
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.opsworkscm.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.opsworkscm.paginators.ListTagsForResourceIterable responses = client .listTagsForResourcePaginator(request); for (software.amazon.awssdk.services.opsworkscm.model.ListTagsForResourceResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.opsworkscm.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(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
listTagsForResource(software.amazon.awssdk.services.opsworkscm.model.ListTagsForResourceRequest)
operation.- Parameters:
listTagsForResourceRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResourcePaginator
default ListTagsForResourceIterable listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpsWorksCmException This is a variant of
listTagsForResource(software.amazon.awssdk.services.opsworkscm.model.ListTagsForResourceRequest)
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.opsworkscm.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.opsworkscm.paginators.ListTagsForResourceIterable responses = client .listTagsForResourcePaginator(request); for (software.amazon.awssdk.services.opsworkscm.model.ListTagsForResourceResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.opsworkscm.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(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
listTagsForResource(software.amazon.awssdk.services.opsworkscm.model.ListTagsForResourceRequest)
operation.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
restoreServer
default RestoreServerResponse restoreServer(RestoreServerRequest restoreServerRequest) throws InvalidStateException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpsWorksCmException Restores a backup to a server that is in a
CONNECTION_LOST
,HEALTHY
,RUNNING
,UNHEALTHY
, orTERMINATED
state. When you run RestoreServer, the server's EC2 instance is deleted, and a new EC2 instance is configured. RestoreServer maintains the existing server endpoint, so configuration management of the server's client devices (nodes) should continue to work.Restoring from a backup is performed by creating a new EC2 instance. If restoration is successful, and the server is in a
HEALTHY
state, AWS OpsWorks CM switches traffic over to the new instance. After restoration is finished, the old EC2 instance is maintained in aRunning
orStopped
state, but is eventually terminated.This operation is asynchronous.
An
InvalidStateException
is thrown when the server is not in a valid state. AResourceNotFoundException
is thrown when the server does not exist. AValidationException
is raised when parameters of the request are not valid.- Parameters:
restoreServerRequest
-- Returns:
- Result of the RestoreServer operation returned by the service.
- See Also:
-
restoreServer
default RestoreServerResponse restoreServer(Consumer<RestoreServerRequest.Builder> restoreServerRequest) throws InvalidStateException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpsWorksCmException Restores a backup to a server that is in a
CONNECTION_LOST
,HEALTHY
,RUNNING
,UNHEALTHY
, orTERMINATED
state. When you run RestoreServer, the server's EC2 instance is deleted, and a new EC2 instance is configured. RestoreServer maintains the existing server endpoint, so configuration management of the server's client devices (nodes) should continue to work.Restoring from a backup is performed by creating a new EC2 instance. If restoration is successful, and the server is in a
HEALTHY
state, AWS OpsWorks CM switches traffic over to the new instance. After restoration is finished, the old EC2 instance is maintained in aRunning
orStopped
state, but is eventually terminated.This operation is asynchronous.
An
InvalidStateException
is thrown when the server is not in a valid state. AResourceNotFoundException
is thrown when the server does not exist. AValidationException
is raised when parameters of the request are not valid.
This is a convenience which creates an instance of the
RestoreServerRequest.Builder
avoiding the need to create one manually viaRestoreServerRequest.builder()
- Parameters:
restoreServerRequest
- AConsumer
that will call methods onRestoreServerRequest.Builder
to create a request.- Returns:
- Result of the RestoreServer operation returned by the service.
- See Also:
-
startMaintenance
default StartMaintenanceResponse startMaintenance(StartMaintenanceRequest startMaintenanceRequest) throws InvalidStateException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpsWorksCmException Manually starts server maintenance. This command can be useful if an earlier maintenance attempt failed, and the underlying cause of maintenance failure has been resolved. The server is in an
UNDER_MAINTENANCE
state while maintenance is in progress.Maintenance can only be started on servers in
HEALTHY
andUNHEALTHY
states. Otherwise, anInvalidStateException
is thrown. AResourceNotFoundException
is thrown when the server does not exist. AValidationException
is raised when parameters of the request are not valid.- Parameters:
startMaintenanceRequest
-- Returns:
- Result of the StartMaintenance operation returned by the service.
- See Also:
-
startMaintenance
default StartMaintenanceResponse startMaintenance(Consumer<StartMaintenanceRequest.Builder> startMaintenanceRequest) throws InvalidStateException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpsWorksCmException Manually starts server maintenance. This command can be useful if an earlier maintenance attempt failed, and the underlying cause of maintenance failure has been resolved. The server is in an
UNDER_MAINTENANCE
state while maintenance is in progress.Maintenance can only be started on servers in
HEALTHY
andUNHEALTHY
states. Otherwise, anInvalidStateException
is thrown. AResourceNotFoundException
is thrown when the server does not exist. AValidationException
is raised when parameters of the request are not valid.
This is a convenience which creates an instance of the
StartMaintenanceRequest.Builder
avoiding the need to create one manually viaStartMaintenanceRequest.builder()
- Parameters:
startMaintenanceRequest
- AConsumer
that will call methods onStartMaintenanceRequest.Builder
to create a request.- Returns:
- Result of the StartMaintenance operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ResourceNotFoundException, ValidationException, InvalidStateException, AwsServiceException, SdkClientException, OpsWorksCmException Applies tags to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server, or to server backups.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ResourceNotFoundException, ValidationException, InvalidStateException, AwsServiceException, SdkClientException, OpsWorksCmException Applies tags to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server, or to server backups.
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:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, ValidationException, InvalidStateException, AwsServiceException, SdkClientException, OpsWorksCmException Removes specified tags from an AWS OpsWorks-CM server or backup.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ResourceNotFoundException, ValidationException, InvalidStateException, AwsServiceException, SdkClientException, OpsWorksCmException Removes specified tags from an AWS OpsWorks-CM server or backup.
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:
-
updateServer
default UpdateServerResponse updateServer(UpdateServerRequest updateServerRequest) throws InvalidStateException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpsWorksCmException Updates settings for a server.
This operation is synchronous.
- Parameters:
updateServerRequest
-- Returns:
- Result of the UpdateServer operation returned by the service.
- See Also:
-
updateServer
default UpdateServerResponse updateServer(Consumer<UpdateServerRequest.Builder> updateServerRequest) throws InvalidStateException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpsWorksCmException Updates settings for a server.
This operation is synchronous.
This is a convenience which creates an instance of the
UpdateServerRequest.Builder
avoiding the need to create one manually viaUpdateServerRequest.builder()
- Parameters:
updateServerRequest
- AConsumer
that will call methods onUpdateServerRequest.Builder
to create a request.- Returns:
- Result of the UpdateServer operation returned by the service.
- See Also:
-
updateServerEngineAttributes
default UpdateServerEngineAttributesResponse updateServerEngineAttributes(UpdateServerEngineAttributesRequest updateServerEngineAttributesRequest) throws InvalidStateException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpsWorksCmException Updates engine-specific attributes on a specified server. The server enters the
MODIFYING
state when this operation is in progress. Only one update can occur at a time. You can use this command to reset a Chef server's public key (CHEF_PIVOTAL_KEY
) or a Puppet server's admin password (PUPPET_ADMIN_PASSWORD
).This operation is asynchronous.
This operation can only be called for servers in
HEALTHY
orUNHEALTHY
states. Otherwise, anInvalidStateException
is raised. AResourceNotFoundException
is thrown when the server does not exist. AValidationException
is raised when parameters of the request are not valid.- Parameters:
updateServerEngineAttributesRequest
-- Returns:
- Result of the UpdateServerEngineAttributes operation returned by the service.
- See Also:
-
updateServerEngineAttributes
default UpdateServerEngineAttributesResponse updateServerEngineAttributes(Consumer<UpdateServerEngineAttributesRequest.Builder> updateServerEngineAttributesRequest) throws InvalidStateException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpsWorksCmException Updates engine-specific attributes on a specified server. The server enters the
MODIFYING
state when this operation is in progress. Only one update can occur at a time. You can use this command to reset a Chef server's public key (CHEF_PIVOTAL_KEY
) or a Puppet server's admin password (PUPPET_ADMIN_PASSWORD
).This operation is asynchronous.
This operation can only be called for servers in
HEALTHY
orUNHEALTHY
states. Otherwise, anInvalidStateException
is raised. AResourceNotFoundException
is thrown when the server does not exist. AValidationException
is raised when parameters of the request are not valid.
This is a convenience which creates an instance of the
UpdateServerEngineAttributesRequest.Builder
avoiding the need to create one manually viaUpdateServerEngineAttributesRequest.builder()
- Parameters:
updateServerEngineAttributesRequest
- AConsumer
that will call methods onUpdateServerEngineAttributesRequest.Builder
to create a request.- Returns:
- Result of the UpdateServerEngineAttributes operation returned by the service.
- See Also:
-
waiter
Create an instance ofOpsWorksCmWaiter
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
OpsWorksCmWaiter
-
create
Create aOpsWorksCmClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aOpsWorksCmClient
. -
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
-