CreateServerRequest.Builder (AWS SDK for Java

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<CreateServerRequest.Builder,CreateServerRequest>, OpsWorksCmRequest.Builder, SdkBuilder<CreateServerRequest.Builder,CreateServerRequest>, SdkRequest.Builder

Enclosing class:

CreateServerRequest
```
public static interface CreateServerRequest.Builder
extends OpsWorksCmRequest.Builder, CopyableBuilder<CreateServerRequest.Builder,CreateServerRequest>
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CreateServerRequest.Builder`	`associatePublicIpAddress(Boolean associatePublicIpAddress)` Associate a public IP address with a server that you are launching.
`CreateServerRequest.Builder`	`backupId(String backupId)` If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.
`CreateServerRequest.Builder`	`backupRetentionCount(Integer backupRetentionCount)` The number of automated backups that you want to keep.
`CreateServerRequest.Builder`	`disableAutomatedBackup(Boolean disableAutomatedBackup)` Enable or disable scheduled backups.
`CreateServerRequest.Builder`	`engine(String engine)` The configuration management engine to use.
`CreateServerRequest.Builder`	`engineAttributes(Collection<EngineAttribute> engineAttributes)` Optional engine attributes on a specified server.
`CreateServerRequest.Builder`	`engineAttributes(Consumer<EngineAttribute.Builder>... engineAttributes)` Optional engine attributes on a specified server.
`CreateServerRequest.Builder`	`engineAttributes(EngineAttribute... engineAttributes)` Optional engine attributes on a specified server.
`CreateServerRequest.Builder`	`engineModel(String engineModel)` The engine model of the server.
`CreateServerRequest.Builder`	`engineVersion(String engineVersion)` The major release version of the engine that you want to use.
`CreateServerRequest.Builder`	`instanceProfileArn(String instanceProfileArn)` The ARN of the instance profile that your Amazon EC2 instances use.
`CreateServerRequest.Builder`	`instanceType(String instanceType)` The Amazon EC2 instance type to use.
`CreateServerRequest.Builder`	`keyPair(String keyPair)` The Amazon EC2 key pair to set for the instance.
`CreateServerRequest.Builder`	`overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)` Add an optional request override configuration.
`CreateServerRequest.Builder`	`overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)` Add an optional request override configuration.
`CreateServerRequest.Builder`	`preferredBackupWindow(String 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.
`CreateServerRequest.Builder`	`preferredMaintenanceWindow(String preferredMaintenanceWindow)` The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance.
`CreateServerRequest.Builder`	`securityGroupIds(Collection<String> securityGroupIds)` A list of security group IDs to attach to the Amazon EC2 instance.
`CreateServerRequest.Builder`	`securityGroupIds(String... securityGroupIds)` A list of security group IDs to attach to the Amazon EC2 instance.
`CreateServerRequest.Builder`	`serverName(String serverName)` The name of the server.
`CreateServerRequest.Builder`	`serviceRoleArn(String serviceRoleArn)` The service role that the AWS OpsWorks CM service backend uses to work with your account.
`CreateServerRequest.Builder`	`subnetIds(Collection<String> subnetIds)` The IDs of subnets in which to launch the server EC2 instance.
`CreateServerRequest.Builder`	`subnetIds(String... subnetIds)` The IDs of subnets in which to launch the server EC2 instance.

Methods inherited from interface software.amazon.awssdk.services.opsworkscm.model.OpsWorksCmRequest.Builder
build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - associatePublicIpAddress
```
CreateServerRequest.Builder associatePublicIpAddress(Boolean associatePublicIpAddress)
```
    Associate a public IP address with a server that you are launching. Valid values are true or false. The default value is true.
    
    Parameters:
    
    associatePublicIpAddress - Associate a public IP address with a server that you are launching. Valid values are true or false. The default value is true.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - disableAutomatedBackup
```
CreateServerRequest.Builder disableAutomatedBackup(Boolean disableAutomatedBackup)
```
    Enable or disable scheduled backups. Valid values are true or false. The default value is true.
    
    Parameters:
    
    disableAutomatedBackup - Enable or disable scheduled backups. Valid values are true or false. The default value is true.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - engine
```
CreateServerRequest.Builder engine(String engine)
```
    The configuration management engine to use. Valid values include Chef and Puppet.
    
    Parameters:
    
    engine - The configuration management engine to use. Valid values include Chef and Puppet.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - engineModel
```
CreateServerRequest.Builder engineModel(String engineModel)
```
    The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.
    
    Parameters:
    
    engineModel - The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - engineVersion
```
CreateServerRequest.Builder engineVersion(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - engineAttributes
```
CreateServerRequest.Builder engineAttributes(Collection<EngineAttribute> engineAttributes)
```
    Optional engine attributes on a specified server.
    
    Attributes accepted in a Chef createServer request:
    - CHEF_PIVOTAL_KEY: A base64-encoded RSA private key that is not stored by AWS OpsWorks for Chef Automate. This private key is required to access the Chef API. When no CHEF_PIVOTAL_KEY is set, one is generated and returned in the response.
    - CHEF_DELIVERY_ADMIN_PASSWORD: The password for the administrative user in the Chef Automate GUI. 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_DELIVERY_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.
    Parameters:
    engineAttributes - Optional engine attributes on a specified server.
    
    Attributes accepted in a Chef createServer request:
    
    CHEF_PIVOTAL_KEY: A base64-encoded RSA private key that is not stored by AWS OpsWorks for Chef Automate. This private key is required to access the Chef API. When no CHEF_PIVOTAL_KEY is set, one is generated and returned in the response.
    
    CHEF_DELIVERY_ADMIN_PASSWORD: The password for the administrative user in the Chef Automate GUI. 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_DELIVERY_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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - engineAttributes
```
CreateServerRequest.Builder engineAttributes(EngineAttribute... engineAttributes)
```
    Optional engine attributes on a specified server.
    
    Attributes accepted in a Chef createServer request:
    - CHEF_PIVOTAL_KEY: A base64-encoded RSA private key that is not stored by AWS OpsWorks for Chef Automate. This private key is required to access the Chef API. When no CHEF_PIVOTAL_KEY is set, one is generated and returned in the response.
    - CHEF_DELIVERY_ADMIN_PASSWORD: The password for the administrative user in the Chef Automate GUI. 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_DELIVERY_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.
    Parameters:
    engineAttributes - Optional engine attributes on a specified server.
    
    Attributes accepted in a Chef createServer request:
    
    CHEF_PIVOTAL_KEY: A base64-encoded RSA private key that is not stored by AWS OpsWorks for Chef Automate. This private key is required to access the Chef API. When no CHEF_PIVOTAL_KEY is set, one is generated and returned in the response.
    
    CHEF_DELIVERY_ADMIN_PASSWORD: The password for the administrative user in the Chef Automate GUI. 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_DELIVERY_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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - engineAttributes
```
CreateServerRequest.Builder engineAttributes(Consumer<EngineAttribute.Builder>... engineAttributes)
```
    Optional engine attributes on a specified server.
    
    Attributes accepted in a Chef createServer request:
    - CHEF_PIVOTAL_KEY: A base64-encoded RSA private key that is not stored by AWS OpsWorks for Chef Automate. This private key is required to access the Chef API. When no CHEF_PIVOTAL_KEY is set, one is generated and returned in the response.
    - CHEF_DELIVERY_ADMIN_PASSWORD: The password for the administrative user in the Chef Automate GUI. 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_DELIVERY_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.
    This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #engineAttributes(List).
    Parameters:
    
    engineAttributes - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #engineAttributes(List)
  - backupRetentionCount
```
CreateServerRequest.Builder backupRetentionCount(Integer 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - serverName
```
CreateServerRequest.Builder serverName(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - instanceProfileArn
```
CreateServerRequest.Builder instanceProfileArn(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - instanceType
```
CreateServerRequest.Builder instanceType(String instanceType)
```
    The Amazon EC2 instance type to use. For example, m4.large. Recommended instance types include t2.medium and greater, m4.*, or c4.xlarge and greater.
    
    Parameters:
    
    instanceType - The Amazon EC2 instance type to use. For example, m4.large. Recommended instance types include t2.medium and greater, m4.*, or c4.xlarge and greater.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - keyPair
```
CreateServerRequest.Builder keyPair(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - preferredMaintenanceWindow
```
CreateServerRequest.Builder preferredMaintenanceWindow(String 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.)
    
    Parameters:
    
    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.)
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - preferredBackupWindow
```
CreateServerRequest.Builder preferredBackupWindow(String 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.)
    Parameters:
    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.)
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - securityGroupIds
```
CreateServerRequest.Builder securityGroupIds(Collection<String> 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).
    
    Parameters:
    
    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).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - securityGroupIds
```
CreateServerRequest.Builder securityGroupIds(String... 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).
    
    Parameters:
    
    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).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - serviceRoleArn
```
CreateServerRequest.Builder serviceRoleArn(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - subnetIds
```
CreateServerRequest.Builder subnetIds(Collection<String> 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - subnetIds
```
CreateServerRequest.Builder subnetIds(String... 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - backupId
```
CreateServerRequest.Builder backupId(String backupId)
```
    If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.
    
    Parameters:
    
    backupId - If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - overrideConfiguration
```
CreateServerRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
```
    Description copied from interface: AwsRequest.Builder
    
    Add an optional request override configuration.
    
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder
    
    Parameters:
    
    overrideConfiguration - The override configuration.
    
    Returns:
    
    This object for method chaining.
  - overrideConfiguration
```
CreateServerRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
```
    Description copied from interface: AwsRequest.Builder
    
    Add an optional request override configuration.
    
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder
    
    Parameters:
    
    builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
    
    Returns:
    
    This object for method chaining.

Interface CreateServerRequest.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.services.opsworkscm.model.OpsWorksCmRequest.Builder

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

Method Detail

associatePublicIpAddress

disableAutomatedBackup

engine

engineModel

engineVersion

engineAttributes

engineAttributes

engineAttributes

backupRetentionCount

serverName

instanceProfileArn

instanceType

keyPair

preferredMaintenanceWindow

preferredBackupWindow

securityGroupIds

securityGroupIds

serviceRoleArn

subnetIds

subnetIds

backupId

overrideConfiguration

overrideConfiguration