opsworkscm/aws.sdk.kotlin.services.opsworkscm.model/CreateServerRequest/Builder

Builder

Properties

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

backupId

var backupId: String?

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

backupRetentionCount

var backupRetentionCount: Int?

The number of automated backups that you want to keep. Whenever a new backup is created, OpsWorks CM deletes the oldest backups if this number is exceeded. The default value is 1.

customCertificate

var customCertificate: String?

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:

customDomain

var customDomain: String?

An optional public endpoint of a server, such as http://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.

customPrivateKey

var customPrivateKey: String?

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.

disableAutomatedBackup

var disableAutomatedBackup: Boolean?

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

engine

var engine: String?

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

engineAttributes

var engineAttributes: List<EngineAttribute>?

Optional engine attributes on a specified server.

engineModel

var engineModel: String?

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

engineVersion

var engineVersion: String?

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.

instanceProfileArn

var instanceProfileArn: String?

The ARN of the instance profile that your Amazon EC2 instances use. The OpsWorks console typically creates the instance profile for you

instanceType

var instanceType: String?

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

keyPair

var keyPair: String?

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.

preferredBackupWindow

var preferredBackupWindow: String?

The start time for a one-hour period during which 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:

preferredMaintenanceWindow

var preferredMaintenanceWindow: String?

The start time for a one-hour period each week during which 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.

securityGroupIds

var securityGroupIds: List<String>?

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.

serverName

var serverName: String?

The name of the server. The server name must be unique within your Amazon Web Services 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.

serviceRoleArn

var serviceRoleArn: String?

The service role that the OpsWorks CM service backend uses to work with your account.

subnetIds

var subnetIds: List<String>?

The IDs of subnets in which to launch the server EC2 instance.