@Generated(value="software.amazon.awssdk:codegen") public final class CreateServerRequest extends OpsWorksCmRequest implements ToCopyableBuilder<CreateServerRequest.Builder,CreateServerRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
CreateServerRequest.Builder |
Modifier and Type | Method and Description |
---|---|
Boolean |
associatePublicIpAddress()
Associate a public IP address with a server that you are launching.
|
String |
backupId()
If you specify this field, AWS OpsWorks CM 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 of the server.
|
String |
engineVersion()
The major release version of the engine that you want to use.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
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 CM 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 CM 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 CM 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() |
overrideConfiguration
copy
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
.
true
or
false
. The default value is true
.public Boolean disableAutomatedBackup()
Enable or disable scheduled backups. Valid values are true
or false
. The default value
is true
.
true
or false
. The
default value is true
.public String engine()
The configuration management engine to use. Valid values include Chef
and Puppet
.
Chef
and
Puppet
.public String engineModel()
The engine model of the server. Valid values in this release include Monolithic
for Puppet and
Single
for Chef.
Monolithic
for Puppet
and Single
for Chef.public 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
.
12
. For a Puppet server, the valid value is 2017
.public List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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.
public 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
.
1
.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.
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.
public 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.
m4.large
. Recommended instance types
include t2.medium
and greater, m4.*
, or c4.xlarge
and greater.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.
public 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.)
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.)
public 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.)
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.)
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 CM creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone).
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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).
public 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.
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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.
public String backupId()
If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.
public CreateServerRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateServerRequest.Builder,CreateServerRequest>
toBuilder
in class OpsWorksCmRequest
public static CreateServerRequest.Builder builder()
public static Class<? extends CreateServerRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.