Package software.amazon.awscdk.services.autoscaling

Class CfnLaunchConfiguration

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.autoscaling.CfnLaunchConfiguration
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:45.263Z") @Stability(Stable) public class CfnLaunchConfiguration extends CfnResource implements IInspectable
A CloudFormation AWS::AutoScaling::LaunchConfiguration.

The AWS::AutoScaling::LaunchConfiguration resource specifies the launch configuration that can be used by an Auto Scaling group to configure Amazon EC2 instances.

When you update the launch configuration for an Auto Scaling group, CloudFormation deletes that resource and creates a new launch configuration with the updated properties and a new name. Existing instances are not affected. To update existing instances when you update the AWS::AutoScaling::LaunchConfiguration resource, you can specify an UpdatePolicy attribute for the group. You can find sample update policies for rolling updates in Auto scaling template snippets .

Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a launch template or a launch configuration. We strongly recommend that you do not use launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2. For more information, see Launch configurations and Migrate AWS CloudFormation stacks from launch configurations to launch templates in the Amazon EC2 Auto Scaling User Guide .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.autoscaling.*;
 CfnLaunchConfiguration cfnLaunchConfiguration = CfnLaunchConfiguration.Builder.create(this, "MyCfnLaunchConfiguration")
         .imageId("imageId")
         .instanceType("instanceType")
         // the properties below are optional
         .associatePublicIpAddress(false)
         .blockDeviceMappings(List.of(BlockDeviceMappingProperty.builder()
                 .deviceName("deviceName")
                 // the properties below are optional
                 .ebs(BlockDeviceProperty.builder()
                         .deleteOnTermination(false)
                         .encrypted(false)
                         .iops(123)
                         .snapshotId("snapshotId")
                         .throughput(123)
                         .volumeSize(123)
                         .volumeType("volumeType")
                         .build())
                 .noDevice(false)
                 .virtualName("virtualName")
                 .build()))
         .classicLinkVpcId("classicLinkVpcId")
         .classicLinkVpcSecurityGroups(List.of("classicLinkVpcSecurityGroups"))
         .ebsOptimized(false)
         .iamInstanceProfile("iamInstanceProfile")
         .instanceId("instanceId")
         .instanceMonitoring(false)
         .kernelId("kernelId")
         .keyName("keyName")
         .launchConfigurationName("launchConfigurationName")
         .metadataOptions(MetadataOptionsProperty.builder()
                 .httpEndpoint("httpEndpoint")
                 .httpPutResponseHopLimit(123)
                 .httpTokens("httpTokens")
                 .build())
         .placementTenancy("placementTenancy")
         .ramDiskId("ramDiskId")
         .securityGroups(List.of("securityGroups"))
         .spotPrice("spotPrice")
         .userData("userData")
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnLaunchConfiguration

      protected CfnLaunchConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnLaunchConfiguration

      protected CfnLaunchConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnLaunchConfiguration

      @Stability(Stable) public CfnLaunchConfiguration(@NotNull Construct scope, @NotNull String id, @NotNull CfnLaunchConfigurationProps props)
      Create a new AWS::AutoScaling::LaunchConfiguration.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getImageId

      @Stability(Stable) @NotNull public String getImageId()
      The ID of the Amazon Machine Image (AMI) that was assigned during registration.

      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.

    • setImageId

      @Stability(Stable) public void setImageId(@NotNull String value)
      The ID of the Amazon Machine Image (AMI) that was assigned during registration.

      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.

    • getInstanceType

      @Stability(Stable) @NotNull public String getInstanceType()
      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.

    • setInstanceType

      @Stability(Stable) public void setInstanceType(@NotNull String value)
      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.

    • getAssociatePublicIpAddress

      @Stability(Stable) @Nullable public Object getAssociatePublicIpAddress()
      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.

    • setAssociatePublicIpAddress

      @Stability(Stable) public void setAssociatePublicIpAddress(@Nullable Boolean value)
      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.

    • setAssociatePublicIpAddress

      @Stability(Stable) public void setAssociatePublicIpAddress(@Nullable IResolvable value)
      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.

    • getBlockDeviceMappings

      @Stability(Stable) @Nullable public Object getBlockDeviceMappings()
      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 .

    • setBlockDeviceMappings

      @Stability(Stable) public void setBlockDeviceMappings(@Nullable IResolvable value)
      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 .

    • setBlockDeviceMappings

      @Stability(Stable) public void setBlockDeviceMappings(@Nullable List<Object> value)
      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 .

    • getClassicLinkVpcId

      @Stability(Stable) @Nullable public String getClassicLinkVpcId()
      Available for backward compatibility.

    • setClassicLinkVpcId

      @Stability(Stable) public void setClassicLinkVpcId(@Nullable String value)
      Available for backward compatibility.

    • getClassicLinkVpcSecurityGroups

      @Stability(Stable) @Nullable public List<String> getClassicLinkVpcSecurityGroups()
      Available for backward compatibility.

    • setClassicLinkVpcSecurityGroups

      @Stability(Stable) public void setClassicLinkVpcSecurityGroups(@Nullable List<String> value)
      Available for backward compatibility.

    • getEbsOptimized

      @Stability(Stable) @Nullable public Object getEbsOptimized()
      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 .

    • setEbsOptimized

      @Stability(Stable) public void setEbsOptimized(@Nullable Boolean value)
      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 .

    • setEbsOptimized

      @Stability(Stable) public void setEbsOptimized(@Nullable IResolvable value)
      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 .

    • getIamInstanceProfile

      @Stability(Stable) @Nullable public String getIamInstanceProfile()
      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 .

    • setIamInstanceProfile

      @Stability(Stable) public void setIamInstanceProfile(@Nullable String value)
      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 .

    • getInstanceId

      @Stability(Stable) @Nullable public String getInstanceId()
      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.

    • setInstanceId

      @Stability(Stable) public void setInstanceId(@Nullable String value)
      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.

    • getInstanceMonitoring

      @Stability(Stable) @Nullable public Object getInstanceMonitoring()
      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 .

    • setInstanceMonitoring

      @Stability(Stable) public void setInstanceMonitoring(@Nullable Boolean value)
      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 .

    • setInstanceMonitoring

      @Stability(Stable) public void setInstanceMonitoring(@Nullable IResolvable value)
      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 .

    • getKernelId

      @Stability(Stable) @Nullable public String getKernelId()
      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 .

    • setKernelId

      @Stability(Stable) public void setKernelId(@Nullable String value)
      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 .

    • getKeyName

      @Stability(Stable) @Nullable public String getKeyName()
      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 .

    • setKeyName

      @Stability(Stable) public void setKeyName(@Nullable String value)
      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 .

    • getLaunchConfigurationName

      @Stability(Stable) @Nullable public String getLaunchConfigurationName()
      The name of the launch configuration.

      This name must be unique per Region per account.

    • setLaunchConfigurationName

      @Stability(Stable) public void setLaunchConfigurationName(@Nullable String value)
      The name of the launch configuration.

      This name must be unique per Region per account.

    • getMetadataOptions

      @Stability(Stable) @Nullable public Object getMetadataOptions()
      The metadata options for the instances.

      For more information, see Configuring the Instance Metadata Options in the Amazon EC2 Auto Scaling User Guide .

    • setMetadataOptions

      @Stability(Stable) public void setMetadataOptions(@Nullable IResolvable value)
      The metadata options for the instances.

      For more information, see Configuring the Instance Metadata Options in the Amazon EC2 Auto Scaling User Guide .

    • setMetadataOptions

      @Stability(Stable) public void setMetadataOptions(@Nullable CfnLaunchConfiguration.MetadataOptionsProperty value)
      The metadata options for the instances.

      For more information, see Configuring the Instance Metadata Options in the Amazon EC2 Auto Scaling User Guide .

    • getPlacementTenancy

      @Stability(Stable) @Nullable public String getPlacementTenancy()
      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

    • setPlacementTenancy

      @Stability(Stable) public void setPlacementTenancy(@Nullable String value)
      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

    • getRamDiskId

      @Stability(Stable) @Nullable public String getRamDiskId()
      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 .

    • setRamDiskId

      @Stability(Stable) public void setRamDiskId(@Nullable String value)
      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 .

    • getSecurityGroups

      @Stability(Stable) @Nullable public List<String> getSecurityGroups()
      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 .

    • setSecurityGroups

      @Stability(Stable) public void setSecurityGroups(@Nullable List<String> value)
      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 .

    • getSpotPrice

      @Stability(Stable) @Nullable public String getSpotPrice()
      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.

    • setSpotPrice

      @Stability(Stable) public void setSpotPrice(@Nullable String value)
      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.

    • getUserData

      @Stability(Stable) @Nullable public String getUserData()
      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 .

    • setUserData

      @Stability(Stable) public void setUserData(@Nullable String value)
      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 .