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
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
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 CM

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 and Puppet.

• 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

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() Deprecated. use AWSOpsWorksCMClientBuilder.defaultClient()
AWSOpsWorksCMClient(AWSCredentials awsCredentials) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSOpsWorksCMClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
AWSOpsWorksCMClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AWSOpsWorksCMClient(AWSCredentialsProvider awsCredentialsProvider) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
AWSOpsWorksCMClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AWSOpsWorksCMClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
AWSOpsWorksCMClient(ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Method Summary

Modifier and Type	Method and Description
AssociateNodeResult	associateNode(AssociateNodeRequest request) Associates a new node with the server.
static AWSOpsWorksCMClientBuilder	builder()
CreateBackupResult	createBackup(CreateBackupRequest request) Creates an application-level backup of a server.
CreateServerResult	createServer(CreateServerRequest request) Creates and immedately starts a new server.
DeleteBackupResult	deleteBackup(DeleteBackupRequest request) Deletes a backup.
DeleteServerResult	deleteServer(DeleteServerRequest request) Deletes the server and the underlying AWS CloudFormation stacks (including the server's EC2 instance).
DescribeAccountAttributesResult	describeAccountAttributes(DescribeAccountAttributesRequest request) Describes your OpsWorks-CM account attributes.
DescribeBackupsResult	describeBackups(DescribeBackupsRequest request) Describes backups.
DescribeEventsResult	describeEvents(DescribeEventsRequest request) Describes events for a specified server.
DescribeNodeAssociationStatusResult	describeNodeAssociationStatus(DescribeNodeAssociationStatusRequest request) Returns the current status of an existing association or disassociation request.
DescribeServersResult	describeServers(DescribeServersRequest request) Lists all configuration management servers that are identified with your account.
DisassociateNodeResult	disassociateNode(DisassociateNodeRequest request) Disassociates a node from an AWS OpsWorks CM server, and removes the node from the server's managed nodes.
ExportServerEngineAttributeResult	exportServerEngineAttribute(ExportServerEngineAttributeRequest request) Exports a specified server engine attribute as a base64-encoded string.
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.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) 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.
RestoreServerResult	restoreServer(RestoreServerRequest request) Restores a backup to a server that is in a CONNECTION_LOST, HEALTHY, RUNNING, UNHEALTHY, or TERMINATED state.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartMaintenanceResult	startMaintenance(StartMaintenanceRequest request) Manually starts server maintenance.
TagResourceResult	tagResource(TagResourceRequest request) Applies tags to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server, or to server backups.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes specified tags from an AWS OpsWorks-CM server or backup.
UpdateServerResult	updateServer(UpdateServerRequest request) Updates settings for a server.
UpdateServerEngineAttributesResult	updateServerEngineAttributes(UpdateServerEngineAttributesRequest request) Updates engine-specific attributes on a specified server.
AWSOpsWorksCMWaiters	waiters()

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, 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

Constructor Detail

AWSOpsWorksCMClient

@Deprecated
public AWSOpsWorksCMClient()

Deprecated. use AWSOpsWorksCMClientBuilder.defaultClient()

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

@Deprecated
public AWSOpsWorksCMClient(ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withClientConfiguration(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

@Deprecated
public AWSOpsWorksCMClient(AWSCredentials awsCredentials)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSOpsWorksCMClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();

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

@Deprecated
public AWSOpsWorksCMClient(AWSCredentials awsCredentials,
                                       ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(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

@Deprecated
public AWSOpsWorksCMClient(AWSCredentialsProvider awsCredentialsProvider)

Deprecated. use AwsClientBuilder.withCredentials(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

@Deprecated
public AWSOpsWorksCMClient(AWSCredentialsProvider awsCredentialsProvider,
                                       ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(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

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

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(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

builder

public static AWSOpsWorksCMClientBuilder builder()

associateNode

public AssociateNodeResult associateNode(AssociateNodeRequest request)

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, an InvalidStateException is thrown. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException 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.

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.

See Also:

AWS API Documentation

createBackup

public CreateBackupResult createBackup(CreateBackupRequest request)

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, and UNHEALTHY 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. An InvalidStateException is thrown when the server is not in any of the following states: RUNNING, HEALTHY, or 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.

See Also:

AWS API Documentation

createServer

public CreateServerResult createServer(CreateServerRequest request)

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). A ResourceAlreadyExistsException is thrown when a server with the same name already exists in the account. A ResourceNotFoundException is thrown when you specify a backup ID that is not valid or is for a backup that does not exist. A ValidationException 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, and CustomPrivateKey.

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.

See Also:

AWS API Documentation

deleteBackup

public DeleteBackupResult deleteBackup(DeleteBackupRequest request)

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. 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.

See Also:

AWS API Documentation

deleteServer

public DeleteServerResult deleteServer(DeleteServerRequest request)

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 by DescribeServer 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. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

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.

See Also:

AWS API Documentation

describeAccountAttributes

public DescribeAccountAttributesResult describeAccountAttributes(DescribeAccountAttributesRequest request)

Describes your OpsWorks-CM account attributes.

This operation is synchronous.

Specified by:

describeAccountAttributes in interface AWSOpsWorksCM

Parameters:

describeAccountAttributesRequest -

Returns:

Result of the DescribeAccountAttributes operation returned by the service.

See Also:

AWS API Documentation

describeBackups

public DescribeBackupsResult describeBackups(DescribeBackupsRequest request)

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 not valid.

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.

See Also:

AWS API Documentation

describeEvents

public DescribeEventsResult describeEvents(DescribeEventsRequest request)

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 not valid.

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.

See Also:

AWS API Documentation

describeNodeAssociationStatus

public DescribeNodeAssociationStatusResult describeNodeAssociationStatus(DescribeNodeAssociationStatusRequest request)

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

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.

See Also:

AWS API Documentation

describeServers

public DescribeServersResult describeServers(DescribeServersRequest request)

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

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.

See Also:

AWS API Documentation

disassociateNode

public DisassociateNodeResult disassociateNode(DisassociateNodeRequest request)

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, an InvalidStateException is thrown. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

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.

See Also:

AWS API Documentation

exportServerEngineAttribute

public ExportServerEngineAttributeResult exportServerEngineAttribute(ExportServerEngineAttributeRequest request)

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. A ResourceNotFoundException is thrown when the server does not exist. An InvalidStateException is thrown when the server is in any of the following states: CREATING, TERMINATED, FAILED or DELETING.

Specified by:

exportServerEngineAttribute in interface AWSOpsWorksCM

Parameters:

exportServerEngineAttributeRequest -

Returns:

Result of the ExportServerEngineAttribute 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.

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

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

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.

Specified by:

listTagsForResource in interface AWSOpsWorksCM

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource 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.

See Also:

AWS API Documentation

restoreServer

public RestoreServerResult restoreServer(RestoreServerRequest request)

Restores a backup to a server that is in a CONNECTION_LOST, HEALTHY, RUNNING, UNHEALTHY, or TERMINATED 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 a Running or Stopped state, but is eventually terminated.

This operation is asynchronous.

An 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 not valid.

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.

See Also:

AWS API Documentation

startMaintenance

public StartMaintenanceResult startMaintenance(StartMaintenanceRequest request)

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 and UNHEALTHY states. Otherwise, an InvalidStateException is thrown. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

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.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Applies tags to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server, or to server backups.

Specified by:

tagResource in interface AWSOpsWorksCM

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource 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.

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

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes specified tags from an AWS OpsWorks-CM server or backup.

Specified by:

untagResource in interface AWSOpsWorksCM

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource 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.

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

See Also:

AWS API Documentation

updateServer

public UpdateServerResult updateServer(UpdateServerRequest request)

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.

See Also:

AWS API Documentation

updateServerEngineAttributes

public UpdateServerEngineAttributesResult updateServerEngineAttributes(UpdateServerEngineAttributesRequest request)

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 or UNHEALTHY states. Otherwise, an InvalidStateException is raised. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

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.

See Also:

AWS API Documentation

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.

waiters

public AWSOpsWorksCMWaiters waiters()

Specified by:

waiters in interface AWSOpsWorksCM

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSOpsWorksCM

Overrides:

shutdown in class AmazonWebServiceClient