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.

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

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, 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)

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

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

  • 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 returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • 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.

Property Details

endpointAWS.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 Chef server. This command is an alternative to knife bootstrap. For more information about how to disassociate a node, see DisassociateNode.

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.

Example: aws opsworks-cm associate-node --server-name MyServer --node-name MyManagedNode --engine-attributes "Name=MyOrganization,Value=default" "Name=Chef_node_public_key,Value=Public_key_contents"

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 Chef client node.

    • EngineAttributes — (Array<map>)

      Engine attributes used for associating the node.

      Attributes accepted in a AssociateNode request:

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

      • 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'
};
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.

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 for Chef Automate-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. 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.

By default, the Chef 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.

Service Reference:

Examples:

Calling the createServer operation

var params = {
  InstanceProfileArn: 'STRING_VALUE', /* required */
  InstanceType: 'STRING_VALUE', /* required */
  ServerName: 'STRING_VALUE', /* required */
  ServiceRoleArn: 'STRING_VALUE', /* required */
  AssociatePublicIpAddress: true || false,
  BackupId: 'STRING_VALUE',
  BackupRetentionCount: 0,
  DisableAutomatedBackup: true || false,
  Engine: 'STRING_VALUE',
  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 */
  ]
};
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.

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

    • EngineModel — (String)

      The engine model, or option. Valid values include Single.

    • EngineVersion — (String)

      The major release version of the engine that you want to use. Values depend on the engine that you choose.

    • EngineAttributes — (Array<map>)

      Optional engine attributes on a specified server.

      Attributes accepted in a createServer request:

      • CHEF_PIVOTAL_KEY: A base64-encoded RSA private key that is not stored by AWS OpsWorks for Chef. This private key is required to access the Chef API. When no CHEF_PIVOTAL_KEY is set, one is generated and returned in the response.

      • CHEF_DELIVERY_ADMIN_PASSWORD: The password for the administrative user in the Chef Automate GUI. 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_DELIVERY_ADMIN_PASSWORD is set, one is generated and returned in the response.

      • 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 for Chef Automate 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. Valid values must be specified in the following format: ^([cm][34]|t2).* For example, m4.large. Valid values are t2.medium, m4.large, or m4.2xlarge.

    • 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 for Chef Automate performs maintenance on the instance. Valid values must be specified in the following format: DDD:HH:MM. 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 for Chef Automate 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

      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 for Chef Automate 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 for Chef Automate 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 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.

    • BackupId — (String)

      If you specify this field, AWS OpsWorks for Chef Automate 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.

        • 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

        • Engine — (String)

          The engine type of the server. The valid value in this release is Chef.

        • EngineModel — (String)

          The engine model of the server. The valid value in this release is Single.

        • 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 for Chef Automate; they are returned only as part of the result of createServer().

          Attributes returned in a createServer response:

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

          • Name — (String)

            The name of the engine attribute.

          • Value — (String)

            The value of the engine attribute.

        • EngineVersion — (String)

          The engine version of the server. Because Chef is the engine available in this release, the valid value for EngineVersion is 12.

        • 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 stack (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 account attributes, and creates requests to increase limits before they are reached or exceeded.

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: 0,
  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)

      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 DescribeBackups 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:

      • 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 for Chef Automate-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)

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

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: 0,
  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.

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

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 for Chef Automate 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: 0,
  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)

      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 DescribeServers 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:

      • Servers — (Array<map>)

        Contains the response to a DescribeServers 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.

        • 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

        • Engine — (String)

          The engine type of the server. The valid value in this release is Chef.

        • EngineModel — (String)

          The engine model of the server. The valid value in this release is Single.

        • 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 for Chef Automate; they are returned only as part of the result of createServer().

          Attributes returned in a createServer response:

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

          • Name — (String)

            The name of the engine attribute.

          • Value — (String)

            The value of the engine attribute.

        • EngineVersion — (String)

          The engine version of the server. Because Chef is the engine available in this release, the valid value for EngineVersion is 12.

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

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

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

Disassociates a node from a Chef server, and removes the node from the Chef server's managed nodes. After a node is disassociated, the node key pair is no longer valid for accessing the Chef 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 Chef client node.

    • EngineAttributes — (Array<map>)

      Engine attributes used for disassociating the node.

      Attributes accepted in a DisassociateNode request:

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

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.

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 the instance to create. Valid values must be specified in the following format: ^([cm][34]|t2).* For example, m4.large. Valid values are t2.medium, m4.large, and m4.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.

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.

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

        • 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

        • Engine — (String)

          The engine type of the server. The valid value in this release is Chef.

        • EngineModel — (String)

          The engine model of the server. The valid value in this release is Single.

        • 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 for Chef Automate; they are returned only as part of the result of createServer().

          Attributes returned in a createServer response:

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

          • Name — (String)

            The name of the engine attribute.

          • Value — (String)

            The value of the engine attribute.

        • EngineVersion — (String)

          The engine version of the server. Because Chef is the engine available in this release, the valid value for EngineVersion is 12.

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

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: 0,
  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.

        • 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

        • Engine — (String)

          The engine type of the server. The valid value in this release is Chef.

        • EngineModel — (String)

          The engine model of the server. The valid value in this release is Single.

        • 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 for Chef Automate; they are returned only as part of the result of createServer().

          Attributes returned in a createServer response:

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

          • Name — (String)

            The name of the engine attribute.

          • Value — (String)

            The value of the engine attribute.

        • EngineVersion — (String)

          The engine version of the server. Because Chef is the engine available in this release, the valid value for EngineVersion is 12.

        • 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 the Chef server's private key (CHEF_PIVOTAL_KEY).

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.

        • 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

        • Engine — (String)

          The engine type of the server. The valid value in this release is Chef.

        • EngineModel — (String)

          The engine model of the server. The valid value in this release is Single.

        • 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 for Chef Automate; they are returned only as part of the result of createServer().

          Attributes returned in a createServer response:

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

          • Name — (String)

            The name of the engine attribute.

          • Value — (String)

            The value of the engine attribute.

        • EngineVersion — (String)

          The engine version of the server. Because Chef is the engine available in this release, the valid value for EngineVersion is 12.

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