You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.OpsWorksCM

Inherits:
AWS.Service show all
Identifier:
opsworkscm
API Version:
2016-11-01
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

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

Sending a Request Using OpsWorksCM

var opsworkscm = new AWS.OpsWorksCM();
opsworkscm.associateNode(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the OpsWorksCM object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var opsworkscm = new AWS.OpsWorksCM({apiVersion: '2016-11-01'});

You can also set the API version globally in AWS.config.apiVersions using the opsworkscm service identifier:

AWS.config.apiVersions = {
  opsworkscm: '2016-11-01',
  // other service API versions
};

var opsworkscm = new AWS.OpsWorksCM();

Version:

  • 2016-11-01

Waiter Resource States

This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:

nodeAssociated

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

new AWS.OpsWorksCM(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a OpsWorksCM object

var opsworkscm = new AWS.OpsWorksCM({apiVersion: '2016-11-01'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.OpsWorksCM.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.OpsWorksCM.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.OpsWorksCM.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

associateNode(params = {}, callback) ⇒ AWS.Request

Associates a new node with the server. For more information about how to disassociate a node, see DisassociateNode.

On a Chef server: This command is an alternative to knife bootstrap.

Example (Chef): aws opsworks-cm associate-node --server-name MyServer --node-name MyManagedNode --engine-attributes "Name=CHEF_ORGANIZATION,Value=default" "Name=CHEF_NODE_PUBLIC_KEY,Value=public-key-pem"

On a Puppet server, this command is an alternative to the puppet cert sign command that signs a Puppet node CSR.

Example (Puppet): aws opsworks-cm associate-node --server-name MyServer --node-name MyManagedNode --engine-attributes "Name=PUPPET_NODE_CSR,Value=csr-pem"

A node can can only be associated with servers that are in a HEALTHY state. Otherwise, an InvalidStateException is thrown. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. The AssociateNode API call can be integrated into Auto Scaling configurations, AWS Cloudformation templates, or the user data of a server's instance.

Service Reference:

Examples:

Calling the associateNode operation

var params = {
  EngineAttributes: [ /* required */
    {
      Name: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  NodeName: 'STRING_VALUE', /* required */
  ServerName: 'STRING_VALUE' /* required */
};
opsworkscm.associateNode(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ServerName — (String)

      The name of the server with which to associate the node.

    • NodeName — (String)

      The name of the node.

    • EngineAttributes — (Array<map>)

      Engine attributes used for associating the node.

      Attributes accepted in a AssociateNode request for Chef

      • CHEF_ORGANIZATION: The Chef organization with which the node is associated. By default only one organization named default can exist.

      • CHEF_NODE_PUBLIC_KEY: A PEM-formatted public key. This key is required for the chef-client agent to access the Chef API.

      Attributes accepted in a AssociateNode request for Puppet

      • PUPPET_NODE_CSR: A PEM-formatted certificate-signing request (CSR) that is created by the node.

      • Name — (String)

        The name of the engine attribute.

      • Value — (String)

        The value of the engine attribute.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NodeAssociationStatusToken — (String)

        Contains a token which can be passed to the DescribeNodeAssociationStatus API call to get the status of the association request.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createBackup(params = {}, callback) ⇒ AWS.Request

Creates an application-level backup of a server. While the server is in the BACKING_UP state, the server cannot be changed, and no additional backup can be created.

Backups can be created for servers in RUNNING, HEALTHY, and UNHEALTHY states. By default, you can create a maximum of 50 manual backups.

This operation is asynchronous.

A LimitExceededException is thrown when the maximum number of manual backups is reached. An InvalidStateException is thrown when the server is not in any of the following states: RUNNING, HEALTHY, or UNHEALTHY. A ResourceNotFoundException is thrown when the server is not found. A ValidationException is thrown when parameters of the request are not valid.

Service Reference:

Examples:

Calling the createBackup operation

var params = {
  ServerName: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
opsworkscm.createBackup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ServerName — (String)

      The name of the server that you want to back up.

    • Description — (String)

      A user-defined description of the backup.

    • Tags — (Array<map>)

      A map that contains tag keys and tag values to attach to an AWS OpsWorks-CM server backup.

      • The key cannot be empty.

      • The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

      • The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

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

      • Key — required — (String)

        A tag key, such as Stage or Name. A tag key cannot be empty. The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

      • Value — required — (String)

        An optional tag value, such as Production or test-owcm-server. The value can be a maximum of 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Backup — (map)

        Backup created by request.

        • BackupArn — (String)

          The ARN of the backup.

        • BackupId — (String)

          The generated ID of the backup. Example: myServerName-yyyyMMddHHmmssSSS

        • BackupType — (String)

          The backup type. Valid values are automated or manual.

          Possible values include:
          • "AUTOMATED"
          • "MANUAL"
        • CreatedAt — (Date)

          The time stamp when the backup was created in the database. Example: 2016-07-29T13:38:47.520Z

        • Description — (String)

          A user-provided description for a manual backup. This field is empty for automated backups.

        • Engine — (String)

          The engine type that is obtained from the server when the backup is created.

        • EngineModel — (String)

          The engine model that is obtained from the server when the backup is created.

        • EngineVersion — (String)

          The engine version that is obtained from the server when the backup is created.

        • InstanceProfileArn — (String)

          The EC2 instance profile ARN that is obtained from the server when the backup is created. Because this value is stored, you are not required to provide the InstanceProfileArn again if you restore a backup.

        • InstanceType — (String)

          The instance type that is obtained from the server when the backup is created.

        • KeyPair — (String)

          The key pair that is obtained from the server when the backup is created.

        • PreferredBackupWindow — (String)

          The preferred backup period that is obtained from the server when the backup is created.

        • PreferredMaintenanceWindow — (String)

          The preferred maintenance period that is obtained from the server when the backup is created.

        • S3DataSize — (Integer)

          This field is deprecated and is no longer used.

        • S3DataUrl — (String)

          This field is deprecated and is no longer used.

        • S3LogUrl — (String)

          The Amazon S3 URL of the backup's log file.

        • SecurityGroupIds — (Array<String>)

          The security group IDs that are obtained from the server when the backup is created.

        • ServerName — (String)

          The name of the server from which the backup was made.

        • ServiceRoleArn — (String)

          The service role ARN that is obtained from the server when the backup is created.

        • Status — (String)

          The status of a backup while in progress.

          Possible values include:
          • "IN_PROGRESS"
          • "OK"
          • "FAILED"
          • "DELETING"
        • StatusDescription — (String)

          An informational message about backup status.

        • SubnetIds — (Array<String>)

          The subnet IDs that are obtained from the server when the backup is created.

        • ToolsVersion — (String)

          The version of AWS OpsWorks CM-specific tools that is obtained from the server when the backup is created.

        • UserArn — (String)

          The IAM user ARN of the requester for manual backups. This field is empty for automated backups.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createServer(params = {}, callback) ⇒ AWS.Request

Creates and immedately starts a new server. The server is ready to use when it is in the HEALTHY state. By default, you can create a maximum of 10 servers.

This operation is asynchronous.

A LimitExceededException is thrown when you have created the maximum number of servers (10). A ResourceAlreadyExistsException is thrown when a server with the same name already exists in the account. A ResourceNotFoundException is thrown when you specify a backup ID that is not valid or is for a backup that does not exist. A ValidationException is thrown when parameters of the request are not valid.

If you do not specify a security group by adding the SecurityGroupIds parameter, AWS OpsWorks creates a new security group.

Chef Automate: The default security group opens the Chef server to the world on TCP port 443. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is also open to the world on TCP port 22.

Puppet Enterprise: The default security group opens TCP ports 22, 443, 4433, 8140, 8142, 8143, and 8170. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is also open to the world on TCP port 22.

By default, your server is accessible from any IP address. We recommend that you update your security group rules to allow access from known IP addresses and address ranges only. To edit security group rules, open Security Groups in the navigation pane of the EC2 management console.

To specify your own domain for a server, and provide your own self-signed or CA-signed certificate and private key, specify values for CustomDomain, CustomCertificate, and CustomPrivateKey.

Service Reference:

Examples:

Calling the createServer operation

var params = {
  Engine: 'STRING_VALUE', /* required */
  InstanceProfileArn: 'STRING_VALUE', /* required */
  InstanceType: 'STRING_VALUE', /* required */
  ServerName: 'STRING_VALUE', /* required */
  ServiceRoleArn: 'STRING_VALUE', /* required */
  AssociatePublicIpAddress: true || false,
  BackupId: 'STRING_VALUE',
  BackupRetentionCount: 'NUMBER_VALUE',
  CustomCertificate: 'STRING_VALUE',
  CustomDomain: 'STRING_VALUE',
  CustomPrivateKey: 'STRING_VALUE',
  DisableAutomatedBackup: true || false,
  EngineAttributes: [
    {
      Name: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  EngineModel: 'STRING_VALUE',
  EngineVersion: 'STRING_VALUE',
  KeyPair: 'STRING_VALUE',
  PreferredBackupWindow: 'STRING_VALUE',
  PreferredMaintenanceWindow: 'STRING_VALUE',
  SecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ],
  SubnetIds: [
    'STRING_VALUE',
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
opsworkscm.createServer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AssociatePublicIpAddress — (Boolean)

      Associate a public IP address with a server that you are launching. Valid values are true or false. The default value is true.

    • CustomDomain — (String)

      An optional public endpoint of a server, such as https://aws.my-company.com. To access the server, create a CNAME DNS record in your preferred DNS service that points the custom domain to the endpoint that is generated when the server is created (the value of the CreateServer Endpoint attribute). You cannot access the server by using the generated Endpoint value if the server is using a custom domain. If you specify a custom domain, you must also specify values for CustomCertificate and CustomPrivateKey.

    • CustomCertificate — (String)

      A PEM-formatted HTTPS certificate. The value can be be a single, self-signed certificate, or a certificate chain. If you specify a custom certificate, you must also specify values for CustomDomain and CustomPrivateKey. The following are requirements for the CustomCertificate value:

      • You can provide either a self-signed, custom certificate, or the full certificate chain.

      • The certificate must be a valid X509 certificate, or a certificate chain in PEM format.

      • The certificate must be valid at the time of upload. A certificate can't be used before its validity period begins (the certificate's NotBefore date), or after it expires (the certificate's NotAfter date).

      • The certificate’s common name or subject alternative names (SANs), if present, must match the value of CustomDomain.

      • The certificate must match the value of CustomPrivateKey.

    • CustomPrivateKey — (String)

      A private key in PEM format for connecting to the server by using HTTPS. The private key must not be encrypted; it cannot be protected by a password or passphrase. If you specify a custom private key, you must also specify values for CustomDomain and CustomCertificate.

    • DisableAutomatedBackup — (Boolean)

      Enable or disable scheduled backups. Valid values are true or false. The default value is true.

    • Engine — (String)

      The configuration management engine to use. Valid values include ChefAutomate and Puppet.

    • EngineModel — (String)

      The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.

    • EngineVersion — (String)

      The major release version of the engine that you want to use. For a Chef server, the valid value for EngineVersion is currently 2. For a Puppet server, valid values are 2019 or 2017.

    • EngineAttributes — (Array<map>)

      Optional engine attributes on a specified server.

      Attributes accepted in a Chef createServer request:

      • CHEF_AUTOMATE_PIVOTAL_KEY: A base64-encoded RSA public key. The corresponding private key is required to access the Chef API. When no CHEF_AUTOMATE_PIVOTAL_KEY is set, a private key is generated and returned in the response.

      • CHEF_AUTOMATE_ADMIN_PASSWORD: The password for the administrative user in the Chef Automate web-based dashboard. The password length is a minimum of eight characters, and a maximum of 32. The password can contain letters, numbers, and special characters (!/@#$%^&+=_). The password must contain at least one lower case letter, one upper case letter, one number, and one special character. When no CHEF_AUTOMATE_ADMIN_PASSWORD is set, one is generated and returned in the response.

      Attributes accepted in a Puppet createServer request:

      • PUPPET_ADMIN_PASSWORD: To work with the Puppet Enterprise console, a password must use ASCII characters.

      • PUPPET_R10K_REMOTE: The r10k remote is the URL of your control repository (for example, ssh://git@your.git-repo.com:user/control-repo.git). Specifying an r10k remote opens TCP port 8170.

      • PUPPET_R10K_PRIVATE_KEY: If you are using a private Git repository, add PUPPET_R10K_PRIVATE_KEY to specify a PEM-encoded private SSH key.

      • Name — (String)

        The name of the engine attribute.

      • Value — (String)

        The value of the engine attribute.

    • BackupRetentionCount — (Integer)

      The number of automated backups that you want to keep. Whenever a new backup is created, AWS OpsWorks CM deletes the oldest backups if this number is exceeded. The default value is 1.

    • ServerName — (String)

      The name of the server. The server name must be unique within your AWS account, within each region. Server names must start with a letter; then letters, numbers, or hyphens (-) are allowed, up to a maximum of 40 characters.

    • InstanceProfileArn — (String)

      The ARN of the instance profile that your Amazon EC2 instances use. Although the AWS OpsWorks console typically creates the instance profile for you, if you are using API commands instead, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template creates a CloudFormation stack that includes the instance profile you need.

    • InstanceType — (String)

      The Amazon EC2 instance type to use. For example, m5.large.

    • KeyPair — (String)

      The Amazon EC2 key pair to set for the instance. This parameter is optional; if desired, you may specify this parameter to connect to your instances by using SSH.

    • PreferredMaintenanceWindow — (String)

      The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance. Valid values must be specified in the following format: DDD:HH:MM. MM must be specified as 00. The specified time is in coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday. See TimeWindowDefinition for more information.

      Example: Mon:08:00, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)

    • PreferredBackupWindow — (String)

      The start time for a one-hour period during which AWS OpsWorks CM backs up application-level data on your server if automated backups are enabled. Valid values must be specified in one of the following formats:

      • HH:MM for daily backups

      • DDD:HH:MM for weekly backups

      MM must be specified as 00. The specified time is in coordinated universal time (UTC). The default value is a random, daily start time.

      Example: 08:00, which represents a daily start time of 08:00 UTC.

      Example: Mon:08:00, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)

    • SecurityGroupIds — (Array<String>)

      A list of security group IDs to attach to the Amazon EC2 instance. If you add this parameter, the specified security groups must be within the VPC that is specified by SubnetIds.

      If you do not specify this parameter, AWS OpsWorks CM creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone).

    • ServiceRoleArn — (String)

      The service role that the AWS OpsWorks CM service backend uses to work with your account. Although the AWS OpsWorks management console typically creates the service role for you, if you are using the AWS CLI or API commands, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template creates a CloudFormation stack that includes the service role and instance profile that you need.

    • SubnetIds — (Array<String>)

      The IDs of subnets in which to launch the server EC2 instance.

      Amazon EC2-Classic customers: This field is required. All servers must run within a VPC. The VPC must have "Auto Assign Public IP" enabled.

      EC2-VPC customers: This field is optional. If you do not specify subnet IDs, your EC2 instances are created in a default subnet that is selected by Amazon EC2. If you specify subnet IDs, the VPC must have "Auto Assign Public IP" enabled.

      For more information about supported Amazon EC2 platforms, see Supported Platforms.

    • Tags — (Array<map>)

      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.

      • The key cannot be empty.

      • The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / @

      • The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / @

      • Leading and trailing white spaces are trimmed from both the key and value.

      • A maximum of 50 user-applied tags is allowed for any AWS OpsWorks-CM server.

      • Key — required — (String)

        A tag key, such as Stage or Name. A tag key cannot be empty. The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

      • Value — required — (String)

        An optional tag value, such as Production or test-owcm-server. The value can be a maximum of 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

    • BackupId — (String)

      If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Server — (map)

        The server that is created by the request.

        • AssociatePublicIpAddress — (Boolean)

          Associate a public IP address with a server that you are launching.

        • BackupRetentionCount — (Integer)

          The number of automated backups to keep.

        • ServerName — (String)

          The name of the server.

        • CreatedAt — (Date)

          Time stamp of server creation. Example 2016-07-29T13:38:47.520Z

        • CloudFormationStackArn — (String)

          The ARN of the CloudFormation stack that was used to create the server.

        • CustomDomain — (String)

          An optional public endpoint of a server, such as https://aws.my-company.com. You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.

        • DisableAutomatedBackup — (Boolean)

          Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.

        • Endpoint — (String)

          A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io. You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.

        • Engine — (String)

          The engine type of the server. Valid values in this release include ChefAutomate and Puppet.

        • EngineModel — (String)

          The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.

        • EngineAttributes — (Array<map>)

          The response of a createServer() request returns the master credential to access the server in EngineAttributes. These credentials are not stored by AWS OpsWorks CM; they are returned only as part of the result of createServer().

          Attributes returned in a createServer response for Chef

          • CHEF_AUTOMATE_PIVOTAL_KEY: A base64-encoded RSA private key that is generated by AWS OpsWorks for Chef Automate. This private key is required to access the Chef API.

          • CHEF_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Chef starter kit, which includes a README, a configuration file, and the required RSA private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents. From this directory, you can run Knife commands.

          Attributes returned in a createServer response for Puppet

          • PUPPET_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Puppet starter kit, including a README and a required private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents.

          • PUPPET_ADMIN_PASSWORD: An administrator password that you can use to sign in to the Puppet Enterprise console after the server is online.

          • Name — (String)

            The name of the engine attribute.

          • Value — (String)

            The value of the engine attribute.

        • EngineVersion — (String)

          The engine version of the server. For a Chef server, the valid value for EngineVersion is currently 2. For a Puppet server, specify either 2019 or 2017.

        • InstanceProfileArn — (String)

          The instance profile ARN of the server.

        • InstanceType — (String)

          The instance type for the server, as specified in the CloudFormation stack. This might not be the same instance type that is shown in the EC2 console.

        • KeyPair — (String)

          The key pair associated with the server.

        • MaintenanceStatus — (String)

          The status of the most recent server maintenance run. Shows SUCCESS or FAILED.

          Possible values include:
          • "SUCCESS"
          • "FAILED"
        • PreferredMaintenanceWindow — (String)

          The preferred maintenance period specified for the server.

        • PreferredBackupWindow — (String)

          The preferred backup period specified for the server.

        • SecurityGroupIds — (Array<String>)

          The security group IDs for the server, as specified in the CloudFormation stack. These might not be the same security groups that are shown in the EC2 console.

        • ServiceRoleArn — (String)

          The service role ARN used to create the server.

        • Status — (String)

          The server's status. This field displays the states of actions in progress, such as creating, running, or backing up the server, as well as the server's health state.

          Possible values include:
          • "BACKING_UP"
          • "CONNECTION_LOST"
          • "CREATING"
          • "DELETING"
          • "MODIFYING"
          • "FAILED"
          • "HEALTHY"
          • "RUNNING"
          • "RESTORING"
          • "SETUP"
          • "UNDER_MAINTENANCE"
          • "UNHEALTHY"
          • "TERMINATED"
        • StatusReason — (String)

          Depending on the server status, this field has either a human-readable message (such as a create or backup error), or an escaped block of JSON (used for health check results).

        • SubnetIds — (Array<String>)

          The subnet IDs specified in a CreateServer request.

        • ServerArn — (String)

          The ARN of the server.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteBackup(params = {}, callback) ⇒ AWS.Request

Deletes a backup. You can delete both manual and automated backups. This operation is asynchronous.

An InvalidStateException is thrown when a backup deletion is already in progress. A ResourceNotFoundException is thrown when the backup does not exist. A ValidationException is thrown when parameters of the request are not valid.

Service Reference:

Examples:

Calling the deleteBackup operation

var params = {
  BackupId: 'STRING_VALUE' /* required */
};
opsworkscm.deleteBackup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BackupId — (String)

      The ID of the backup to delete. Run the DescribeBackups command to get a list of backup IDs. Backup IDs are in the format ServerName-yyyyMMddHHmmssSSS.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteServer(params = {}, callback) ⇒ AWS.Request

Deletes the server and the underlying AWS CloudFormation stacks (including the server's EC2 instance). When you run this command, the server state is updated to DELETING. After the server is deleted, it is no longer returned by DescribeServer requests. If the AWS CloudFormation stack cannot be deleted, the server cannot be deleted.

This operation is asynchronous.

An InvalidStateException is thrown when a server deletion is already in progress. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

Service Reference:

Examples:

Calling the deleteServer operation

var params = {
  ServerName: 'STRING_VALUE' /* required */
};
opsworkscm.deleteServer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ServerName — (String)

      The ID of the server to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeAccountAttributes(params = {}, callback) ⇒ AWS.Request

Describes your OpsWorks-CM account attributes.

This operation is synchronous.

Service Reference:

Examples:

Calling the describeAccountAttributes operation

var params = {
};
opsworkscm.describeAccountAttributes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Attributes — (Array<map>)

        The attributes that are currently set for the account.

        • Name — (String)

          The attribute name. The following are supported attribute names.

          • ServerLimit: The number of current servers/maximum number of servers allowed. By default, you can have a maximum of 10 servers.

          • ManualBackupLimit: The number of current manual backups/maximum number of backups allowed. By default, you can have a maximum of 50 manual backups saved.

        • Maximum — (Integer)

          The maximum allowed value.

        • Used — (Integer)

          The current usage, such as the current number of servers that are associated with the account.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeBackups(params = {}, callback) ⇒ AWS.Request

Describes backups. The results are ordered by time, with newest backups first. If you do not specify a BackupId or ServerName, the command returns all backups.

This operation is synchronous.

A ResourceNotFoundException is thrown when the backup does not exist. A ValidationException is raised when parameters of the request are not valid.

Service Reference:

Examples:

Calling the describeBackups operation

var params = {
  BackupId: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ServerName: 'STRING_VALUE'
};
opsworkscm.describeBackups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BackupId — (String)

      Describes a single backup.

    • ServerName — (String)

      Returns backups for the server with the specified ServerName.

    • NextToken — (String)

      This is not currently implemented for DescribeBackups requests.

    • MaxResults — (Integer)

      This is not currently implemented for DescribeBackups requests.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Backups — (Array<map>)

        Contains the response to a DescribeBackups request.

        • BackupArn — (String)

          The ARN of the backup.

        • BackupId — (String)

          The generated ID of the backup. Example: myServerName-yyyyMMddHHmmssSSS

        • BackupType — (String)

          The backup type. Valid values are automated or manual.

          Possible values include:
          • "AUTOMATED"
          • "MANUAL"
        • CreatedAt — (Date)

          The time stamp when the backup was created in the database. Example: 2016-07-29T13:38:47.520Z

        • Description — (String)

          A user-provided description for a manual backup. This field is empty for automated backups.

        • Engine — (String)

          The engine type that is obtained from the server when the backup is created.

        • EngineModel — (String)

          The engine model that is obtained from the server when the backup is created.

        • EngineVersion — (String)

          The engine version that is obtained from the server when the backup is created.

        • InstanceProfileArn — (String)

          The EC2 instance profile ARN that is obtained from the server when the backup is created. Because this value is stored, you are not required to provide the InstanceProfileArn again if you restore a backup.

        • InstanceType — (String)

          The instance type that is obtained from the server when the backup is created.

        • KeyPair — (String)

          The key pair that is obtained from the server when the backup is created.

        • PreferredBackupWindow — (String)

          The preferred backup period that is obtained from the server when the backup is created.

        • PreferredMaintenanceWindow — (String)

          The preferred maintenance period that is obtained from the server when the backup is created.

        • S3DataSize — (Integer)

          This field is deprecated and is no longer used.

        • S3DataUrl — (String)

          This field is deprecated and is no longer used.

        • S3LogUrl — (String)

          The Amazon S3 URL of the backup's log file.

        • SecurityGroupIds — (Array<String>)

          The security group IDs that are obtained from the server when the backup is created.

        • ServerName — (String)

          The name of the server from which the backup was made.

        • ServiceRoleArn — (String)

          The service role ARN that is obtained from the server when the backup is created.

        • Status — (String)

          The status of a backup while in progress.

          Possible values include:
          • "IN_PROGRESS"
          • "OK"
          • "FAILED"
          • "DELETING"
        • StatusDescription — (String)

          An informational message about backup status.

        • SubnetIds — (Array<String>)

          The subnet IDs that are obtained from the server when the backup is created.

        • ToolsVersion — (String)

          The version of AWS OpsWorks CM-specific tools that is obtained from the server when the backup is created.

        • UserArn — (String)

          The IAM user ARN of the requester for manual backups. This field is empty for automated backups.

      • NextToken — (String)

        This is not currently implemented for DescribeBackups requests.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeEvents(params = {}, callback) ⇒ AWS.Request

Describes events for a specified server. Results are ordered by time, with newest events first.

This operation is synchronous.

A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

Service Reference:

Examples:

Calling the describeEvents operation

var params = {
  ServerName: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
opsworkscm.describeEvents(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ServerName — (String)

      The name of the server for which you want to view events.

    • NextToken — (String)

      NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call DescribeEvents again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object's nextToken parameter value is null. Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur.

    • MaxResults — (Integer)

      To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ServerEvents — (Array<map>)

        Contains the response to a DescribeEvents request.

        • CreatedAt — (Date)

          The time when the event occurred.

        • ServerName — (String)

          The name of the server on or for which the event occurred.

        • Message — (String)

          A human-readable informational or status message.

        • LogUrl — (String)

          The Amazon S3 URL of the event's log file.

      • NextToken — (String)

        NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call DescribeEvents again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object's nextToken parameter value is null. Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeNodeAssociationStatus(params = {}, callback) ⇒ AWS.Request

Returns the current status of an existing association or disassociation request.

A ResourceNotFoundException is thrown when no recent association or disassociation request with the specified token is found, or when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

Service Reference:

Examples:

Calling the describeNodeAssociationStatus operation

var params = {
  NodeAssociationStatusToken: 'STRING_VALUE', /* required */
  ServerName: 'STRING_VALUE' /* required */
};
opsworkscm.describeNodeAssociationStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NodeAssociationStatusToken — (String)

      The token returned in either the AssociateNodeResponse or the DisassociateNodeResponse.

    • ServerName — (String)

      The name of the server from which to disassociate the node.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NodeAssociationStatus — (String)

        The status of the association or disassociation request.

        Possible values:

        • SUCCESS: The association or disassociation succeeded.

        • FAILED: The association or disassociation failed.

        • IN_PROGRESS: The association or disassociation is still in progress.

        Possible values include:
        • "SUCCESS"
        • "FAILED"
        • "IN_PROGRESS"
      • EngineAttributes — (Array<map>)

        Attributes specific to the node association. In Puppet, the attibute PUPPET_NODE_CERT contains the signed certificate (the result of the CSR).

        • Name — (String)

          The name of the engine attribute.

        • Value — (String)

          The value of the engine attribute.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

describeServers(params = {}, callback) ⇒ AWS.Request

Lists all configuration management servers that are identified with your account. Only the stored results from Amazon DynamoDB are returned. AWS OpsWorks CM does not query other services.

This operation is synchronous.

A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

Service Reference:

Examples:

Calling the describeServers operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ServerName: 'STRING_VALUE'
};
opsworkscm.describeServers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ServerName — (String)

      Describes the server with the specified ServerName.

    • NextToken — (String)

      This is not currently implemented for DescribeServers requests.

    • MaxResults — (Integer)

      This is not currently implemented for DescribeServers requests.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Servers — (Array<map>)

        Contains the response to a DescribeServers request.

        For Chef Automate servers: If DescribeServersResponse$Servers$EngineAttributes includes CHEF_MAJOR_UPGRADE_AVAILABLE, you can upgrade the Chef Automate server to Chef Automate 2. To be eligible for upgrade, a server running Chef Automate 1 must have had at least one successful maintenance run after November 1, 2019.

        For Puppet servers: DescribeServersResponse$Servers$EngineAttributes contains the following two responses:

        • PUPPET_API_CA_CERT, the PEM-encoded CA certificate that is used by the Puppet API over TCP port number 8140. The CA certificate is also used to sign node certificates.

        • PUPPET_API_CRL, a certificate revocation list. The certificate revocation list is for internal maintenance purposes only. For more information about the Puppet certificate revocation list, see Man Page: puppet certificate_revocation_list in the Puppet documentation.

        • AssociatePublicIpAddress — (Boolean)

          Associate a public IP address with a server that you are launching.

        • BackupRetentionCount — (Integer)

          The number of automated backups to keep.

        • ServerName — (String)

          The name of the server.

        • CreatedAt — (Date)

          Time stamp of server creation. Example 2016-07-29T13:38:47.520Z

        • CloudFormationStackArn — (String)

          The ARN of the CloudFormation stack that was used to create the server.

        • CustomDomain — (String)

          An optional public endpoint of a server, such as https://aws.my-company.com. You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.

        • DisableAutomatedBackup — (Boolean)

          Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.

        • Endpoint — (String)

          A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io. You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.

        • Engine — (String)

          The engine type of the server. Valid values in this release include ChefAutomate and Puppet.

        • EngineModel — (String)

          The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.

        • EngineAttributes — (Array<map>)

          The response of a createServer() request returns the master credential to access the server in EngineAttributes. These credentials are not stored by AWS OpsWorks CM; they are returned only as part of the result of createServer().

          Attributes returned in a createServer response for Chef

          • CHEF_AUTOMATE_PIVOTAL_KEY: A base64-encoded RSA private key that is generated by AWS OpsWorks for Chef Automate. This private key is required to access the Chef API.

          • CHEF_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Chef starter kit, which includes a README, a configuration file, and the required RSA private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents. From this directory, you can run Knife commands.

          Attributes returned in a createServer response for Puppet

          • PUPPET_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Puppet starter kit, including a README and a required private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents.

          • PUPPET_ADMIN_PASSWORD: An administrator password that you can use to sign in to the Puppet Enterprise console after the server is online.

          • Name — (String)

            The name of the engine attribute.

          • Value — (String)

            The value of the engine attribute.

        • EngineVersion — (String)

          The engine version of the server. For a Chef server, the valid value for EngineVersion is currently 2. For a Puppet server, specify either 2019 or 2017.

        • InstanceProfileArn — (String)

          The instance profile ARN of the server.

        • InstanceType — (String)

          The instance type for the server, as specified in the CloudFormation stack. This might not be the same instance type that is shown in the EC2 console.

        • KeyPair — (String)

          The key pair associated with the server.

        • MaintenanceStatus — (String)

          The status of the most recent server maintenance run. Shows SUCCESS or FAILED.

          Possible values include:
          • "SUCCESS"
          • "FAILED"
        • PreferredMaintenanceWindow — (String)

          The preferred maintenance period specified for the server.

        • PreferredBackupWindow — (String)

          The preferred backup period specified for the server.

        • SecurityGroupIds — (Array<String>)

          The security group IDs for the server, as specified in the CloudFormation stack. These might not be the same security groups that are shown in the EC2 console.

        • ServiceRoleArn — (String)

          The service role ARN used to create the server.

        • Status — (String)

          The server's status. This field displays the states of actions in progress, such as creating, running, or backing up the server, as well as the server's health state.

          Possible values include:
          • "BACKING_UP"
          • "CONNECTION_LOST"
          • "CREATING"
          • "DELETING"
          • "MODIFYING"
          • "FAILED"
          • "HEALTHY"
          • "RUNNING"
          • "RESTORING"
          • "SETUP"
          • "UNDER_MAINTENANCE"
          • "UNHEALTHY"
          • "TERMINATED"
        • StatusReason — (String)

          Depending on the server status, this field has either a human-readable message (such as a create or backup error), or an escaped block of JSON (used for health check results).

        • SubnetIds — (Array<String>)

          The subnet IDs specified in a CreateServer request.

        • ServerArn — (String)

          The ARN of the server.

      • NextToken — (String)

        This is not currently implemented for DescribeServers requests.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

disassociateNode(params = {}, callback) ⇒ AWS.Request

Disassociates a node from an AWS OpsWorks CM server, and removes the node from the server's managed nodes. After a node is disassociated, the node key pair is no longer valid for accessing the configuration manager's API. For more information about how to associate a node, see AssociateNode.

A node can can only be disassociated from a server that is in a HEALTHY state. Otherwise, an InvalidStateException is thrown. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

Service Reference:

Examples:

Calling the disassociateNode operation

var params = {
  NodeName: 'STRING_VALUE', /* required */
  ServerName: 'STRING_VALUE', /* required */
  EngineAttributes: [
    {
      Name: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
opsworkscm.disassociateNode(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ServerName — (String)

      The name of the server from which to disassociate the node.

    • NodeName — (String)

      The name of the client node.

    • EngineAttributes — (Array<map>)

      Engine attributes that are used for disassociating the node. No attributes are required for Puppet.

      Attributes required in a DisassociateNode request for Chef

      • CHEF_ORGANIZATION: The Chef organization with which the node was associated. By default only one organization named default can exist.

      • Name — (String)

        The name of the engine attribute.

      • Value — (String)

        The value of the engine attribute.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NodeAssociationStatusToken — (String)

        Contains a token which can be passed to the DescribeNodeAssociationStatus API call to get the status of the disassociation request.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

exportServerEngineAttribute(params = {}, callback) ⇒ AWS.Request

Exports a specified server engine attribute as a base64-encoded string. For example, you can export user data that you can use in EC2 to associate nodes with a server.

This operation is synchronous.

A ValidationException is raised when parameters of the request are not valid. A ResourceNotFoundException is thrown when the server does not exist. An InvalidStateException is thrown when the server is in any of the following states: CREATING, TERMINATED, FAILED or DELETING.

Service Reference:

Examples:

Calling the exportServerEngineAttribute operation

var params = {
  ExportAttributeName: 'STRING_VALUE', /* required */
  ServerName: 'STRING_VALUE', /* required */
  InputAttributes: [
    {
      Name: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
opsworkscm.exportServerEngineAttribute(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ExportAttributeName — (String)

      The name of the export attribute. Currently, the supported export attribute is Userdata. This exports a user data script that includes parameters and values provided in the InputAttributes list.

    • ServerName — (String)

      The name of the server from which you are exporting the attribute.

    • InputAttributes — (Array<map>)

      The list of engine attributes. The list type is EngineAttribute. An EngineAttribute list item is a pair that includes an attribute name and its value. For the Userdata ExportAttributeName, the following are supported engine attribute names.

      • RunList In Chef, a list of roles or recipes that are run in the specified order. In Puppet, this parameter is ignored.

      • OrganizationName In Chef, an organization name. AWS OpsWorks for Chef Automate always creates the organization default. In Puppet, this parameter is ignored.

      • NodeEnvironment In Chef, a node environment (for example, development, staging, or one-box). In Puppet, this parameter is ignored.

      • NodeClientVersion In Chef, the version of the Chef engine (three numbers separated by dots, such as 13.8.5). If this attribute is empty, OpsWorks for Chef Automate uses the most current version. In Puppet, this parameter is ignored.

      • Name — (String)

        The name of the engine attribute.

      • Value — (String)

        The value of the engine attribute.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EngineAttribute — (map)

        The requested engine attribute pair with attribute name and value.

        • Name — (String)

          The name of the engine attribute.

        • Value — (String)

          The value of the engine attribute.

      • ServerName — (String)

        The server name used in the request.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
opsworkscm.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      The Amazon Resource Number (ARN) of an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server for which you want to show applied tags. For example, arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE.

    • NextToken — (String)

      NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call ListTagsForResource again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object's nextToken parameter value is null. Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur.

    • MaxResults — (Integer)

      To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (Array<map>)

        Tags that have been applied to the resource.

        • Key — required — (String)

          A tag key, such as Stage or Name. A tag key cannot be empty. The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

        • Value — required — (String)

          An optional tag value, such as Production or test-owcm-server. The value can be a maximum of 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

      • NextToken — (String)

        A token that you can use as the value of NextToken in subsequent calls to the API to show more results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

restoreServer(params = {}, callback) ⇒ AWS.Request

Restores a backup to a server that is in a CONNECTION_LOST, HEALTHY, RUNNING, UNHEALTHY, or TERMINATED state. When you run RestoreServer, the server's EC2 instance is deleted, and a new EC2 instance is configured. RestoreServer maintains the existing server endpoint, so configuration management of the server's client devices (nodes) should continue to work.

Restoring from a backup is performed by creating a new EC2 instance. If restoration is successful, and the server is in a HEALTHY state, AWS OpsWorks CM switches traffic over to the new instance. After restoration is finished, the old EC2 instance is maintained in a Running or Stopped state, but is eventually terminated.

This operation is asynchronous.

An InvalidStateException is thrown when the server is not in a valid state. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

Service Reference:

Examples:

Calling the restoreServer operation

var params = {
  BackupId: 'STRING_VALUE', /* required */
  ServerName: 'STRING_VALUE', /* required */
  InstanceType: 'STRING_VALUE',
  KeyPair: 'STRING_VALUE'
};
opsworkscm.restoreServer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BackupId — (String)

      The ID of the backup that you want to use to restore a server.

    • ServerName — (String)

      The name of the server that you want to restore.

    • InstanceType — (String)

      The type of instance to restore. Valid values must be specified in the following format: ^([cm][34]|t2).* For example, m5.large. Valid values are m5.large, r5.xlarge, and r5.2xlarge. If you do not specify this parameter, RestoreServer uses the instance type from the specified backup.

    • KeyPair — (String)

      The name of the key pair to set on the new EC2 instance. This can be helpful if the administrator no longer has the SSH key.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Server — (map)

        Describes a configuration management server.

        • AssociatePublicIpAddress — (Boolean)

          Associate a public IP address with a server that you are launching.

        • BackupRetentionCount — (Integer)

          The number of automated backups to keep.

        • ServerName — (String)

          The name of the server.

        • CreatedAt — (Date)

          Time stamp of server creation. Example 2016-07-29T13:38:47.520Z

        • CloudFormationStackArn — (String)

          The ARN of the CloudFormation stack that was used to create the server.

        • CustomDomain — (String)

          An optional public endpoint of a server, such as https://aws.my-company.com. You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.

        • DisableAutomatedBackup — (Boolean)

          Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.

        • Endpoint — (String)

          A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io. You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.

        • Engine — (String)

          The engine type of the server. Valid values in this release include ChefAutomate and Puppet.

        • EngineModel — (String)

          The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.

        • EngineAttributes — (Array<map>)

          The response of a createServer() request returns the master credential to access the server in EngineAttributes. These credentials are not stored by AWS OpsWorks CM; they are returned only as part of the result of createServer().

          Attributes returned in a createServer response for Chef

          • CHEF_AUTOMATE_PIVOTAL_KEY: A base64-encoded RSA private key that is generated by AWS OpsWorks for Chef Automate. This private key is required to access the Chef API.

          • CHEF_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Chef starter kit, which includes a README, a configuration file, and the required RSA private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents. From this directory, you can run Knife commands.

          Attributes returned in a createServer response for Puppet

          • PUPPET_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Puppet starter kit, including a README and a required private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents.

          • PUPPET_ADMIN_PASSWORD: An administrator password that you can use to sign in to the Puppet Enterprise console after the server is online.

          • Name — (String)

            The name of the engine attribute.

          • Value — (String)

            The value of the engine attribute.

        • EngineVersion — (String)

          The engine version of the server. For a Chef server, the valid value for EngineVersion is currently 2. For a Puppet server, specify either 2019 or 2017.

        • InstanceProfileArn — (String)

          The instance profile ARN of the server.

        • InstanceType — (String)

          The instance type for the server, as specified in the CloudFormation stack. This might not be the same instance type that is shown in the EC2 console.

        • KeyPair — (String)

          The key pair associated with the server.

        • MaintenanceStatus — (String)

          The status of the most recent server maintenance run. Shows SUCCESS or FAILED.

          Possible values include:
          • "SUCCESS"
          • "FAILED"
        • PreferredMaintenanceWindow — (String)

          The preferred maintenance period specified for the server.

        • PreferredBackupWindow — (String)

          The preferred backup period specified for the server.

        • SecurityGroupIds — (Array<String>)

          The security group IDs for the server, as specified in the CloudFormation stack. These might not be the same security groups that are shown in the EC2 console.

        • ServiceRoleArn — (String)

          The service role ARN used to create the server.

        • Status — (String)

          The server's status. This field displays the states of actions in progress, such as creating, running, or backing up the server, as well as the server's health state.

          Possible values include:
          • "BACKING_UP"
          • "CONNECTION_LOST"
          • "CREATING"
          • "DELETING"
          • "MODIFYING"
          • "FAILED"
          • "HEALTHY"
          • "RUNNING"
          • "RESTORING"
          • "SETUP"
          • "UNDER_MAINTENANCE"
          • "UNHEALTHY"
          • "TERMINATED"
        • StatusReason — (String)

          Depending on the server status, this field has either a human-readable message (such as a create or backup error), or an escaped block of JSON (used for health check results).

        • SubnetIds — (Array<String>)

          The subnet IDs specified in a CreateServer request.

        • ServerArn — (String)

          The ARN of the server.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

startMaintenance(params = {}, callback) ⇒ AWS.Request

Manually starts server maintenance. This command can be useful if an earlier maintenance attempt failed, and the underlying cause of maintenance failure has been resolved. The server is in an UNDER_MAINTENANCE state while maintenance is in progress.

Maintenance can only be started on servers in HEALTHY and UNHEALTHY states. Otherwise, an InvalidStateException is thrown. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

Service Reference:

Examples:

Calling the startMaintenance operation

var params = {
  ServerName: 'STRING_VALUE', /* required */
  EngineAttributes: [
    {
      Name: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
opsworkscm.startMaintenance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ServerName — (String)

      The name of the server on which to run maintenance.

    • EngineAttributes — (Array<map>)

      Engine attributes that are specific to the server on which you want to run maintenance.

      Attributes accepted in a StartMaintenance request for Chef

      • Name — (String)

        The name of the engine attribute.

      • Value — (String)

        The value of the engine attribute.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Server — (map)

        Contains the response to a StartMaintenance request.

        • AssociatePublicIpAddress — (Boolean)

          Associate a public IP address with a server that you are launching.

        • BackupRetentionCount — (Integer)

          The number of automated backups to keep.

        • ServerName — (String)

          The name of the server.

        • CreatedAt — (Date)

          Time stamp of server creation. Example 2016-07-29T13:38:47.520Z

        • CloudFormationStackArn — (String)

          The ARN of the CloudFormation stack that was used to create the server.

        • CustomDomain — (String)

          An optional public endpoint of a server, such as https://aws.my-company.com. You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.

        • DisableAutomatedBackup — (Boolean)

          Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.

        • Endpoint — (String)

          A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io. You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.

        • Engine — (String)

          The engine type of the server. Valid values in this release include ChefAutomate and Puppet.

        • EngineModel — (String)

          The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.

        • EngineAttributes — (Array<map>)

          The response of a createServer() request returns the master credential to access the server in EngineAttributes. These credentials are not stored by AWS OpsWorks CM; they are returned only as part of the result of createServer().

          Attributes returned in a createServer response for Chef

          • CHEF_AUTOMATE_PIVOTAL_KEY: A base64-encoded RSA private key that is generated by AWS OpsWorks for Chef Automate. This private key is required to access the Chef API.

          • CHEF_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Chef starter kit, which includes a README, a configuration file, and the required RSA private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents. From this directory, you can run Knife commands.

          Attributes returned in a createServer response for Puppet

          • PUPPET_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Puppet starter kit, including a README and a required private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents.

          • PUPPET_ADMIN_PASSWORD: An administrator password that you can use to sign in to the Puppet Enterprise console after the server is online.

          • Name — (String)

            The name of the engine attribute.

          • Value — (String)

            The value of the engine attribute.

        • EngineVersion — (String)

          The engine version of the server. For a Chef server, the valid value for EngineVersion is currently 2. For a Puppet server, specify either 2019 or 2017.

        • InstanceProfileArn — (String)

          The instance profile ARN of the server.

        • InstanceType — (String)

          The instance type for the server, as specified in the CloudFormation stack. This might not be the same instance type that is shown in the EC2 console.

        • KeyPair — (String)

          The key pair associated with the server.

        • MaintenanceStatus — (String)

          The status of the most recent server maintenance run. Shows SUCCESS or FAILED.

          Possible values include:
          • "SUCCESS"
          • "FAILED"
        • PreferredMaintenanceWindow — (String)

          The preferred maintenance period specified for the server.

        • PreferredBackupWindow — (String)

          The preferred backup period specified for the server.

        • SecurityGroupIds — (Array<String>)

          The security group IDs for the server, as specified in the CloudFormation stack. These might not be the same security groups that are shown in the EC2 console.

        • ServiceRoleArn — (String)

          The service role ARN used to create the server.

        • Status — (String)

          The server's status. This field displays the states of actions in progress, such as creating, running, or backing up the server, as well as the server's health state.

          Possible values include:
          • "BACKING_UP"
          • "CONNECTION_LOST"
          • "CREATING"
          • "DELETING"
          • "MODIFYING"
          • "FAILED"
          • "HEALTHY"
          • "RUNNING"
          • "RESTORING"
          • "SETUP"
          • "UNDER_MAINTENANCE"
          • "UNHEALTHY"
          • "TERMINATED"
        • StatusReason — (String)

          Depending on the server status, this field has either a human-readable message (such as a create or backup error), or an escaped block of JSON (used for health check results).

        • SubnetIds — (Array<String>)

          The subnet IDs specified in a CreateServer request.

        • ServerArn — (String)

          The ARN of the server.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Applies tags to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server, or to server backups.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
opsworkscm.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      The Amazon Resource Number (ARN) of a resource to which you want to apply tags. For example, arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE.

    • Tags — (Array<map>)

      A map that contains tag keys and tag values to attach to AWS OpsWorks-CM servers or backups.

      • The key cannot be empty.

      • The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

      • The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

      • Leading and trailing white spaces are trimmed from both the key and value.

      • A maximum of 50 user-applied tags is allowed for any AWS OpsWorks-CM server or backup.

      • Key — required — (String)

        A tag key, such as Stage or Name. A tag key cannot be empty. The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

      • Value — required — (String)

        An optional tag value, such as Production or test-owcm-server. The value can be a maximum of 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes specified tags from an AWS OpsWorks-CM server or backup.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
opsworkscm.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      The Amazon Resource Number (ARN) of a resource from which you want to remove tags. For example, arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE.

    • TagKeys — (Array<String>)

      The keys of tags that you want to remove.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateServer(params = {}, callback) ⇒ AWS.Request

Updates settings for a server.

This operation is synchronous.

Service Reference:

Examples:

Calling the updateServer operation

var params = {
  ServerName: 'STRING_VALUE', /* required */
  BackupRetentionCount: 'NUMBER_VALUE',
  DisableAutomatedBackup: true || false,
  PreferredBackupWindow: 'STRING_VALUE',
  PreferredMaintenanceWindow: 'STRING_VALUE'
};
opsworkscm.updateServer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DisableAutomatedBackup — (Boolean)

      Setting DisableAutomatedBackup to true disables automated or scheduled backups. Automated backups are enabled by default.

    • BackupRetentionCount — (Integer)

      Sets the number of automated backups that you want to keep.

    • ServerName — (String)

      The name of the server to update.

    • PreferredMaintenanceWindow — (String)

      DDD:HH:MM (weekly start time) or HH:MM (daily start time).

      Time windows always use coordinated universal time (UTC). Valid strings for day of week (DDD) are: Mon, Tue, Wed, Thr, Fri, Sat, or Sun.

    • PreferredBackupWindow — (String)

      DDD:HH:MM (weekly start time) or HH:MM (daily start time).

      Time windows always use coordinated universal time (UTC). Valid strings for day of week (DDD) are: Mon, Tue, Wed, Thr, Fri, Sat, or Sun.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Server — (map)

        Contains the response to a UpdateServer request.

        • AssociatePublicIpAddress — (Boolean)

          Associate a public IP address with a server that you are launching.

        • BackupRetentionCount — (Integer)

          The number of automated backups to keep.

        • ServerName — (String)

          The name of the server.

        • CreatedAt — (Date)

          Time stamp of server creation. Example 2016-07-29T13:38:47.520Z

        • CloudFormationStackArn — (String)

          The ARN of the CloudFormation stack that was used to create the server.

        • CustomDomain — (String)

          An optional public endpoint of a server, such as https://aws.my-company.com. You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.

        • DisableAutomatedBackup — (Boolean)

          Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.

        • Endpoint — (String)

          A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io. You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.

        • Engine — (String)

          The engine type of the server. Valid values in this release include ChefAutomate and Puppet.

        • EngineModel — (String)

          The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.

        • EngineAttributes — (Array<map>)

          The response of a createServer() request returns the master credential to access the server in EngineAttributes. These credentials are not stored by AWS OpsWorks CM; they are returned only as part of the result of createServer().

          Attributes returned in a createServer response for Chef

          • CHEF_AUTOMATE_PIVOTAL_KEY: A base64-encoded RSA private key that is generated by AWS OpsWorks for Chef Automate. This private key is required to access the Chef API.

          • CHEF_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Chef starter kit, which includes a README, a configuration file, and the required RSA private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents. From this directory, you can run Knife commands.

          Attributes returned in a createServer response for Puppet

          • PUPPET_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Puppet starter kit, including a README and a required private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents.

          • PUPPET_ADMIN_PASSWORD: An administrator password that you can use to sign in to the Puppet Enterprise console after the server is online.

          • Name — (String)

            The name of the engine attribute.

          • Value — (String)

            The value of the engine attribute.

        • EngineVersion — (String)

          The engine version of the server. For a Chef server, the valid value for EngineVersion is currently 2. For a Puppet server, specify either 2019 or 2017.

        • InstanceProfileArn — (String)

          The instance profile ARN of the server.

        • InstanceType — (String)

          The instance type for the server, as specified in the CloudFormation stack. This might not be the same instance type that is shown in the EC2 console.

        • KeyPair — (String)

          The key pair associated with the server.

        • MaintenanceStatus — (String)

          The status of the most recent server maintenance run. Shows SUCCESS or FAILED.

          Possible values include:
          • "SUCCESS"
          • "FAILED"
        • PreferredMaintenanceWindow — (String)

          The preferred maintenance period specified for the server.

        • PreferredBackupWindow — (String)

          The preferred backup period specified for the server.

        • SecurityGroupIds — (Array<String>)

          The security group IDs for the server, as specified in the CloudFormation stack. These might not be the same security groups that are shown in the EC2 console.

        • ServiceRoleArn — (String)

          The service role ARN used to create the server.

        • Status — (String)

          The server's status. This field displays the states of actions in progress, such as creating, running, or backing up the server, as well as the server's health state.

          Possible values include:
          • "BACKING_UP"
          • "CONNECTION_LOST"
          • "CREATING"
          • "DELETING"
          • "MODIFYING"
          • "FAILED"
          • "HEALTHY"
          • "RUNNING"
          • "RESTORING"
          • "SETUP"
          • "UNDER_MAINTENANCE"
          • "UNHEALTHY"
          • "TERMINATED"
        • StatusReason — (String)

          Depending on the server status, this field has either a human-readable message (such as a create or backup error), or an escaped block of JSON (used for health check results).

        • SubnetIds — (Array<String>)

          The subnet IDs specified in a CreateServer request.

        • ServerArn — (String)

          The ARN of the server.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateServerEngineAttributes(params = {}, callback) ⇒ AWS.Request

Updates engine-specific attributes on a specified server. The server enters the MODIFYING state when this operation is in progress. Only one update can occur at a time. You can use this command to reset a Chef server's public key (CHEF_PIVOTAL_KEY) or a Puppet server's admin password (PUPPET_ADMIN_PASSWORD).

This operation is asynchronous.

This operation can only be called for servers in HEALTHY or UNHEALTHY states. Otherwise, an InvalidStateException is raised. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

Service Reference:

Examples:

Calling the updateServerEngineAttributes operation

var params = {
  AttributeName: 'STRING_VALUE', /* required */
  ServerName: 'STRING_VALUE', /* required */
  AttributeValue: 'STRING_VALUE'
};
opsworkscm.updateServerEngineAttributes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ServerName — (String)

      The name of the server to update.

    • AttributeName — (String)

      The name of the engine attribute to update.

    • AttributeValue — (String)

      The value to set for the attribute.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Server — (map)

        Contains the response to an UpdateServerEngineAttributes request.

        • AssociatePublicIpAddress — (Boolean)

          Associate a public IP address with a server that you are launching.

        • BackupRetentionCount — (Integer)

          The number of automated backups to keep.

        • ServerName — (String)

          The name of the server.

        • CreatedAt — (Date)

          Time stamp of server creation. Example 2016-07-29T13:38:47.520Z

        • CloudFormationStackArn — (String)

          The ARN of the CloudFormation stack that was used to create the server.

        • CustomDomain — (String)

          An optional public endpoint of a server, such as https://aws.my-company.com. You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.

        • DisableAutomatedBackup — (Boolean)

          Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.

        • Endpoint — (String)

          A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io. You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.

        • Engine — (String)

          The engine type of the server. Valid values in this release include ChefAutomate and Puppet.

        • EngineModel — (String)

          The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.

        • EngineAttributes — (Array<map>)

          The response of a createServer() request returns the master credential to access the server in EngineAttributes. These credentials are not stored by AWS OpsWorks CM; they are returned only as part of the result of createServer().

          Attributes returned in a createServer response for Chef

          • CHEF_AUTOMATE_PIVOTAL_KEY: A base64-encoded RSA private key that is generated by AWS OpsWorks for Chef Automate. This private key is required to access the Chef API.

          • CHEF_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Chef starter kit, which includes a README, a configuration file, and the required RSA private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents. From this directory, you can run Knife commands.

          Attributes returned in a createServer response for Puppet

          • PUPPET_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Puppet starter kit, including a README and a required private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents.

          • PUPPET_ADMIN_PASSWORD: An administrator password that you can use to sign in to the Puppet Enterprise console after the server is online.

          • Name — (String)

            The name of the engine attribute.

          • Value — (String)

            The value of the engine attribute.

        • EngineVersion — (String)

          The engine version of the server. For a Chef server, the valid value for EngineVersion is currently 2. For a Puppet server, specify either 2019 or 2017.

        • InstanceProfileArn — (String)

          The instance profile ARN of the server.

        • InstanceType — (String)

          The instance type for the server, as specified in the CloudFormation stack. This might not be the same instance type that is shown in the EC2 console.

        • KeyPair — (String)

          The key pair associated with the server.

        • MaintenanceStatus — (String)

          The status of the most recent server maintenance run. Shows SUCCESS or FAILED.

          Possible values include:
          • "SUCCESS"
          • "FAILED"
        • PreferredMaintenanceWindow — (String)

          The preferred maintenance period specified for the server.

        • PreferredBackupWindow — (String)

          The preferred backup period specified for the server.

        • SecurityGroupIds — (Array<String>)

          The security group IDs for the server, as specified in the CloudFormation stack. These might not be the same security groups that are shown in the EC2 console.

        • ServiceRoleArn — (String)

          The service role ARN used to create the server.

        • Status — (String)

          The server's status. This field displays the states of actions in progress, such as creating, running, or backing up the server, as well as the server's health state.

          Possible values include:
          • "BACKING_UP"
          • "CONNECTION_LOST"
          • "CREATING"
          • "DELETING"
          • "MODIFYING"
          • "FAILED"
          • "HEALTHY"
          • "RUNNING"
          • "RESTORING"
          • "SETUP"
          • "UNDER_MAINTENANCE"
          • "UNHEALTHY"
          • "TERMINATED"
        • StatusReason — (String)

          Depending on the server status, this field has either a human-readable message (such as a create or backup error), or an escaped block of JSON (used for health check results).

        • SubnetIds — (Array<String>)

          The subnet IDs specified in a CreateServer request.

        • ServerArn — (String)

          The ARN of the server.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given OpsWorksCM resource. The final callback or 'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.

Examples:

Waiting for the nodeAssociated state

var params = {
  NodeAssociationStatusToken: 'STRING_VALUE', /* required */
  ServerName: 'STRING_VALUE' /* required */
};
opsworkscm.waitFor('nodeAssociated', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • state (String) —

    the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

  • params (map) (defaults to: {}) —

    a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

  • function(err, data) { ... }

    Callback containing error and data information. See the respective resource state for the expected error or data information.

    If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

Waiter Resource Details

opsworkscm.waitFor('nodeAssociated', params = {}, [callback]) ⇒ AWS.Request

Waits for the nodeAssociated state by periodically calling the underlying OpsWorksCM.describeNodeAssociationStatus() operation every 15 seconds (at most 15 times).

Examples:

Waiting for the nodeAssociated state

var params = {
  NodeAssociationStatusToken: 'STRING_VALUE', /* required */
  ServerName: 'STRING_VALUE' /* required */
};
opsworkscm.waitFor('nodeAssociated', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • NodeAssociationStatusToken — (String)

      The token returned in either the AssociateNodeResponse or the DisassociateNodeResponse.

    • ServerName — (String)

      The name of the server from which to disassociate the node.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NodeAssociationStatus — (String)

        The status of the association or disassociation request.

        Possible values:

        • SUCCESS: The association or disassociation succeeded.

        • FAILED: The association or disassociation failed.

        • IN_PROGRESS: The association or disassociation is still in progress.

        Possible values include:
        • "SUCCESS"
        • "FAILED"
        • "IN_PROGRESS"
      • EngineAttributes — (Array<map>)

        Attributes specific to the node association. In Puppet, the attibute PUPPET_NODE_CERT contains the signed certificate (the result of the CSR).

        • Name — (String)

          The name of the engine attribute.

        • Value — (String)

          The value of the engine attribute.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

See Also: