@Generated(value="software.amazon.awssdk:codegen") public class CreateInstanceRequest extends OpsWorksRequest implements ToCopyableBuilder<CreateInstanceRequest.Builder,CreateInstanceRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
CreateInstanceRequest.Builder |
Modifier and Type | Method and Description |
---|---|
String |
agentVersion()
The default AWS OpsWorks Stacks agent version.
|
String |
amiId()
A custom AMI ID to be used to create the instance.
|
Architecture |
architecture()
The instance architecture.
|
String |
architectureString()
The instance architecture.
|
AutoScalingType |
autoScalingType()
For load-based or time-based instances, the type.
|
String |
autoScalingTypeString()
For load-based or time-based instances, the type.
|
String |
availabilityZone()
The instance Availability Zone.
|
List<BlockDeviceMapping> |
blockDeviceMappings()
An array of
BlockDeviceMapping objects that specify the instance's block devices. |
static CreateInstanceRequest.Builder |
builder() |
Boolean |
ebsOptimized()
Whether to create an Amazon EBS-optimized instance.
|
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 |
hostname()
The instance host name.
|
Boolean |
installUpdatesOnBoot()
Whether to install operating system and package updates when the instance boots.
|
String |
instanceType()
The instance type, such as
t2.micro . |
List<String> |
layerIds()
An array that contains the instance's layer IDs.
|
String |
os()
The instance's operating system, which must be set to one of the following.
|
RootDeviceType |
rootDeviceType()
The instance root device type.
|
String |
rootDeviceTypeString()
The instance root device type.
|
static Class<? extends CreateInstanceRequest.Builder> |
serializableBuilderClass() |
String |
sshKeyName()
The instance's Amazon EC2 key-pair name.
|
String |
stackId()
The stack ID.
|
String |
subnetId()
The ID of the instance's subnet.
|
String |
tenancy()
The instance's tenancy option.
|
CreateInstanceRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
String |
virtualizationType()
The instance's virtualization type,
paravirtual or hvm . |
requestOverrideConfig
copy
public String stackId()
The stack ID.
public List<String> layerIds()
An array that contains the instance's layer IDs.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String instanceType()
The instance type, such as t2.micro
. For a list of supported instance types, open the stack in the
console, choose Instances, and choose + Instance. The Size list contains the currently
supported types. For more information, see Instance Families and Types.
The parameter values that you use to specify the various types are in the API Name column of the
Available Instance Types table.
t2.micro
. For a list of supported instance types, open the stack
in the console, choose Instances, and choose + Instance. The Size list contains the
currently supported types. For more information, see Instance Families and
Types. The parameter values that you use to specify the various types are in the API Name
column of the Available Instance Types table.public AutoScalingType autoScalingType()
For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
If the service returns an enum value that is not available in the current SDK version, autoScalingType
will return AutoScalingType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from autoScalingTypeString()
.
AutoScalingType
public String autoScalingTypeString()
For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
If the service returns an enum value that is not available in the current SDK version, autoScalingType
will return AutoScalingType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from autoScalingTypeString()
.
AutoScalingType
public String hostname()
The instance host name.
public String os()
The instance's operating system, which must be set to one of the following.
A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2017.03
,
Amazon Linux 2016.09
, Amazon Linux 2016.03
, Amazon Linux 2015.09
, or
Amazon Linux 2015.03
.
A supported Ubuntu operating system, such as Ubuntu 16.04 LTS
, Ubuntu 14.04 LTS
, or
Ubuntu 12.04 LTS
.
CentOS Linux 7
Red Hat Enterprise Linux 7
A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base
,
Microsoft Windows Server 2012 R2 with SQL Server Express
,
Microsoft Windows Server 2012 R2 with SQL Server Standard
, or
Microsoft Windows Server 2012 R2 with SQL Server Web
.
A custom AMI: Custom
.
For more information on the supported operating systems, see AWS OpsWorks Stacks Operating Systems.
The default option is the current Amazon Linux version. If you set this parameter to Custom
, you
must use the CreateInstance action's AmiId parameter to specify the custom AMI that you want to use. Block
device mappings are not supported if the value is Custom
. For more information on the supported
operating systems, see Operating SystemsFor
more information on how to use custom AMIs with AWS OpsWorks Stacks, see Using Custom
AMIs.
A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2017.03
,
Amazon Linux 2016.09
, Amazon Linux 2016.03
, Amazon Linux 2015.09
,
or Amazon Linux 2015.03
.
A supported Ubuntu operating system, such as Ubuntu 16.04 LTS
, Ubuntu 14.04 LTS
, or Ubuntu 12.04 LTS
.
CentOS Linux 7
Red Hat Enterprise Linux 7
A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base
,
Microsoft Windows Server 2012 R2 with SQL Server Express
,
Microsoft Windows Server 2012 R2 with SQL Server Standard
, or
Microsoft Windows Server 2012 R2 with SQL Server Web
.
A custom AMI: Custom
.
For more information on the supported operating systems, see AWS OpsWorks Stacks Operating Systems.
The default option is the current Amazon Linux version. If you set this parameter to Custom
,
you must use the CreateInstance action's AmiId parameter to specify the custom AMI that you want
to use. Block device mappings are not supported if the value is Custom
. For more information
on the supported operating systems, see Operating
SystemsFor more information on how to use custom AMIs with AWS OpsWorks Stacks, see Using Custom
AMIs.
public String amiId()
A custom AMI ID to be used to create the instance. The AMI should be based on one of the supported operating systems. For more information, see Using Custom AMIs.
If you specify a custom AMI, you must set Os
to Custom
.
If you specify a custom AMI, you must set Os
to Custom
.
public String sshKeyName()
The instance's Amazon EC2 key-pair name.
public String availabilityZone()
The instance Availability Zone. For more information, see Regions and Endpoints.
public String virtualizationType()
The instance's virtualization type, paravirtual
or hvm
.
paravirtual
or hvm
.public String subnetId()
The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct AWS OpsWorks Stacks to launch the instance in a different subnet.
public Architecture architecture()
The instance architecture. The default option is x86_64
. Instance types do not necessarily support
both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.
If the service returns an enum value that is not available in the current SDK version, architecture
will
return Architecture.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
architectureString()
.
x86_64
. Instance types do not necessarily
support both architectures. For a list of the architectures that are supported by the different instance
types, see Instance
Families and Types.Architecture
public String architectureString()
The instance architecture. The default option is x86_64
. Instance types do not necessarily support
both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.
If the service returns an enum value that is not available in the current SDK version, architecture
will
return Architecture.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
architectureString()
.
x86_64
. Instance types do not necessarily
support both architectures. For a list of the architectures that are supported by the different instance
types, see Instance
Families and Types.Architecture
public RootDeviceType rootDeviceType()
The instance root device type. For more information, see Storage for the Root Device.
If the service returns an enum value that is not available in the current SDK version, rootDeviceType
will return RootDeviceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from rootDeviceTypeString()
.
RootDeviceType
public String rootDeviceTypeString()
The instance root device type. For more information, see Storage for the Root Device.
If the service returns an enum value that is not available in the current SDK version, rootDeviceType
will return RootDeviceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from rootDeviceTypeString()
.
RootDeviceType
public List<BlockDeviceMapping> blockDeviceMappings()
An array of BlockDeviceMapping
objects that specify the instance's block devices. For more
information, see Block Device
Mapping. Note that block device mappings are not supported for custom AMIs.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
BlockDeviceMapping
objects that specify the instance's block devices. For more
information, see Block Device
Mapping. Note that block device mappings are not supported for custom AMIs.public Boolean installUpdatesOnBoot()
Whether to install operating system and package updates when the instance boots. The default value is
true
. To control when updates are installed, set this value to false
. You must then
update your instances manually by using CreateDeployment to run the update_dependencies
stack
command or by manually running yum
(Amazon Linux) or apt-get
(Ubuntu) on the instances.
We strongly recommend using the default value of true
to ensure that your instances have the latest
security updates.
true
. To control when updates are installed, set this value to false
. You must
then update your instances manually by using CreateDeployment to run the
update_dependencies
stack command or by manually running yum
(Amazon Linux) or
apt-get
(Ubuntu) on the instances.
We strongly recommend using the default value of true
to ensure that your instances have the
latest security updates.
public Boolean ebsOptimized()
Whether to create an Amazon EBS-optimized instance.
public String agentVersion()
The default AWS OpsWorks Stacks agent version. You have the following options:
INHERIT
- Use the stack's default agent version setting.
version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, edit the instance configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the instance.
The default setting is INHERIT
. To specify an agent version, you must use the complete version
number, not the abbreviated number shown on the console. For a list of available agent version numbers, call
DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.
INHERIT
- Use the stack's default agent version setting.
version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, edit the instance configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the instance.
The default setting is INHERIT
. To specify an agent version, you must use the complete
version number, not the abbreviated number shown on the console. For a list of available agent version
numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.
public String tenancy()
The instance's tenancy option. The default option is no tenancy, or if the instance is running in a VPC, inherit
tenancy settings from the VPC. The following are valid values for this parameter: dedicated
,
default
, or host
. Because there are costs associated with changes in tenancy options,
we recommend that you research tenancy options before choosing them for your instances. For more information
about dedicated hosts, see Dedicated Hosts Overview and
Amazon EC2 Dedicated Hosts. For more information about
dedicated instances, see Dedicated Instances and
Amazon EC2 Dedicated Instances.
dedicated
, default
, or host
. Because there are costs associated
with changes in tenancy options, we recommend that you research tenancy options before choosing them for
your instances. For more information about dedicated hosts, see Dedicated Hosts Overview and Amazon EC2 Dedicated Hosts. For more information
about dedicated instances, see Dedicated
Instances and Amazon EC2
Dedicated Instances.public CreateInstanceRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateInstanceRequest.Builder,CreateInstanceRequest>
toBuilder
in class OpsWorksRequest
public static CreateInstanceRequest.Builder builder()
public static Class<? extends CreateInstanceRequest.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.