Interface CfnLaunchConfigurationProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnLaunchConfigurationProps.Jsii$Proxy
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();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnLaunchConfigurationPropsstatic final classAn implementation forCfnLaunchConfigurationProps -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default ObjectSpecifies whether to assign a public IPv4 address to the group's instances.default ObjectThe block device mapping entries that define the block devices to attach to the instances at launch.default StringAvailable for backward compatibility.Available for backward compatibility.default ObjectSpecifies whether the launch configuration is optimized for EBS I/O (true) or not (false).default StringThe name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.The ID of the Amazon Machine Image (AMI) that was assigned during registration.default StringThe ID of the Amazon EC2 instance to use to create the launch configuration.default ObjectControls whether instances in this group are launched with detailed (true) or basic (false) monitoring.Specifies the instance type of the EC2 instance.default StringThe ID of the kernel associated with the AMI.default StringThe name of the key pair.default StringThe name of the launch configuration.default ObjectThe metadata options for the instances.default StringThe tenancy of the instance, eitherdefaultordedicated.default StringThe ID of the RAM disk to select.A list that contains the security groups to assign to the instances in the Auto Scaling group.default StringThe maximum hourly price to be paid for any Spot Instance launched to fulfill the request.default StringThe Base64-encoded user data to make available to the launched EC2 instances.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getImageId
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, anImageIdis not required.- See Also:
-
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, anInstanceTypeis not required.- See Also:
-
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 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
VPCZoneIdentifierwhen you create your group.- See Also:
-
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 .
- See Also:
-
getClassicLinkVpcId
Available for backward compatibility.- See Also:
-
getClassicLinkVpcSecurityGroups
Available for backward compatibility.- See Also:
-
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.- See Also:
-
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 .
- See Also:
-
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
BlockDeviceMappingandAssociatePublicIpAddress. You can override any properties from the instance by specifying them in the launch configuration.- See Also:
-
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 .
- See Also:
-
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 .
- See Also:
-
getKeyName
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 .
- See Also:
-
getLaunchConfigurationName
The name of the launch configuration.This name must be unique per Region per account.
- See Also:
-
getMetadataOptions
The metadata options for the instances.For more information, see Configure the instance metadata options in the Amazon EC2 Auto Scaling User Guide .
- See Also:
-
getPlacementTenancy
The tenancy of the instance, eitherdefaultordedicated.An instance with
dedicatedtenancy 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 todefault), you must set the value of this property todedicated.If you specify
PlacementTenancy, you must specify at least one subnet forVPCZoneIdentifierwhen you create your group.Valid values:
default|dedicated- See Also:
-
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 .
- See Also:
-
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 .
- See Also:
-
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.
- See Also:
-
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 .
- See Also:
-
builder
-