@datafire/amazonaws_opsworks_cm v5.0.0
@datafire/amazonaws_opsworks_cm
Client library for AWS OpsWorks for Chef Automate
Installation and Usage
npm install --save @datafire/amazonaws_opsworks_cmlet 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
- input object- EngineAttributes required EngineAttributes
- NodeName required NodeName
- ServerName required ServerName
 
Output
- output AssociateNodeResponse
CreateBackup
amazonaws_opsworks_cm.CreateBackup({
  "ServerName": ""
}, context)Input
- input object- Description String
- ServerName required ServerName
 
Output
- output CreateBackupResponse
CreateServer
amazonaws_opsworks_cm.CreateServer({
  "ServerName": "",
  "InstanceProfileArn": "",
  "InstanceType": "",
  "ServiceRoleArn": ""
}, context)Input
- input object- AssociatePublicIpAddress Boolean
- BackupId BackupId
- BackupRetentionCount BackupRetentionCountDefinition
- DisableAutomatedBackup Boolean
- Engine String
- EngineAttributes EngineAttributes
- EngineModel String
- EngineVersion String
- InstanceProfileArn required InstanceProfileArn
- InstanceType required String
- KeyPair KeyPair
- PreferredBackupWindow TimeWindowDefinition
- PreferredMaintenanceWindow TimeWindowDefinition
- SecurityGroupIds Strings
- ServerName required ServerName
- ServiceRoleArn required ServiceRoleArn
- SubnetIds Strings
 
Output
- output CreateServerResponse
DeleteBackup
amazonaws_opsworks_cm.DeleteBackup({
  "BackupId": ""
}, context)Input
- input object- BackupId required BackupId
 
Output
- output DeleteBackupResponse
DeleteServer
amazonaws_opsworks_cm.DeleteServer({
  "ServerName": ""
}, context)Input
- input object- ServerName required ServerName
 
Output
- output DeleteServerResponse
DescribeAccountAttributes
amazonaws_opsworks_cm.DescribeAccountAttributes({}, context)Input
- input object
Output
DescribeBackups
amazonaws_opsworks_cm.DescribeBackups({}, context)Input
- input object- BackupId BackupId
- MaxResults MaxResults
- NextToken NextToken
- ServerName ServerName
 
Output
- output DescribeBackupsResponse
DescribeEvents
amazonaws_opsworks_cm.DescribeEvents({
  "ServerName": ""
}, context)Input
- input object- MaxResults MaxResults
- NextToken NextToken
- ServerName required ServerName
 
Output
- output DescribeEventsResponse
DescribeNodeAssociationStatus
amazonaws_opsworks_cm.DescribeNodeAssociationStatus({
  "NodeAssociationStatusToken": "",
  "ServerName": ""
}, context)Input
- input object- NodeAssociationStatusToken required NodeAssociationStatusToken
- ServerName required ServerName
 
Output
DescribeServers
amazonaws_opsworks_cm.DescribeServers({}, context)Input
- input object- MaxResults MaxResults
- NextToken NextToken
- ServerName ServerName
 
Output
- output DescribeServersResponse
DisassociateNode
amazonaws_opsworks_cm.DisassociateNode({
  "ServerName": "",
  "NodeName": ""
}, context)Input
- input object- EngineAttributes EngineAttributes
- NodeName required NodeName
- ServerName required ServerName
 
Output
- output DisassociateNodeResponse
RestoreServer
amazonaws_opsworks_cm.RestoreServer({
  "BackupId": "",
  "ServerName": ""
}, context)Input
- input object- BackupId required BackupId
- InstanceType String
- KeyPair KeyPair
- ServerName required ServerName
 
Output
- output RestoreServerResponse
StartMaintenance
amazonaws_opsworks_cm.StartMaintenance({
  "ServerName": ""
}, context)Input
- input object- EngineAttributes EngineAttributes
- ServerName required ServerName
 
Output
- output StartMaintenanceResponse
UpdateServer
amazonaws_opsworks_cm.UpdateServer({
  "ServerName": ""
}, context)Input
- input object- BackupRetentionCount Integer
- DisableAutomatedBackup Boolean
- PreferredBackupWindow TimeWindowDefinition
- PreferredMaintenanceWindow TimeWindowDefinition
- ServerName required ServerName
 
Output
- output UpdateServerResponse
UpdateServerEngineAttributes
amazonaws_opsworks_cm.UpdateServerEngineAttributes({
  "ServerName": "",
  "AttributeName": ""
}, context)Input
- input object- AttributeName required AttributeName
- AttributeValue AttributeValue
- ServerName required ServerName
 
Output
Definitions
AccountAttribute
AccountAttributes
- AccountAttributes array: A list of individual account attributes.- items AccountAttribute
 
AssociateNodeRequest
- AssociateNodeRequest object- EngineAttributes required EngineAttributes
- NodeName required NodeName
- ServerName required ServerName
 
AssociateNodeResponse
- AssociateNodeResponse object- NodeAssociationStatusToken NodeAssociationStatusToken
 
AttributeName
- AttributeName string
AttributeValue
- AttributeValue string
Backup
- Backup object: Describes a single backup.- BackupArn String
- BackupId BackupId
- BackupType BackupType
- CreatedAt Timestamp
- Description String
- Engine String
- EngineModel String
- EngineVersion String
- InstanceProfileArn String
- InstanceType String
- KeyPair String
- PreferredBackupWindow TimeWindowDefinition
- PreferredMaintenanceWindow TimeWindowDefinition
- S3DataSize Integer
- S3DataUrl String
- S3LogUrl String
- SecurityGroupIds Strings
- ServerName ServerName
- ServiceRoleArn String
- Status BackupStatus
- StatusDescription String
- SubnetIds Strings
- ToolsVersion String
- UserArn String
 
BackupId
- BackupId string
BackupRetentionCountDefinition
- BackupRetentionCountDefinition integer
BackupStatus
- BackupStatus string(values: IN_PROGRESS, OK, FAILED, DELETING)
BackupType
- BackupType string(values: AUTOMATED, MANUAL)
Backups
- Backups array- items Backup
 
Boolean
- Boolean boolean
CreateBackupRequest
- CreateBackupRequest object- Description String
- ServerName required ServerName
 
CreateBackupResponse
- CreateBackupResponse object- Backup Backup
 
CreateServerRequest
- CreateServerRequest object- AssociatePublicIpAddress Boolean
- BackupId BackupId
- BackupRetentionCount BackupRetentionCountDefinition
- DisableAutomatedBackup Boolean
- Engine String
- EngineAttributes EngineAttributes
- EngineModel String
- EngineVersion String
- InstanceProfileArn required InstanceProfileArn
- InstanceType required String
- KeyPair KeyPair
- PreferredBackupWindow TimeWindowDefinition
- PreferredMaintenanceWindow TimeWindowDefinition
- SecurityGroupIds Strings
- ServerName required ServerName
- ServiceRoleArn required ServiceRoleArn
- SubnetIds Strings
 
CreateServerResponse
- CreateServerResponse object- Server Server
 
DeleteBackupRequest
- DeleteBackupRequest object- BackupId required BackupId
 
DeleteBackupResponse
- DeleteBackupResponse object
DeleteServerRequest
- DeleteServerRequest object- ServerName required ServerName
 
DeleteServerResponse
- DeleteServerResponse object
DescribeAccountAttributesRequest
- DescribeAccountAttributesRequest object
DescribeAccountAttributesResponse
- DescribeAccountAttributesResponse object- Attributes AccountAttributes
 
DescribeBackupsRequest
- DescribeBackupsRequest object- BackupId BackupId
- MaxResults MaxResults
- NextToken NextToken
- ServerName ServerName
 
DescribeBackupsResponse
DescribeEventsRequest
- DescribeEventsRequest object- MaxResults MaxResults
- NextToken NextToken
- ServerName required ServerName
 
DescribeEventsResponse
- DescribeEventsResponse object- NextToken String
- ServerEvents ServerEvents
 
DescribeNodeAssociationStatusRequest
- DescribeNodeAssociationStatusRequest object- NodeAssociationStatusToken required NodeAssociationStatusToken
- ServerName required ServerName
 
DescribeNodeAssociationStatusResponse
- DescribeNodeAssociationStatusResponse object- EngineAttributes EngineAttributes
- NodeAssociationStatus NodeAssociationStatus
 
DescribeServersRequest
- DescribeServersRequest object- MaxResults MaxResults
- NextToken NextToken
- ServerName ServerName
 
DescribeServersResponse
DisassociateNodeRequest
- DisassociateNodeRequest object- EngineAttributes EngineAttributes
- NodeName required NodeName
- ServerName required ServerName
 
DisassociateNodeResponse
- DisassociateNodeResponse object- NodeAssociationStatusToken NodeAssociationStatusToken
 
EngineAttribute
- EngineAttribute object: A name and value pair that is specific to the engine of the server.- Name EngineAttributeName
- Value EngineAttributeValue
 
EngineAttributeName
- EngineAttributeName string
EngineAttributeValue
- EngineAttributeValue string
EngineAttributes
- EngineAttributes array- items EngineAttribute
 
InstanceProfileArn
- InstanceProfileArn string
Integer
- Integer integer
InvalidNextTokenException
- InvalidNextTokenException object: This occurs when the provided nextToken is not valid.- Message String
 
InvalidStateException
- InvalidStateException object: The resource is in a state that does not allow you to perform a specified action.- Message String
 
KeyPair
- KeyPair string
LimitExceededException
- LimitExceededException object: The limit of servers or backups has been reached.- Message String
 
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.- Message String
 
ResourceNotFoundException
- ResourceNotFoundException object: The requested resource does not exist, or access was denied.- Message String
 
RestoreServerRequest
- RestoreServerRequest object- BackupId required BackupId
- InstanceType String
- KeyPair KeyPair
- ServerName required ServerName
 
RestoreServerResponse
- RestoreServerResponse object
Server
- Server object: Describes a configuration management server.- AssociatePublicIpAddress Boolean
- BackupRetentionCount Integer
- CloudFormationStackArn String
- CreatedAt Timestamp
- DisableAutomatedBackup Boolean
- Endpoint String
- Engine String
- EngineAttributes EngineAttributes
- EngineModel String
- EngineVersion String
- InstanceProfileArn String
- InstanceType String
- KeyPair String
- MaintenanceStatus MaintenanceStatus
- PreferredBackupWindow TimeWindowDefinition
- PreferredMaintenanceWindow TimeWindowDefinition
- SecurityGroupIds Strings
- ServerArn String
- ServerName String
- ServiceRoleArn String
- Status ServerStatus
- StatusReason String
- SubnetIds Strings
 
ServerEvent
- ServerEvent object: An event that is related to the server, such as the start of maintenance or backup.
ServerEvents
- ServerEvents array- items ServerEvent
 
ServerName
- ServerName string
ServerStatus
- ServerStatus string(values: BACKING_UP, CONNECTION_LOST, CREATING, DELETING, MODIFYING, FAILED, HEALTHY, RUNNING, RESTORING, SETUP, UNDER_MAINTENANCE, UNHEALTHY, TERMINATED)
Servers
- Servers array- items Server
 
ServiceRoleArn
- ServiceRoleArn string
StartMaintenanceRequest
- StartMaintenanceRequest object- EngineAttributes EngineAttributes
- ServerName required ServerName
 
StartMaintenanceResponse
- StartMaintenanceResponse object- Server Server
 
String
- String string
Strings
- Strings array- items String
 
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
- UpdateServerEngineAttributesRequest object- AttributeName required AttributeName
- AttributeValue AttributeValue
- ServerName required ServerName
 
UpdateServerEngineAttributesResponse
- UpdateServerEngineAttributesResponse object- Server Server
 
UpdateServerRequest
- UpdateServerRequest object- BackupRetentionCount Integer
- DisableAutomatedBackup Boolean
- PreferredBackupWindow TimeWindowDefinition
- PreferredMaintenanceWindow TimeWindowDefinition
- ServerName required ServerName
 
UpdateServerResponse
- UpdateServerResponse object- Server Server
 
ValidationException
- ValidationException object: One or more of the provided request parameters are not valid.- Message String