CreateServerRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.opsworkscm.model.CreateServerRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateServerRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreateServerRequest()

Constructors
Constructor and Description
`CreateServerRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateServerRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`Boolean`	`getAssociatePublicIpAddress()` Associate a public IP address with a server that you are launching.
`String`	`getBackupId()` If you specify this field, AWS OpsWorks for Chef Automate creates the server by using the backup represented by BackupId.
`Integer`	`getBackupRetentionCount()` The number of automated backups that you want to keep.
`Boolean`	`getDisableAutomatedBackup()` Enable or disable scheduled backups.
`String`	`getEngine()` The configuration management engine to use.
`List<EngineAttribute>`	`getEngineAttributes()` Optional engine attributes on a specified server.
`String`	`getEngineModel()` The engine model, or option.
`String`	`getEngineVersion()` The major release version of the engine that you want to use.
`String`	`getInstanceProfileArn()` The ARN of the instance profile that your Amazon EC2 instances use.
`String`	`getInstanceType()` The Amazon EC2 instance type to use.
`String`	`getKeyPair()` The Amazon EC2 key pair to set for the instance.
`String`	`getPreferredBackupWindow()` 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`	`getPreferredMaintenanceWindow()` The start time for a one-hour period each week during which AWS OpsWorks for Chef Automate performs maintenance on the instance.
`List<String>`	`getSecurityGroupIds()` A list of security group IDs to attach to the Amazon EC2 instance.
`String`	`getServerName()` The name of the server.
`String`	`getServiceRoleArn()` The service role that the AWS OpsWorks for Chef Automate service backend uses to work with your account.
`List<String>`	`getSubnetIds()` The IDs of subnets in which to launch the server EC2 instance.
`int`	`hashCode()`
`Boolean`	`isAssociatePublicIpAddress()` Associate a public IP address with a server that you are launching.
`Boolean`	`isDisableAutomatedBackup()` Enable or disable scheduled backups.
`void`	`setAssociatePublicIpAddress(Boolean associatePublicIpAddress)` Associate a public IP address with a server that you are launching.
`void`	`setBackupId(String backupId)` If you specify this field, AWS OpsWorks for Chef Automate creates the server by using the backup represented by BackupId.
`void`	`setBackupRetentionCount(Integer backupRetentionCount)` The number of automated backups that you want to keep.
`void`	`setDisableAutomatedBackup(Boolean disableAutomatedBackup)` Enable or disable scheduled backups.
`void`	`setEngine(String engine)` The configuration management engine to use.
`void`	`setEngineAttributes(Collection<EngineAttribute> engineAttributes)` Optional engine attributes on a specified server.
`void`	`setEngineModel(String engineModel)` The engine model, or option.
`void`	`setEngineVersion(String engineVersion)` The major release version of the engine that you want to use.
`void`	`setInstanceProfileArn(String instanceProfileArn)` The ARN of the instance profile that your Amazon EC2 instances use.
`void`	`setInstanceType(String instanceType)` The Amazon EC2 instance type to use.
`void`	`setKeyPair(String keyPair)` The Amazon EC2 key pair to set for the instance.
`void`	`setPreferredBackupWindow(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.
`void`	`setPreferredMaintenanceWindow(String preferredMaintenanceWindow)` The start time for a one-hour period each week during which AWS OpsWorks for Chef Automate performs maintenance on the instance.
`void`	`setSecurityGroupIds(Collection<String> securityGroupIds)` A list of security group IDs to attach to the Amazon EC2 instance.
`void`	`setServerName(String serverName)` The name of the server.
`void`	`setServiceRoleArn(String serviceRoleArn)` The service role that the AWS OpsWorks for Chef Automate service backend uses to work with your account.
`void`	`setSubnetIds(Collection<String> subnetIds)` The IDs of subnets in which to launch the server EC2 instance.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`CreateServerRequest`	`withAssociatePublicIpAddress(Boolean associatePublicIpAddress)` Associate a public IP address with a server that you are launching.
`CreateServerRequest`	`withBackupId(String backupId)` If you specify this field, AWS OpsWorks for Chef Automate creates the server by using the backup represented by BackupId.
`CreateServerRequest`	`withBackupRetentionCount(Integer backupRetentionCount)` The number of automated backups that you want to keep.
`CreateServerRequest`	`withDisableAutomatedBackup(Boolean disableAutomatedBackup)` Enable or disable scheduled backups.
`CreateServerRequest`	`withEngine(String engine)` The configuration management engine to use.
`CreateServerRequest`	`withEngineAttributes(Collection<EngineAttribute> engineAttributes)` Optional engine attributes on a specified server.
`CreateServerRequest`	`withEngineAttributes(EngineAttribute... engineAttributes)` Optional engine attributes on a specified server.
`CreateServerRequest`	`withEngineModel(String engineModel)` The engine model, or option.
`CreateServerRequest`	`withEngineVersion(String engineVersion)` The major release version of the engine that you want to use.
`CreateServerRequest`	`withInstanceProfileArn(String instanceProfileArn)` The ARN of the instance profile that your Amazon EC2 instances use.
`CreateServerRequest`	`withInstanceType(String instanceType)` The Amazon EC2 instance type to use.
`CreateServerRequest`	`withKeyPair(String keyPair)` The Amazon EC2 key pair to set for the instance.
`CreateServerRequest`	`withPreferredBackupWindow(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.
`CreateServerRequest`	`withPreferredMaintenanceWindow(String preferredMaintenanceWindow)` The start time for a one-hour period each week during which AWS OpsWorks for Chef Automate performs maintenance on the instance.
`CreateServerRequest`	`withSecurityGroupIds(Collection<String> securityGroupIds)` A list of security group IDs to attach to the Amazon EC2 instance.
`CreateServerRequest`	`withSecurityGroupIds(String... securityGroupIds)` A list of security group IDs to attach to the Amazon EC2 instance.
`CreateServerRequest`	`withServerName(String serverName)` The name of the server.
`CreateServerRequest`	`withServiceRoleArn(String serviceRoleArn)` The service role that the AWS OpsWorks for Chef Automate service backend uses to work with your account.
`CreateServerRequest`	`withSubnetIds(Collection<String> subnetIds)` The IDs of subnets in which to launch the server EC2 instance.
`CreateServerRequest`	`withSubnetIds(String... subnetIds)` The IDs of subnets in which to launch the server EC2 instance.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateServerRequest
```
public CreateServerRequest()
```
- Method Detail
  - setAssociatePublicIpAddress
```
public void setAssociatePublicIpAddress(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.
  - getAssociatePublicIpAddress
```
public Boolean getAssociatePublicIpAddress()
```
    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.
  - withAssociatePublicIpAddress
```
public CreateServerRequest withAssociatePublicIpAddress(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.
  - isAssociatePublicIpAddress
```
public Boolean isAssociatePublicIpAddress()
```
    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.
  - setDisableAutomatedBackup
```
public void setDisableAutomatedBackup(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.
  - getDisableAutomatedBackup
```
public Boolean getDisableAutomatedBackup()
```
    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.
  - withDisableAutomatedBackup
```
public CreateServerRequest withDisableAutomatedBackup(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.
  - isDisableAutomatedBackup
```
public Boolean isDisableAutomatedBackup()
```
    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.
  - setEngine
```
public void setEngine(String engine)
```
    The configuration management engine to use. Valid values include Chef.
    
    Parameters:
    
    engine - The configuration management engine to use. Valid values include Chef.
  - getEngine
```
public String getEngine()
```
    The configuration management engine to use. Valid values include Chef.
    
    Returns:
    
    The configuration management engine to use. Valid values include Chef.
  - withEngine
```
public CreateServerRequest withEngine(String engine)
```
    The configuration management engine to use. Valid values include Chef.
    
    Parameters:
    
    engine - The configuration management engine to use. Valid values include Chef.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEngineModel
```
public void setEngineModel(String engineModel)
```
    The engine model, or option. Valid values include Single.
    
    Parameters:
    
    engineModel - The engine model, or option. Valid values include Single.
  - getEngineModel
```
public String getEngineModel()
```
    The engine model, or option. Valid values include Single.
    
    Returns:
    
    The engine model, or option. Valid values include Single.
  - withEngineModel
```
public CreateServerRequest withEngineModel(String engineModel)
```
    The engine model, or option. Valid values include Single.
    
    Parameters:
    
    engineModel - The engine model, or option. Valid values include Single.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEngineVersion
```
public void setEngineVersion(String engineVersion)
```
    The major release version of the engine that you want to use. Values depend on the engine that you choose.
    
    Parameters:
    
    engineVersion - The major release version of the engine that you want to use. Values depend on the engine that you choose.
  - getEngineVersion
```
public String getEngineVersion()
```
    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.
  - withEngineVersion
```
public CreateServerRequest withEngineVersion(String engineVersion)
```
    The major release version of the engine that you want to use. Values depend on the engine that you choose.
    
    Parameters:
    
    engineVersion - The major release version of the engine that you want to use. Values depend on the engine that you choose.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getEngineAttributes
```
public List<EngineAttribute> getEngineAttributes()
```
    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.
  - setEngineAttributes
```
public void setEngineAttributes(Collection<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.
    Parameters:
    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.
  - withEngineAttributes
```
public CreateServerRequest withEngineAttributes(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.
    NOTE: This method appends the values to the existing list (if any). Use setEngineAttributes(java.util.Collection) or withEngineAttributes(java.util.Collection) if you want to override the existing values.
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - withEngineAttributes
```
public CreateServerRequest withEngineAttributes(Collection<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.
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBackupRetentionCount
```
public void setBackupRetentionCount(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.
    
    Parameters:
    
    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.
  - getBackupRetentionCount
```
public Integer getBackupRetentionCount()
```
    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.
  - withBackupRetentionCount
```
public CreateServerRequest withBackupRetentionCount(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setServerName
```
public void setServerName(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.
  - getServerName
```
public String getServerName()
```
    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.
  - withServerName
```
public CreateServerRequest withServerName(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.
  - setInstanceProfileArn
```
public void setInstanceProfileArn(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.
  - getInstanceProfileArn
```
public String getInstanceProfileArn()
```
    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.
  - withInstanceProfileArn
```
public CreateServerRequest withInstanceProfileArn(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.
  - setInstanceType
```
public void setInstanceType(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.
    
    Parameters:
    
    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.
  - getInstanceType
```
public String getInstanceType()
```
    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.
  - withInstanceType
```
public CreateServerRequest withInstanceType(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKeyPair
```
public void setKeyPair(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.
  - getKeyPair
```
public String getKeyPair()
```
    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.
  - withKeyPair
```
public CreateServerRequest withKeyPair(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.
  - setPreferredMaintenanceWindow
```
public void setPreferredMaintenanceWindow(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.)
    
    Parameters:
    
    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.)
  - getPreferredMaintenanceWindow
```
public String getPreferredMaintenanceWindow()
```
    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.)
  - withPreferredMaintenanceWindow
```
public CreateServerRequest withPreferredMaintenanceWindow(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.)
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPreferredBackupWindow
```
public void setPreferredBackupWindow(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.)
    Parameters:
    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.)
  - getPreferredBackupWindow
```
public String getPreferredBackupWindow()
```
    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.)
  - withPreferredBackupWindow
```
public CreateServerRequest withPreferredBackupWindow(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.)
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSecurityGroupIds
```
public List<String> getSecurityGroupIds()
```
    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).
  - setSecurityGroupIds
```
public void setSecurityGroupIds(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 for Chef Automate 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 for Chef Automate creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone).
  - withSecurityGroupIds
```
public CreateServerRequest withSecurityGroupIds(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).
    
    NOTE: This method appends the values to the existing list (if any). Use setSecurityGroupIds(java.util.Collection) or withSecurityGroupIds(java.util.Collection) if you want to override the existing values.
    
    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 for Chef Automate 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.
  - withSecurityGroupIds
```
public CreateServerRequest withSecurityGroupIds(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 for Chef Automate 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 for Chef Automate 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.
  - setServiceRoleArn
```
public void setServiceRoleArn(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-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template creates a CloudFormation stack that includes the service role that you need.
    
    Parameters:
    
    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-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template creates a CloudFormation stack that includes the service role that you need.
  - getServiceRoleArn
```
public String getServiceRoleArn()
```
    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-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.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-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template creates a CloudFormation stack that includes the service role that you need.
  - withServiceRoleArn
```
public CreateServerRequest withServiceRoleArn(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-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template creates a CloudFormation stack that includes the service role that you need.
    
    Parameters:
    
    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-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template creates a CloudFormation stack that includes the service role that you need.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSubnetIds
```
public List<String> getSubnetIds()
```
    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.
  - setSubnetIds
```
public void setSubnetIds(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.
  - withSubnetIds
```
public CreateServerRequest withSubnetIds(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setSubnetIds(java.util.Collection) or withSubnetIds(java.util.Collection) if you want to override the existing values.
    
    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.
  - withSubnetIds
```
public CreateServerRequest withSubnetIds(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.
  - setBackupId
```
public void setBackupId(String backupId)
```
    If you specify this field, AWS OpsWorks for Chef Automate creates the server by using the backup represented by BackupId.
    
    Parameters:
    
    backupId - If you specify this field, AWS OpsWorks for Chef Automate creates the server by using the backup represented by BackupId.
  - getBackupId
```
public String getBackupId()
```
    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.
  - withBackupId
```
public CreateServerRequest withBackupId(String backupId)
```
    If you specify this field, AWS OpsWorks for Chef Automate creates the server by using the backup represented by BackupId.
    
    Parameters:
    
    backupId - If you specify this field, AWS OpsWorks for Chef Automate 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.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CreateServerRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Did this page help you?

Class CreateServerRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateServerRequest

Method Detail

setAssociatePublicIpAddress

getAssociatePublicIpAddress

withAssociatePublicIpAddress

isAssociatePublicIpAddress

setDisableAutomatedBackup

getDisableAutomatedBackup

withDisableAutomatedBackup

isDisableAutomatedBackup

setEngine

getEngine

withEngine

setEngineModel

getEngineModel

withEngineModel

setEngineVersion

getEngineVersion

withEngineVersion

getEngineAttributes

setEngineAttributes

withEngineAttributes

withEngineAttributes

setBackupRetentionCount

getBackupRetentionCount

withBackupRetentionCount

setServerName

getServerName

withServerName

setInstanceProfileArn

getInstanceProfileArn

withInstanceProfileArn

setInstanceType

getInstanceType

withInstanceType

setKeyPair

getKeyPair

withKeyPair

setPreferredMaintenanceWindow

getPreferredMaintenanceWindow

withPreferredMaintenanceWindow

setPreferredBackupWindow

getPreferredBackupWindow

withPreferredBackupWindow

getSecurityGroupIds

setSecurityGroupIds

withSecurityGroupIds

withSecurityGroupIds

setServiceRoleArn

getServiceRoleArn

withServiceRoleArn

getSubnetIds

setSubnetIds

withSubnetIds

withSubnetIds

setBackupId

getBackupId

withBackupId

toString

equals

hashCode

clone