paws.management (version 0.1.0)

opsworkscm: AWS OpsWorks for Chef Automate

Description

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 Chef 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

Throttling limits

All API operations allow for five requests per second with a burst of 10 requests per second.

Usage

opsworkscm()

Arguments

Operations

associate_node Associates a new node with the server
create_backup Creates an application-level backup of a server
create_server Creates and immedately starts a new server
delete_backup Deletes a backup
delete_server Deletes the server and the underlying AWS CloudFormation stacks (including the server's EC2 instance)
describe_account_attributes Describes your account attributes, and creates requests to increase limits before they are reached or exceeded
describe_backups Describes backups
describe_events Describes events for a specified server
describe_node_association_status Returns the current status of an existing association or disassociation request
describe_servers Lists all configuration management servers that are identified with your account
disassociate_node Disassociates a node from an AWS OpsWorks CM server, and removes the node from the server's managed nodes
export_server_engine_attribute Exports a specified server engine attribute as a base64-encoded string
restore_server Restores a backup to a server that is in a CONNECTION_LOST, HEALTHY, RUNNING, UNHEALTHY, or TERMINATED state
start_maintenance Manually starts server maintenance
update_server Updates settings for a server

Examples

Run this code
# NOT RUN {
svc <- opsworkscm()
svc$associate_node(
  Foo = 123
)
# }
# NOT RUN {
# }

Run the code above in your browser using DataCamp Workspace