The name of the server with which to associate the node.

The name of the node.

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.

Contains a token which can be passed to the DescribeNodeAssociationStatus API call to get the status of the association request.

The response's http status code.

Setting DisableAutomatedBackup to true disables automated or scheduled backups. Automated backups are enabled by default.

Undocumented member.

Undocumented member.

Sets the number of automated backups that you want to keep.

The name of the server to update.

Contains the response to a UpdateServer request.

The response's http status code.

The ID of the server to delete.

The response's http status code.

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.

The response's http status code.

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.

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.

The name of the server for which you want to view events.

Contains the response to a DescribeEvents request.

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.

The response's http status code.

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.

The name of the server from which to disassociate the node.

The name of the client node.

Contains a token which can be passed to the DescribeNodeAssociationStatus API call to get the status of the disassociation request.

The response's http status code.

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 ListTagsForResource 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.

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.

The Amazon Resource Number (ARN) of an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server for which you want to show applied tags. For example, arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE.

A token that you can use as the value of NextToken in subsequent calls to the API to show more results.

Tags that have been applied to the resource.

The response's http status code.

A user-defined description of the backup.

A map that contains tag keys and tag values to attach to an AWS OpsWorks-CM server backup.

• The 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: + - = . _ : /
• The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
• 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.

The name of the server that you want to back up.

Backup created by request.

The response's http status code.

The value to set for the attribute.

The name of the server to update.

The name of the engine attribute to update.

Contains the response to an UpdateServerEngineAttributes request.

The response's http status code.

Engine attributes that are specific to the server on which you want to run maintenance.

Attributes accepted in a StartMaintenance request for Chef

• CHEF_MAJOR_UPGRADE: If a Chef Automate server is eligible for upgrade to Chef Automate 2, add this engine attribute to a StartMaintenance request and set the value to true to upgrade the server to Chef Automate 2. For more information, see Upgrade an AWS OpsWorks for Chef Automate Server to Chef Automate 2.

The name of the server on which to run maintenance.

Contains the response to a StartMaintenance request.

The response's http status code.

Returns backups for the server with the specified ServerName.

Describes a single backup.

This is not currently implemented for DescribeBackups requests.

This is not currently implemented for DescribeBackups requests.

Contains the response to a DescribeBackups request.

This is not currently implemented for DescribeBackups requests.

The response's http status code.

The major release version of the engine that you want to use. For a Chef server, the valid value for EngineVersion is currently 2. For a Puppet server, valid values are 2019 or 2017.

Enable or disable scheduled backups. Valid values are true or false. The default value is true.

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).

Associate a public IP address with a server that you are launching. Valid values are true or false. The default value is true.

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.

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.

If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.

An optional public endpoint of a server, such as https://aws.my-company.com. To access the server, create a CNAME DNS record in your preferred DNS service that points the custom domain to the endpoint that is generated when the server is created (the value of the CreateServer Endpoint attribute). You cannot access the server by using the generated Endpoint value if the server is using a custom domain. If you specify a custom domain, you must also specify values for CustomCertificate and CustomPrivateKey.

A private key in PEM format for connecting to the server by using HTTPS. The private key must not be encrypted; it cannot be protected by a password or passphrase. If you specify a custom private key, you must also specify values for CustomDomain and CustomCertificate.

The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.

Optional engine attributes on a specified server.

Attributes accepted in a Chef createServer request:

• CHEF_AUTOMATE_PIVOTAL_KEY: A base64-encoded RSA public key. The corresponding private key is required to access the Chef API. When no CHEF_AUTOMATE_PIVOTAL_KEY is set, a private key is generated and returned in the response.
• CHEF_AUTOMATE_ADMIN_PASSWORD: The password for the administrative user in the Chef Automate web-based dashboard. 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_AUTOMATE_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.
• PUPPET_R10K_REMOTE: The r10k remote is the URL of your control repository (for example, ssh://git@your.git-repo.com:user/control-repo.git). Specifying an r10k remote opens TCP port 8170.
• PUPPET_R10K_PRIVATE_KEY: If you are using a private Git repository, add PUPPET_R10K_PRIVATE_KEY to specify a PEM-encoded private SSH key.

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. MM must be specified as 00. 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.)

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

MM must be specified as 00. 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.)

A PEM-formatted HTTPS certificate. The value can be be a single, self-signed certificate, or a certificate chain. If you specify a custom certificate, you must also specify values for CustomDomain and CustomPrivateKey. The following are requirements for the CustomCertificate value:

• You can provide either a self-signed, custom certificate, or the full certificate chain.
• The certificate must be a valid X509 certificate, or a certificate chain in PEM format.
• The certificate must be valid at the time of upload. A certificate can't be used before its validity period begins (the certificate's NotBefore date), or after it expires (the certificate's NotAfter date).
• The certificate’s common name or subject alternative names (SANs), if present, must match the value of CustomDomain.
• The certificate must match the value of CustomPrivateKey.

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.

• The 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: + - = . _ : / @
• The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / @
• Leading and trailing white spaces are trimmed from both the key and value.
• A maximum of 50 user-applied tags is allowed for any AWS OpsWorks-CM server.

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.

The configuration management engine to use. Valid values include ChefAutomate and Puppet.

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.

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.

The Amazon EC2 instance type to use. For example, m5.large.

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.

The server that is created by the request.

The response's http status code.

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.

The type of instance to restore. Valid values must be specified in the following format: ^([cm][34]|t2).* For example, m5.large. Valid values are m5.large, r5.xlarge, and r5.2xlarge. If you do not specify this parameter, RestoreServer uses the instance type from the specified backup.

The ID of the backup that you want to use to restore a server.

The name of the server that you want to restore.

Undocumented member.

The response's http status code.

The token returned in either the AssociateNodeResponse or the DisassociateNodeResponse.

The name of the server from which to disassociate the node.

Attributes specific to the node association. In Puppet, the attibute PUPPET_NODE_CERT contains the signed certificate (the result of the CSR).

The response's http status code.

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.

The Amazon Resource Number (ARN) of a resource to which you want to apply tags. For example, arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE.

A map that contains tag keys and tag values to attach to AWS OpsWorks-CM servers or backups.

• The 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: + - = . _ : /
• The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
• Leading and trailing white spaces are trimmed from both the key and value.
• A maximum of 50 user-applied tags is allowed for any AWS OpsWorks-CM server or backup.

The response's http status code.

The attributes that are currently set for the account.

The response's http status code.

The Amazon Resource Number (ARN) of a resource from which you want to remove tags. For example, arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE.

The keys of tags that you want to remove.

The response's http status code.

Describes the server with the specified ServerName.

This is not currently implemented for DescribeServers requests.

This is not currently implemented for DescribeServers requests.

Contains the response to a DescribeServers request.

For Chef Automate servers: If DescribeServersResponse$Servers$EngineAttributes includes CHEF_MAJOR_UPGRADE_AVAILABLE, you can upgrade the Chef Automate server to Chef Automate 2. To be eligible for upgrade, a server running Chef Automate 1 must have had at least one successful maintenance run after November 1, 2019.

For Puppet servers: DescribeServersResponse$Servers$EngineAttributes contains the following two responses:

• PUPPET_API_CA_CERT, 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.
• PUPPET_API_CRL, a certificate revocation list. The certificate revocation list is for internal maintenance purposes only. For more information about the Puppet certificate revocation list, see Man Page: puppet certificate_revocation_list in the Puppet documentation.

This is not currently implemented for DescribeServers requests.

The response's http status code.

The list of engine attributes. The list type is EngineAttribute. An EngineAttribute list item is a pair that includes an attribute name and its value. For the Userdata ExportAttributeName, the following are supported engine attribute names.

• RunList In Chef, a list of roles or recipes that are run in the specified order. In Puppet, this parameter is ignored.
• OrganizationName In Chef, an organization name. AWS OpsWorks for Chef Automate always creates the organization default. In Puppet, this parameter is ignored.
• NodeEnvironment In Chef, a node environment (for example, development, staging, or one-box). In Puppet, this parameter is ignored.
• NodeClientVersion In Chef, the version of the Chef engine (three numbers separated by dots, such as 13.8.5). If this attribute is empty, OpsWorks for Chef Automate uses the most current version. In Puppet, this parameter is ignored.

The name of the export attribute. Currently, the supported export attribute is Userdata. This exports a user data script that includes parameters and values provided in the InputAttributes list.

The name of the server from which you are exporting the attribute.

The server name used in the request.

The requested engine attribute pair with attribute name and value.

The response's http status code.

The current usage, such as the current number of servers that are associated with the account.

The maximum allowed value.

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.

The engine version that is obtained from the server when the backup is created.

The service role ARN that is obtained from the server when the backup is created.

The status of a backup while in progress.

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.

The security group IDs that are obtained from the server when the backup is created.

An informational message about backup status.

The name of the server from which the backup was made.

The subnet IDs that are obtained from the server when the backup is created.

The key pair that is obtained from the server when the backup is created.

The time stamp when the backup was created in the database. Example: 2016-07-29T13:38:47.520Z

The generated ID of the backup. Example: myServerName-yyyyMMddHHmmssSSS

The engine type that is obtained from the server when the backup is created.

The instance type that is obtained from the server when the backup is created.

The engine model that is obtained from the server when the backup is created.

The preferred maintenance period that is obtained from the server when the backup is created.

The IAM user ARN of the requester for manual backups. This field is empty for automated backups.

The preferred backup period that is obtained from the server when the backup is created.

The Amazon S3 URL of the backup's log file.

This field is deprecated and is no longer used.

The ARN of the backup.

This field is deprecated and is no longer used.

A user-provided description for a manual backup. This field is empty for automated backups.

The backup type. Valid values are automated or manual.

The version of AWS OpsWorks CM-specific tools that is obtained from the server when the backup is created.

The value of the engine attribute.

The name of the engine attribute.

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.

The service role ARN used to create the server.

Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.

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.

The instance profile ARN of the server.

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.

Associate a public IP address with a server that you are launching.

The name of the server.

The subnet IDs specified in a CreateServer request.

The key pair associated with the server.

Time stamp of server creation. Example 2016-07-29T13:38:47.520Z

The ARN of the server.

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.

The engine type of the server. Valid values in this release include ChefAutomate and Puppet.

The status of the most recent server maintenance run. Shows SUCCESS or FAILED.

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.

The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.

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.

The preferred maintenance period specified for the server.

The preferred backup period specified for the server.

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).

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.

The ARN of the CloudFormation stack that was used to create the server.

The number of automated backups to keep.

The Amazon S3 URL of the event's log file.

The name of the server on or for which the event occurred.

The time when the event occurred.

A human-readable informational or status message.

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: + - = . _ : /

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: + - = . _ : /