API version 2016-11-01 of the Amazon OpsWorks CM SDK configuration.

One or more of the provided request parameters are not valid.

The requested resource cannot be created because it already exists.

This occurs when the provided nextToken is not valid.

The requested resource does not exist, or access was denied.

The resource is in a state that does not allow you to perform a specified action.

The limit of servers or backups has been reached.

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.

Stores account attributes.

See: newAccountAttribute smart constructor.

Create a value of AccountAttribute with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:used:AccountAttribute', accountAttribute_used - The current usage, such as the current number of servers that are associated with the account.

$sel:maximum:AccountAttribute', accountAttribute_maximum - The maximum allowed value.

$sel:name:AccountAttribute', accountAttribute_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.

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.

Describes a single backup.

See: newBackup smart constructor.

Create a value of Backup with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:engineVersion:Backup', backup_engineVersion - The engine version that is obtained from the server when the backup is created.

$sel:serviceRoleArn:Backup', backup_serviceRoleArn - The service role ARN that is obtained from the server when the backup is created.

$sel:status:Backup', backup_status - The status of a backup while in progress.

$sel:instanceProfileArn:Backup', backup_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.

$sel:securityGroupIds:Backup', backup_securityGroupIds - The security group IDs that are obtained from the server when the backup is created.

$sel:statusDescription:Backup', backup_statusDescription - An informational message about backup status.

$sel:serverName:Backup', backup_serverName - The name of the server from which the backup was made.

$sel:subnetIds:Backup', backup_subnetIds - The subnet IDs that are obtained from the server when the backup is created.

$sel:keyPair:Backup', backup_keyPair - The key pair that is obtained from the server when the backup is created.

$sel:createdAt:Backup', backup_createdAt - The time stamp when the backup was created in the database. Example: 2016-07-29T13:38:47.520Z

$sel:backupId:Backup', backup_backupId - The generated ID of the backup. Example: myServerName-yyyyMMddHHmmssSSS

$sel:engine:Backup', backup_engine - The engine type that is obtained from the server when the backup is created.

$sel:instanceType:Backup', backup_instanceType - The instance type that is obtained from the server when the backup is created.

$sel:engineModel:Backup', backup_engineModel - The engine model that is obtained from the server when the backup is created.

$sel:preferredMaintenanceWindow:Backup', backup_preferredMaintenanceWindow - The preferred maintenance period that is obtained from the server when the backup is created.

$sel:userArn:Backup', backup_userArn - The IAM user ARN of the requester for manual backups. This field is empty for automated backups.

$sel:preferredBackupWindow:Backup', backup_preferredBackupWindow - The preferred backup period that is obtained from the server when the backup is created.

$sel:s3LogUrl:Backup', backup_s3LogUrl - The Amazon S3 URL of the backup's log file.

$sel:s3DataSize:Backup', backup_s3DataSize - This field is deprecated and is no longer used.

$sel:backupArn:Backup', backup_backupArn - The ARN of the backup.

$sel:s3DataUrl:Backup', backup_s3DataUrl - This field is deprecated and is no longer used.

$sel:description:Backup', backup_description - A user-provided description for a manual backup. This field is empty for automated backups.

$sel:backupType:Backup', backup_backupType - The backup type. Valid values are automated or manual.

$sel:toolsVersion:Backup', backup_toolsVersion - The version of AWS OpsWorks CM-specific tools that is obtained from the server when the backup is created.

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.

A name and value pair that is specific to the engine of the server.

See: newEngineAttribute smart constructor.

Create a value of EngineAttribute with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:value:EngineAttribute', engineAttribute_value - The value of the engine attribute.

$sel:name:EngineAttribute', engineAttribute_name - The name of the engine attribute.

The value of the engine attribute.

The name of the engine attribute.

Describes a configuration management server.

See: newServer smart constructor.

Create a value of Server with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:engineVersion:Server', server_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.

$sel:serviceRoleArn:Server', server_serviceRoleArn - The service role ARN used to create the server.

$sel:disableAutomatedBackup:Server', server_disableAutomatedBackup - Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.

$sel:status:Server', server_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.

$sel:instanceProfileArn:Server', server_instanceProfileArn - The instance profile ARN of the server.

$sel:securityGroupIds:Server', server_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.

$sel:associatePublicIpAddress:Server', server_associatePublicIpAddress - Associate a public IP address with a server that you are launching.

$sel:serverName:Server', server_serverName - The name of the server.

$sel:subnetIds:Server', server_subnetIds - The subnet IDs specified in a CreateServer request.

$sel:keyPair:Server', server_keyPair - The key pair associated with the server.

$sel:createdAt:Server', server_createdAt - Time stamp of server creation. Example 2016-07-29T13:38:47.520Z

$sel:serverArn:Server', server_serverArn - The ARN of the server.

$sel:customDomain:Server', server_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.

$sel:engine:Server', server_engine - The engine type of the server. Valid values in this release include ChefAutomate and Puppet.

$sel:maintenanceStatus:Server', server_maintenanceStatus - The status of the most recent server maintenance run. Shows SUCCESS or FAILED.

$sel:instanceType:Server', server_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.

$sel:engineModel:Server', server_engineModel - The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.

$sel:engineAttributes:Server', server_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.

$sel:preferredMaintenanceWindow:Server', server_preferredMaintenanceWindow - The preferred maintenance period specified for the server.

$sel:preferredBackupWindow:Server', server_preferredBackupWindow - The preferred backup period specified for the server.

$sel:statusReason:Server', server_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).

$sel:endpoint:Server', server_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.

$sel:cloudFormationStackArn:Server', server_cloudFormationStackArn - The ARN of the CloudFormation stack that was used to create the server.

$sel:backupRetentionCount:Server', server_backupRetentionCount - The number of automated backups to keep.

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.

An event that is related to the server, such as the start of maintenance or backup.

See: newServerEvent smart constructor.

Create a value of ServerEvent with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:logUrl:ServerEvent', serverEvent_logUrl - The Amazon S3 URL of the event's log file.

$sel:serverName:ServerEvent', serverEvent_serverName - The name of the server on or for which the event occurred.

$sel:createdAt:ServerEvent', serverEvent_createdAt - The time when the event occurred.

$sel:message:ServerEvent', serverEvent_message - A human-readable informational or status message.

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

See: newTag smart constructor.