Interface CreateInstanceRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateInstanceRequest.Builder,
,CreateInstanceRequest> OpsWorksRequest.Builder
,SdkBuilder<CreateInstanceRequest.Builder,
,CreateInstanceRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateInstanceRequest
-
Method Summary
Modifier and TypeMethodDescriptionagentVersion
(String agentVersion) The default AWS OpsWorks Stacks agent version.A custom AMI ID to be used to create the instance.architecture
(String architecture) The instance architecture.architecture
(Architecture architecture) The instance architecture.autoScalingType
(String autoScalingType) For load-based or time-based instances, the type.autoScalingType
(AutoScalingType autoScalingType) For load-based or time-based instances, the type.availabilityZone
(String availabilityZone) The instance Availability Zone.blockDeviceMappings
(Collection<BlockDeviceMapping> blockDeviceMappings) An array ofBlockDeviceMapping
objects that specify the instance's block devices.blockDeviceMappings
(Consumer<BlockDeviceMapping.Builder>... blockDeviceMappings) An array ofBlockDeviceMapping
objects that specify the instance's block devices.blockDeviceMappings
(BlockDeviceMapping... blockDeviceMappings) An array ofBlockDeviceMapping
objects that specify the instance's block devices.ebsOptimized
(Boolean ebsOptimized) Whether to create an Amazon EBS-optimized instance.The instance host name.installUpdatesOnBoot
(Boolean installUpdatesOnBoot) Whether to install operating system and package updates when the instance boots.instanceType
(String instanceType) The instance type, such ast2.micro
.An array that contains the instance's layer IDs.layerIds
(Collection<String> layerIds) An array that contains the instance's layer IDs.The instance's operating system, which must be set to one of the following.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.rootDeviceType
(String rootDeviceType) The instance root device type.rootDeviceType
(RootDeviceType rootDeviceType) The instance root device type.sshKeyName
(String sshKeyName) The instance's Amazon EC2 key-pair name.The stack ID.The ID of the instance's subnet.The instance's tenancy option.virtualizationType
(String virtualizationType) The instance's virtualization type,paravirtual
orhvm
.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.opsworks.model.OpsWorksRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
stackId
The stack ID.
- Parameters:
stackId
- The stack ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
layerIds
An array that contains the instance's layer IDs.
- Parameters:
layerIds
- An array that contains the instance's layer IDs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
layerIds
An array that contains the instance's layer IDs.
- Parameters:
layerIds
- An array that contains the instance's layer IDs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
instanceType
- The instance type, such ast2.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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
autoScalingType
For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
- Parameters:
autoScalingType
- For load-based or time-based instances, the type. Windows stacks can use only time-based instances.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
autoScalingType
For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
- Parameters:
autoScalingType
- For load-based or time-based instances, the type. Windows stacks can use only time-based instances.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
hostname
The instance host name.
- Parameters:
hostname
- The instance host name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 2018.03
,Amazon Linux 2017.09
,Amazon Linux 2017.03
,Amazon Linux 2016.09
,Amazon Linux 2016.03
,Amazon Linux 2015.09
, orAmazon Linux 2015.03
. -
A supported Ubuntu operating system, such as
Ubuntu 16.04 LTS
,Ubuntu 14.04 LTS
, orUbuntu 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
, orMicrosoft Windows Server 2012 R2 with SQL Server Web
. -
A custom AMI:
Custom
.
For more information about 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 isCustom
. For more information about supported operating systems, see Operating SystemsFor more information about how to use custom AMIs with AWS OpsWorks Stacks, see Using Custom AMIs.- Parameters:
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 2018.03
,Amazon Linux 2017.09
,Amazon Linux 2017.03
,Amazon Linux 2016.09
,Amazon Linux 2016.03
,Amazon Linux 2015.09
, orAmazon Linux 2015.03
. -
A supported Ubuntu operating system, such as
Ubuntu 16.04 LTS
,Ubuntu 14.04 LTS
, orUbuntu 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
, orMicrosoft Windows Server 2012 R2 with SQL Server Web
. -
A custom AMI:
Custom
.
For more information about 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 isCustom
. For more information about supported operating systems, see Operating SystemsFor more information about how to use custom AMIs with AWS OpsWorks Stacks, see Using Custom AMIs.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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
toCustom
.- Parameters:
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
toCustom
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sshKeyName
The instance's Amazon EC2 key-pair name.
- Parameters:
sshKeyName
- The instance's Amazon EC2 key-pair name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
availabilityZone
The instance Availability Zone. For more information, see Regions and Endpoints.
- Parameters:
availabilityZone
- The instance Availability Zone. For more information, see Regions and Endpoints.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
virtualizationType
The instance's virtualization type,
paravirtual
orhvm
.- Parameters:
virtualizationType
- The instance's virtualization type,paravirtual
orhvm
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
architecture
- The instance architecture. The default option isx86_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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.- Parameters:
architecture
- The instance architecture. The default option isx86_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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
rootDeviceType
The instance root device type. For more information, see Storage for the Root Device.
- Parameters:
rootDeviceType
- The instance root device type. For more information, see Storage for the Root Device.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
rootDeviceType
The instance root device type. For more information, see Storage for the Root Device.
- Parameters:
rootDeviceType
- The instance root device type. For more information, see Storage for the Root Device.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
blockDeviceMappings
CreateInstanceRequest.Builder blockDeviceMappings(Collection<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.- Parameters:
blockDeviceMappings
- An array ofBlockDeviceMapping
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
blockDeviceMappings
- An array ofBlockDeviceMapping
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
blockDeviceMappings
CreateInstanceRequest.Builder blockDeviceMappings(Consumer<BlockDeviceMapping.Builder>... blockDeviceMappings) An array of
This is a convenience method that creates an instance of theBlockDeviceMapping
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.BlockDeviceMapping.Builder
avoiding the need to create one manually viaBlockDeviceMapping.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toblockDeviceMappings(List<BlockDeviceMapping>)
.- Parameters:
blockDeviceMappings
- a consumer that will call methods onBlockDeviceMapping.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 tofalse
. You must then update your instances manually by using CreateDeployment to run theupdate_dependencies
stack command or by manually runningyum
(Amazon Linux) orapt-get
(Ubuntu) on the instances.We strongly recommend using the default value of
true
to ensure that your instances have the latest security updates.- Parameters:
installUpdatesOnBoot
- Whether to install operating system and package updates when the instance boots. The default value istrue
. To control when updates are installed, set this value tofalse
. You must then update your instances manually by using CreateDeployment to run theupdate_dependencies
stack command or by manually runningyum
(Amazon Linux) orapt-get
(Ubuntu) on the instances.We strongly recommend using the default value of
true
to ensure that your instances have the latest security updates.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ebsOptimized
Whether to create an Amazon EBS-optimized instance.
- Parameters:
ebsOptimized
- Whether to create an Amazon EBS-optimized instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
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.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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
, orhost
. 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.- Parameters:
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
, orhost
. 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
CreateInstanceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateInstanceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-