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

CreateServer

Creates and immedately starts a new server. The server is ready to use when it is in the HEALTHY state. By default, you can create a maximum of 10 servers.

This operation is asynchronous.

A LimitExceededException is thrown when you have created the maximum number of servers (10). A ResourceAlreadyExistsException is thrown when a server with the same name already exists in the account. A ResourceNotFoundException is thrown when you specify a backup ID that is not valid or is for a backup that does not exist. A ValidationException is thrown when parameters of the request are not valid.

If you do not specify a security group by adding the SecurityGroupIds parameter, AWS OpsWorks creates a new security group.

Chef Automate: The default security group opens the Chef server to the world on TCP port 443. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is also open to the world on TCP port 22.

Puppet Enterprise: The default security group opens TCP ports 22, 443, 4433, 8140, 8142, 8143, and 8170. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is also open to the world on TCP port 22.

By default, your server is accessible from any IP address. We recommend that you update your security group rules to allow access from known IP addresses and address ranges only. To edit security group rules, open Security Groups in the navigation pane of the EC2 management console.

To specify your own domain for a server, and provide your own self-signed or CA-signed certificate and private key, specify values for CustomDomain, CustomCertificate, and CustomPrivateKey.

Request Syntax

{ "AssociatePublicIpAddress": boolean, "BackupId": "string", "BackupRetentionCount": number, "CustomCertificate": "string", "CustomDomain": "string", "CustomPrivateKey": "string", "DisableAutomatedBackup": boolean, "Engine": "string", "EngineAttributes": [ { "Name": "string", "Value": "string" } ], "EngineModel": "string", "EngineVersion": "string", "InstanceProfileArn": "string", "InstanceType": "string", "KeyPair": "string", "PreferredBackupWindow": "string", "PreferredMaintenanceWindow": "string", "SecurityGroupIds": [ "string" ], "ServerName": "string", "ServiceRoleArn": "string", "SubnetIds": [ "string" ] }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

AssociatePublicIpAddress

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

Type: Boolean

Required: No

BackupId

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

Type: String

Length Constraints: Maximum length of 79.

Pattern: [a-zA-Z][a-zA-Z0-9\-\.\:]*

Required: No

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.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

CustomCertificate

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.

Type: String

Length Constraints: Maximum length of 2097152.

Pattern: (?s)\s*-----BEGIN CERTIFICATE-----.+-----END CERTIFICATE-----\s*

Required: No

CustomDomain

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.

Type: String

Length Constraints: Maximum length of 253.

Pattern: ^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])$

Required: No

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.

Type: String

Length Constraints: Maximum length of 4096.

Pattern: (?ms)\s*^-----BEGIN (?-s:.*)PRIVATE KEY-----$.*?^-----END (?-s:.*)PRIVATE KEY-----$\s*

Required: No

DisableAutomatedBackup

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

Type: Boolean

Required: No

Engine

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

Type: String

Length Constraints: Maximum length of 10000.

Pattern: (?s).*

Required: No

EngineAttributes

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.

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

Length Constraints: Maximum length of 10000.

Pattern: (?s).*

Required: No

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.

Type: String

Length Constraints: Maximum length of 10000.

Pattern: (?s).*

Required: No

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.

Type: String

Length Constraints: Maximum length of 10000.

Pattern: arn:aws:iam::[0-9]{12}:instance-profile/.*

Required: Yes

InstanceType

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

Type: String

Length Constraints: Maximum length of 10000.

Pattern: (?s).*

Required: Yes

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.

Type: String

Length Constraints: Maximum length of 10000.

Pattern: .*

Required: No

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

Type: String

Length Constraints: Maximum length of 10000.

Pattern: ^((Mon|Tue|Wed|Thu|Fri|Sat|Sun):)?([0-1][0-9]|2[0-3]):[0-5][0-9]$

Required: No

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

Type: String

Length Constraints: Maximum length of 10000.

Pattern: ^((Mon|Tue|Wed|Thu|Fri|Sat|Sun):)?([0-1][0-9]|2[0-3]):[0-5][0-9]$

Required: No

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

Type: Array of strings

Length Constraints: Maximum length of 10000.

Pattern: (?s).*

Required: No

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 40.

Pattern: [a-zA-Z][a-zA-Z0-9\-]*

Required: Yes

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.

Type: String

Length Constraints: Maximum length of 10000.

Pattern: arn:aws:iam::[0-9]{12}:role/.*

Required: Yes

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.

Type: Array of strings

Length Constraints: Maximum length of 10000.

Pattern: (?s).*

Required: No

Response Syntax

{ "Server": { "AssociatePublicIpAddress": boolean, "BackupRetentionCount": number, "CloudFormationStackArn": "string", "CreatedAt": number, "CustomDomain": "string", "DisableAutomatedBackup": boolean, "Endpoint": "string", "Engine": "string", "EngineAttributes": [ { "Name": "string", "Value": "string" } ], "EngineModel": "string", "EngineVersion": "string", "InstanceProfileArn": "string", "InstanceType": "string", "KeyPair": "string", "MaintenanceStatus": "string", "PreferredBackupWindow": "string", "PreferredMaintenanceWindow": "string", "SecurityGroupIds": [ "string" ], "ServerArn": "string", "ServerName": "string", "ServiceRoleArn": "string", "Status": "string", "StatusReason": "string", "SubnetIds": [ "string" ] } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Server

The server that is created by the request.

Type: Server object

Errors

For information about the errors that are common to all actions, see Common Errors.

LimitExceededException

The limit of servers or backups has been reached.

HTTP Status Code: 400

ResourceAlreadyExistsException

The requested resource cannot be created because it already exists.

HTTP Status Code: 400

ResourceNotFoundException

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

HTTP Status Code: 400

ValidationException

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

HTTP Status Code: 400

See Also

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