software.amazon.awscdk.services.autoscaling

Class CfnLaunchConfiguration.Builder

java.lang.Object

software.amazon.awscdk.services.autoscaling.CfnLaunchConfiguration.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnLaunchConfiguration>

Enclosing class:

CfnLaunchConfiguration

@Stability(value=Stable)
public static final class CfnLaunchConfiguration.Builder
extends Object
implements software.amazon.jsii.Builder<CfnLaunchConfiguration>

A fluent builder for CfnLaunchConfiguration.

Method Summary

Modifier and Type	Method and Description
CfnLaunchConfiguration.Builder	associatePublicIpAddress(Boolean associatePublicIpAddress) For Auto Scaling groups that are running in a virtual private cloud (VPC), specifies whether to assign a public IP address to the group's instances.
CfnLaunchConfiguration.Builder	associatePublicIpAddress(IResolvable associatePublicIpAddress) For Auto Scaling groups that are running in a virtual private cloud (VPC), specifies whether to assign a public IP address to the group's instances.
CfnLaunchConfiguration.Builder	blockDeviceMappings(IResolvable blockDeviceMappings) Specifies how block devices are exposed to the instance.
CfnLaunchConfiguration.Builder	blockDeviceMappings(List<? extends Object> blockDeviceMappings) Specifies how block devices are exposed to the instance.
CfnLaunchConfiguration	build()
CfnLaunchConfiguration.Builder	classicLinkVpcId(String classicLinkVpcId) *EC2-Classic retires on August 15, 2022.
CfnLaunchConfiguration.Builder	classicLinkVpcSecurityGroups(List<String> classicLinkVpcSecurityGroups) *EC2-Classic retires on August 15, 2022.
static CfnLaunchConfiguration.Builder	create(software.constructs.Construct scope, String id)
CfnLaunchConfiguration.Builder	ebsOptimized(Boolean ebsOptimized) Specifies whether the launch configuration is optimized for EBS I/O ( `true` ) or not ( `false` ).
CfnLaunchConfiguration.Builder	ebsOptimized(IResolvable ebsOptimized) Specifies whether the launch configuration is optimized for EBS I/O ( `true` ) or not ( `false` ).
CfnLaunchConfiguration.Builder	iamInstanceProfile(String iamInstanceProfile) Provides the name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.
CfnLaunchConfiguration.Builder	imageId(String imageId) Provides the unique ID of the Amazon Machine Image (AMI) that was assigned during registration.
CfnLaunchConfiguration.Builder	instanceId(String instanceId) The ID of the Amazon EC2 instance you want to use to create the launch configuration.
CfnLaunchConfiguration.Builder	instanceMonitoring(Boolean instanceMonitoring) Controls whether instances in this group are launched with detailed ( `true` ) or basic ( `false` ) monitoring.
CfnLaunchConfiguration.Builder	instanceMonitoring(IResolvable instanceMonitoring) Controls whether instances in this group are launched with detailed ( `true` ) or basic ( `false` ) monitoring.
CfnLaunchConfiguration.Builder	instanceType(String instanceType) Specifies the instance type of the EC2 instance.
CfnLaunchConfiguration.Builder	kernelId(String kernelId) Provides the ID of the kernel associated with the EC2 AMI.
CfnLaunchConfiguration.Builder	keyName(String keyName) Provides the name of the EC2 key pair.
CfnLaunchConfiguration.Builder	launchConfigurationName(String launchConfigurationName) The name of the launch configuration.
CfnLaunchConfiguration.Builder	metadataOptions(CfnLaunchConfiguration.MetadataOptionsProperty metadataOptions) The metadata options for the instances.
CfnLaunchConfiguration.Builder	metadataOptions(IResolvable metadataOptions) The metadata options for the instances.
CfnLaunchConfiguration.Builder	placementTenancy(String placementTenancy) The tenancy of the instance, either `default` or `dedicated` .
CfnLaunchConfiguration.Builder	ramDiskId(String ramDiskId) The ID of the RAM disk to select.
CfnLaunchConfiguration.Builder	securityGroups(List<String> securityGroups) A list that contains the security groups to assign to the instances in the Auto Scaling group.
CfnLaunchConfiguration.Builder	spotPrice(String spotPrice) The maximum hourly price you are willing to pay for any Spot Instances launched to fulfill the request.
CfnLaunchConfiguration.Builder	userData(String userData) The Base64-encoded user data to make available to the launched EC2 instances.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static CfnLaunchConfiguration.Builder create(software.constructs.Construct scope,
                                                                             String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnLaunchConfiguration.BlockDeviceMappingProperty.Builder.

imageId

@Stability(value=Stable)
public CfnLaunchConfiguration.Builder imageId(String imageId)

Provides the unique ID of the Amazon Machine Image (AMI) that was assigned during registration.

For more information, see Find a Linux AMI in the Amazon EC2 User Guide for Linux Instances .

Parameters:

imageId - Provides the unique ID of the Amazon Machine Image (AMI) that was assigned during registration. This parameter is required.

Returns:

this

instanceType

@Stability(value=Stable)
public CfnLaunchConfiguration.Builder instanceType(String instanceType)

Specifies the instance type of the EC2 instance.

For information about available instance types, see Available instance types in the Amazon EC2 User Guide for Linux Instances .

Parameters:

instanceType - Specifies the instance type of the EC2 instance. This parameter is required.

Returns:

this

associatePublicIpAddress

@Stability(value=Stable)
public CfnLaunchConfiguration.Builder associatePublicIpAddress(Boolean associatePublicIpAddress)

For Auto Scaling groups that are running in a virtual private cloud (VPC), specifies whether to assign a public IP address to the group's instances.

If you specify true , each instance in the Auto Scaling group receives a unique public IP address. For more information, see Launching Auto Scaling instances in a VPC in the Amazon EC2 Auto Scaling User Guide .

If an instance receives a public IP address and is also in a VPC that is defined in the same stack template, you must use the DependsOn attribute to declare a dependency on the VPC-gateway attachment .

If the instance is launched into a default subnet, the default is to assign a public IP address, unless you disabled the option to assign a public IP address on the subnet. If the instance is launched into a nondefault subnet, the default is not to assign a public IP address, unless you enabled the option to assign a public IP address on the subnet.

Parameters:

associatePublicIpAddress - For Auto Scaling groups that are running in a virtual private cloud (VPC), specifies whether to assign a public IP address to the group's instances. This parameter is required.

Returns:

this

associatePublicIpAddress

@Stability(value=Stable)
public CfnLaunchConfiguration.Builder associatePublicIpAddress(IResolvable associatePublicIpAddress)

For Auto Scaling groups that are running in a virtual private cloud (VPC), specifies whether to assign a public IP address to the group's instances.

If you specify true , each instance in the Auto Scaling group receives a unique public IP address. For more information, see Launching Auto Scaling instances in a VPC in the Amazon EC2 Auto Scaling User Guide .

If an instance receives a public IP address and is also in a VPC that is defined in the same stack template, you must use the DependsOn attribute to declare a dependency on the VPC-gateway attachment .

If the instance is launched into a default subnet, the default is to assign a public IP address, unless you disabled the option to assign a public IP address on the subnet. If the instance is launched into a nondefault subnet, the default is not to assign a public IP address, unless you enabled the option to assign a public IP address on the subnet.

Parameters:

associatePublicIpAddress - For Auto Scaling groups that are running in a virtual private cloud (VPC), specifies whether to assign a public IP address to the group's instances. This parameter is required.

Returns:

this

blockDeviceMappings

@Stability(value=Stable)
public CfnLaunchConfiguration.Builder blockDeviceMappings(IResolvable blockDeviceMappings)

Specifies how block devices are exposed to the instance.

You can specify virtual devices and EBS volumes.

Parameters:

blockDeviceMappings - Specifies how block devices are exposed to the instance. This parameter is required.

Returns:

this

blockDeviceMappings

@Stability(value=Stable)
public CfnLaunchConfiguration.Builder blockDeviceMappings(List<? extends Object> blockDeviceMappings)

Specifies how block devices are exposed to the instance.

You can specify virtual devices and EBS volumes.

Parameters:

blockDeviceMappings - Specifies how block devices are exposed to the instance. This parameter is required.

Returns:

this

classicLinkVpcId

@Stability(value=Stable)
public CfnLaunchConfiguration.Builder classicLinkVpcId(String classicLinkVpcId)

*EC2-Classic retires on August 15, 2022. This parameter is not supported after that date.*.

The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to.

Parameters:

classicLinkVpcId - *EC2-Classic retires on August 15, 2022. This parameter is not supported after that date.*. This parameter is required.

Returns:

this

classicLinkVpcSecurityGroups

@Stability(value=Stable)
public CfnLaunchConfiguration.Builder classicLinkVpcSecurityGroups(List<String> classicLinkVpcSecurityGroups)

*EC2-Classic retires on August 15, 2022. This parameter is not supported after that date.*.

The IDs of one or more security groups for the VPC that you specified in the ClassicLinkVPCId property.

If you specify the ClassicLinkVPCId property, you must specify this property.

Parameters:

classicLinkVpcSecurityGroups - *EC2-Classic retires on August 15, 2022. This parameter is not supported after that date.*. This parameter is required.

Returns:

this

ebsOptimized

@Stability(value=Stable)
public CfnLaunchConfiguration.Builder ebsOptimized(Boolean ebsOptimized)

Specifies whether the launch configuration is optimized for EBS I/O ( `true` ) or not ( `false` ).

This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. Additional fees are incurred when you enable EBS optimization for an instance type that is not EBS-optimized by default. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide for Linux Instances .

The default value is false .

Parameters:

ebsOptimized - Specifies whether the launch configuration is optimized for EBS I/O ( `true` ) or not ( `false` ). This parameter is required.

Returns:

this

ebsOptimized

@Stability(value=Stable)
public CfnLaunchConfiguration.Builder ebsOptimized(IResolvable ebsOptimized)

Specifies whether the launch configuration is optimized for EBS I/O ( `true` ) or not ( `false` ).

This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. Additional fees are incurred when you enable EBS optimization for an instance type that is not EBS-optimized by default. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide for Linux Instances .

The default value is false .

Parameters:

ebsOptimized - Specifies whether the launch configuration is optimized for EBS I/O ( `true` ) or not ( `false` ). This parameter is required.

Returns:

this

iamInstanceProfile

@Stability(value=Stable)
public CfnLaunchConfiguration.Builder iamInstanceProfile(String iamInstanceProfile)

Provides 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 - Provides the name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. This parameter is required.

Returns:

this

instanceId

@Stability(value=Stable)
public CfnLaunchConfiguration.Builder instanceId(String instanceId)

The ID of the Amazon EC2 instance you want to use to create the launch configuration.

Use this property if you want the launch configuration to use settings from an existing Amazon EC2 instance. When you use an instance to create a launch configuration, all properties are derived from the instance with the exception of BlockDeviceMapping and AssociatePublicIpAddress . You can override any properties from the instance by specifying them in the launch configuration.

Parameters:

instanceId - The ID of the Amazon EC2 instance you want to use to create the launch configuration. This parameter is required.

Returns:

this

instanceMonitoring

@Stability(value=Stable)
public CfnLaunchConfiguration.Builder instanceMonitoring(Boolean instanceMonitoring)

Controls whether instances in this group are launched with detailed ( `true` ) or basic ( `false` ) monitoring.

The default value is true (enabled).

When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and your account is charged a fee. When you disable detailed monitoring, CloudWatch generates metrics every 5 minutes. 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. This parameter is required.

Returns:

this

instanceMonitoring

@Stability(value=Stable)
public CfnLaunchConfiguration.Builder instanceMonitoring(IResolvable instanceMonitoring)

Controls whether instances in this group are launched with detailed ( `true` ) or basic ( `false` ) monitoring.

The default value is true (enabled).

When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and your account is charged a fee. When you disable detailed monitoring, CloudWatch generates metrics every 5 minutes. 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. This parameter is required.

Returns:

this

kernelId

@Stability(value=Stable)
public CfnLaunchConfiguration.Builder kernelId(String kernelId)

Provides the ID of the kernel associated with the EC2 AMI.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon EC2 User Guide for Linux Instances .

Parameters:

kernelId - Provides the ID of the kernel associated with the EC2 AMI. This parameter is required.

Returns:

this

keyName

@Stability(value=Stable)
public CfnLaunchConfiguration.Builder keyName(String keyName)

Provides the name of the EC2 key pair.

If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in. For information on creating a key pair, see Amazon EC2 key pairs and Linux instances in the Amazon EC2 User Guide for Linux Instances .

Parameters:

keyName - Provides the name of the EC2 key pair. This parameter is required.

Returns:

this

launchConfigurationName

@Stability(value=Stable)
public CfnLaunchConfiguration.Builder launchConfigurationName(String launchConfigurationName)

The name of the launch configuration.

This name must be unique per Region per account.

Parameters:

launchConfigurationName - The name of the launch configuration. This parameter is required.

Returns:

this

metadataOptions

@Stability(value=Stable)
public CfnLaunchConfiguration.Builder metadataOptions(CfnLaunchConfiguration.MetadataOptionsProperty 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. This parameter is required.

Returns:

this

metadataOptions

@Stability(value=Stable)
public CfnLaunchConfiguration.Builder metadataOptions(IResolvable 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. This parameter is required.

Returns:

this

placementTenancy

@Stability(value=Stable)
public CfnLaunchConfiguration.Builder placementTenancy(String placementTenancy)

The tenancy of the instance, either `default` or `dedicated` .

An instance with dedicated tenancy runs on isolated, single-tenant hardware and can only be launched into a VPC. You must set the value of this property to dedicated if want to launch dedicated instances in a shared tenancy VPC (a VPC with the instance placement tenancy attribute set to default).

If you specify this property, you must specify at least one subnet in the VPCZoneIdentifier property of the AWS::AutoScaling::AutoScalingGroup resource.

For more information, see Configure instance tenancy with Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide .

Parameters:

placementTenancy - The tenancy of the instance, either `default` or `dedicated` . This parameter is required.

Returns:

this

ramDiskId

@Stability(value=Stable)
public CfnLaunchConfiguration.Builder ramDiskId(String ramDiskId)

The ID of the RAM disk to select.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon EC2 User Guide for Linux Instances .

Parameters:

ramDiskId - The ID of the RAM disk to select. This parameter is required.

Returns:

this

securityGroups

@Stability(value=Stable)
public CfnLaunchConfiguration.Builder securityGroups(List<String> securityGroups)

A list that contains the security groups to assign to the instances in the Auto Scaling group.

The list can contain both the IDs of existing security groups and references to SecurityGroup resources created in the template.

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. This parameter is required.

Returns:

this

spotPrice

@Stability(value=Stable)
public CfnLaunchConfiguration.Builder spotPrice(String spotPrice)

The maximum hourly price you are willing to pay for any Spot Instances launched to fulfill the request.

Spot Instances are launched when the price you specify exceeds the current Spot price. For more information, see Request Spot Instances for fault-tolerant and flexible applications in the Amazon EC2 Auto Scaling User Guide .

When you change your maximum price by creating a new launch configuration, running instances will continue to run as long as the maximum price for those running instances is higher than the current Spot price.

Valid Range: Minimum value of 0.001

Parameters:

spotPrice - The maximum hourly price you are willing to pay for any Spot Instances launched to fulfill the request. This parameter is required.

Returns:

this

userData

@Stability(value=Stable)
public CfnLaunchConfiguration.Builder userData(String userData)

The Base64-encoded user data to make available to the launched EC2 instances.

For more information, see Instance metadata and user data in the Amazon EC2 User Guide for Linux Instances .

Parameters:

userData - The Base64-encoded user data to make available to the launched EC2 instances. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnLaunchConfiguration build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnLaunchConfiguration>