Package software.amazon.awscdk.services.autoscaling

Class CfnLaunchConfigurationProps.Builder

java.lang.Object

software.amazon.awscdk.services.autoscaling.CfnLaunchConfigurationProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnLaunchConfigurationProps>

Enclosing interface:

CfnLaunchConfigurationProps

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

A builder for CfnLaunchConfigurationProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnLaunchConfigurationProps.Builder	associatePublicIpAddress(Boolean associatePublicIpAddress)	Sets the value of CfnLaunchConfigurationProps.getAssociatePublicIpAddress()
CfnLaunchConfigurationProps.Builder	associatePublicIpAddress(IResolvable associatePublicIpAddress)	Sets the value of CfnLaunchConfigurationProps.getAssociatePublicIpAddress()
CfnLaunchConfigurationProps.Builder	blockDeviceMappings(List<? extends Object> blockDeviceMappings)	Sets the value of CfnLaunchConfigurationProps.getBlockDeviceMappings()
CfnLaunchConfigurationProps.Builder	blockDeviceMappings(IResolvable blockDeviceMappings)	Sets the value of CfnLaunchConfigurationProps.getBlockDeviceMappings()
CfnLaunchConfigurationProps	build()	Builds the configured instance.
CfnLaunchConfigurationProps.Builder	classicLinkVpcId(String classicLinkVpcId)	Sets the value of CfnLaunchConfigurationProps.getClassicLinkVpcId()
CfnLaunchConfigurationProps.Builder	classicLinkVpcSecurityGroups(List<String> classicLinkVpcSecurityGroups)	Sets the value of CfnLaunchConfigurationProps.getClassicLinkVpcSecurityGroups()
CfnLaunchConfigurationProps.Builder	ebsOptimized(Boolean ebsOptimized)	Sets the value of CfnLaunchConfigurationProps.getEbsOptimized()
CfnLaunchConfigurationProps.Builder	ebsOptimized(IResolvable ebsOptimized)	Sets the value of CfnLaunchConfigurationProps.getEbsOptimized()
CfnLaunchConfigurationProps.Builder	iamInstanceProfile(String iamInstanceProfile)	Sets the value of CfnLaunchConfigurationProps.getIamInstanceProfile()
CfnLaunchConfigurationProps.Builder	imageId(String imageId)	Sets the value of CfnLaunchConfigurationProps.getImageId()
CfnLaunchConfigurationProps.Builder	instanceId(String instanceId)	Sets the value of CfnLaunchConfigurationProps.getInstanceId()
CfnLaunchConfigurationProps.Builder	instanceMonitoring(Boolean instanceMonitoring)	Sets the value of CfnLaunchConfigurationProps.getInstanceMonitoring()
CfnLaunchConfigurationProps.Builder	instanceMonitoring(IResolvable instanceMonitoring)	Sets the value of CfnLaunchConfigurationProps.getInstanceMonitoring()
CfnLaunchConfigurationProps.Builder	instanceType(String instanceType)	Sets the value of CfnLaunchConfigurationProps.getInstanceType()
CfnLaunchConfigurationProps.Builder	kernelId(String kernelId)	Sets the value of CfnLaunchConfigurationProps.getKernelId()
CfnLaunchConfigurationProps.Builder	keyName(String keyName)	Sets the value of CfnLaunchConfigurationProps.getKeyName()
CfnLaunchConfigurationProps.Builder	launchConfigurationName(String launchConfigurationName)	Sets the value of CfnLaunchConfigurationProps.getLaunchConfigurationName()
CfnLaunchConfigurationProps.Builder	metadataOptions(IResolvable metadataOptions)	Sets the value of CfnLaunchConfigurationProps.getMetadataOptions()
CfnLaunchConfigurationProps.Builder	metadataOptions(CfnLaunchConfiguration.MetadataOptionsProperty metadataOptions)	Sets the value of CfnLaunchConfigurationProps.getMetadataOptions()
CfnLaunchConfigurationProps.Builder	placementTenancy(String placementTenancy)	Sets the value of CfnLaunchConfigurationProps.getPlacementTenancy()
CfnLaunchConfigurationProps.Builder	ramDiskId(String ramDiskId)	Sets the value of CfnLaunchConfigurationProps.getRamDiskId()
CfnLaunchConfigurationProps.Builder	securityGroups(List<String> securityGroups)	Sets the value of CfnLaunchConfigurationProps.getSecurityGroups()
CfnLaunchConfigurationProps.Builder	spotPrice(String spotPrice)	Sets the value of CfnLaunchConfigurationProps.getSpotPrice()
CfnLaunchConfigurationProps.Builder	userData(String userData)	Sets the value of CfnLaunchConfigurationProps.getUserData()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

imageId

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

Sets the value of CfnLaunchConfigurationProps.getImageId()

Parameters:

imageId - The ID of the Amazon Machine Image (AMI) that was assigned during registration. This parameter is required. For more information, see Finding a Linux AMI in the Amazon EC2 User Guide for Linux Instances .

If you specify InstanceId , an ImageId is not required.

Returns:

this

instanceType

@Stability(Stable)
public CfnLaunchConfigurationProps.Builder instanceType(String instanceType)

Sets the value of CfnLaunchConfigurationProps.getInstanceType()

Parameters:

instanceType - Specifies the instance type of the EC2 instance. This parameter is required. 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.

Returns:

this

associatePublicIpAddress

@Stability(Stable)
public CfnLaunchConfigurationProps.Builder associatePublicIpAddress(Boolean associatePublicIpAddress)

Sets the value of CfnLaunchConfigurationProps.getAssociatePublicIpAddress()

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.

If you specify true , each instance in the Auto Scaling group receives a unique public IPv4 address. For more information, see Launching Auto Scaling instances in a 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.

Returns:

this

associatePublicIpAddress

@Stability(Stable)
public CfnLaunchConfigurationProps.Builder associatePublicIpAddress(IResolvable associatePublicIpAddress)

Sets the value of CfnLaunchConfigurationProps.getAssociatePublicIpAddress()

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.

If you specify true , each instance in the Auto Scaling group receives a unique public IPv4 address. For more information, see Launching Auto Scaling instances in a 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.

Returns:

this

blockDeviceMappings

@Stability(Stable)
public CfnLaunchConfigurationProps.Builder blockDeviceMappings(IResolvable blockDeviceMappings)

Sets the value of CfnLaunchConfigurationProps.getBlockDeviceMappings()

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 mappings in the Amazon EC2 User Guide for Linux Instances .

Returns:

this

blockDeviceMappings

@Stability(Stable)
public CfnLaunchConfigurationProps.Builder blockDeviceMappings(List<? extends Object> blockDeviceMappings)

Sets the value of CfnLaunchConfigurationProps.getBlockDeviceMappings()

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 mappings in the Amazon EC2 User Guide for Linux Instances .

Returns:

this

classicLinkVpcId

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

Sets the value of CfnLaunchConfigurationProps.getClassicLinkVpcId()

Parameters:

classicLinkVpcId - Available for backward compatibility.

Returns:

this

classicLinkVpcSecurityGroups

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

Sets the value of CfnLaunchConfigurationProps.getClassicLinkVpcSecurityGroups()

Parameters:

classicLinkVpcSecurityGroups - Available for backward compatibility.

Returns:

this

ebsOptimized

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

Sets the value of CfnLaunchConfigurationProps.getEbsOptimized()

Parameters:

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 .

Returns:

this

ebsOptimized

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

Sets the value of CfnLaunchConfigurationProps.getEbsOptimized()

Parameters:

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 .

Returns:

this

iamInstanceProfile

@Stability(Stable)
public CfnLaunchConfigurationProps.Builder iamInstanceProfile(String iamInstanceProfile)

Sets the value of CfnLaunchConfigurationProps.getIamInstanceProfile()

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:

this

instanceId

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

Sets the value of CfnLaunchConfigurationProps.getInstanceId()

Parameters:

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.

Returns:

this

instanceMonitoring

@Stability(Stable)
public CfnLaunchConfigurationProps.Builder instanceMonitoring(Boolean instanceMonitoring)

Sets the value of CfnLaunchConfigurationProps.getInstanceMonitoring()

Parameters:

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 .

Returns:

this

instanceMonitoring

@Stability(Stable)
public CfnLaunchConfigurationProps.Builder instanceMonitoring(IResolvable instanceMonitoring)

Sets the value of CfnLaunchConfigurationProps.getInstanceMonitoring()

Parameters:

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 .

Returns:

this

kernelId

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

Sets the value of CfnLaunchConfigurationProps.getKernelId()

Parameters:

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 .

Returns:

this

keyName

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

Sets the value of CfnLaunchConfigurationProps.getKeyName()

Parameters:

keyName - The name of the key pair. For more information, see Amazon EC2 key pairs and Linux instances in the Amazon EC2 User Guide for Linux Instances .

Returns:

this

launchConfigurationName

@Stability(Stable)
public CfnLaunchConfigurationProps.Builder launchConfigurationName(String launchConfigurationName)

Sets the value of CfnLaunchConfigurationProps.getLaunchConfigurationName()

Parameters:

launchConfigurationName - The name of the launch configuration. This name must be unique per Region per account.

Returns:

this

metadataOptions

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

Sets the value of CfnLaunchConfigurationProps.getMetadataOptions()

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:

this

metadataOptions

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

Sets the value of CfnLaunchConfigurationProps.getMetadataOptions()

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:

this

placementTenancy

@Stability(Stable)
public CfnLaunchConfigurationProps.Builder placementTenancy(String placementTenancy)

Sets the value of CfnLaunchConfigurationProps.getPlacementTenancy()

Parameters:

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 . For more information, see Configuring instance tenancy with Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide .

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

Valid values: default | dedicated

Returns:

this

ramDiskId

@Stability(Stable)
public CfnLaunchConfigurationProps.Builder ramDiskId(String ramDiskId)

Sets the value of CfnLaunchConfigurationProps.getRamDiskId()

Parameters:

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 .

Returns:

this

securityGroups

@Stability(Stable)
public CfnLaunchConfigurationProps.Builder securityGroups(List<String> securityGroups)

Sets the value of CfnLaunchConfigurationProps.getSecurityGroups()

Parameters:

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 .

Returns:

this

spotPrice

@Stability(Stable)
public CfnLaunchConfigurationProps.Builder spotPrice(String spotPrice)

Sets the value of CfnLaunchConfigurationProps.getSpotPrice()

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

Returns:

this

userData

@Stability(Stable)
public CfnLaunchConfigurationProps.Builder userData(String userData)

Sets the value of CfnLaunchConfigurationProps.getUserData()

Parameters:

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 .

Returns:

this

build

@Stability(Stable)
public CfnLaunchConfigurationProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnLaunchConfigurationProps

Throws:

NullPointerException - if any required attribute was not provided