OpsWorksCmClient
OpsWorks CM
The OpsWorks services have reached end of life and have been disabled for both new and existing customers. We strongly recommend customers migrate their workloads to other solutions as soon as possible. If you have questions about migration, reach out to the Amazon Web ServicesSupport Team on Amazon Web Services re:Post or through Amazon Web Services Premium Support.
OpsWorks CM is a service that runs and manages configuration management servers. You can use OpsWorks CM to create and manage OpsWorks for Chef Automate and 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 Amazon Web Services 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 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
ChefAutomateandPuppet.Backup: This is an application-level backup of the data that the configuration manager stores. 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 OpsWorks CM database. These attributes store information about configuration limits (servers, backups, etc.) and your customer account.
Endpoints
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 OpsWorks endpoints and quotas in the Amazon Web Services General Reference.
Throttling limits
All API operations allow for five requests per second with a burst of 10 requests per second.
Functions
Associates a new node with the server. For more information about how to disassociate a node, see DisassociateNode.
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.
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.
Deletes a backup. You can delete both manual and automated backups. This operation is asynchronous.
Deletes the server and the underlying 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 CloudFormation stack cannot be deleted, the server cannot be deleted.
Describes your OpsWorks CM account attributes.
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.
Describes events for a specified server. Results are ordered by time, with newest events first.
Returns the current status of an existing association or disassociation request.
Lists all configuration management servers that are identified with your account. Only the stored results from Amazon DynamoDB are returned. OpsWorks CM does not query other services.
Disassociates a node from an 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.
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.
Returns a list of tags that are applied to the specified OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise servers or backups.
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.
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.
Applies tags to an OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise server, or to server backups.
Removes specified tags from an OpsWorks CM server or backup.
Updates settings for a server.
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).
Inherited functions
Associates a new node with the server. For more information about how to disassociate a node, see DisassociateNode.
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.
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.
Deletes a backup. You can delete both manual and automated backups. This operation is asynchronous.
Deletes the server and the underlying 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 CloudFormation stack cannot be deleted, the server cannot be deleted.
Describes your OpsWorks CM account attributes.
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.
Paginate over DescribeBackupsResponse results.
Describes events for a specified server. Results are ordered by time, with newest events first.
Paginate over DescribeEventsResponse results.
Returns the current status of an existing association or disassociation request.
Lists all configuration management servers that are identified with your account. Only the stored results from Amazon DynamoDB are returned. OpsWorks CM does not query other services.
Paginate over DescribeServersResponse results.
Disassociates a node from an 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.
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.
Returns a list of tags that are applied to the specified OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise servers or backups.
Paginate over ListTagsForResourceResponse results.
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.
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.
Applies tags to an OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise server, or to server backups.
Removes specified tags from an OpsWorks CM server or backup.
Updates settings for a server.
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).
Wait until node is associated or disassociated.
Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.