Interface LaunchConfiguration.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<LaunchConfiguration.Builder,
,LaunchConfiguration> SdkBuilder<LaunchConfiguration.Builder,
,LaunchConfiguration> SdkPojo
- Enclosing class:
LaunchConfiguration
-
Method Summary
Modifier and TypeMethodDescriptionassociatePublicIpAddress
(Boolean associatePublicIpAddress) Specifies whether to assign a public IPv4 address to the group's instances.blockDeviceMappings
(Collection<BlockDeviceMapping> blockDeviceMappings) The block device mapping entries that define the block devices to attach to the instances at launch.blockDeviceMappings
(Consumer<BlockDeviceMapping.Builder>... blockDeviceMappings) The block device mapping entries that define the block devices to attach to the instances at launch.blockDeviceMappings
(BlockDeviceMapping... blockDeviceMappings) The block device mapping entries that define the block devices to attach to the instances at launch.classicLinkVPCId
(String classicLinkVPCId) Available for backward compatibility.classicLinkVPCSecurityGroups
(String... classicLinkVPCSecurityGroups) Available for backward compatibility.classicLinkVPCSecurityGroups
(Collection<String> classicLinkVPCSecurityGroups) Available for backward compatibility.createdTime
(Instant createdTime) The creation date and time for the launch configuration.ebsOptimized
(Boolean ebsOptimized) Specifies whether the launch configuration is optimized for EBS I/O (true
) or not (false
).iamInstanceProfile
(String iamInstanceProfile) The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances.default LaunchConfiguration.Builder
instanceMonitoring
(Consumer<InstanceMonitoring.Builder> instanceMonitoring) Controls whether instances in this group are launched with detailed (true
) or basic (false
) monitoring.instanceMonitoring
(InstanceMonitoring instanceMonitoring) Controls whether instances in this group are launched with detailed (true
) or basic (false
) monitoring.instanceType
(String instanceType) The instance type for the instances.The ID of the kernel associated with the AMI.The name of the key pair.launchConfigurationARN
(String launchConfigurationARN) The Amazon Resource Name (ARN) of the launch configuration.launchConfigurationName
(String launchConfigurationName) The name of the launch configuration.default LaunchConfiguration.Builder
metadataOptions
(Consumer<InstanceMetadataOptions.Builder> metadataOptions) The metadata options for the instances.metadataOptions
(InstanceMetadataOptions metadataOptions) The metadata options for the instances.placementTenancy
(String placementTenancy) The tenancy of the instance, eitherdefault
ordedicated
.The ID of the RAM disk associated with the AMI.securityGroups
(String... securityGroups) A list that contains the security groups to assign to the instances in the Auto Scaling group.securityGroups
(Collection<String> securityGroups) A list that contains the security groups to assign to the instances in the Auto Scaling group.The maximum hourly price to be paid for any Spot Instance launched to fulfill the request.The user data to make available to the launched EC2 instances.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
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
-
launchConfigurationName
The name of the launch configuration.
- Parameters:
launchConfigurationName
- The name of the launch configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
launchConfigurationARN
The Amazon Resource Name (ARN) of the launch configuration.
- Parameters:
launchConfigurationARN
- The Amazon Resource Name (ARN) of the launch configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
imageId
The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. For more information, see Find a Linux AMI in the Amazon EC2 User Guide for Linux Instances.
- Parameters:
imageId
- The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. For more information, see Find a Linux AMI in the Amazon EC2 User Guide for Linux Instances.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
keyName
The name of the key pair.
For more information, see Amazon EC2 Key Pairs in the Amazon EC2 User Guide for Linux Instances.
- Parameters:
keyName
- The name of the key pair.For more information, see Amazon EC2 Key Pairs in the Amazon EC2 User Guide for Linux Instances.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
securityGroups
A list that contains the security groups to assign to the instances in the Auto Scaling group. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.
- Parameters:
securityGroups
- A list that contains the security groups to assign to the instances in the Auto Scaling group. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
securityGroups
A list that contains the security groups to assign to the instances in the Auto Scaling group. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.
- Parameters:
securityGroups
- A list that contains the security groups to assign to the instances in the Auto Scaling group. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
classicLinkVPCId
Available for backward compatibility.
- Parameters:
classicLinkVPCId
- Available for backward compatibility.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
classicLinkVPCSecurityGroups
LaunchConfiguration.Builder classicLinkVPCSecurityGroups(Collection<String> classicLinkVPCSecurityGroups) Available for backward compatibility.
- Parameters:
classicLinkVPCSecurityGroups
- Available for backward compatibility.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
classicLinkVPCSecurityGroups
Available for backward compatibility.
- Parameters:
classicLinkVPCSecurityGroups
- Available for backward compatibility.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
userData
The user data to make available to the launched EC2 instances. For more information, see Instance metadata and user data (Linux) and Instance metadata and user data (Windows). If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB.
- Parameters:
userData
- The user data to make available to the launched EC2 instances. For more information, see Instance metadata and user data (Linux) and Instance metadata and user data (Windows). If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
instanceType
The instance type for the instances. For information about available instance types, see Available instance types in the Amazon EC2 User Guide for Linux Instances.
- Parameters:
instanceType
- The instance type for the instances. For information about available instance types, see Available instance types in the Amazon EC2 User Guide for Linux Instances.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
kernelId
The ID of the kernel associated with the AMI.
- Parameters:
kernelId
- The ID of the kernel associated with the AMI.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ramdiskId
The ID of the RAM disk associated with the AMI.
- Parameters:
ramdiskId
- The ID of the RAM disk associated with the AMI.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
blockDeviceMappings
The block device mapping entries that define the block devices to attach to the instances at launch. By default, the block devices specified in the block device mapping for the AMI are used. For more information, see Block Device Mapping in the Amazon EC2 User Guide for Linux Instances.
- Parameters:
blockDeviceMappings
- The block device mapping entries that define the block devices to attach to the instances at launch. By default, the block devices specified in the block device mapping for the AMI are used. For more information, see Block Device Mapping in the Amazon EC2 User Guide for Linux Instances.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
blockDeviceMappings
The block device mapping entries that define the block devices to attach to the instances at launch. By default, the block devices specified in the block device mapping for the AMI are used. For more information, see Block Device Mapping in the Amazon EC2 User Guide for Linux Instances.
- Parameters:
blockDeviceMappings
- The block device mapping entries that define the block devices to attach to the instances at launch. By default, the block devices specified in the block device mapping for the AMI are used. For more information, see Block Device Mapping in the Amazon EC2 User Guide for Linux Instances.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
blockDeviceMappings
LaunchConfiguration.Builder blockDeviceMappings(Consumer<BlockDeviceMapping.Builder>... blockDeviceMappings) The block device mapping entries that define the block devices to attach to the instances at launch. By default, the block devices specified in the block device mapping for the AMI are used. For more information, see Block Device Mapping in the Amazon EC2 User Guide for Linux Instances.
This is a convenience method that creates an instance of theBlockDeviceMapping.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:
-
instanceMonitoring
Controls whether instances in this group are launched with detailed (
true
) or basic (false
) monitoring.For more information, see Configure Monitoring for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
instanceMonitoring
- Controls whether instances in this group are launched with detailed (true
) or basic (false
) monitoring.For more information, see Configure Monitoring for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
instanceMonitoring
default LaunchConfiguration.Builder instanceMonitoring(Consumer<InstanceMonitoring.Builder> instanceMonitoring) Controls whether instances in this group are launched with detailed (
true
) or basic (false
) monitoring.For more information, see Configure Monitoring for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.
This is a convenience method that creates an instance of theInstanceMonitoring.Builder
avoiding the need to create one manually viaInstanceMonitoring.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toinstanceMonitoring(InstanceMonitoring)
.- Parameters:
instanceMonitoring
- a consumer that will call methods onInstanceMonitoring.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
spotPrice
The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot price. For more information, see Requesting Spot Instances in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
spotPrice
- The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot price. For more information, see Requesting Spot Instances in the Amazon EC2 Auto Scaling User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
iamInstanceProfile
The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role. For more information, see IAM role for applications that run on Amazon EC2 instances in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
iamInstanceProfile
- The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role. For more information, see IAM role for applications that run on Amazon EC2 instances in the Amazon EC2 Auto Scaling User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createdTime
The creation date and time for the launch configuration.
- Parameters:
createdTime
- The creation date and time for the launch configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ebsOptimized
Specifies whether the launch configuration is optimized for EBS I/O (
true
) or not (false
). For more information, see Amazon EBS-Optimized Instances in the Amazon EC2 User Guide for Linux Instances.- Parameters:
ebsOptimized
- Specifies whether the launch configuration is optimized for EBS I/O (true
) or not (false
). For more information, see Amazon EBS-Optimized Instances in the Amazon EC2 User Guide for Linux Instances.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
associatePublicIpAddress
Specifies whether to assign a public IPv4 address to the group's instances. If the instance is launched into a default subnet, the default is to assign a public IPv4 address, unless you disabled the option to assign a public IPv4 address on the subnet. If the instance is launched into a nondefault subnet, the default is not to assign a public IPv4 address, unless you enabled the option to assign a public IPv4 address on the subnet. For more information, see Launching Auto Scaling instances in a VPC in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
associatePublicIpAddress
- Specifies whether to assign a public IPv4 address to the group's instances. If the instance is launched into a default subnet, the default is to assign a public IPv4 address, unless you disabled the option to assign a public IPv4 address on the subnet. If the instance is launched into a nondefault subnet, the default is not to assign a public IPv4 address, unless you enabled the option to assign a public IPv4 address on the subnet. For more information, see Launching Auto Scaling instances in a VPC in the Amazon EC2 Auto Scaling User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
placementTenancy
The tenancy of the instance, either
default
ordedicated
. An instance withdedicated
tenancy runs on isolated, single-tenant hardware and can only be launched into a VPC.For more information, see Configuring instance tenancy with Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
placementTenancy
- The tenancy of the instance, eitherdefault
ordedicated
. An instance withdedicated
tenancy runs on isolated, single-tenant hardware and can only be launched into a VPC.For more information, see Configuring instance tenancy with Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
metadataOptions
The metadata options for the instances. For more information, see Configuring the Instance Metadata Options in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
metadataOptions
- The metadata options for the instances. For more information, see Configuring the Instance Metadata Options in the Amazon EC2 Auto Scaling User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
metadataOptions
default LaunchConfiguration.Builder metadataOptions(Consumer<InstanceMetadataOptions.Builder> metadataOptions) The metadata options for the instances. For more information, see Configuring the Instance Metadata Options in the Amazon EC2 Auto Scaling User Guide.
This is a convenience method that creates an instance of theInstanceMetadataOptions.Builder
avoiding the need to create one manually viaInstanceMetadataOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tometadataOptions(InstanceMetadataOptions)
.- Parameters:
metadataOptions
- a consumer that will call methods onInstanceMetadataOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-