github.com/aavshr/aws-sdk-go@v1.41.3/service/opsworkscm/doc.go (about)

     1  // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
     2  
     3  // Package opsworkscm provides the client and types for making API
     4  // requests to AWS OpsWorks CM.
     5  //
     6  // AWS OpsWorks for configuration management (CM) is a service that runs and
     7  // manages configuration management servers. You can use AWS OpsWorks CM to
     8  // create and manage AWS OpsWorks for Chef Automate and AWS OpsWorks for Puppet
     9  // Enterprise servers, and add or remove nodes for the servers to manage.
    10  //
    11  // Glossary of terms
    12  //
    13  //    * Server: A configuration management server that can be highly-available.
    14  //    The configuration management server runs on an Amazon Elastic Compute
    15  //    Cloud (EC2) instance, and may use various other AWS services, such as
    16  //    Amazon Relational Database Service (RDS) and Elastic Load Balancing. A
    17  //    server is a generic abstraction over the configuration manager that you
    18  //    want to use, much like Amazon RDS. In AWS OpsWorks CM, you do not start
    19  //    or stop servers. After you create servers, they continue to run until
    20  //    they are deleted.
    21  //
    22  //    * Engine: The engine is the specific configuration manager that you want
    23  //    to use. Valid values in this release include ChefAutomate and Puppet.
    24  //
    25  //    * Backup: This is an application-level backup of the data that the configuration
    26  //    manager stores. AWS OpsWorks CM creates an S3 bucket for backups when
    27  //    you launch the first server. A backup maintains a snapshot of a server's
    28  //    configuration-related attributes at the time the backup starts.
    29  //
    30  //    * Events: Events are always related to a server. Events are written during
    31  //    server creation, when health checks run, when backups are created, when
    32  //    system maintenance is performed, etc. When you delete a server, the server's
    33  //    events are also deleted.
    34  //
    35  //    * Account attributes: Every account has attributes that are assigned in
    36  //    the AWS OpsWorks CM database. These attributes store information about
    37  //    configuration limits (servers, backups, etc.) and your customer account.
    38  //
    39  // Endpoints
    40  //
    41  // AWS OpsWorks CM supports the following endpoints, all HTTPS. You must connect
    42  // to one of the following endpoints. Your servers can only be accessed or managed
    43  // within the endpoint in which they are created.
    44  //
    45  //    * opsworks-cm.us-east-1.amazonaws.com
    46  //
    47  //    * opsworks-cm.us-east-2.amazonaws.com
    48  //
    49  //    * opsworks-cm.us-west-1.amazonaws.com
    50  //
    51  //    * opsworks-cm.us-west-2.amazonaws.com
    52  //
    53  //    * opsworks-cm.ap-northeast-1.amazonaws.com
    54  //
    55  //    * opsworks-cm.ap-southeast-1.amazonaws.com
    56  //
    57  //    * opsworks-cm.ap-southeast-2.amazonaws.com
    58  //
    59  //    * opsworks-cm.eu-central-1.amazonaws.com
    60  //
    61  //    * opsworks-cm.eu-west-1.amazonaws.com
    62  //
    63  // For more information, see AWS OpsWorks endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/opsworks-service.html)
    64  // in the AWS General Reference.
    65  //
    66  // Throttling limits
    67  //
    68  // All API operations allow for five requests per second with a burst of 10
    69  // requests per second.
    70  //
    71  // See https://docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01 for more information on this service.
    72  //
    73  // See opsworkscm package documentation for more information.
    74  // https://docs.aws.amazon.com/sdk-for-go/api/service/opsworkscm/
    75  //
    76  // Using the Client
    77  //
    78  // To contact AWS OpsWorks CM with the SDK use the New function to create
    79  // a new service client. With that client you can make API requests to the service.
    80  // These clients are safe to use concurrently.
    81  //
    82  // See the SDK's documentation for more information on how to use the SDK.
    83  // https://docs.aws.amazon.com/sdk-for-go/api/
    84  //
    85  // See aws.Config documentation for more information on configuring SDK clients.
    86  // https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
    87  //
    88  // See the AWS OpsWorks CM client OpsWorksCM for more
    89  // information on creating client for this service.
    90  // https://docs.aws.amazon.com/sdk-for-go/api/service/opsworkscm/#New
    91  package opsworkscm