opsworkscm: AWS OpsWorks CM

Description Usage Arguments Value Service syntax Operations Examples

View source: R/opsworkscm_service.R

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

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.

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

1
opsworkscm(config = list())

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
svc <- opsworkscm(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    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

1
2
3
4
5
6
7
## Not run: 
svc <- opsworkscm()
svc$associate_node(
  Foo = 123
)

## End(Not run)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.