Package software.amazon.awssdk.services.opsworkscm.model

Class CreateServerRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.opsworkscm.model.CreateServerRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<CreateServerRequest.Builder,CreateServerRequest>

@Generated("software.amazon.awssdk:codegen")
public class CreateServerRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<CreateServerRequest.Builder,CreateServerRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateServerRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
Boolean	associatePublicIpAddress()	Associate a public IP address with a server that you are launching.
String	backupId()	If you specify this field, AWS OpsWorks for Chef Automate creates the server by using the backup represented by BackupId.
Integer	backupRetentionCount()	The number of automated backups that you want to keep.
static CreateServerRequest.Builder	builder()
Boolean	disableAutomatedBackup()	Enable or disable scheduled backups.
String	engine()	The configuration management engine to use.
List<EngineAttribute>	engineAttributes()	Optional engine attributes on a specified server.
String	engineModel()	The engine model, or option.
String	engineVersion()	The major release version of the engine that you want to use.
boolean	equals(Object obj)
int	hashCode()
String	instanceProfileArn()	The ARN of the instance profile that your Amazon EC2 instances use.
String	instanceType()	The Amazon EC2 instance type to use.
String	keyPair()	The Amazon EC2 key pair to set for the instance.
String	preferredBackupWindow()	The start time for a one-hour period during which AWS OpsWorks for Chef Automate backs up application-level data on your server if automated backups are enabled.
String	preferredMaintenanceWindow()	The start time for a one-hour period each week during which AWS OpsWorks for Chef Automate performs maintenance on the instance.
List<String>	securityGroupIds()	A list of security group IDs to attach to the Amazon EC2 instance.
static Class<? extends CreateServerRequest.Builder>	serializableBuilderClass()
String	serverName()	The name of the server.
String	serviceRoleArn()	The service role that the AWS OpsWorks for Chef Automate service backend uses to work with your account.
List<String>	subnetIds()	The IDs of subnets in which to launch the server EC2 instance.
CreateServerRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

associatePublicIpAddress

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

Returns:

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

disableAutomatedBackup

public Boolean disableAutomatedBackup()

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

Returns:

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

engine

public String engine()

The configuration management engine to use. Valid values include Chef.

Returns:

The configuration management engine to use. Valid values include Chef.

engineModel

public String engineModel()

The engine model, or option. Valid values include Single.

Returns:

The engine model, or option. Valid values include Single.

engineVersion

public String engineVersion()

The major release version of the engine that you want to use. Values depend on the engine that you choose.

Returns:

The major release version of the engine that you want to use. Values depend on the engine that you choose.

engineAttributes

public List<EngineAttribute> engineAttributes()

Optional engine attributes on a specified server.

Attributes accepted in a createServer request:

• CHEF_PIVOTAL_KEY: A base64-encoded RSA private key that is not stored by AWS OpsWorks for Chef. 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.

Returns:

Optional engine attributes on a specified server.

Attributes accepted in a createServer request:

• CHEF_PIVOTAL_KEY: A base64-encoded RSA private key that is not stored by AWS OpsWorks for Chef. 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.

backupRetentionCount

public Integer backupRetentionCount()

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

Returns:

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

serverName

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

Returns:

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.

instanceProfileArn

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

Returns:

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.

instanceType

public String instanceType()

The Amazon EC2 instance type to use. Valid values must be specified in the following format: ^([cm][34]|t2).* For example, m4.large. Valid values are t2.medium, m4.large, or m4.2xlarge.

Returns:

The Amazon EC2 instance type to use. Valid values must be specified in the following format: ^([cm][34]|t2).* For example, m4.large. Valid values are t2.medium , m4.large, or m4.2xlarge.

keyPair

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

Returns:

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.

preferredMaintenanceWindow

public String preferredMaintenanceWindow()

The start time for a one-hour period each week during which AWS OpsWorks for Chef Automate 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:

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

preferredBackupWindow

public String preferredBackupWindow()

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

The start time for a one-hour period during which AWS OpsWorks for Chef Automate 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.)

securityGroupIds

public List<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 for Chef Automate creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone).

Returns:

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 for Chef Automate creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone).

serviceRoleArn

public String serviceRoleArn()

The service role that the AWS OpsWorks for Chef Automate 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-stuff/latest/service-role-creation.yaml. This template creates a CloudFormation stack that includes the service role that you need.

Returns:

The service role that the AWS OpsWorks for Chef Automate 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-stuff/latest/service-role-creation.yaml. This template creates a CloudFormation stack that includes the service role that you need.

subnetIds

public List<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.

Returns:

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.

backupId

public String backupId()

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

Returns:

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

toBuilder

public CreateServerRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateServerRequest.Builder,CreateServerRequest>

Returns:

a builder for type T

builder

public static CreateServerRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateServerRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object