Documentation

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.