String 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.
Integer maximum
The maximum allowed value.
Integer used
The current usage, such as the current number of servers that are associated with the account.
String serverName
The name of the server with which to associate the node.
String nodeName
The name of the node.
List<E> engineAttributes
Engine attributes used for associating the node.
Attributes accepted in a AssociateNode request for Chef
CHEF_ORGANIZATION: The Chef organization with which the node is associated. By default only one
organization named default can exist.
CHEF_NODE_PUBLIC_KEY: A PEM-formatted public key. This key is required for the
chef-client agent to access the Chef API.
Attributes accepted in a AssociateNode request for Puppet
PUPPET_NODE_CSR: A PEM-formatted certificate-signing request (CSR) that is created by the node.
String nodeAssociationStatusToken
Contains a token which can be passed to the DescribeNodeAssociationStatus API call to get the status
of the association request.
String backupArn
The ARN of the backup.
String backupId
The generated ID of the backup. Example: myServerName-yyyyMMddHHmmssSSS
String backupType
The backup type. Valid values are automated or manual.
Date createdAt
The time stamp when the backup was created in the database. Example: 2016-07-29T13:38:47.520Z
String description
A user-provided description for a manual backup. This field is empty for automated backups.
String engine
The engine type that is obtained from the server when the backup is created.
String engineModel
The engine model that is obtained from the server when the backup is created.
String engineVersion
The engine version that is obtained from the server when the backup is created.
String 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.
String instanceType
The instance type that is obtained from the server when the backup is created.
String keyPair
The key pair that is obtained from the server when the backup is created.
String preferredBackupWindow
The preferred backup period that is obtained from the server when the backup is created.
String preferredMaintenanceWindow
The preferred maintenance period that is obtained from the server when the backup is created.
Integer s3DataSize
This field is deprecated and is no longer used.
String s3DataUrl
This field is deprecated and is no longer used.
String s3LogUrl
The Amazon S3 URL of the backup's log file.
List<E> securityGroupIds
The security group IDs that are obtained from the server when the backup is created.
String serverName
The name of the server from which the backup was made.
String serviceRoleArn
The service role ARN that is obtained from the server when the backup is created.
String status
The status of a backup while in progress.
String statusDescription
An informational message about backup status.
List<E> subnetIds
The subnet IDs that are obtained from the server when the backup is created.
String toolsVersion
The version of AWS OpsWorks CM-specific tools that is obtained from the server when the backup is created.
String userArn
The IAM user ARN of the requester for manual backups. This field is empty for automated backups.
Backup backup
Backup created by request.
Boolean associatePublicIpAddress
Associate a public IP address with a server that you are launching. Valid values are true or
false. The default value is true.
Boolean disableAutomatedBackup
Enable or disable scheduled backups. Valid values are true or false. The default value
is true.
String engine
The configuration management engine to use. Valid values include Chef and Puppet.
String engineModel
The engine model of the server. Valid values in this release include Monolithic for Puppet and
Single for Chef.
String engineVersion
The major release version of the engine that you want to use. For a Chef server, the valid value for
EngineVersion is currently 12. For a Puppet server, the valid value is 2017.
List<E> engineAttributes
Optional engine attributes on a specified server.
Attributes accepted in a Chef createServer request:
CHEF_PIVOTAL_KEY: A base64-encoded RSA private key that is not stored by AWS OpsWorks for Chef
Automate. This private key is required to access the Chef API. When no CHEF_PIVOTAL_KEY is set, one is generated
and returned in the response.
CHEF_DELIVERY_ADMIN_PASSWORD: The password for the administrative user in the Chef Automate GUI. The
password length is a minimum of eight characters, and a maximum of 32. The password can contain letters, numbers,
and special characters (!/@#$%^&+=_). The password must contain at least one lower case letter, one upper
case letter, one number, and one special character. When no CHEF_DELIVERY_ADMIN_PASSWORD is set, one is generated
and returned in the response.
Attributes accepted in a Puppet createServer request:
PUPPET_ADMIN_PASSWORD: To work with the Puppet Enterprise console, a password must use ASCII
characters.
Integer backupRetentionCount
The number of automated backups that you want to keep. Whenever a new backup is created, AWS OpsWorks CM deletes
the oldest backups if this number is exceeded. The default value is 1.
String serverName
The name of the server. The server name must be unique within your AWS account, within each region. Server names must start with a letter; then letters, numbers, or hyphens (-) are allowed, up to a maximum of 40 characters.
String instanceProfileArn
The ARN of the instance profile that your Amazon EC2 instances use. Although the AWS OpsWorks console typically creates the instance profile for you, if you are using API commands instead, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template creates a CloudFormation stack that includes the instance profile you need.
String instanceType
The Amazon EC2 instance type to use. For example, m4.large. Recommended instance types include
t2.medium and greater, m4.*, or c4.xlarge and greater.
String keyPair
The Amazon EC2 key pair to set for the instance. This parameter is optional; if desired, you may specify this parameter to connect to your instances by using SSH.
String preferredMaintenanceWindow
The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance.
Valid values must be specified in the following format: DDD:HH:MM. The specified time is in
coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday.
See TimeWindowDefinition for more information.
Example: Mon:08:00, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)
String preferredBackupWindow
The start time for a one-hour period during which AWS OpsWorks CM backs up application-level data on your server if automated backups are enabled. Valid values must be specified in one of the following formats:
HH:MM for daily backups
DDD:HH:MM for weekly backups
The specified time is in coordinated universal time (UTC). The default value is a random, daily start time.
Example: 08:00, which represents a daily start time of 08:00 UTC.
Example: Mon:08:00, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)
List<E> securityGroupIds
A list of security group IDs to attach to the Amazon EC2 instance. If you add this parameter, the specified
security groups must be within the VPC that is specified by SubnetIds.
If you do not specify this parameter, AWS OpsWorks CM creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone).
String serviceRoleArn
The service role that the AWS OpsWorks CM service backend uses to work with your account. Although the AWS OpsWorks management console typically creates the service role for you, if you are using the AWS CLI or API commands, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template creates a CloudFormation stack that includes the service role and instance profile that you need.
List<E> subnetIds
The IDs of subnets in which to launch the server EC2 instance.
Amazon EC2-Classic customers: This field is required. All servers must run within a VPC. The VPC must have "Auto Assign Public IP" enabled.
EC2-VPC customers: This field is optional. If you do not specify subnet IDs, your EC2 instances are created in a default subnet that is selected by Amazon EC2. If you specify subnet IDs, the VPC must have "Auto Assign Public IP" enabled.
For more information about supported Amazon EC2 platforms, see Supported Platforms.
String backupId
If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.
Server server
The server that is created by the request.
String backupId
The ID of the backup to delete. Run the DescribeBackups command to get a list of backup IDs. Backup IDs are in
the format ServerName-yyyyMMddHHmmssSSS.
String serverName
The ID of the server to delete.
String backupId
Describes a single backup.
String serverName
Returns backups for the server with the specified ServerName.
String nextToken
This is not currently implemented for DescribeBackups requests.
Integer maxResults
This is not currently implemented for DescribeBackups requests.
String serverName
The name of the server for which you want to view events.
String nextToken
NextToken is a string that is returned in some command responses. It indicates that not all entries have been
returned, and that you must run at least one more request to get remaining items. To get remaining results, call
DescribeEvents again, and assign the token from the previous results as the value of the
nextToken parameter. If there are no more results, the response object's nextToken
parameter value is null. Setting a nextToken value that was not returned in your
previous results causes an InvalidNextTokenException to occur.
Integer maxResults
To receive a paginated response, use this parameter to specify the maximum number of results to be returned with
a single call. If the number of available results exceeds this maximum, the response includes a
NextToken value that you can assign to the NextToken request parameter to get the next
set of results.
List<E> serverEvents
Contains the response to a DescribeEvents request.
String nextToken
NextToken is a string that is returned in some command responses. It indicates that not all entries have been
returned, and that you must run at least one more request to get remaining items. To get remaining results, call
DescribeEvents again, and assign the token from the previous results as the value of the
nextToken parameter. If there are no more results, the response object's nextToken
parameter value is null. Setting a nextToken value that was not returned in your
previous results causes an InvalidNextTokenException to occur.
String nodeAssociationStatus
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.
List<E> engineAttributes
Attributes specific to the node association. In Puppet, the attibute PUPPET_NODE_CERT contains the signed certificate (the result of the CSR).
List<E> servers
Contains the response to a DescribeServers request.
For Puppet Server: DescribeServersResponse$Servers$EngineAttributes contains
PUPPET_API_CA_CERT. This is the PEM-encoded CA certificate that is used by the Puppet API over TCP port number
8140. The CA certificate is also used to sign node certificates.
String nextToken
This is not currently implemented for DescribeServers requests.
String serverName
The name of the server from which to disassociate the node.
String nodeName
The name of the client node.
List<E> engineAttributes
Engine attributes that are used for disassociating the node. No attributes are required for Puppet.
Attributes required in a DisassociateNode request for Chef
CHEF_ORGANIZATION: The Chef organization with which the node was associated. By default only one
organization named default can exist.
String nodeAssociationStatusToken
Contains a token which can be passed to the DescribeNodeAssociationStatus API call to get the status
of the disassociation request.
String exportAttributeName
The name of the export attribute. Currently supported export attribute is "Userdata" which exports a userdata
script filled out with parameters provided in the InputAttributes list.
String serverName
The name of the Server to which the attribute is being exported from
List<E> inputAttributes
The list of engine attributes. The list type is EngineAttribute. EngineAttribute is a
pair of attribute name and value. For ExportAttributeName "Userdata", currently supported input
attribute names are: - "RunList": For Chef, an ordered list of roles and/or recipes that are run in the exact
order. For Puppet, this parameter is ignored. - "OrganizationName": For Chef, an organization name. AWS OpsWorks
for Chef Server always creates the organization "default". For Puppet, this parameter is ignored. -
"NodeEnvironment": For Chef, a node environment (eg. development, staging, onebox). For Puppet, this parameter is
ignored. - "NodeClientVersion": For Chef, version of Chef Engine (3 numbers separated by dots, eg. "13.8.5"). If
empty, it uses the latest one. For Puppet, this parameter is ignored.
EngineAttribute engineAttribute
The requested engine attribute pair with attribute name and value.
String serverName
The requested ServerName.
String backupId
The ID of the backup that you want to use to restore a server.
String serverName
The name of the server that you want to restore.
String instanceType
The type of the instance to create. Valid values must be specified in the following format:
^([cm][34]|t2).* For example, m4.large. Valid values are t2.medium,
m4.large, and m4.2xlarge. If you do not specify this parameter, RestoreServer uses the
instance type from the specified backup.
String keyPair
The name of the key pair to set on the new EC2 instance. This can be helpful if the administrator no longer has the SSH key.
Boolean associatePublicIpAddress
Associate a public IP address with a server that you are launching.
Integer backupRetentionCount
The number of automated backups to keep.
String serverName
The name of the server.
Date createdAt
Time stamp of server creation. Example 2016-07-29T13:38:47.520Z
String cloudFormationStackArn
The ARN of the CloudFormation stack that was used to create the server.
Boolean disableAutomatedBackup
Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.
String endpoint
A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io
String engine
The engine type of the server. Valid values in this release include Chef and Puppet.
String engineModel
The engine model of the server. Valid values in this release include Monolithic for Puppet and
Single for Chef.
List<E> 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_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.
String engineVersion
The engine version of the server. For a Chef server, the valid value for EngineVersion is currently
12. For a Puppet server, the valid value is 2017.
String instanceProfileArn
The instance profile ARN of the server.
String 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.
String keyPair
The key pair associated with the server.
String maintenanceStatus
The status of the most recent server maintenance run. Shows SUCCESS or FAILED.
String preferredMaintenanceWindow
The preferred maintenance period specified for the server.
String preferredBackupWindow
The preferred backup period specified for the server.
List<E> 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.
String serviceRoleArn
The service role ARN used to create the server.
String 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.
String 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).
List<E> subnetIds
The subnet IDs specified in a CreateServer request.
String serverArn
The ARN of the server.
Server server
Contains the response to a StartMaintenance request.
Server server
Contains the response to an UpdateServerEngineAttributes request.
Boolean disableAutomatedBackup
Setting DisableAutomatedBackup to true disables automated or scheduled backups. Automated backups
are enabled by default.
Integer backupRetentionCount
Sets the number of automated backups that you want to keep.
String serverName
The name of the server to update.
String preferredMaintenanceWindow
String preferredBackupWindow
Server server
Contains the response to a UpdateServer request.
Copyright © 2018. All rights reserved.