Amazon Web Services, Inc.

AWS OpsWorks CM

AWS OpsWorks CM AWS OpsWorks for configuration management (CM) is a service that runs and manages configuration management servers. You can use AWS OpsWorks…

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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.

Endpoints 19

  • POSTAssociateNode/#X-Amz-Target=OpsWorksCM_V2016_11_01.AssociateNode<p> Associates a new node with the server. For more information about how to disassociate a node, see <a>DisassociateNode</a>.</p> <p> On a Chef server: This…
  • POSTCreateBackup/#X-Amz-Target=OpsWorksCM_V2016_11_01.CreateBackup<p> Creates an application-level backup of a server. While the server is in the <code>BACKING_UP</code> state, the server cannot be changed, and no additional…
  • POSTCreateServer/#X-Amz-Target=OpsWorksCM_V2016_11_01.CreateServer<p> Creates and immedately starts a new server. The server is ready to use when it is in the <code>HEALTHY</code> state. By default, you can create a maximum…
  • POSTDeleteBackup/#X-Amz-Target=OpsWorksCM_V2016_11_01.DeleteBackup<p> Deletes a backup. You can delete both manual and automated backups. This operation is asynchronous. </p> <p> An <code>InvalidStateException</code> is…
  • POSTDeleteServer/#X-Amz-Target=OpsWorksCM_V2016_11_01.DeleteServer<p> Deletes the server and the underlying AWS CloudFormation stacks (including the server's EC2 instance). When you run this command, the server state is…
  • POSTDescribeAccountAttributes/#X-Amz-Target=OpsWorksCM_V2016_11_01.DescribeAccountAttributes<p> Describes your OpsWorks-CM account attributes. </p> <p> This operation is synchronous. </p>
  • POSTDescribeBackups/#X-Amz-Target=OpsWorksCM_V2016_11_01.DescribeBackups?MaxResults=string&NextToken=string<p> 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…
  • POSTDescribeEvents/#X-Amz-Target=OpsWorksCM_V2016_11_01.DescribeEvents?MaxResults=string&NextToken=string<p> Describes events for a specified server. Results are ordered by time, with newest events first. </p> <p> This operation is synchronous. </p> <p> A…
  • POSTDescribeNodeAssociationStatus/#X-Amz-Target=OpsWorksCM_V2016_11_01.DescribeNodeAssociationStatus<p> Returns the current status of an existing association or disassociation request. </p> <p> A <code>ResourceNotFoundException</code> is thrown when no…
  • POSTDescribeServers/#X-Amz-Target=OpsWorksCM_V2016_11_01.DescribeServers?MaxResults=string&NextToken=string<p> Lists all configuration management servers that are identified with your account. Only the stored results from Amazon DynamoDB are returned. AWS OpsWorks…
  • POSTDisassociateNode/#X-Amz-Target=OpsWorksCM_V2016_11_01.DisassociateNode<p> 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…
  • POSTExportServerEngineAttribute/#X-Amz-Target=OpsWorksCM_V2016_11_01.ExportServerEngineAttribute<p> 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…
  • POSTListTagsForResource/#X-Amz-Target=OpsWorksCM_V2016_11_01.ListTagsForResource?MaxResults=string&NextToken=stringReturns a list of tags that are applied to the specified AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise servers or backups.
  • POSTRestoreServer/#X-Amz-Target=OpsWorksCM_V2016_11_01.RestoreServer<p> Restores a backup to a server that is in a <code>CONNECTION_LOST</code>, <code>HEALTHY</code>, <code>RUNNING</code>, <code>UNHEALTHY</code>, or…
  • POSTStartMaintenance/#X-Amz-Target=OpsWorksCM_V2016_11_01.StartMaintenance<p> Manually starts server maintenance. This command can be useful if an earlier maintenance attempt failed, and the underlying cause of maintenance failure…
  • POSTTagResource/#X-Amz-Target=OpsWorksCM_V2016_11_01.TagResourceApplies tags to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server, or to server backups.
  • POSTUntagResource/#X-Amz-Target=OpsWorksCM_V2016_11_01.UntagResourceRemoves specified tags from an AWS OpsWorks-CM server or backup.
  • POSTUpdateServer/#X-Amz-Target=OpsWorksCM_V2016_11_01.UpdateServer<p> Updates settings for a server. </p> <p> This operation is synchronous. </p>
  • POSTUpdateServerEngineAttributes/#X-Amz-Target=OpsWorksCM_V2016_11_01.UpdateServerEngineAttributes<p> Updates engine-specific attributes on a specified server. The server enters the <code>MODIFYING</code> state when this operation is in progress. Only one…

API details

Base URL
http://opsworks-cm.{region}.amazonaws.com
https://opsworks-cm.{region}.amazonaws.com
http://opsworks-cm.{region}.amazonaws.com.cn
https://opsworks-cm.{region}.amazonaws.com.cn
Authentication
An API key in the Authorization header
Operations
19 operations on 19 pathsPOST 19
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 2016-11-01
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the AWS OpsWorks CM in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS OpsWorks CM collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “AssociateNode” (POST /#X-Amz-Target=OpsWorksCM_V2016_11_01.AssociateNode), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS OpsWorks CM?

AWS OpsWorks CM AWS OpsWorks for configuration management (CM) is a service that runs and manages configuration management servers. You can use AWS OpsWorks… It is listed under Developer tools and has 19 endpoints.

Who publishes the AWS OpsWorks CM?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS OpsWorks CM?

Its description lists 4 base URLs: http://opsworks-cm.{region}.amazonaws.com, https://opsworks-cm.{region}.amazonaws.com, http://opsworks-cm.{region}.amazonaws.com.cn, https://opsworks-cm.{region}.amazonaws.com.cn. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the AWS OpsWorks CM?

With an API key in the Authorization header.

How many endpoints does the AWS OpsWorks CM have?

19 operations on 19 paths (19 POST).

Is forking the AWS OpsWorks CM free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.