Expand description
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
ChefAutomateandPuppet. -
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.
If you’re using the service, you’re probably looking for OpsWorksCMClient and OpsWorksCM.
Structs§
- Account
Attribute Stores account attributes.
- Associate
Node Request - Associate
Node Response - Backup
Describes a single backup.
- Create
Backup Request - Create
Backup Response - Create
Server Request - Create
Server Response - Delete
Backup Request - Delete
Backup Response - Delete
Server Request - Delete
Server Response - Describe
Account Attributes Request - Describe
Account Attributes Response - Describe
Backups Request - Describe
Backups Response - Describe
Events Request - Describe
Events Response - Describe
Node Association Status Request - Describe
Node Association Status Response - Describe
Servers Request - Describe
Servers Response - Disassociate
Node Request - Disassociate
Node Response - Engine
Attribute A name and value pair that is specific to the engine of the server.
- Export
Server Engine Attribute Request - Export
Server Engine Attribute Response - List
Tags ForResource Request - List
Tags ForResource Response - OpsWorksCM
Client - A client for the OpsWorksCM API.
- Restore
Server Request - Restore
Server Response - Server
Describes a configuration management server.
- Server
Event An event that is related to the server, such as the start of maintenance or backup.
- Start
Maintenance Request - Start
Maintenance Response - Tag
A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server. Leading and trailing white spaces are trimmed from both the key and value. A maximum of 50 user-applied tags is allowed for tag-supported AWS OpsWorks-CM resources.
- TagResource
Request - TagResource
Response - Untag
Resource Request - Untag
Resource Response - Update
Server Engine Attributes Request - Update
Server Engine Attributes Response - Update
Server Request - Update
Server Response
Enums§
- Associate
Node Error - Errors returned by AssociateNode
- Create
Backup Error - Errors returned by CreateBackup
- Create
Server Error - Errors returned by CreateServer
- Delete
Backup Error - Errors returned by DeleteBackup
- Delete
Server Error - Errors returned by DeleteServer
- Describe
Account Attributes Error - Errors returned by DescribeAccountAttributes
- Describe
Backups Error - Errors returned by DescribeBackups
- Describe
Events Error - Errors returned by DescribeEvents
- Describe
Node Association Status Error - Errors returned by DescribeNodeAssociationStatus
- Describe
Servers Error - Errors returned by DescribeServers
- Disassociate
Node Error - Errors returned by DisassociateNode
- Export
Server Engine Attribute Error - Errors returned by ExportServerEngineAttribute
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- Restore
Server Error - Errors returned by RestoreServer
- Start
Maintenance Error - Errors returned by StartMaintenance
- TagResource
Error - Errors returned by TagResource
- Untag
Resource Error - Errors returned by UntagResource
- Update
Server Engine Attributes Error - Errors returned by UpdateServerEngineAttributes
- Update
Server Error - Errors returned by UpdateServer
Traits§
- OpsWorksCM
- Trait representing the capabilities of the OpsWorksCM API. OpsWorksCM clients implement this trait.