AWSOpsWorksCM (AWS SDK for Java

All Known Subinterfaces:

AWSOpsWorksCMAsync

All Known Implementing Classes:

AbstractAWSOpsWorksCM, AbstractAWSOpsWorksCMAsync, AWSOpsWorksCMAsyncClient, AWSOpsWorksCMClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSOpsWorksCM
```
Interface for accessing OpsWorksCM.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSOpsWorksCM instead.

AWS OpsWorks for Chef Automate
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.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`AssociateNodeResult`	`associateNode(AssociateNodeRequest associateNodeRequest)` Associates a new node with the Chef server.
`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)` Returns the current status of an existing association or disassociation request.
`DescribeServersResult`	`describeServers(DescribeServersRequest describeServersRequest)` Lists all configuration management servers that are identified with your account.
`DisassociateNodeResult`	`disassociateNode(DisassociateNodeRequest disassociateNodeRequest)` 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 restoreServerRequest)` Restores a backup to a server that is in a `CONNECTION_LOST`, `HEALTHY`, `RUNNING`, `UNHEALTHY`, or `TERMINATED` state.
`void`	`setEndpoint(String endpoint)` Deprecated. use `AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)` for example: `builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));`
`void`	`setRegion(Region region)` Deprecated. use `AwsClientBuilder#setRegion(String)`
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`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.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - setEndpoint
```
@Deprecated
void setEndpoint(String endpoint)
```
    Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
    
    Overrides the default endpoint for this client ("opsworks-cm.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.
    Callers can pass in just the endpoint (ex: "opsworks-cm.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "opsworks-cm.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
    For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
    This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Parameters:
    
    endpoint - The endpoint (ex: "opsworks-cm.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "opsworks-cm.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
  - setRegion
```
@Deprecated
void setRegion(Region region)
```
    Deprecated. use AwsClientBuilder#setRegion(String)
    
    An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.
    By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.
    This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Parameters:
    
    region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - associateNode
```
AssociateNodeResult associateNode(AssociateNodeRequest associateNodeRequest)
```
    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"
    
    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
```
CreateBackupResult createBackup(CreateBackupRequest createBackupRequest)
```
    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.
    
    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
```
CreateServerResult createServer(CreateServerRequest createServerRequest)
```
    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.
    
    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
```
DeleteBackupResult deleteBackup(DeleteBackupRequest deleteBackupRequest)
```
    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.
    
    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
```
DeleteServerResult deleteServer(DeleteServerRequest deleteServerRequest)
```
    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.
    
    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
```
DescribeAccountAttributesResult describeAccountAttributes(DescribeAccountAttributesRequest describeAccountAttributesRequest)
```
    Describes your account attributes, and creates requests to increase limits before they are reached or exceeded.
    
    This operation is synchronous.
    
    Parameters:
    
    describeAccountAttributesRequest -
    
    Returns:
    
    Result of the DescribeAccountAttributes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeBackups
```
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 not valid.
    
    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
```
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 not valid.
    
    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
```
DescribeNodeAssociationStatusResult describeNodeAssociationStatus(DescribeNodeAssociationStatusRequest describeNodeAssociationStatusRequest)
```
    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.
    
    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
```
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 not valid.
    
    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
```
DisassociateNodeResult disassociateNode(DisassociateNodeRequest disassociateNodeRequest)
```
    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.
    
    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
  - restoreServer
```
RestoreServerResult restoreServer(RestoreServerRequest restoreServerRequest)
```
    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.
    
    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
```
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 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.
    
    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
  - updateServer
```
UpdateServerResult updateServer(UpdateServerRequest updateServerRequest)
```
    Updates settings for a server.
    
    This operation is synchronous.
    
    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
```
UpdateServerEngineAttributesResult updateServerEngineAttributes(UpdateServerEngineAttributesRequest updateServerEngineAttributesRequest)
```
    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.
    
    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
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
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 a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Interface AWSOpsWorksCM

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

setEndpoint

setRegion

associateNode

createBackup

createServer

deleteBackup

deleteServer

describeAccountAttributes

describeBackups

describeEvents

describeNodeAssociationStatus

describeServers

disassociateNode

restoreServer

startMaintenance

updateServer

updateServerEngineAttributes

shutdown

getCachedResponseMetadata