@aws-sdk/client-opsworkscm-browser NPM

@aws-sdk/client-opsworkscm-browser

Description

AWS OpsWorks CM 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 Throttling limits All API operations allow for five requests per second with a burst of 10 requests per second.

Installing

To install the this package using NPM, simply type the following into a terminal window:

npm install @aws-sdk/client-opsworkscm-browser

Getting Started

Import

The AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(OpsWorksCMClient) and the commands you need, for example AssociateNodeCommand:

//JavaScript
const {
  OpsWorksCMClient
} = require("@aws-sdk/client-opsworkscm-browser/OpsWorksCMClient");
const {
  AssociateNodeCommand
} = require("@aws-sdk/client-opsworkscm-browser/commands/AssociateNodeCommand");

//TypeScript
import { OpsWorksCMClient } from "@aws-sdk/client-opsworkscm-browser/OpsWorksCMClient";
import { AssociateNodeCommand } from "@aws-sdk/client-opsworkscm-browser/commands/AssociateNodeCommand";

Usage

To send a request, you:

Initiate client with configuration (e.g. credentials, region). For more information you can refer to the API reference.
Initiate command with input parameters.
Call send operation on client with command object as input.
If you are using a custom http handler, you may call destroy() to close open connections.

const opsWorksCM = new OpsWorksCMClient({region: 'region'});
//clients can be shared by different commands
const params = {
  ServerName: /**a string value*/,
  NodeName: /**a string value*/,
  EngineAttributes: [ /**a list of structure*/ ],
};
const associateNodeCommand = new AssociateNodeCommand(params);
opsWorksCM.send(associateNodeCommand).then(data => {
    // do something
}).catch(error => {
    // error handling
})

In addition to using promises, there are 2 other ways to send a request:

// async/await
try {
  const data = await opsWorksCM.send(associateNodeCommand);
  // do something
} catch (error) {
  // error handling
}

// callback
opsWorksCM.send(associateNodeCommand, (err, data) => {
  //do something
});

The SDK can also send requests using the simplified callback style from version 2 of the SDK.

import * as AWS from "@aws-sdk/@aws-sdk/client-opsworkscm-browser/OpsWorksCM";
const opsWorksCM = new AWS.OpsWorksCM({ region: "region" });
opsWorksCM.associateNode(params, (err, data) => {
  //do something
});

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
  const data = await opsWorksCM.send(associateNodeCommand);
  // do something
} catch (error) {
  const metadata = error.$metadata;
  console.log(
    `requestId: ${metadata.requestId}
cfId: ${metadata.cfId}
extendedRequestId: ${metadata.extendedRequestId}`
  );
  /*
The keys within exceptions are also parsed. You can access them by specifying exception names:
    if(error.name === 'SomeServiceException') {
        const value = error.specialKeyInException;
    }
*/
}

Getting Help

Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.

Ask a question on StackOverflow and tag it with aws-sdk-js
Come join the AWS JavaScript community on gitter
If it turns out that you may have found a bug, please open an issue

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-opsworkscm-browser' package is updated. To contribute to SDK you can checkout our code generator package.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.