opsworkscm: AWS OpsWorks CM

In paws: Amazon Web Services Software Development Kit

AWS OpsWorks CM

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

Usage

opsworkscm(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments

config	Optional configuration of credentials, endpoint, and/or region. credentials: creds: access_key_id: AWS access key ID secret_access_key: AWS secret access key session_token: AWS temporary session token profile: The name of a profile to use. If not given, then the default profile is used. anonymous: Set anonymous credentials. endpoint: The complete URL to use for the constructed client. region: The AWS Region used in instantiating the client. close_connection: Immediately close all HTTP connections. timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds. s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠. sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
credentials	Optional credentials shorthand for the config parameter creds: access_key_id: AWS access key ID secret_access_key: AWS secret access key session_token: AWS temporary session token profile: The name of a profile to use. If not given, then the default profile is used. anonymous: Set anonymous credentials.
endpoint	Optional shorthand for complete URL to use for the constructed client.
region	Optional shorthand for AWS Region used in instantiating the client.

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- opsworkscm(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

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 OpsWorks-CM account attributes
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
list_tags_for_resource	Returns a list of tags that are applied to the specified AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise servers or backups
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
tag_resource	Applies tags to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server, or to server backups
untag_resource	Removes specified tags from an AWS OpsWorks-CM server or backup
update_server	Updates settings for a server
update_server_engine_attributes	Updates engine-specific attributes on a specified server

Examples

## Not run: 
svc <- opsworkscm()
svc$associate_node(
  Foo = 123
)

## End(Not run)

paws documentation built on Sept. 15, 2023, 5:06 p.m.