5.0.0 • Published 7 years ago

@datafire/amazonaws_opsworks_cm v5.0.0

Weekly downloads
2
License
MIT
Repository
github
Last release
7 years ago

@datafire/amazonaws_opsworks_cm

Client library for AWS OpsWorks for Chef Automate

Installation and Usage

npm install --save @datafire/amazonaws_opsworks_cm
let amazonaws_opsworks_cm = require('@datafire/amazonaws_opsworks_cm').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_opsworks_cm.AssociateNode({
  "ServerName": "",
  "NodeName": "",
  "EngineAttributes": []
}).then(data => {
  console.log(data);
});

Description

AWS OpsWorks CM AWS OpsWorks for configuration management (CM) is a service that runs and manages configuration management servers. 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 Chef 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-west-2.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.

Actions

AssociateNode

amazonaws_opsworks_cm.AssociateNode({
  "ServerName": "",
  "NodeName": "",
  "EngineAttributes": []
}, context)

Input

Output

CreateBackup

amazonaws_opsworks_cm.CreateBackup({
  "ServerName": ""
}, context)

Input

Output

CreateServer

amazonaws_opsworks_cm.CreateServer({
  "ServerName": "",
  "InstanceProfileArn": "",
  "InstanceType": "",
  "ServiceRoleArn": ""
}, context)

Input

Output

DeleteBackup

amazonaws_opsworks_cm.DeleteBackup({
  "BackupId": ""
}, context)

Input

Output

DeleteServer

amazonaws_opsworks_cm.DeleteServer({
  "ServerName": ""
}, context)

Input

Output

DescribeAccountAttributes

amazonaws_opsworks_cm.DescribeAccountAttributes({}, context)

Input

  • input object

Output

DescribeBackups

amazonaws_opsworks_cm.DescribeBackups({}, context)

Input

Output

DescribeEvents

amazonaws_opsworks_cm.DescribeEvents({
  "ServerName": ""
}, context)

Input

Output

DescribeNodeAssociationStatus

amazonaws_opsworks_cm.DescribeNodeAssociationStatus({
  "NodeAssociationStatusToken": "",
  "ServerName": ""
}, context)

Input

Output

DescribeServers

amazonaws_opsworks_cm.DescribeServers({}, context)

Input

Output

DisassociateNode

amazonaws_opsworks_cm.DisassociateNode({
  "ServerName": "",
  "NodeName": ""
}, context)

Input

Output

RestoreServer

amazonaws_opsworks_cm.RestoreServer({
  "BackupId": "",
  "ServerName": ""
}, context)

Input

Output

StartMaintenance

amazonaws_opsworks_cm.StartMaintenance({
  "ServerName": ""
}, context)

Input

Output

UpdateServer

amazonaws_opsworks_cm.UpdateServer({
  "ServerName": ""
}, context)

Input

Output

UpdateServerEngineAttributes

amazonaws_opsworks_cm.UpdateServerEngineAttributes({
  "ServerName": "",
  "AttributeName": ""
}, context)

Input

Output

Definitions

AccountAttribute

AccountAttributes

  • AccountAttributes array: A list of individual account attributes.

AssociateNodeRequest

AssociateNodeResponse

AttributeName

  • AttributeName string

AttributeValue

  • AttributeValue string

Backup

BackupId

  • BackupId string

BackupRetentionCountDefinition

  • BackupRetentionCountDefinition integer

BackupStatus

  • BackupStatus string (values: IN_PROGRESS, OK, FAILED, DELETING)

BackupType

  • BackupType string (values: AUTOMATED, MANUAL)

Backups

Boolean

  • Boolean boolean

CreateBackupRequest

CreateBackupResponse

  • CreateBackupResponse object

CreateServerRequest

CreateServerResponse

  • CreateServerResponse object

DeleteBackupRequest

  • DeleteBackupRequest object

DeleteBackupResponse

  • DeleteBackupResponse object

DeleteServerRequest

  • DeleteServerRequest object

DeleteServerResponse

  • DeleteServerResponse object

DescribeAccountAttributesRequest

  • DescribeAccountAttributesRequest object

DescribeAccountAttributesResponse

DescribeBackupsRequest

DescribeBackupsResponse

DescribeEventsRequest

DescribeEventsResponse

DescribeNodeAssociationStatusRequest

DescribeNodeAssociationStatusResponse

DescribeServersRequest

DescribeServersResponse

DisassociateNodeRequest

DisassociateNodeResponse

EngineAttribute

EngineAttributeName

  • EngineAttributeName string

EngineAttributeValue

  • EngineAttributeValue string

EngineAttributes

InstanceProfileArn

  • InstanceProfileArn string

Integer

  • Integer integer

InvalidNextTokenException

  • InvalidNextTokenException object: This occurs when the provided nextToken is not valid.

InvalidStateException

  • InvalidStateException object: The resource is in a state that does not allow you to perform a specified action.

KeyPair

  • KeyPair string

LimitExceededException

  • LimitExceededException object: The limit of servers or backups has been reached.

MaintenanceStatus

  • MaintenanceStatus string (values: SUCCESS, FAILED)

MaxResults

  • MaxResults integer

NextToken

  • NextToken string

NodeAssociationStatus

  • NodeAssociationStatus string (values: SUCCESS, FAILED, IN_PROGRESS): 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.

NodeAssociationStatusToken

  • NodeAssociationStatusToken string

NodeName

  • NodeName string: The node name that is used by chef-client or puppet-agentfor a new node. We recommend to use a unique FQDN as hostname. For more information, see the Chef or Puppet documentation.

ResourceAlreadyExistsException

  • ResourceAlreadyExistsException object: The requested resource cannot be created because it already exists.

ResourceNotFoundException

  • ResourceNotFoundException object: The requested resource does not exist, or access was denied.

RestoreServerRequest

RestoreServerResponse

  • RestoreServerResponse object

Server

ServerEvent

  • ServerEvent object: An event that is related to the server, such as the start of maintenance or backup.

ServerEvents

ServerName

  • ServerName string

ServerStatus

  • ServerStatus string (values: BACKING_UP, CONNECTION_LOST, CREATING, DELETING, MODIFYING, FAILED, HEALTHY, RUNNING, RESTORING, SETUP, UNDER_MAINTENANCE, UNHEALTHY, TERMINATED)

Servers

ServiceRoleArn

  • ServiceRoleArn string

StartMaintenanceRequest

StartMaintenanceResponse

  • StartMaintenanceResponse object

String

  • String string

Strings

TimeWindowDefinition

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

Timestamp

  • Timestamp string

UpdateServerEngineAttributesRequest

UpdateServerEngineAttributesResponse

  • UpdateServerEngineAttributesResponse object

UpdateServerRequest

UpdateServerResponse

  • UpdateServerResponse object

ValidationException

  • ValidationException object: One or more of the provided request parameters are not valid.
5.0.0

7 years ago

4.0.0

8 years ago

3.0.4

8 years ago

3.0.3

8 years ago

3.0.2

8 years ago

3.0.1

8 years ago

3.0.0

8 years ago

2.0.2

8 years ago

2.0.1

8 years ago

2.0.0

8 years ago