CfnLaunchConfigurationProps (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnLaunchConfigurationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.764Z")
 @Stability(value=Stable)
public interface CfnLaunchConfigurationProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnLaunchConfiguration`.

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.*;
 CfnLaunchConfigurationProps cfnLaunchConfigurationProps = CfnLaunchConfigurationProps.builder()
         .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();

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`CfnLaunchConfigurationProps.Builder` A builder for `CfnLaunchConfigurationProps`
`static class`	`CfnLaunchConfigurationProps.Jsii$Proxy` An implementation for `CfnLaunchConfigurationProps`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static CfnLaunchConfigurationProps.Builder`	`builder()`
`default Object`	`getAssociatePublicIpAddress()` Specifies whether to assign a public IPv4 address to the group's instances.
`default Object`	`getBlockDeviceMappings()` The block device mapping entries that define the block devices to attach to the instances at launch.
`default String`	`getClassicLinkVpcId()` *EC2-Classic retires on August 15, 2022.
`default List<String>`	`getClassicLinkVpcSecurityGroups()` *EC2-Classic retires on August 15, 2022.
`default Object`	`getEbsOptimized()` Specifies whether the launch configuration is optimized for EBS I/O ( `true` ) or not ( `false` ).
`default String`	`getIamInstanceProfile()` The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.
`String`	`getImageId()` The ID of the Amazon Machine Image (AMI) that was assigned during registration.
`default String`	`getInstanceId()` The ID of the Amazon EC2 instance to use to create the launch configuration.
`default Object`	`getInstanceMonitoring()` Controls whether instances in this group are launched with detailed ( `true` ) or basic ( `false` ) monitoring.
`String`	`getInstanceType()` Specifies the instance type of the EC2 instance.
`default String`	`getKernelId()` The ID of the kernel associated with the AMI.
`default String`	`getKeyName()` The name of the key pair.
`default String`	`getLaunchConfigurationName()` The name of the launch configuration.
`default Object`	`getMetadataOptions()` The metadata options for the instances.
`default String`	`getPlacementTenancy()` The tenancy of the instance, either `default` or `dedicated` .
`default String`	`getRamDiskId()` The ID of the RAM disk to select.
`default List<String>`	`getSecurityGroups()` A list that contains the security groups to assign to the instances in the Auto Scaling group.
`default String`	`getSpotPrice()` The maximum hourly price to be paid for any Spot Instance launched to fulfill the request.
`default String`	`getUserData()` The Base64-encoded user data to make available to the launched EC2 instances.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Method Detail
  - getImageId
```
@Stability(value=Stable)
 @NotNull
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.
  - getInstanceType
```
@Stability(value=Stable)
 @NotNull
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.
  - getAssociatePublicIpAddress
```
@Stability(value=Stable)
 @Nullable
default 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.
  - getBlockDeviceMappings
```
@Stability(value=Stable)
 @Nullable
default 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 .
  - getClassicLinkVpcId
```
@Stability(value=Stable)
 @Nullable
default String getClassicLinkVpcId()
```
    *EC2-Classic retires on August 15, 2022. This property is not supported after that date.*.
    The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances .
  - getClassicLinkVpcSecurityGroups
```
@Stability(value=Stable)
 @Nullable
default List<String> getClassicLinkVpcSecurityGroups()
```
    *EC2-Classic retires on August 15, 2022. This property is not supported after that date.*.
    The IDs of one or more security groups for the specified ClassicLink-enabled VPC.
    If you specify the ClassicLinkVPCId property, you must specify ClassicLinkVPCSecurityGroups .
  - getEbsOptimized
```
@Stability(value=Stable)
 @Nullable
default 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 .
  - getIamInstanceProfile
```
@Stability(value=Stable)
 @Nullable
default 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 .
  - getInstanceId
```
@Stability(value=Stable)
 @Nullable
default 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.
  - getInstanceMonitoring
```
@Stability(value=Stable)
 @Nullable
default 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 .
  - getKernelId
```
@Stability(value=Stable)
 @Nullable
default 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 .
  - getKeyName
```
@Stability(value=Stable)
 @Nullable
default 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 .
  - getLaunchConfigurationName
```
@Stability(value=Stable)
 @Nullable
default String getLaunchConfigurationName()
```
    The name of the launch configuration.
    This name must be unique per Region per account.
  - getMetadataOptions
```
@Stability(value=Stable)
 @Nullable
default 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 .
  - getPlacementTenancy
```
@Stability(value=Stable)
 @Nullable
default 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
  - getRamDiskId
```
@Stability(value=Stable)
 @Nullable
default 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 .
  - getSecurityGroups
```
@Stability(value=Stable)
 @Nullable
default 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 .
  - getSpotPrice
```
@Stability(value=Stable)
 @Nullable
default 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.
  - getUserData
```
@Stability(value=Stable)
 @Nullable
default 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 .
  - builder
```
@Stability(value=Stable)
static CfnLaunchConfigurationProps.Builder builder()
```
    Returns:
    
    a CfnLaunchConfigurationProps.Builder of CfnLaunchConfigurationProps

Interface CfnLaunchConfigurationProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Detail

getImageId

getInstanceType

getAssociatePublicIpAddress

getBlockDeviceMappings

getClassicLinkVpcId

getClassicLinkVpcSecurityGroups

getEbsOptimized

getIamInstanceProfile

getInstanceId

getInstanceMonitoring

getKernelId

getKeyName

getLaunchConfigurationName

getMetadataOptions

getPlacementTenancy

getRamDiskId

getSecurityGroups

getSpotPrice

getUserData

builder