com.amazonaws.services.opsworkscm

Class AWSOpsWorksCMAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.opsworkscm.AWSOpsWorksCMClient

com.amazonaws.services.opsworkscm.AWSOpsWorksCMAsyncClient

All Implemented Interfaces:

AWSOpsWorksCM, AWSOpsWorksCMAsync

@ThreadSafe
public class AWSOpsWorksCMAsyncClient
extends AWSOpsWorksCMClient
implements AWSOpsWorksCMAsync

Client for accessing OpsWorksCM asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

AWS OpsWorks for Chef Automate

A service that runs and manages configuration management servers.

Glossary of terms

• Server: A server is a configuration management server, and can be highly-available. The configuration manager runs on your instances by using various AWS services, such as Amazon Elastic Compute Cloud (EC2), and potentially Amazon Relational Database Service (RDS). A server is a generic abstraction over the configuration manager that you want to use, much like Amazon RDS. In AWS OpsWorks for Chef Automate, you do not start or stop servers. After you create servers, they continue to run until they are deleted.

• Engine: The specific configuration manager that you want to use (such as Chef) is the engine.

• Backup: This is an application-level backup of the data that the configuration manager stores. A backup creates a .tar.gz file that is stored in an Amazon Simple Storage Service (S3) bucket in your account. AWS OpsWorks for Chef Automate creates the S3 bucket when you launch the first instance. A backup maintains a snapshot of all of a server's important attributes at the time of the backup.

• Events: Events are always related to a server. Events are written during server creation, when health checks run, when backups are created, etc. When you delete a server, the server's events are also deleted.

• AccountAttributes: Every account has attributes that are assigned in the AWS OpsWorks for Chef Automate database. These attributes store information about configuration limits (servers, backups, etc.) and your customer account.

Throttling limits

All API operations allow for 5 requests per second with a burst of 10 requests per second.

Field Summary

Fields inherited from class com.amazonaws.services.opsworkscm.AWSOpsWorksCMClient

configFactory

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.opsworkscm.AWSOpsWorksCM

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AWSOpsWorksCMAsyncClient() Constructs a new asynchronous client to invoke service methods on OpsWorksCM.
AWSOpsWorksCMAsyncClient(AWSCredentials awsCredentials) Constructs a new asynchronous client to invoke service methods on OpsWorksCM using the specified AWS account credentials.
AWSOpsWorksCMAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on OpsWorksCM using the specified AWS account credentials, executor service, and client configuration options.
AWSOpsWorksCMAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on OpsWorksCM using the specified AWS account credentials and executor service.
AWSOpsWorksCMAsyncClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new asynchronous client to invoke service methods on OpsWorksCM using the specified AWS account credentials provider.
AWSOpsWorksCMAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new asynchronous client to invoke service methods on OpsWorksCM using the provided AWS account credentials provider and client configuration options.
AWSOpsWorksCMAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on OpsWorksCM using the specified AWS account credentials provider, executor service, and client configuration options.
AWSOpsWorksCMAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on OpsWorksCM using the specified AWS account credentials provider and executor service.
AWSOpsWorksCMAsyncClient(ClientConfiguration clientConfiguration) Constructs a new asynchronous client to invoke service methods on OpsWorksCM.

Method Summary

Modifier and Type	Method and Description
Future<AssociateNodeResult>	associateNodeAsync(AssociateNodeRequest request)
Future<AssociateNodeResult>	associateNodeAsync(AssociateNodeRequest request, AsyncHandler<AssociateNodeRequest,AssociateNodeResult> asyncHandler)
Future<CreateBackupResult>	createBackupAsync(CreateBackupRequest request) Creates an application-level backup of a server.
Future<CreateBackupResult>	createBackupAsync(CreateBackupRequest request, AsyncHandler<CreateBackupRequest,CreateBackupResult> asyncHandler) Creates an application-level backup of a server.
Future<CreateServerResult>	createServerAsync(CreateServerRequest request) Creates and immedately starts a new Server.
Future<CreateServerResult>	createServerAsync(CreateServerRequest request, AsyncHandler<CreateServerRequest,CreateServerResult> asyncHandler) Creates and immedately starts a new Server.
Future<DeleteBackupResult>	deleteBackupAsync(DeleteBackupRequest request) Deletes a backup.
Future<DeleteBackupResult>	deleteBackupAsync(DeleteBackupRequest request, AsyncHandler<DeleteBackupRequest,DeleteBackupResult> asyncHandler) Deletes a backup.
Future<DeleteServerResult>	deleteServerAsync(DeleteServerRequest request) Deletes the server and the underlying AWS CloudFormation stack (including the server's EC2 instance).
Future<DeleteServerResult>	deleteServerAsync(DeleteServerRequest request, AsyncHandler<DeleteServerRequest,DeleteServerResult> asyncHandler) Deletes the server and the underlying AWS CloudFormation stack (including the server's EC2 instance).
Future<DescribeAccountAttributesResult>	describeAccountAttributesAsync(DescribeAccountAttributesRequest request) Describes your account attributes, and creates requests to increase limits before they are reached or exceeded.
Future<DescribeAccountAttributesResult>	describeAccountAttributesAsync(DescribeAccountAttributesRequest request, AsyncHandler<DescribeAccountAttributesRequest,DescribeAccountAttributesResult> asyncHandler) Describes your account attributes, and creates requests to increase limits before they are reached or exceeded.
Future<DescribeBackupsResult>	describeBackupsAsync(DescribeBackupsRequest request) Describes backups.
Future<DescribeBackupsResult>	describeBackupsAsync(DescribeBackupsRequest request, AsyncHandler<DescribeBackupsRequest,DescribeBackupsResult> asyncHandler) Describes backups.
Future<DescribeEventsResult>	describeEventsAsync(DescribeEventsRequest request) Describes events for a specified server.
Future<DescribeEventsResult>	describeEventsAsync(DescribeEventsRequest request, AsyncHandler<DescribeEventsRequest,DescribeEventsResult> asyncHandler) Describes events for a specified server.
Future<DescribeNodeAssociationStatusResult>	describeNodeAssociationStatusAsync(DescribeNodeAssociationStatusRequest request)
Future<DescribeNodeAssociationStatusResult>	describeNodeAssociationStatusAsync(DescribeNodeAssociationStatusRequest request, AsyncHandler<DescribeNodeAssociationStatusRequest,DescribeNodeAssociationStatusResult> asyncHandler)
Future<DescribeServersResult>	describeServersAsync(DescribeServersRequest request) Lists all configuration management servers that are identified with your account.
Future<DescribeServersResult>	describeServersAsync(DescribeServersRequest request, AsyncHandler<DescribeServersRequest,DescribeServersResult> asyncHandler) Lists all configuration management servers that are identified with your account.
Future<DisassociateNodeResult>	disassociateNodeAsync(DisassociateNodeRequest request)
Future<DisassociateNodeResult>	disassociateNodeAsync(DisassociateNodeRequest request, AsyncHandler<DisassociateNodeRequest,DisassociateNodeResult> asyncHandler)
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<RestoreServerResult>	restoreServerAsync(RestoreServerRequest request) Restores a backup to a server that is in a RUNNING, FAILED, or HEALTHY state.
Future<RestoreServerResult>	restoreServerAsync(RestoreServerRequest request, AsyncHandler<RestoreServerRequest,RestoreServerResult> asyncHandler) Restores a backup to a server that is in a RUNNING, FAILED, or HEALTHY state.
void	shutdown() Shuts down the client, releasing all managed resources.
Future<StartMaintenanceResult>	startMaintenanceAsync(StartMaintenanceRequest request) Manually starts server maintenance.
Future<StartMaintenanceResult>	startMaintenanceAsync(StartMaintenanceRequest request, AsyncHandler<StartMaintenanceRequest,StartMaintenanceResult> asyncHandler) Manually starts server maintenance.
Future<UpdateServerResult>	updateServerAsync(UpdateServerRequest request) Updates settings for a server.
Future<UpdateServerResult>	updateServerAsync(UpdateServerRequest request, AsyncHandler<UpdateServerRequest,UpdateServerResult> asyncHandler) Updates settings for a server.
Future<UpdateServerEngineAttributesResult>	updateServerEngineAttributesAsync(UpdateServerEngineAttributesRequest request) Updates engine specific attributes on a specified server.
Future<UpdateServerEngineAttributesResult>	updateServerEngineAttributesAsync(UpdateServerEngineAttributesRequest request, AsyncHandler<UpdateServerEngineAttributesRequest,UpdateServerEngineAttributesResult> asyncHandler) Updates engine specific attributes on a specified server.

Methods inherited from class com.amazonaws.services.opsworkscm.AWSOpsWorksCMClient

associateNode, createBackup, createServer, deleteBackup, deleteServer, describeAccountAttributes, describeBackups, describeEvents, describeNodeAssociationStatus, describeServers, disassociateNode, getCachedResponseMetadata, restoreServer, startMaintenance, updateServer, updateServerEngineAttributes

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerProvider, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.opsworkscm.AWSOpsWorksCM

associateNode, createBackup, createServer, deleteBackup, deleteServer, describeAccountAttributes, describeBackups, describeEvents, describeNodeAssociationStatus, describeServers, disassociateNode, getCachedResponseMetadata, restoreServer, setEndpoint, setRegion, startMaintenance, updateServer, updateServerEngineAttributes

Constructor Detail

AWSOpsWorksCMAsyncClient

public AWSOpsWorksCMAsyncClient()

Constructs a new asynchronous client to invoke service methods on OpsWorksCM. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
• Instance profile credentials delivered through the Amazon EC2 metadata service

Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).

See Also:

DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)

AWSOpsWorksCMAsyncClient

public AWSOpsWorksCMAsyncClient(ClientConfiguration clientConfiguration)

Constructs a new asynchronous client to invoke service methods on OpsWorksCM. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
• Instance profile credentials delivered through the Amazon EC2 metadata service

Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to OpsWorksCM (ex: proxy settings, retry counts, etc).

See Also:

DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)

AWSOpsWorksCMAsyncClient

public AWSOpsWorksCMAsyncClient(AWSCredentials awsCredentials)

Constructs a new asynchronous client to invoke service methods on OpsWorksCM using the specified AWS account credentials.

Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

See Also:

Executors.newFixedThreadPool(int)

AWSOpsWorksCMAsyncClient

public AWSOpsWorksCMAsyncClient(AWSCredentials awsCredentials,
                                ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on OpsWorksCM using the specified AWS account credentials and executor service. Default client settings will be used.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

executorService - The executor service by which all asynchronous requests will be executed.

AWSOpsWorksCMAsyncClient

public AWSOpsWorksCMAsyncClient(AWSCredentials awsCredentials,
                                ClientConfiguration clientConfiguration,
                                ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on OpsWorksCM using the specified AWS account credentials, executor service, and client configuration options.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

executorService - The executor service by which all asynchronous requests will be executed.

AWSOpsWorksCMAsyncClient

public AWSOpsWorksCMAsyncClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new asynchronous client to invoke service methods on OpsWorksCM using the specified AWS account credentials provider. Default client settings will be used.

Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

See Also:

Executors.newFixedThreadPool(int)

AWSOpsWorksCMAsyncClient

public AWSOpsWorksCMAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                ClientConfiguration clientConfiguration)

Constructs a new asynchronous client to invoke service methods on OpsWorksCM using the provided AWS account credentials provider and client configuration options.

Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

See Also:

DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)

AWSOpsWorksCMAsyncClient

public AWSOpsWorksCMAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on OpsWorksCM using the specified AWS account credentials provider and executor service. Default client settings will be used.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

executorService - The executor service by which all asynchronous requests will be executed.

AWSOpsWorksCMAsyncClient

public AWSOpsWorksCMAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                ClientConfiguration clientConfiguration,
                                ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on OpsWorksCM using the specified AWS account credentials provider, executor service, and client configuration options.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

executorService - The executor service by which all asynchronous requests will be executed.

Method Detail

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this client to execute async requests.

Returns:

The executor service used by this client to execute async requests.

associateNodeAsync

public Future<AssociateNodeResult> associateNodeAsync(AssociateNodeRequest request)

Specified by:

associateNodeAsync in interface AWSOpsWorksCMAsync

Returns:

A Java Future containing the result of the AssociateNode operation returned by the service.

See Also:

AWS API Documentation

associateNodeAsync

public Future<AssociateNodeResult> associateNodeAsync(AssociateNodeRequest request,
                                                      AsyncHandler<AssociateNodeRequest,AssociateNodeResult> asyncHandler)

Specified by:

associateNodeAsync in interface AWSOpsWorksCMAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the AssociateNode operation returned by the service.

See Also:

AWS API Documentation

createBackupAsync

public Future<CreateBackupResult> createBackupAsync(CreateBackupRequest request)

Description copied from interface: AWSOpsWorksCMAsync

Creates an application-level backup of a server. While the server is BACKING_UP, the server can not be modified and no additional backup can be created.

Backups can be created for RUNNING, HEALTHY and UNHEALTHY servers.

This operation is asnychronous.

By default 50 manual backups can be created.

A LimitExceededException is thrown then the maximum number of manual backup is reached. A InvalidStateException is thrown when the server is not in any of RUNNING, HEALTHY, UNHEALTHY. A ResourceNotFoundException is thrown when the server is not found. A ValidationException is thrown when parameters of the request are not valid.

Specified by:

createBackupAsync in interface AWSOpsWorksCMAsync

Returns:

A Java Future containing the result of the CreateBackup operation returned by the service.

See Also:

AWS API Documentation

createBackupAsync

public Future<CreateBackupResult> createBackupAsync(CreateBackupRequest request,
                                                    AsyncHandler<CreateBackupRequest,CreateBackupResult> asyncHandler)

Description copied from interface: AWSOpsWorksCMAsync

Creates an application-level backup of a server. While the server is BACKING_UP, the server can not be modified and no additional backup can be created.

Backups can be created for RUNNING, HEALTHY and UNHEALTHY servers.

This operation is asnychronous.

By default 50 manual backups can be created.

A LimitExceededException is thrown then the maximum number of manual backup is reached. A InvalidStateException is thrown when the server is not in any of RUNNING, HEALTHY, UNHEALTHY. A ResourceNotFoundException is thrown when the server is not found. A ValidationException is thrown when parameters of the request are not valid.

Specified by:

createBackupAsync in interface AWSOpsWorksCMAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the CreateBackup operation returned by the service.

See Also:

AWS API Documentation

createServerAsync

public Future<CreateServerResult> createServerAsync(CreateServerRequest request)

Description copied from interface: AWSOpsWorksCMAsync

Creates and immedately starts a new Server. The server can be used once it has reached the HEALTHY state.

This operation is asnychronous.

A LimitExceededException is thrown then the maximum number of server backup is reached. A ResourceAlreadyExistsException is raise when a server with the same name already exists in the account. A ResourceNotFoundException is thrown when a backupId is passed, but the backup does not exist. A ValidationException is thrown when parameters of the request are not valid.

By default 10 servers can be created. A LimitExceededException is raised when the limit is exceeded.

When no security groups are provided by using SecurityGroupIds, AWS OpsWorks creates a new security group. This security group opens the Chef server to the world on TCP port 443. If a KeyName is present, SSH access is enabled. SSH is also open to the world on TCP port 22.

By default, the Chef 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.

Specified by:

createServerAsync in interface AWSOpsWorksCMAsync

Returns:

A Java Future containing the result of the CreateServer operation returned by the service.

See Also:

AWS API Documentation

createServerAsync

public Future<CreateServerResult> createServerAsync(CreateServerRequest request,
                                                    AsyncHandler<CreateServerRequest,CreateServerResult> asyncHandler)

Description copied from interface: AWSOpsWorksCMAsync

Creates and immedately starts a new Server. The server can be used once it has reached the HEALTHY state.

This operation is asnychronous.

A LimitExceededException is thrown then the maximum number of server backup is reached. A ResourceAlreadyExistsException is raise when a server with the same name already exists in the account. A ResourceNotFoundException is thrown when a backupId is passed, but the backup does not exist. A ValidationException is thrown when parameters of the request are not valid.

By default 10 servers can be created. A LimitExceededException is raised when the limit is exceeded.

When no security groups are provided by using SecurityGroupIds, AWS OpsWorks creates a new security group. This security group opens the Chef server to the world on TCP port 443. If a KeyName is present, SSH access is enabled. SSH is also open to the world on TCP port 22.

By default, the Chef 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.

Specified by:

createServerAsync in interface AWSOpsWorksCMAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the CreateServer operation returned by the service.

See Also:

AWS API Documentation

deleteBackupAsync

public Future<DeleteBackupResult> deleteBackupAsync(DeleteBackupRequest request)

Description copied from interface: AWSOpsWorksCMAsync

Deletes a backup. You can delete both manual and automated backups.

This operation is asynchronous.

A InvalidStateException is thrown then a backup is already deleting. A ResourceNotFoundException is thrown when the backup does not exist. A ValidationException is thrown when parameters of the request are not valid.

Specified by:

deleteBackupAsync in interface AWSOpsWorksCMAsync

Returns:

A Java Future containing the result of the DeleteBackup operation returned by the service.

See Also:

AWS API Documentation

deleteBackupAsync

public Future<DeleteBackupResult> deleteBackupAsync(DeleteBackupRequest request,
                                                    AsyncHandler<DeleteBackupRequest,DeleteBackupResult> asyncHandler)

Description copied from interface: AWSOpsWorksCMAsync

Deletes a backup. You can delete both manual and automated backups.

This operation is asynchronous.

A InvalidStateException is thrown then a backup is already deleting. A ResourceNotFoundException is thrown when the backup does not exist. A ValidationException is thrown when parameters of the request are not valid.

Specified by:

deleteBackupAsync in interface AWSOpsWorksCMAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DeleteBackup operation returned by the service.

See Also:

AWS API Documentation

deleteServerAsync

public Future<DeleteServerResult> deleteServerAsync(DeleteServerRequest request)

Description copied from interface: AWSOpsWorksCMAsync

Deletes the server and the underlying AWS CloudFormation stack (including the server's EC2 instance). The server status updated to DELETING. Once the server is successfully deleted, it will no longer be returned by DescribeServer requests. If the AWS CloudFormation stack cannot be deleted, the server cannot be deleted.

This operation is asynchronous.

A InvalidStateException is thrown then a server is already deleting. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are invalid.

Specified by:

deleteServerAsync in interface AWSOpsWorksCMAsync

Returns:

A Java Future containing the result of the DeleteServer operation returned by the service.

See Also:

AWS API Documentation

deleteServerAsync

public Future<DeleteServerResult> deleteServerAsync(DeleteServerRequest request,
                                                    AsyncHandler<DeleteServerRequest,DeleteServerResult> asyncHandler)

Description copied from interface: AWSOpsWorksCMAsync

Deletes the server and the underlying AWS CloudFormation stack (including the server's EC2 instance). The server status updated to DELETING. Once the server is successfully deleted, it will no longer be returned by DescribeServer requests. If the AWS CloudFormation stack cannot be deleted, the server cannot be deleted.

This operation is asynchronous.

A InvalidStateException is thrown then a server is already deleting. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are invalid.

Specified by:

deleteServerAsync in interface AWSOpsWorksCMAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DeleteServer operation returned by the service.

See Also:

AWS API Documentation

describeAccountAttributesAsync

public Future<DescribeAccountAttributesResult> describeAccountAttributesAsync(DescribeAccountAttributesRequest request)

Description copied from interface: AWSOpsWorksCMAsync

Describes your account attributes, and creates requests to increase limits before they are reached or exceeded.

This operation is synchronous.

Specified by:

describeAccountAttributesAsync in interface AWSOpsWorksCMAsync

Returns:

A Java Future containing the result of the DescribeAccountAttributes operation returned by the service.

See Also:

AWS API Documentation

describeAccountAttributesAsync

public Future<DescribeAccountAttributesResult> describeAccountAttributesAsync(DescribeAccountAttributesRequest request,
                                                                              AsyncHandler<DescribeAccountAttributesRequest,DescribeAccountAttributesResult> asyncHandler)

Description copied from interface: AWSOpsWorksCMAsync

Describes your account attributes, and creates requests to increase limits before they are reached or exceeded.

This operation is synchronous.

Specified by:

describeAccountAttributesAsync in interface AWSOpsWorksCMAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DescribeAccountAttributes operation returned by the service.

See Also:

AWS API Documentation

describeBackupsAsync

public Future<DescribeBackupsResult> describeBackupsAsync(DescribeBackupsRequest request)

Description copied from interface: AWSOpsWorksCMAsync

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. A ValidationException is raised when parameters of the request are invalid.

Specified by:

describeBackupsAsync in interface AWSOpsWorksCMAsync

Returns:

A Java Future containing the result of the DescribeBackups operation returned by the service.

See Also:

AWS API Documentation

describeBackupsAsync

public Future<DescribeBackupsResult> describeBackupsAsync(DescribeBackupsRequest request,
                                                          AsyncHandler<DescribeBackupsRequest,DescribeBackupsResult> asyncHandler)

Description copied from interface: AWSOpsWorksCMAsync

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. A ValidationException is raised when parameters of the request are invalid.

Specified by:

describeBackupsAsync in interface AWSOpsWorksCMAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DescribeBackups operation returned by the service.

See Also:

AWS API Documentation

describeEventsAsync

public Future<DescribeEventsResult> describeEventsAsync(DescribeEventsRequest request)

Description copied from interface: AWSOpsWorksCMAsync

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. A ValidationException is raised when parameters of the request are invalid.

Specified by:

describeEventsAsync in interface AWSOpsWorksCMAsync

Returns:

A Java Future containing the result of the DescribeEvents operation returned by the service.

See Also:

AWS API Documentation

describeEventsAsync

public Future<DescribeEventsResult> describeEventsAsync(DescribeEventsRequest request,
                                                        AsyncHandler<DescribeEventsRequest,DescribeEventsResult> asyncHandler)

Description copied from interface: AWSOpsWorksCMAsync

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. A ValidationException is raised when parameters of the request are invalid.

Specified by:

describeEventsAsync in interface AWSOpsWorksCMAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DescribeEvents operation returned by the service.

See Also:

AWS API Documentation

describeNodeAssociationStatusAsync

public Future<DescribeNodeAssociationStatusResult> describeNodeAssociationStatusAsync(DescribeNodeAssociationStatusRequest request)

Specified by:

describeNodeAssociationStatusAsync in interface AWSOpsWorksCMAsync

Returns:

A Java Future containing the result of the DescribeNodeAssociationStatus operation returned by the service.

See Also:

AWS API Documentation

describeNodeAssociationStatusAsync

public Future<DescribeNodeAssociationStatusResult> describeNodeAssociationStatusAsync(DescribeNodeAssociationStatusRequest request,
                                                                                      AsyncHandler<DescribeNodeAssociationStatusRequest,DescribeNodeAssociationStatusResult> asyncHandler)

Specified by:

describeNodeAssociationStatusAsync in interface AWSOpsWorksCMAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DescribeNodeAssociationStatus operation returned by the service.

See Also:

AWS API Documentation

describeServersAsync

public Future<DescribeServersResult> describeServersAsync(DescribeServersRequest request)

Description copied from interface: AWSOpsWorksCMAsync

Lists all configuration management servers that are identified with your account. Only the stored results from Amazon DynamoDB are returned. AWS OpsWorks for Chef Automate does not query other services.

This operation is synchronous.

A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are invalid.

Specified by:

describeServersAsync in interface AWSOpsWorksCMAsync

Returns:

A Java Future containing the result of the DescribeServers operation returned by the service.

See Also:

AWS API Documentation

describeServersAsync

public Future<DescribeServersResult> describeServersAsync(DescribeServersRequest request,
                                                          AsyncHandler<DescribeServersRequest,DescribeServersResult> asyncHandler)

Description copied from interface: AWSOpsWorksCMAsync

Lists all configuration management servers that are identified with your account. Only the stored results from Amazon DynamoDB are returned. AWS OpsWorks for Chef Automate does not query other services.

This operation is synchronous.

A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are invalid.

Specified by:

describeServersAsync in interface AWSOpsWorksCMAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DescribeServers operation returned by the service.

See Also:

AWS API Documentation

disassociateNodeAsync

public Future<DisassociateNodeResult> disassociateNodeAsync(DisassociateNodeRequest request)

Specified by:

disassociateNodeAsync in interface AWSOpsWorksCMAsync

Returns:

A Java Future containing the result of the DisassociateNode operation returned by the service.

See Also:

AWS API Documentation

disassociateNodeAsync

public Future<DisassociateNodeResult> disassociateNodeAsync(DisassociateNodeRequest request,
                                                            AsyncHandler<DisassociateNodeRequest,DisassociateNodeResult> asyncHandler)

Specified by:

disassociateNodeAsync in interface AWSOpsWorksCMAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DisassociateNode operation returned by the service.

See Also:

AWS API Documentation

restoreServerAsync

public Future<RestoreServerResult> restoreServerAsync(RestoreServerRequest request)

Description copied from interface: AWSOpsWorksCMAsync

Restores a backup to a server that is in a RUNNING, FAILED, or HEALTHY 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 all of the server's client devices should continue to work.

This operation is asynchronous.

A InvalidStateException is thrown when the server is not in a valid state. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are invalid.

Specified by:

restoreServerAsync in interface AWSOpsWorksCMAsync

Returns:

A Java Future containing the result of the RestoreServer operation returned by the service.

See Also:

AWS API Documentation

restoreServerAsync

public Future<RestoreServerResult> restoreServerAsync(RestoreServerRequest request,
                                                      AsyncHandler<RestoreServerRequest,RestoreServerResult> asyncHandler)

Description copied from interface: AWSOpsWorksCMAsync

Restores a backup to a server that is in a RUNNING, FAILED, or HEALTHY 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 all of the server's client devices should continue to work.

This operation is asynchronous.

A InvalidStateException is thrown when the server is not in a valid state. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are invalid.

Specified by:

restoreServerAsync in interface AWSOpsWorksCMAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the RestoreServer operation returned by the service.

See Also:

AWS API Documentation

startMaintenanceAsync

public Future<StartMaintenanceResult> startMaintenanceAsync(StartMaintenanceRequest request)

Description copied from interface: AWSOpsWorksCMAsync

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 will switch to UNDER_MAINTENANCE state, while maintenace is in progress.

Maintenace can only be started for HEALTHY and UNHEALTHY servers. A InvalidStateException is thrown otherwise. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are invalid.

Specified by:

startMaintenanceAsync in interface AWSOpsWorksCMAsync

Returns:

A Java Future containing the result of the StartMaintenance operation returned by the service.

See Also:

AWS API Documentation

startMaintenanceAsync

public Future<StartMaintenanceResult> startMaintenanceAsync(StartMaintenanceRequest request,
                                                            AsyncHandler<StartMaintenanceRequest,StartMaintenanceResult> asyncHandler)

Description copied from interface: AWSOpsWorksCMAsync

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 will switch to UNDER_MAINTENANCE state, while maintenace is in progress.

Maintenace can only be started for HEALTHY and UNHEALTHY servers. A InvalidStateException is thrown otherwise. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are invalid.

Specified by:

startMaintenanceAsync in interface AWSOpsWorksCMAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the StartMaintenance operation returned by the service.

See Also:

AWS API Documentation

updateServerAsync

public Future<UpdateServerResult> updateServerAsync(UpdateServerRequest request)

Description copied from interface: AWSOpsWorksCMAsync

Updates settings for a server.

This operation is synchronous.

Specified by:

updateServerAsync in interface AWSOpsWorksCMAsync

Returns:

A Java Future containing the result of the UpdateServer operation returned by the service.

See Also:

AWS API Documentation

updateServerAsync

public Future<UpdateServerResult> updateServerAsync(UpdateServerRequest request,
                                                    AsyncHandler<UpdateServerRequest,UpdateServerResult> asyncHandler)

Description copied from interface: AWSOpsWorksCMAsync

Updates settings for a server.

This operation is synchronous.

Specified by:

updateServerAsync in interface AWSOpsWorksCMAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the UpdateServer operation returned by the service.

See Also:

AWS API Documentation

updateServerEngineAttributesAsync

public Future<UpdateServerEngineAttributesResult> updateServerEngineAttributesAsync(UpdateServerEngineAttributesRequest request)

Description copied from interface: AWSOpsWorksCMAsync

Updates engine specific attributes on a specified server. Server will enter the MODIFYING state when this operation is in progress. Only one update can take place at a time.

This operation can be use to reset Chef Server main API key (CHEF_PIVOTAL_KEY).

This operation is asynchronous.

This operation can only be called for HEALTHY and UNHEALTHY servers. Otherwise a InvalidStateException is raised. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are invalid.

Specified by:

updateServerEngineAttributesAsync in interface AWSOpsWorksCMAsync

Returns:

A Java Future containing the result of the UpdateServerEngineAttributes operation returned by the service.

See Also:

AWS API Documentation

updateServerEngineAttributesAsync

public Future<UpdateServerEngineAttributesResult> updateServerEngineAttributesAsync(UpdateServerEngineAttributesRequest request,
                                                                                    AsyncHandler<UpdateServerEngineAttributesRequest,UpdateServerEngineAttributesResult> asyncHandler)

Description copied from interface: AWSOpsWorksCMAsync

Updates engine specific attributes on a specified server. Server will enter the MODIFYING state when this operation is in progress. Only one update can take place at a time.

This operation can be use to reset Chef Server main API key (CHEF_PIVOTAL_KEY).

This operation is asynchronous.

This operation can only be called for HEALTHY and UNHEALTHY servers. Otherwise a InvalidStateException is raised. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are invalid.

Specified by:

updateServerEngineAttributesAsync in interface AWSOpsWorksCMAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the UpdateServerEngineAttributes operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AWSOpsWorksCM

Overrides:

shutdown in class AmazonWebServiceClient