The AWS OpsWorks CM API contains several data types that various actions use. This section describes each data type in detail.
Note
The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.
The following data types are supported:
• AccountAttribute (p. 61)
• Backup (p. 62)
• EngineAttribute (p. 67)
• Server (p. 68)
• ServerEvent (p. 73)
• Tag (p. 75)
AccountAttribute
Stores account attributes.
Contents
Maximum
The maximum allowed value.
Type: Integer Required: No Name
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.
Type: String
Length Constraints: Maximum length of 10000.
Pattern: (?s).*
Required: No Used
The current usage, such as the current number of servers that are associated with the account.
Type: Integer Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2016-11-01 61
Backup
Backup
Describes a single backup.
Contents
BackupArn
The ARN of the backup.
Type: String
Length Constraints: Maximum length of 10000.
Pattern: (?s).*
Required: No BackupId
The generated ID of the backup. Example: myServerName-yyyyMMddHHmmssSSS Type: String
Length Constraints: Maximum length of 79.
Pattern: [a-zA-Z][a-zA-Z0-9\-\.\:]*
Required: No BackupType
The backup type. Valid values are automated or manual.
Type: String
Valid Values: AUTOMATED | MANUAL Required: No
CreatedAt
The time stamp when the backup was created in the database. Example:
2016-07-29T13:38:47.520Z Type: Timestamp
Required: No Description
A user-provided description for a manual backup. This field is empty for automated backups.
Type: String
Length Constraints: Maximum length of 10000.
Pattern: (?s).*
Required: No Engine
The engine type that is obtained from the server when the backup is created.
Type: String
Length Constraints: Maximum length of 10000.
Pattern: (?s).*
Required: No EngineModel
The engine model that is obtained from the server when the backup is created.
Type: String
Length Constraints: Maximum length of 10000.
Pattern: (?s).*
Required: No EngineVersion
The engine version that is obtained from the server when the backup is created.
Type: String
Length Constraints: Maximum length of 10000.
Pattern: (?s).*
Required: No InstanceProfileArn
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.
Type: String
Length Constraints: Maximum length of 10000.
Pattern: (?s).*
Required: No InstanceType
The instance type that is obtained from the server when the backup is created.
Type: String
Length Constraints: Maximum length of 10000.
Pattern: (?s).*
Required: No KeyPair
The key pair that is obtained from the server when the backup is created.
Type: String
Length Constraints: Maximum length of 10000.
API Version 2016-11-01 63
Contents
Pattern: (?s).*
Required: No
PreferredBackupWindow
The preferred backup period that is obtained from the server when the backup is created.
Type: String
Length Constraints: Maximum length of 10000.
Pattern: ^((Mon|Tue|Wed|Thu|Fri|Sat|Sun):)?([0-1][0-9]|2[0-3]):[0-5][0-9]$
Required: No
PreferredMaintenanceWindow
The preferred maintenance period that is obtained from the server when the backup is created.
Type: String
Length Constraints: Maximum length of 10000.
Pattern: ^((Mon|Tue|Wed|Thu|Fri|Sat|Sun):)?([0-1][0-9]|2[0-3]):[0-5][0-9]$
Required: No S3DataSize
This field is deprecated and is no longer used.
Type: Integer Required: No S3DataUrl
This field is deprecated and is no longer used.
Type: String
Length Constraints: Maximum length of 10000.
Pattern: (?s).*
Required: No S3LogUrl
The Amazon S3 URL of the backup's log file.
Type: String
Length Constraints: Maximum length of 10000.
Pattern: (?s).*
Required: No SecurityGroupIds
The security group IDs that are obtained from the server when the backup is created.
Type: Array of strings
Length Constraints: Maximum length of 10000.
Pattern: (?s).*
Required: No ServerName
The name of the server from which the backup was made.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 40.
Pattern: [a-zA-Z][a-zA-Z0-9\-]*
Required: No ServiceRoleArn
The service role ARN that is obtained from the server when the backup is created.
Type: String
Length Constraints: Maximum length of 10000.
Pattern: (?s).*
Required: No Status
The status of a backup while in progress.
Type: String
Valid Values: IN_PROGRESS | OK | FAILED | DELETING Required: No
StatusDescription
An informational message about backup status.
Type: String
Length Constraints: Maximum length of 10000.
Pattern: (?s).*
Required: No SubnetIds
The subnet IDs that are obtained from the server when the backup is created.
Type: Array of strings
Length Constraints: Maximum length of 10000.
Pattern: (?s).*
Required: No ToolsVersion
The version of AWS OpsWorks CM-specific tools that is obtained from the server when the backup is created.
API Version 2016-11-01 65
See Also
Type: String
Length Constraints: Maximum length of 10000.
Pattern: (?s).*
Required: No UserArn
The IAM user ARN of the requester for manual backups. This field is empty for automated backups.
Type: String
Length Constraints: Maximum length of 10000.
Pattern: (?s).*
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
EngineAttribute
A name and value pair that is specific to the engine of the server.
Contents
Name
The name of the engine attribute.
Type: String
Length Constraints: Maximum length of 10000.
Pattern: (?s).*
Required: No Value
The value of the engine attribute.
Type: String
Length Constraints: Maximum length of 10000.
Pattern: (?s).*
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2016-11-01 67
Server
Server
Describes a configuration management server.
Contents
AssociatePublicIpAddress
Associate a public IP address with a server that you are launching.
Type: Boolean Required: No BackupRetentionCount
The number of automated backups to keep.
Type: Integer Required: No
CloudFormationStackArn
The ARN of the CloudFormation stack that was used to create the server.
Type: String
Length Constraints: Maximum length of 10000.
Pattern: (?s).*
Required: No CreatedAt
Time stamp of server creation. Example 2016-07-29T13:38:47.520Z Type: Timestamp
Required: No CustomDomain
An optional public endpoint of a server, such as https://aws.my-company.com. You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.
Type: String
Length Constraints: Maximum length of 253.
Pattern: ^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])$
Required: No
DisableAutomatedBackup
Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.
Type: Boolean
Required: No Endpoint
A DNS name that can be used to access the engine. Example:
myserver-asdfghjkl.us-east-1.opsworks.io. You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.
Type: String
Length Constraints: Maximum length of 10000.
Pattern: (?s).*
Required: No Engine
The engine type of the server. Valid values in this release include ChefAutomate and Puppet.
Type: String
Length Constraints: Maximum length of 10000.
Pattern: (?s).*
Required: No EngineAttributes
The response of a createServer() request returns the master credential to access the server in EngineAttributes. These credentials are not stored by AWS OpsWorks CM; they are returned only as part of the result of createServer().
Attributes returned in a createServer response for Chef
• CHEF_AUTOMATE_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.
Attributes returned in a createServer response for Puppet
• PUPPET_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Puppet starter kit, including a README and a required private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents.
• PUPPET_ADMIN_PASSWORD: An administrator password that you can use to sign in to the Puppet Enterprise console after the server is online.
Type: Array of EngineAttribute (p. 67) objects Required: No
EngineModel
The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.
Type: String
Length Constraints: Maximum length of 10000.
API Version 2016-11-01 69
Contents
Pattern: (?s).*
Required: No EngineVersion
The engine version of the server. For a Chef server, the valid value for EngineVersion is currently 2.
For a Puppet server, specify either 2019 or 2017.
Type: String
Length Constraints: Maximum length of 10000.
Pattern: (?s).*
Required: No InstanceProfileArn
The instance profile ARN of the server.
Type: String
Length Constraints: Maximum length of 10000.
Pattern: (?s).*
Required: No InstanceType
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.
Type: String
Length Constraints: Maximum length of 10000.
Pattern: (?s).*
Required: No KeyPair
The key pair associated with the server.
Type: String
Length Constraints: Maximum length of 10000.
Pattern: (?s).*
Required: No MaintenanceStatus
The status of the most recent server maintenance run. Shows SUCCESS or FAILED.
Type: String
Valid Values: SUCCESS | FAILED Required: No
PreferredBackupWindow
The preferred backup period specified for the server.
Type: String
Length Constraints: Maximum length of 10000.
Pattern: ^((Mon|Tue|Wed|Thu|Fri|Sat|Sun):)?([0-1][0-9]|2[0-3]):[0-5][0-9]$
Required: No
PreferredMaintenanceWindow
The preferred maintenance period specified for the server.
Type: String
Length Constraints: Maximum length of 10000.
Pattern: ^((Mon|Tue|Wed|Thu|Fri|Sat|Sun):)?([0-1][0-9]|2[0-3]):[0-5][0-9]$
Required: No SecurityGroupIds
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.
Type: Array of strings
Length Constraints: Maximum length of 10000.
Pattern: (?s).*
Required: No ServerArn
The ARN of the server.
Type: String
Length Constraints: Maximum length of 10000.
Pattern: (?s).*
Required: No ServerName
The name of the server.
Type: String
Length Constraints: Maximum length of 10000.
Pattern: (?s).*
Required: No ServiceRoleArn
The service role ARN used to create the server.
Type: String
Length Constraints: Maximum length of 10000.
Pattern: (?s).*
API Version 2016-11-01 71
See Also
Required: No Status
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.
Type: String
Valid Values: BACKING_UP | CONNECTION_LOST | CREATING | DELETING | MODIFYING
| FAILED | HEALTHY | RUNNING | RESTORING | SETUP | UNDER_MAINTENANCE | UNHEALTHY | TERMINATED
Required: No StatusReason
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).
Type: String
Length Constraints: Maximum length of 10000.
Pattern: (?s).*
Required: No SubnetIds
The subnet IDs specified in a CreateServer request.
Type: Array of strings
Length Constraints: Maximum length of 10000.
Pattern: (?s).*
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ServerEvent
An event that is related to the server, such as the start of maintenance or backup.
Contents
CreatedAt
The time when the event occurred.
Type: Timestamp Required: No LogUrl
The Amazon S3 URL of the event's log file.
Type: String
Length Constraints: Maximum length of 10000.
Pattern: (?s).*
Required: No Message
A human-readable informational or status message.
Type: String
Length Constraints: Maximum length of 10000.
Pattern: (?s).*
Required: No ServerName
The name of the server on or for which the event occurred.
Type: String
Length Constraints: Maximum length of 10000.
Pattern: (?s).*
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2016-11-01 73
See Also
Tag
A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise server. Leading and trailing 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.
Contents
Key
A tag key, such as Stage or Name. A tag key cannot be empty. The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
Required: Yes Value
An optional tag value, such as Production or test-owcm-server. The value can be a maximum of 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2016-11-01 75