Menu
AWS OpsWorks CM
API Reference (API Version 2016-11-01)

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

Required: No

CreatedAt

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

Type: Timestamp

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

Type: String

Required: No

Engine

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

Type: String

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

Required: No

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.

Type: String

Required: No

InstanceProfileArn

The instance profile ARN of the server.

Type: String

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

Required: No

KeyPair

The key pair associated with the server.

Type: String

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

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

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

Required: No

ServerArn

The ARN of the server.

Type: String

Required: No

ServerName

The name of the server.

Type: String

Required: No

ServiceRoleArn

The service role ARN used to create the server.

Type: String

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

Required: No

SubnetIds

The subnet IDs specified in a CreateServer request.

Type: Array of strings

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: