Skip to content

Latest commit

 

History

History

amazonaws_opsworks_cm

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
index.js
index.js
 
 
openapi.json
openapi.json
 
 
package.json
package.json
 
 

README.md

@datafire/amazonaws_opsworks_cm

Client library for AWS OpsWorks CM

Installation and Usage

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

.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. You can use AWS OpsWorks CM to create and manage AWS OpsWorks for Chef Automate and AWS OpsWorks for Puppet Enterprise servers, and add or remove nodes for the servers to manage.

Glossary of terms

  • Server: A configuration management server that can be highly-available. The configuration management server runs on an Amazon Elastic Compute Cloud (EC2) instance, and may use various other AWS services, such as Amazon Relational Database Service (RDS) and Elastic Load Balancing. A server is a generic abstraction over the configuration manager that you want to use, much like Amazon RDS. In AWS OpsWorks CM, you do not start or stop servers. After you create servers, they continue to run until they are deleted.

  • Engine: The engine is the specific configuration manager that you want to use. Valid values in this release include ChefAutomate and Puppet.

  • Backup: This is an application-level backup of the data that the configuration manager stores. AWS OpsWorks CM creates an S3 bucket for backups when you launch the first server. A backup maintains a snapshot of a server's configuration-related attributes at the time the backup starts.

  • Events: Events are always related to a server. Events are written during server creation, when health checks run, when backups are created, when system maintenance is performed, etc. When you delete a server, the server's events are also deleted.

  • Account attributes: Every account has attributes that are assigned in the AWS OpsWorks CM database. These attributes store information about configuration limits (servers, backups, etc.) and your customer account.

Endpoints

AWS OpsWorks CM supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Your servers can only be accessed or managed within the endpoint in which they are created.

  • opsworks-cm.us-east-1.amazonaws.com

  • opsworks-cm.us-east-2.amazonaws.com

  • opsworks-cm.us-west-1.amazonaws.com

  • opsworks-cm.us-west-2.amazonaws.com

  • opsworks-cm.ap-northeast-1.amazonaws.com

  • opsworks-cm.ap-southeast-1.amazonaws.com

  • opsworks-cm.ap-southeast-2.amazonaws.com

  • opsworks-cm.eu-central-1.amazonaws.com

  • opsworks-cm.eu-west-1.amazonaws.com

For more information, see AWS OpsWorks endpoints and quotas in the AWS General Reference.

Throttling limits

All API operations allow for five requests per second with a burst of 10 requests per second.

Actions

AssociateNode

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

Input

  • input object
    • EngineAttributes required
    • NodeName required
    • ServerName required

Output

CreateBackup

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

Input

  • input object
    • Description
    • ServerName required
    • Tags

Output

CreateServer

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

Input

  • input object
    • AssociatePublicIpAddress
    • BackupId
    • BackupRetentionCount
    • CustomCertificate
    • CustomDomain
    • CustomPrivateKey
    • DisableAutomatedBackup
    • Engine required
    • EngineAttributes
    • EngineModel
    • EngineVersion
    • InstanceProfileArn required
    • InstanceType required
    • KeyPair
    • PreferredBackupWindow
    • PreferredMaintenanceWindow
    • SecurityGroupIds
    • ServerName required
    • ServiceRoleArn required
    • SubnetIds
    • Tags

Output

DeleteBackup

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

Input

  • input object
    • BackupId required

Output

DeleteServer

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

Input

  • input object
    • ServerName required

Output

DescribeAccountAttributes

amazonaws_opsworks_cm.DescribeAccountAttributes({}, context)

Input

  • input object

Output

DescribeBackups

amazonaws_opsworks_cm.DescribeBackups({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • BackupId
    • MaxResults
    • NextToken
    • ServerName

Output

DescribeEvents

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

Input

  • input object
    • MaxResults string
    • NextToken string
    • MaxResults
    • NextToken
    • ServerName required

Output

DescribeNodeAssociationStatus

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

Input

  • input object
    • NodeAssociationStatusToken required
    • ServerName required

Output

DescribeServers

amazonaws_opsworks_cm.DescribeServers({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • MaxResults
    • NextToken
    • ServerName

Output

DisassociateNode

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

Input

  • input object
    • EngineAttributes
    • NodeName required
    • ServerName required

Output

ExportServerEngineAttribute

amazonaws_opsworks_cm.ExportServerEngineAttribute({
  "ExportAttributeName": null,
  "ServerName": null
}, context)

Input

  • input object
    • ExportAttributeName required
    • InputAttributes
    • ServerName required

Output

ListTagsForResource

amazonaws_opsworks_cm.ListTagsForResource({
  "ResourceArn": null
}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • MaxResults
    • NextToken
    • ResourceArn required

Output

RestoreServer

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

Input

  • input object
    • BackupId required
    • InstanceType
    • KeyPair
    • ServerName required

Output

StartMaintenance

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

Input

Output

TagResource

amazonaws_opsworks_cm.TagResource({
  "ResourceArn": null,
  "Tags": null
}, context)

Input

  • input object
    • ResourceArn required
    • Tags required

Output

UntagResource

amazonaws_opsworks_cm.UntagResource({
  "ResourceArn": null,
  "TagKeys": null
}, context)

Input

  • input object
    • ResourceArn required
    • TagKeys required

Output

UpdateServer

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

Input

Output

UpdateServerEngineAttributes

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

Input

  • input object
    • AttributeName required
    • AttributeValue
    • ServerName required

Output

Definitions

AWSOpsWorksCMResourceArn

  • AWSOpsWorksCMResourceArn string

AccountAttribute

  • AccountAttribute object: Stores account attributes.
    • Maximum
    • Name
    • Used

AccountAttributes

  • AccountAttributes array: A list of individual account attributes.

AssociateNodeRequest

  • AssociateNodeRequest object
    • EngineAttributes required
    • NodeName required
    • ServerName required

AssociateNodeResponse

  • AssociateNodeResponse object
    • NodeAssociationStatusToken

AttributeName

  • AttributeName string

AttributeValue

  • AttributeValue string

Backup

  • Backup object: Describes a single backup.
    • BackupArn
    • BackupId
    • BackupType
    • CreatedAt
    • Description
    • Engine
    • EngineModel
    • EngineVersion
    • InstanceProfileArn
    • InstanceType
    • KeyPair
    • PreferredBackupWindow
    • PreferredMaintenanceWindow
    • S3DataSize
    • S3DataUrl
    • S3LogUrl
    • SecurityGroupIds
    • ServerName
    • ServiceRoleArn
    • Status
    • StatusDescription
    • SubnetIds
    • ToolsVersion
    • UserArn

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

  • CreateBackupRequest object
    • Description
    • ServerName required
    • Tags

CreateBackupResponse

  • CreateBackupResponse object
    • Backup
      • BackupArn
      • BackupId
      • BackupType
      • CreatedAt
      • Description
      • Engine
      • EngineModel
      • EngineVersion
      • InstanceProfileArn
      • InstanceType
      • KeyPair
      • PreferredBackupWindow
      • PreferredMaintenanceWindow
      • S3DataSize
      • S3DataUrl
      • S3LogUrl
      • SecurityGroupIds
      • ServerName
      • ServiceRoleArn
      • Status
      • StatusDescription
      • SubnetIds
      • ToolsVersion
      • UserArn

CreateServerRequest

  • CreateServerRequest object
    • AssociatePublicIpAddress
    • BackupId
    • BackupRetentionCount
    • CustomCertificate
    • CustomDomain
    • CustomPrivateKey
    • DisableAutomatedBackup
    • Engine required
    • EngineAttributes
    • EngineModel
    • EngineVersion
    • InstanceProfileArn required
    • InstanceType required
    • KeyPair
    • PreferredBackupWindow
    • PreferredMaintenanceWindow
    • SecurityGroupIds
    • ServerName required
    • ServiceRoleArn required
    • SubnetIds
    • Tags

CreateServerResponse

  • CreateServerResponse object
    • Server
      • AssociatePublicIpAddress
      • BackupRetentionCount
      • CloudFormationStackArn
      • CreatedAt
      • CustomDomain
      • DisableAutomatedBackup
      • Endpoint
      • Engine
      • EngineAttributes
      • EngineModel
      • EngineVersion
      • InstanceProfileArn
      • InstanceType
      • KeyPair
      • MaintenanceStatus
      • PreferredBackupWindow
      • PreferredMaintenanceWindow
      • SecurityGroupIds
      • ServerArn
      • ServerName
      • ServiceRoleArn
      • Status
      • StatusReason
      • SubnetIds

CustomCertificate

  • CustomCertificate string

CustomDomain

  • CustomDomain string

CustomPrivateKey

  • CustomPrivateKey string

DeleteBackupRequest

  • DeleteBackupRequest object
    • BackupId required

DeleteBackupResponse

  • DeleteBackupResponse object

DeleteServerRequest

  • DeleteServerRequest object
    • ServerName required

DeleteServerResponse

  • DeleteServerResponse object

DescribeAccountAttributesRequest

  • DescribeAccountAttributesRequest object

DescribeAccountAttributesResponse

DescribeBackupsRequest

  • DescribeBackupsRequest object
    • BackupId
    • MaxResults
    • NextToken
    • ServerName

DescribeBackupsResponse

  • DescribeBackupsResponse object
    • Backups
    • NextToken

DescribeEventsRequest

  • DescribeEventsRequest object
    • MaxResults
    • NextToken
    • ServerName required

DescribeEventsResponse

  • DescribeEventsResponse object

DescribeNodeAssociationStatusRequest

  • DescribeNodeAssociationStatusRequest object
    • NodeAssociationStatusToken required
    • ServerName required

DescribeNodeAssociationStatusResponse

  • DescribeNodeAssociationStatusResponse object

DescribeServersRequest

  • DescribeServersRequest object
    • MaxResults
    • NextToken
    • ServerName

DescribeServersResponse

  • DescribeServersResponse object
    • NextToken
    • Servers

DisassociateNodeRequest

  • DisassociateNodeRequest object
    • EngineAttributes
    • NodeName required
    • ServerName required

DisassociateNodeResponse

  • DisassociateNodeResponse object
    • NodeAssociationStatusToken

EngineAttribute

  • EngineAttribute object: A name and value pair that is specific to the engine of the server.
    • Name
    • Value

EngineAttributeName

  • EngineAttributeName string

EngineAttributeValue

  • EngineAttributeValue string

EngineAttributes

ExportServerEngineAttributeRequest

  • ExportServerEngineAttributeRequest object
    • ExportAttributeName required
    • InputAttributes
    • ServerName required

ExportServerEngineAttributeResponse

  • ExportServerEngineAttributeResponse object
    • EngineAttribute
      • Name
      • Value
    • ServerName

InstanceProfileArn

  • InstanceProfileArn string

Integer

  • Integer integer

InvalidNextTokenException

InvalidStateException

KeyPair

  • KeyPair string

LimitExceededException

ListTagsForResourceRequest

  • ListTagsForResourceRequest object
    • MaxResults
    • NextToken
    • ResourceArn required

ListTagsForResourceResponse

  • ListTagsForResourceResponse object
    • NextToken
    • Tags

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

ResourceNotFoundException

RestoreServerRequest

  • RestoreServerRequest object
    • BackupId required
    • InstanceType
    • KeyPair
    • ServerName required

RestoreServerResponse

  • RestoreServerResponse object

Server

  • Server object: Describes a configuration management server.
    • AssociatePublicIpAddress
    • BackupRetentionCount
    • CloudFormationStackArn
    • CreatedAt
    • CustomDomain
    • DisableAutomatedBackup
    • Endpoint
    • Engine
    • EngineAttributes
    • EngineModel
    • EngineVersion
    • InstanceProfileArn
    • InstanceType
    • KeyPair
    • MaintenanceStatus
    • PreferredBackupWindow
    • PreferredMaintenanceWindow
    • SecurityGroupIds
    • ServerArn
    • ServerName
    • ServiceRoleArn
    • Status
    • StatusReason
    • SubnetIds

ServerEvent

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

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

  • StartMaintenanceRequest object

StartMaintenanceResponse

  • StartMaintenanceResponse object
    • Server
      • AssociatePublicIpAddress
      • BackupRetentionCount
      • CloudFormationStackArn
      • CreatedAt
      • CustomDomain
      • DisableAutomatedBackup
      • Endpoint
      • Engine
      • EngineAttributes
      • EngineModel
      • EngineVersion
      • InstanceProfileArn
      • InstanceType
      • KeyPair
      • MaintenanceStatus
      • PreferredBackupWindow
      • PreferredMaintenanceWindow
      • SecurityGroupIds
      • ServerArn
      • ServerName
      • ServiceRoleArn
      • Status
      • StatusReason
      • SubnetIds

String

  • String string

Strings

Tag

  • Tag object: A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server. Leading and trailing white spaces are trimmed from both the key and value. A maximum of 50 user-applied tags is allowed for tag-supported AWS OpsWorks-CM resources.
    • Key required
    • Value required

TagKey

  • TagKey string

TagKeyList

  • TagKeyList array

TagList

  • TagList array

TagResourceRequest

  • TagResourceRequest object
    • ResourceArn required
    • Tags required

TagResourceResponse

  • TagResourceResponse object

TagValue

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

UntagResourceRequest

  • UntagResourceRequest object
    • ResourceArn required
    • TagKeys required

UntagResourceResponse

  • UntagResourceResponse object

UpdateServerEngineAttributesRequest

  • UpdateServerEngineAttributesRequest object
    • AttributeName required
    • AttributeValue
    • ServerName required

UpdateServerEngineAttributesResponse

  • UpdateServerEngineAttributesResponse object
    • Server
      • AssociatePublicIpAddress
      • BackupRetentionCount
      • CloudFormationStackArn
      • CreatedAt
      • CustomDomain
      • DisableAutomatedBackup
      • Endpoint
      • Engine
      • EngineAttributes
      • EngineModel
      • EngineVersion
      • InstanceProfileArn
      • InstanceType
      • KeyPair
      • MaintenanceStatus
      • PreferredBackupWindow
      • PreferredMaintenanceWindow
      • SecurityGroupIds
      • ServerArn
      • ServerName
      • ServiceRoleArn
      • Status
      • StatusReason
      • SubnetIds

UpdateServerRequest

UpdateServerResponse

  • UpdateServerResponse object
    • Server
      • AssociatePublicIpAddress
      • BackupRetentionCount
      • CloudFormationStackArn
      • CreatedAt
      • CustomDomain
      • DisableAutomatedBackup
      • Endpoint
      • Engine
      • EngineAttributes
      • EngineModel
      • EngineVersion
      • InstanceProfileArn
      • InstanceType
      • KeyPair
      • MaintenanceStatus
      • PreferredBackupWindow
      • PreferredMaintenanceWindow
      • SecurityGroupIds
      • ServerArn
      • ServerName
      • ServiceRoleArn
      • Status
      • StatusReason
      • SubnetIds

ValidationException