@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSOpsWorksCMClient extends AmazonWebServiceClient implements AWSOpsWorksCM
AWS OpsWorks for Chef Automate is a service that runs and manages configuration management servers.
Glossary of terms
Server: A configuration management server that 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.
Endpoints
AWS OpsWorks for Chef Automate supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Chef 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-west-2.amazonaws.com
opsworks-cm.eu-west-1.amazonaws.com
Throttling limits
All API operations allow for five requests per second with a burst of 10 requests per second.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Constructor and Description |
|---|
AWSOpsWorksCMClient()
Deprecated.
|
AWSOpsWorksCMClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AWSOpsWorksCMClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AWSOpsWorksCMClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AWSOpsWorksCMClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AWSOpsWorksCMClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AWSOpsWorksCMClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AWSOpsWorksCMClient(ClientConfiguration clientConfiguration)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
AssociateNodeResult |
associateNode(AssociateNodeRequest request)
Associates a new node with the Chef 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 stack (including the server's EC2 instance).
|
DescribeAccountAttributesResult |
describeAccountAttributes(DescribeAccountAttributesRequest request)
Describes your account attributes, and creates requests to increase limits before they are reached or exceeded.
|
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 a Chef server, and removes the node from the Chef server's managed nodes.
|
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 request)
Restores a backup to a server that is in a
CONNECTION_LOST, HEALTHY,
RUNNING, UNHEALTHY, or TERMINATED state. |
StartMaintenanceResult |
startMaintenance(StartMaintenanceRequest request)
Manually starts server maintenance.
|
UpdateServerResult |
updateServer(UpdateServerRequest request)
Updates settings for a server.
|
UpdateServerEngineAttributesResult |
updateServerEngineAttributes(UpdateServerEngineAttributesRequest request)
Updates engine-specific attributes on a specified server.
|
addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion, shutdown@Deprecated public AWSOpsWorksCMClient()
AWSOpsWorksCMClientBuilder.defaultClient()All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain@Deprecated public AWSOpsWorksCMClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this client connects to OpsWorksCM (ex: proxy settings,
retry counts, etc.).DefaultAWSCredentialsProviderChain@Deprecated public AWSOpsWorksCMClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AWSOpsWorksCMClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AWSOpsWorksCMClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
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.).@Deprecated public AWSOpsWorksCMClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AWSOpsWorksCMClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
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.).@Deprecated public AWSOpsWorksCMClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)All service calls made using this new client object are blocking, and will not return until the service call completes.
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 collectorpublic static AWSOpsWorksCMClientBuilder builder()
public AssociateNodeResult associateNode(AssociateNodeRequest request)
Associates a new node with the Chef server. This command is an alternative to knife bootstrap. For
more information about how to disassociate a node, see DisassociateNode.
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.
Example:
aws opsworks-cm associate-node --server-name MyServer --node-name MyManagedNode --engine-attributes "Name=MyOrganization,Value=default" "Name=Chef_node_public_key,Value=Public_key_contents"
associateNode in interface AWSOpsWorksCMassociateNodeRequest - 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.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.
createBackup in interface AWSOpsWorksCMcreateBackupRequest - 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.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. 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.
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.
createServer in interface AWSOpsWorksCMcreateServerRequest - 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.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.
deleteBackup in interface AWSOpsWorksCMdeleteBackupRequest - 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.public DeleteServerResult deleteServer(DeleteServerRequest request)
Deletes the server and the underlying AWS CloudFormation stack (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.
deleteServer in interface AWSOpsWorksCMdeleteServerRequest - 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.public DescribeAccountAttributesResult describeAccountAttributes(DescribeAccountAttributesRequest request)
Describes your account attributes, and creates requests to increase limits before they are reached or exceeded.
This operation is synchronous.
describeAccountAttributes in interface AWSOpsWorksCMdescribeAccountAttributesRequest - 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.
describeBackups in interface AWSOpsWorksCMdescribeBackupsRequest - 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.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.
describeEvents in interface AWSOpsWorksCMdescribeEventsRequest - 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.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.
describeNodeAssociationStatus in interface AWSOpsWorksCMdescribeNodeAssociationStatusRequest - ResourceNotFoundException - The requested resource does not exist, or access was denied.ValidationException - One or more of the provided request parameters are not valid.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 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 not valid.
describeServers in interface AWSOpsWorksCMdescribeServersRequest - 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.public DisassociateNodeResult disassociateNode(DisassociateNodeRequest request)
Disassociates a node from a Chef server, and removes the node from the Chef server's managed nodes. After a node is disassociated, the node key pair is no longer valid for accessing the Chef 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.
disassociateNode in interface AWSOpsWorksCMdisassociateNodeRequest - 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.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.
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.
restoreServer in interface AWSOpsWorksCMrestoreServerRequest - 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.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.
startMaintenance in interface AWSOpsWorksCMstartMaintenanceRequest - 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.public UpdateServerResult updateServer(UpdateServerRequest request)
Updates settings for a server.
This operation is synchronous.
updateServer in interface AWSOpsWorksCMupdateServerRequest - 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.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 the Chef
server's private key (CHEF_PIVOTAL_KEY).
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.
updateServerEngineAttributes in interface AWSOpsWorksCMupdateServerEngineAttributesRequest - 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.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
getCachedResponseMetadata in interface AWSOpsWorksCMrequest - The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.