Package 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(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	Description
CfnLaunchConfiguration.Builder	associatePublicIpAddress(Boolean associatePublicIpAddress)	Specifies whether to assign a public IPv4 address to the group's instances.
CfnLaunchConfiguration.Builder	associatePublicIpAddress(IResolvable associatePublicIpAddress)	Specifies whether to assign a public IPv4 address to the group's instances.
CfnLaunchConfiguration.Builder	blockDeviceMappings(List<? extends Object> blockDeviceMappings)	The block device mapping entries that define the block devices to attach to the instances at launch.
CfnLaunchConfiguration.Builder	blockDeviceMappings(IResolvable blockDeviceMappings)	The block device mapping entries that define the block devices to attach to the instances at launch.
CfnLaunchConfiguration	build()
CfnLaunchConfiguration.Builder	classicLinkVpcId(String classicLinkVpcId)	Available for backward compatibility.
CfnLaunchConfiguration.Builder	classicLinkVpcSecurityGroups(List<String> classicLinkVpcSecurityGroups)	Available for backward compatibility.
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)	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)	The ID of the Amazon Machine Image (AMI) that was assigned during registration.
CfnLaunchConfiguration.Builder	instanceId(String instanceId)	The ID of the Amazon EC2 instance 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)	The ID of the kernel associated with the AMI.
CfnLaunchConfiguration.Builder	keyName(String keyName)	The name of the key pair.
CfnLaunchConfiguration.Builder	launchConfigurationName(String launchConfigurationName)	The name of the launch configuration.
CfnLaunchConfiguration.Builder	metadataOptions(IResolvable metadataOptions)	The metadata options for the instances.
CfnLaunchConfiguration.Builder	metadataOptions(CfnLaunchConfiguration.MetadataOptionsProperty 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 to be paid for any Spot Instance 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 Details

create

@Stability(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 - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnLaunchConfiguration.Builder.

imageId

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

The 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 .

If you specify InstanceId , an ImageId is not required.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-imageid

instanceType

@Stability(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 .

If you specify InstanceId , an InstanceType is not required.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-instancetype

associatePublicIpAddress

@Stability(Stable)
public CfnLaunchConfiguration.Builder associatePublicIpAddress(Boolean 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.

If you specify true , each instance in the Auto Scaling group receives a unique public IPv4 address. For more information, see Provide network connectivity for your Auto Scaling instances using Amazon VPC in the Amazon EC2 Auto Scaling User Guide .

If you specify this property, you must specify at least one subnet for VPCZoneIdentifier when you create your group.

Parameters:

associatePublicIpAddress - Specifies whether to assign a public IPv4 address to the group's instances. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-associatepublicipaddress

associatePublicIpAddress

@Stability(Stable)
public CfnLaunchConfiguration.Builder associatePublicIpAddress(IResolvable 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.

If you specify true , each instance in the Auto Scaling group receives a unique public IPv4 address. For more information, see Provide network connectivity for your Auto Scaling instances using Amazon VPC in the Amazon EC2 Auto Scaling User Guide .

If you specify this property, you must specify at least one subnet for VPCZoneIdentifier when you create your group.

Parameters:

associatePublicIpAddress - Specifies whether to assign a public IPv4 address to the group's instances. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-associatepublicipaddress

blockDeviceMappings

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-blockdevicemappings

blockDeviceMappings

@Stability(Stable)
public CfnLaunchConfiguration.Builder blockDeviceMappings(List<? extends Object> 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 mappings 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-blockdevicemappings

classicLinkVpcId

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

Available for backward compatibility.

Parameters:

classicLinkVpcId - Available for backward compatibility. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-classiclinkvpcid

classicLinkVpcSecurityGroups

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

Available for backward compatibility.

Parameters:

classicLinkVpcSecurityGroups - Available for backward compatibility. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-classiclinkvpcsecuritygroups

ebsOptimized

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

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

The optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization is not available with all instance types. 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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-ebsoptimized

ebsOptimized

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

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

The optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization is not available with all instance types. 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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-ebsoptimized

iamInstanceProfile

@Stability(Stable)
public CfnLaunchConfiguration.Builder iamInstanceProfile(String 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-iaminstanceprofile

instanceId

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

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

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 to use to create the launch configuration. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-instanceid

instanceMonitoring

@Stability(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-instancemonitoring

instanceMonitoring

@Stability(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-instancemonitoring

kernelId

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

The ID of the kernel associated with the 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 - The ID of the kernel associated with the AMI. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-kernelid

keyName

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

The name of the key pair.

For more information, see Amazon EC2 key pairs and Amazon EC2 instances in the Amazon EC2 User Guide for Linux Instances .

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-keyname

launchConfigurationName

@Stability(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-launchconfigurationname

metadataOptions

@Stability(Stable)
public CfnLaunchConfiguration.Builder metadataOptions(IResolvable metadataOptions)

The metadata options for the instances.

For more information, see Configure 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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-metadataoptions

metadataOptions

@Stability(Stable)
public CfnLaunchConfiguration.Builder metadataOptions(CfnLaunchConfiguration.MetadataOptionsProperty metadataOptions)

The metadata options for the instances.

For more information, see Configure 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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-metadataoptions

placementTenancy

@Stability(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. To launch dedicated instances into a shared tenancy VPC (a VPC with the instance placement tenancy attribute set to default ), you must set the value of this property to dedicated .

If you specify PlacementTenancy , you must specify at least one subnet for VPCZoneIdentifier when you create your group.

Valid values: default | dedicated

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-placementtenancy

ramDiskId

@Stability(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-ramdiskid

securityGroups

@Stability(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 Control traffic to resources using security groups 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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-securitygroups

spotPrice

@Stability(Stable)
public CfnLaunchConfiguration.Builder spotPrice(String 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 Request Spot Instances for fault-tolerant and flexible applications in the Amazon EC2 Auto Scaling User Guide .

Valid Range: Minimum value of 0.001

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.

Parameters:

spotPrice - The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-spotprice

userData

@Stability(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-userdata

build

@Stability(Stable)
public CfnLaunchConfiguration build()

Specified by:

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

Returns:

a newly built instance of CfnLaunchConfiguration.