Class CfnLaunchConfiguration
- Namespace
- Amazon.CDK.AWS.AutoScaling
- Assembly
- Amazon.CDK.AWS.AutoScaling.dll
A CloudFormation AWS::AutoScaling::LaunchConfiguration.
public class CfnLaunchConfiguration : CfnResource, IInspectable- Inheritance
-
CfnLaunchConfiguration
- Implements
-
IInspectable
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AutoScaling;
var cfnLaunchConfiguration = new CfnLaunchConfiguration(this, "MyCfnLaunchConfiguration", new CfnLaunchConfigurationProps {
ImageId = "imageId",
InstanceType = "instanceType",
// the properties below are optional
AssociatePublicIpAddress = false,
BlockDeviceMappings = new [] { new BlockDeviceMappingProperty {
DeviceName = "deviceName",
// the properties below are optional
Ebs = new BlockDeviceProperty {
DeleteOnTermination = false,
Encrypted = false,
Iops = 123,
SnapshotId = "snapshotId",
Throughput = 123,
VolumeSize = 123,
VolumeType = "volumeType"
},
NoDevice = false,
VirtualName = "virtualName"
} },
ClassicLinkVpcId = "classicLinkVpcId",
ClassicLinkVpcSecurityGroups = new [] { "classicLinkVpcSecurityGroups" },
EbsOptimized = false,
IamInstanceProfile = "iamInstanceProfile",
InstanceId = "instanceId",
InstanceMonitoring = false,
KernelId = "kernelId",
KeyName = "keyName",
LaunchConfigurationName = "launchConfigurationName",
MetadataOptions = new MetadataOptionsProperty {
HttpEndpoint = "httpEndpoint",
HttpPutResponseHopLimit = 123,
HttpTokens = "httpTokens"
},
PlacementTenancy = "placementTenancy",
RamDiskId = "ramDiskId",
SecurityGroups = new [] { "securityGroups" },
SpotPrice = "spotPrice",
UserData = "userData"
});Remarks
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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html">launch template</a> 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 <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-configurations.html">Launch configurations</a> and <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/migrate-launch-configurations-with-cloudformation.html">Migrate AWS CloudFormation stacks from launch configurations to launch templates</a> in the <em>Amazon EC2 Auto Scaling User Guide</em> .
CloudformationResource: AWS::AutoScaling::LaunchConfiguration
ExampleMetadata: fixture=_generated
Constructors
CfnLaunchConfiguration(Construct, string, ICfnLaunchConfigurationProps)
Create a new AWS::AutoScaling::LaunchConfiguration.
public CfnLaunchConfiguration(Construct scope, string id, ICfnLaunchConfigurationProps props)Parameters
scopeConstruct- scope in which this resource is defined.
idstring- scoped id of the resource.
propsICfnLaunchConfigurationProps- resource properties.
Properties
AssociatePublicIpAddress
Specifies whether to assign a public IPv4 address to the group's instances.
public virtual object? AssociatePublicIpAddress { get; set; }Property Value
Remarks
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.
BlockDeviceMappings
The block device mapping entries that define the block devices to attach to the instances at launch.
public virtual object? BlockDeviceMappings { get; set; }Property Value
Remarks
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 .
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }Property Value
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }Property Value
ClassicLinkVpcId
Available for backward compatibility.
public virtual string? ClassicLinkVpcId { get; set; }Property Value
Remarks
ClassicLinkVpcSecurityGroups
Available for backward compatibility.
public virtual string[]? ClassicLinkVpcSecurityGroups { get; set; }Property Value
- string[]
Remarks
EbsOptimized
Specifies whether the launch configuration is optimized for EBS I/O ( true ) or not ( false ).
public virtual object? EbsOptimized { get; set; }Property Value
Remarks
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 .
IamInstanceProfile
The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.
public virtual string? IamInstanceProfile { get; set; }Property Value
Remarks
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 .
ImageId
The ID of the Amazon Machine Image (AMI) that was assigned during registration.
public virtual string ImageId { get; set; }Property Value
Remarks
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.
InstanceId
The ID of the Amazon EC2 instance to use to create the launch configuration.
public virtual string? InstanceId { get; set; }Property Value
Remarks
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.
InstanceMonitoring
Controls whether instances in this group are launched with detailed ( true ) or basic ( false ) monitoring.
public virtual object? InstanceMonitoring { get; set; }Property Value
Remarks
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 <a href="https://docs.aws.amazon.com/autoscaling/latest/userguide/enable-as-instance-metrics.html">Configure Monitoring for Auto Scaling Instances</a> in the <em>Amazon EC2 Auto Scaling User Guide</em> .
InstanceType
Specifies the instance type of the EC2 instance.
public virtual string InstanceType { get; set; }Property Value
Remarks
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.
KernelId
The ID of the kernel associated with the AMI.
public virtual string? KernelId { get; set; }Property Value
Remarks
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html">User provided kernels</a> in the <em>Amazon EC2 User Guide for Linux Instances</em> .
KeyName
The name of the key pair.
public virtual string? KeyName { get; set; }Property Value
Remarks
For more information, see Amazon EC2 key pairs and Linux instances in the Amazon EC2 User Guide for Linux Instances .
LaunchConfigurationName
The name of the launch configuration.
public virtual string? LaunchConfigurationName { get; set; }Property Value
Remarks
This name must be unique per Region per account.
MetadataOptions
The metadata options for the instances.
public virtual object? MetadataOptions { get; set; }Property Value
Remarks
For more information, see Configuring the Instance Metadata Options in the Amazon EC2 Auto Scaling User Guide .
PlacementTenancy
The tenancy of the instance, either default or dedicated .
public virtual string? PlacementTenancy { get; set; }Property Value
Remarks
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
RamDiskId
The ID of the RAM disk to select.
public virtual string? RamDiskId { get; set; }Property Value
Remarks
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html">User provided kernels</a> in the <em>Amazon EC2 User Guide for Linux Instances</em> .
SecurityGroups
A list that contains the security groups to assign to the instances in the Auto Scaling group.
public virtual string[]? SecurityGroups { get; set; }Property Value
- string[]
Remarks
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 .
SpotPrice
The maximum hourly price to be paid for any Spot Instance launched to fulfill the request.
public virtual string? SpotPrice { get; set; }Property Value
Remarks
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.
UserData
The Base64-encoded user data to make available to the launched EC2 instances.
public virtual string? UserData { get; set; }Property Value
Remarks
For more information, see Instance metadata and user data in the Amazon EC2 User Guide for Linux Instances .
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)Parameters
inspectorTreeInspector- tree inspector to collect and process attributes.
RenderProperties(IDictionary<string, object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)Parameters
propsIDictionary<string, object>