com.amazonaws.services.opsworkscm

Class AWSOpsWorksCMClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.opsworkscm.AWSOpsWorksCMClient

All Implemented Interfaces:

AWSOpsWorksCM

Direct Known Subclasses:

AWSOpsWorksCMAsyncClient

@ThreadSafe
public class AWSOpsWorksCMClient
extends AmazonWebServiceClient
implements AWSOpsWorksCM

Client for accessing OpsWorksCM. All service calls made using this client are blocking, and will not return until the service call 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.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

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

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AWSOpsWorksCMClient() Constructs a new client to invoke service methods on OpsWorksCM.
AWSOpsWorksCMClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on OpsWorksCM using the specified AWS account credentials.
AWSOpsWorksCMClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on OpsWorksCM using the specified AWS account credentials and client configuration options.
AWSOpsWorksCMClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on OpsWorksCM using the specified AWS account credentials provider.
AWSOpsWorksCMClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on OpsWorksCM using the specified AWS account credentials provider and client configuration options.
AWSOpsWorksCMClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on OpsWorksCM using the specified AWS account credentials provider, client configuration options, and request metric collector.
AWSOpsWorksCMClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on OpsWorksCM.

Method Summary

Modifier and Type	Method and Description
AssociateNodeResult	associateNode(AssociateNodeRequest associateNodeRequest)
CreateBackupResult	createBackup(CreateBackupRequest createBackupRequest) Creates an application-level backup of a server.
CreateServerResult	createServer(CreateServerRequest createServerRequest) Creates and immedately starts a new Server.
DeleteBackupResult	deleteBackup(DeleteBackupRequest deleteBackupRequest) Deletes a backup.
DeleteServerResult	deleteServer(DeleteServerRequest deleteServerRequest) Deletes the server and the underlying AWS CloudFormation stack (including the server's EC2 instance).
DescribeAccountAttributesResult	describeAccountAttributes(DescribeAccountAttributesRequest describeAccountAttributesRequest) Describes your account attributes, and creates requests to increase limits before they are reached or exceeded.
DescribeBackupsResult	describeBackups(DescribeBackupsRequest describeBackupsRequest) Describes backups.
DescribeEventsResult	describeEvents(DescribeEventsRequest describeEventsRequest) Describes events for a specified server.
DescribeNodeAssociationStatusResult	describeNodeAssociationStatus(DescribeNodeAssociationStatusRequest describeNodeAssociationStatusRequest)
DescribeServersResult	describeServers(DescribeServersRequest describeServersRequest) Lists all configuration management servers that are identified with your account.
DisassociateNodeResult	disassociateNode(DisassociateNodeRequest disassociateNodeRequest)
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
RestoreServerResult	restoreServer(RestoreServerRequest restoreServerRequest) Restores a backup to a server that is in a RUNNING, FAILED, or HEALTHY state.
StartMaintenanceResult	startMaintenance(StartMaintenanceRequest startMaintenanceRequest) Manually starts server maintenance.
UpdateServerResult	updateServer(UpdateServerRequest updateServerRequest) Updates settings for a server.
UpdateServerEngineAttributesResult	updateServerEngineAttributes(UpdateServerEngineAttributesRequest updateServerEngineAttributesRequest) Updates engine specific attributes on a specified server.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

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

setEndpoint, setRegion, shutdown

Constructor Detail

AWSOpsWorksCMClient

public AWSOpsWorksCMClient()

Constructs a new 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
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AWSOpsWorksCMClient

public AWSOpsWorksCMClient(ClientConfiguration clientConfiguration)

Constructs a new 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
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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

See Also:

DefaultAWSCredentialsProviderChain

AWSOpsWorksCMClient

public AWSOpsWorksCMClient(AWSCredentials awsCredentials)

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

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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

AWSOpsWorksCMClient

public AWSOpsWorksCMClient(AWSCredentials awsCredentials,
                           ClientConfiguration clientConfiguration)

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

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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

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

AWSOpsWorksCMClient

public AWSOpsWorksCMClient(AWSCredentialsProvider awsCredentialsProvider)

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

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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

AWSOpsWorksCMClient

public AWSOpsWorksCMClient(AWSCredentialsProvider awsCredentialsProvider,
                           ClientConfiguration clientConfiguration)

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

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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

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

AWSOpsWorksCMClient

public AWSOpsWorksCMClient(AWSCredentialsProvider awsCredentialsProvider,
                           ClientConfiguration clientConfiguration,
                           RequestMetricCollector requestMetricCollector)

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

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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

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

requestMetricCollector - optional request metric collector

Method Detail

associateNode

public AssociateNodeResult associateNode(AssociateNodeRequest associateNodeRequest)

Specified by:

associateNode in interface AWSOpsWorksCM

Parameters:

associateNodeRequest -

Returns:

Result of the AssociateNode operation returned by the service.

Throws:

InvalidStateException - The resource is in a state that does not allow you to perform a specified action.

ResourceNotFoundException - The requested resource does not exist, or access was denied.

ValidationException - One or more of the provided request parameters are not valid.

createBackup

public CreateBackupResult createBackup(CreateBackupRequest createBackupRequest)

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:

createBackup in interface AWSOpsWorksCM

Parameters:

createBackupRequest -

Returns:

Result of the CreateBackup operation returned by the service.

Throws:

InvalidStateException - The resource is in a state that does not allow you to perform a specified action.

LimitExceededException - The limit of servers or backups has been reached.

ResourceNotFoundException - The requested resource does not exist, or access was denied.

ValidationException - One or more of the provided request parameters are not valid.

createServer

public CreateServerResult createServer(CreateServerRequest createServerRequest)

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:

createServer in interface AWSOpsWorksCM

Parameters:

createServerRequest -

Returns:

Result of the CreateServer operation returned by the service.

Throws:

LimitExceededException - The limit of servers or backups has been reached.

ResourceAlreadyExistsException - The requested resource cannot be created because it already exists.

ResourceNotFoundException - The requested resource does not exist, or access was denied.

ValidationException - One or more of the provided request parameters are not valid.

deleteBackup

public DeleteBackupResult deleteBackup(DeleteBackupRequest deleteBackupRequest)

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:

deleteBackup in interface AWSOpsWorksCM

Parameters:

deleteBackupRequest -

Returns:

Result of the DeleteBackup operation returned by the service.

Throws:

InvalidStateException - The resource is in a state that does not allow you to perform a specified action.

ResourceNotFoundException - The requested resource does not exist, or access was denied.

ValidationException - One or more of the provided request parameters are not valid.

deleteServer

public DeleteServerResult deleteServer(DeleteServerRequest deleteServerRequest)

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:

deleteServer in interface AWSOpsWorksCM

Parameters:

deleteServerRequest -

Returns:

Result of the DeleteServer operation returned by the service.

Throws:

InvalidStateException - The resource is in a state that does not allow you to perform a specified action.

ResourceNotFoundException - The requested resource does not exist, or access was denied.

ValidationException - One or more of the provided request parameters are not valid.

describeAccountAttributes

public DescribeAccountAttributesResult describeAccountAttributes(DescribeAccountAttributesRequest describeAccountAttributesRequest)

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

This operation is synchronous.

Specified by:

describeAccountAttributes in interface AWSOpsWorksCM

Parameters:

describeAccountAttributesRequest -

Returns:

Result of the DescribeAccountAttributes operation returned by the service.

describeBackups

public DescribeBackupsResult describeBackups(DescribeBackupsRequest describeBackupsRequest)

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:

describeBackups in interface AWSOpsWorksCM

Parameters:

describeBackupsRequest -

Returns:

Result of the DescribeBackups operation returned by the service.

Throws:

ValidationException - One or more of the provided request parameters are not valid.

ResourceNotFoundException - The requested resource does not exist, or access was denied.

InvalidNextTokenException - This occurs when the provided nextToken is not valid.

describeEvents

public DescribeEventsResult describeEvents(DescribeEventsRequest describeEventsRequest)

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:

describeEvents in interface AWSOpsWorksCM

Parameters:

describeEventsRequest -

Returns:

Result of the DescribeEvents operation returned by the service.

Throws:

ValidationException - One or more of the provided request parameters are not valid.

InvalidNextTokenException - This occurs when the provided nextToken is not valid.

ResourceNotFoundException - The requested resource does not exist, or access was denied.

describeNodeAssociationStatus

public DescribeNodeAssociationStatusResult describeNodeAssociationStatus(DescribeNodeAssociationStatusRequest describeNodeAssociationStatusRequest)

Specified by:

describeNodeAssociationStatus in interface AWSOpsWorksCM

Parameters:

describeNodeAssociationStatusRequest -

Returns:

Result of the DescribeNodeAssociationStatus operation returned by the service.

Throws:

ResourceNotFoundException - The requested resource does not exist, or access was denied.

ValidationException - One or more of the provided request parameters are not valid.

describeServers

public DescribeServersResult describeServers(DescribeServersRequest describeServersRequest)

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:

describeServers in interface AWSOpsWorksCM

Parameters:

describeServersRequest -

Returns:

Result of the DescribeServers operation returned by the service.

Throws:

ValidationException - One or more of the provided request parameters are not valid.

ResourceNotFoundException - The requested resource does not exist, or access was denied.

InvalidNextTokenException - This occurs when the provided nextToken is not valid.

disassociateNode

public DisassociateNodeResult disassociateNode(DisassociateNodeRequest disassociateNodeRequest)

Specified by:

disassociateNode in interface AWSOpsWorksCM

Parameters:

disassociateNodeRequest -

Returns:

Result of the DisassociateNode operation returned by the service.

Throws:

InvalidStateException - The resource is in a state that does not allow you to perform a specified action.

ResourceNotFoundException - The requested resource does not exist, or access was denied.

ValidationException - One or more of the provided request parameters are not valid.

restoreServer

public RestoreServerResult restoreServer(RestoreServerRequest restoreServerRequest)

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:

restoreServer in interface AWSOpsWorksCM

Parameters:

restoreServerRequest -

Returns:

Result of the RestoreServer operation returned by the service.

Throws:

InvalidStateException - The resource is in a state that does not allow you to perform a specified action.

ResourceNotFoundException - The requested resource does not exist, or access was denied.

ValidationException - One or more of the provided request parameters are not valid.

startMaintenance

public StartMaintenanceResult startMaintenance(StartMaintenanceRequest startMaintenanceRequest)

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:

startMaintenance in interface AWSOpsWorksCM

Parameters:

startMaintenanceRequest -

Returns:

Result of the StartMaintenance operation returned by the service.

Throws:

InvalidStateException - The resource is in a state that does not allow you to perform a specified action.

ResourceNotFoundException - The requested resource does not exist, or access was denied.

ValidationException - One or more of the provided request parameters are not valid.

updateServer

public UpdateServerResult updateServer(UpdateServerRequest updateServerRequest)

Updates settings for a server.

This operation is synchronous.

Specified by:

updateServer in interface AWSOpsWorksCM

Parameters:

updateServerRequest -

Returns:

Result of the UpdateServer operation returned by the service.

Throws:

InvalidStateException - The resource is in a state that does not allow you to perform a specified action.

ResourceNotFoundException - The requested resource does not exist, or access was denied.

ValidationException - One or more of the provided request parameters are not valid.

updateServerEngineAttributes

public UpdateServerEngineAttributesResult updateServerEngineAttributes(UpdateServerEngineAttributesRequest updateServerEngineAttributesRequest)

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:

updateServerEngineAttributes in interface AWSOpsWorksCM

Parameters:

updateServerEngineAttributesRequest -

Returns:

Result of the UpdateServerEngineAttributes operation returned by the service.

Throws:

InvalidStateException - The resource is in a state that does not allow you to perform a specified action.

ResourceNotFoundException - The requested resource does not exist, or access was denied.

ValidationException - One or more of the provided request parameters are not valid.

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AWSOpsWorksCM

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.