Interface ICfnAutoScalingGroupProps
- Namespace
- Amazon.CDK.AWS.AutoScaling
- Assembly
- Amazon.CDK.AWS.AutoScaling.dll
Properties for defining a CfnAutoScalingGroup.
public interface ICfnAutoScalingGroupPropsExamples
// 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 cfnAutoScalingGroupProps = new CfnAutoScalingGroupProps {
MaxSize = "maxSize",
MinSize = "minSize",
// the properties below are optional
AutoScalingGroupName = "autoScalingGroupName",
AvailabilityZones = new [] { "availabilityZones" },
CapacityRebalance = false,
Context = "context",
Cooldown = "cooldown",
DefaultInstanceWarmup = 123,
DesiredCapacity = "desiredCapacity",
DesiredCapacityType = "desiredCapacityType",
HealthCheckGracePeriod = 123,
HealthCheckType = "healthCheckType",
InstanceId = "instanceId",
LaunchConfigurationName = "launchConfigurationName",
LaunchTemplate = new LaunchTemplateSpecificationProperty {
Version = "version",
// the properties below are optional
LaunchTemplateId = "launchTemplateId",
LaunchTemplateName = "launchTemplateName"
},
LifecycleHookSpecificationList = new [] { new LifecycleHookSpecificationProperty {
LifecycleHookName = "lifecycleHookName",
LifecycleTransition = "lifecycleTransition",
// the properties below are optional
DefaultResult = "defaultResult",
HeartbeatTimeout = 123,
NotificationMetadata = "notificationMetadata",
NotificationTargetArn = "notificationTargetArn",
RoleArn = "roleArn"
} },
LoadBalancerNames = new [] { "loadBalancerNames" },
MaxInstanceLifetime = 123,
MetricsCollection = new [] { new MetricsCollectionProperty {
Granularity = "granularity",
// the properties below are optional
Metrics = new [] { "metrics" }
} },
MixedInstancesPolicy = new MixedInstancesPolicyProperty {
LaunchTemplate = new LaunchTemplateProperty {
LaunchTemplateSpecification = new LaunchTemplateSpecificationProperty {
Version = "version",
// the properties below are optional
LaunchTemplateId = "launchTemplateId",
LaunchTemplateName = "launchTemplateName"
},
// the properties below are optional
Overrides = new [] { new LaunchTemplateOverridesProperty {
InstanceRequirements = new InstanceRequirementsProperty {
AcceleratorCount = new AcceleratorCountRequestProperty {
Max = 123,
Min = 123
},
AcceleratorManufacturers = new [] { "acceleratorManufacturers" },
AcceleratorNames = new [] { "acceleratorNames" },
AcceleratorTotalMemoryMiB = new AcceleratorTotalMemoryMiBRequestProperty {
Max = 123,
Min = 123
},
AcceleratorTypes = new [] { "acceleratorTypes" },
AllowedInstanceTypes = new [] { "allowedInstanceTypes" },
BareMetal = "bareMetal",
BaselineEbsBandwidthMbps = new BaselineEbsBandwidthMbpsRequestProperty {
Max = 123,
Min = 123
},
BurstablePerformance = "burstablePerformance",
CpuManufacturers = new [] { "cpuManufacturers" },
ExcludedInstanceTypes = new [] { "excludedInstanceTypes" },
InstanceGenerations = new [] { "instanceGenerations" },
LocalStorage = "localStorage",
LocalStorageTypes = new [] { "localStorageTypes" },
MemoryGiBPerVCpu = new MemoryGiBPerVCpuRequestProperty {
Max = 123,
Min = 123
},
MemoryMiB = new MemoryMiBRequestProperty {
Max = 123,
Min = 123
},
NetworkBandwidthGbps = new NetworkBandwidthGbpsRequestProperty {
Max = 123,
Min = 123
},
NetworkInterfaceCount = new NetworkInterfaceCountRequestProperty {
Max = 123,
Min = 123
},
OnDemandMaxPricePercentageOverLowestPrice = 123,
RequireHibernateSupport = false,
SpotMaxPricePercentageOverLowestPrice = 123,
TotalLocalStorageGb = new TotalLocalStorageGBRequestProperty {
Max = 123,
Min = 123
},
VCpuCount = new VCpuCountRequestProperty {
Max = 123,
Min = 123
}
},
InstanceType = "instanceType",
LaunchTemplateSpecification = new LaunchTemplateSpecificationProperty {
Version = "version",
// the properties below are optional
LaunchTemplateId = "launchTemplateId",
LaunchTemplateName = "launchTemplateName"
},
WeightedCapacity = "weightedCapacity"
} }
},
// the properties below are optional
InstancesDistribution = new InstancesDistributionProperty {
OnDemandAllocationStrategy = "onDemandAllocationStrategy",
OnDemandBaseCapacity = 123,
OnDemandPercentageAboveBaseCapacity = 123,
SpotAllocationStrategy = "spotAllocationStrategy",
SpotInstancePools = 123,
SpotMaxPrice = "spotMaxPrice"
}
},
NewInstancesProtectedFromScaleIn = false,
NotificationConfigurations = new [] { new NotificationConfigurationProperty {
TopicArn = "topicArn",
// the properties below are optional
NotificationTypes = new [] { "notificationTypes" }
} },
PlacementGroup = "placementGroup",
ServiceLinkedRoleArn = "serviceLinkedRoleArn",
Tags = new [] { new TagPropertyProperty {
Key = "key",
PropagateAtLaunch = false,
Value = "value"
} },
TargetGroupArns = new [] { "targetGroupArns" },
TerminationPolicies = new [] { "terminationPolicies" },
VpcZoneIdentifier = new [] { "vpcZoneIdentifier" }
};Remarks
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html
ExampleMetadata: fixture=_generated
Properties
AutoScalingGroupName
The name of the Auto Scaling group. This name must be unique per Region per account.
string? AutoScalingGroupName { get; }Property Value
Remarks
The name can contain any ASCII character 33 to 126 including most punctuation characters, digits, and upper and lowercased letters.
You cannot use a colon (:) in the name.
AvailabilityZones
A list of Availability Zones where instances in the Auto Scaling group can be created.
string[]? AvailabilityZones { get; }Property Value
- string[]
Remarks
Used for launching into the default VPC subnet in each Availability Zone when not using the VPCZoneIdentifier property, or for attaching a network interface when an existing network interface ID is specified in a launch template.
CapacityRebalance
Indicates whether Capacity Rebalancing is enabled.
object? CapacityRebalance { get; }Property Value
Remarks
Otherwise, Capacity Rebalancing is disabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of interruption. After launching a new instance, it then terminates an old instance. For more information, see Use Capacity Rebalancing to handle Amazon EC2 Spot Interruptions in the in the Amazon EC2 Auto Scaling User Guide .
Context
Reserved.
string? Context { get; }Property Value
Remarks
Cooldown
Only needed if you use simple scaling policies..
string? Cooldown { get; }Property Value
Remarks
The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide .
Default: 300 seconds
DefaultInstanceWarmup
The amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the InService state.
double? DefaultInstanceWarmup { get; }Property Value
Remarks
During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see Set the default instance warmup for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide .
To manage various warm-up settings at the group level, we recommend that you set the default instance warmup, <em>even if it is set to 0 seconds</em> . To remove a value that you previously set, include the property but specify <code>-1</code> for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of <code>0</code> or other nominal value.
Default: None
DesiredCapacity
The desired capacity is the initial capacity of the Auto Scaling group at the time of its creation and the capacity it attempts to maintain.
string? DesiredCapacity { get; }Property Value
Remarks
It can scale beyond this capacity if you configure automatic scaling.
The number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity when creating the stack, the default is the minimum size of the group.
CloudFormation marks the Auto Scaling group as successful (by setting its status to CREATE_COMPLETE) when the desired capacity is reached. However, if a maximum Spot price is set in the launch template or launch configuration that you specified, then desired capacity is not used as a criteria for success. Whether your request is fulfilled depends on Spot Instance capacity and your maximum price.
DesiredCapacityType
The unit of measurement for the value specified for desired capacity.
string? DesiredCapacityType { get; }Property Value
Remarks
Amazon EC2 Auto Scaling supports DesiredCapacityType for attribute-based instance type selection only. For more information, see Creating an Auto Scaling group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide .
By default, Amazon EC2 Auto Scaling specifies units , which translates into number of instances.
Valid values: units | vcpu | memory-mib
HealthCheckGracePeriod
The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed health check.
double? HealthCheckGracePeriod { get; }Property Value
Remarks
This is useful if your instances do not immediately pass their health checks after they enter the InService state. For more information, see Set the health check grace period for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide .
Default: 0 seconds
HealthCheckType
A comma-separated value string of one or more health check types.
string? HealthCheckType { get; }Property Value
Remarks
The valid values are EC2 , ELB , and VPC_LATTICE . EC2 is the default health check and cannot be disabled. For more information, see Health checks for Auto Scaling instances in the Amazon EC2 Auto Scaling User Guide .
Only specify EC2 if you must clear a value that was previously set.
InstanceId
The ID of the instance used to base the launch configuration on.
string? InstanceId { get; }Property Value
Remarks
For more information, see Create an Auto Scaling group using an EC2 instance in the Amazon EC2 Auto Scaling User Guide .
If you specify LaunchTemplate , MixedInstancesPolicy , or LaunchConfigurationName , don't specify InstanceId .
LaunchConfigurationName
The name of the launch configuration to use to launch instances.
string? LaunchConfigurationName { get; }Property Value
Remarks
Required only if you don't specify LaunchTemplate , MixedInstancesPolicy , or InstanceId .
LaunchTemplate
Information used to specify the launch template and version to use to launch instances.
object? LaunchTemplate { get; }Property Value
Remarks
You can alternatively associate a launch template to the Auto Scaling group by specifying a MixedInstancesPolicy . For more information about creating launch templates, see Create a launch template for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide .
If you omit this property, you must specify MixedInstancesPolicy , LaunchConfigurationName , or InstanceId .
LifecycleHookSpecificationList
One or more lifecycle hooks to add to the Auto Scaling group before instances are launched.
object? LifecycleHookSpecificationList { get; }Property Value
Remarks
LoadBalancerNames
A list of Classic Load Balancers associated with this Auto Scaling group.
string[]? LoadBalancerNames { get; }Property Value
- string[]
Remarks
For Application Load Balancers, Network Load Balancers, and Gateway Load Balancers, specify the TargetGroupARNs property instead.
MaxInstanceLifetime
The maximum amount of time, in seconds, that an instance can be in service.
double? MaxInstanceLifetime { get; }Property Value
Remarks
The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). For more information, see Replacing Auto Scaling instances based on maximum instance lifetime in the Amazon EC2 Auto Scaling User Guide .
MaxSize
The maximum size of the group.
string MaxSize { get; }Property Value
Remarks
With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above <code>MaxSize</code> to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go above <code>MaxSize</code> by more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group).
MetricsCollection
Enables the monitoring of group metrics of an Auto Scaling group.
object? MetricsCollection { get; }Property Value
Remarks
By default, these metrics are disabled.
MinSize
The minimum size of the group.
string MinSize { get; }Property Value
Remarks
MixedInstancesPolicy
An embedded object that specifies a mixed instances policy.
object? MixedInstancesPolicy { get; }Property Value
Remarks
The policy includes properties that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances (optional), and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities, but also the properties that specify the instance configuration information—the launch template and instance types. The policy can also include a weight for each instance type and different launch templates for individual instance types.
For more information, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide .
NewInstancesProtectedFromScaleIn
Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.
object? NewInstancesProtectedFromScaleIn { get; }Property Value
Remarks
For more information about preventing instances from terminating on scale in, see Using instance scale-in protection in the Amazon EC2 Auto Scaling User Guide .
NotificationConfigurations
Configures an Auto Scaling group to send notifications when specified events take place.
object? NotificationConfigurations { get; }Property Value
Remarks
PlacementGroup
The name of the placement group into which to launch your instances.
string? PlacementGroup { get; }Property Value
Remarks
For more information, see Placement groups in the Amazon EC2 User Guide for Linux Instances .
A <em>cluster</em> placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group.
ServiceLinkedRoleArn
The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS service on your behalf.
string? ServiceLinkedRoleArn { get; }Property Value
Remarks
By default, Amazon EC2 Auto Scaling uses a service-linked role named AWSServiceRoleForAutoScaling , which it creates if it does not exist. For more information, see Service-linked roles in the Amazon EC2 Auto Scaling User Guide .
Tags
One or more tags.
CfnAutoScalingGroup.ITagPropertyProperty[]? Tags { get; }Property Value
Remarks
You can tag your Auto Scaling group and propagate the tags to the Amazon EC2 instances it launches. Tags are not propagated to Amazon EBS volumes. To add tags to Amazon EBS volumes, specify the tags in a launch template but use caution. If the launch template specifies an instance tag with a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling overrides the value of that instance tag with the value specified by the Auto Scaling group. For more information, see Tag Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide .
TargetGroupArns
The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling group.
string[]? TargetGroupArns { get; }Property Value
- string[]
Remarks
Instances are registered as targets with the target groups. The target groups receive incoming traffic and route requests to one or more registered targets. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide .
TerminationPolicies
A policy or a list of policies that are used to select the instance to terminate.
string[]? TerminationPolicies { get; }Property Value
- string[]
Remarks
These policies are executed in the order that you list them. For more information, see Work with Amazon EC2 Auto Scaling termination policies in the Amazon EC2 Auto Scaling User Guide .
Valid values: Default | AllocationStrategy | ClosestToNextInstanceHour | NewestInstance | OldestInstance | OldestLaunchConfiguration | OldestLaunchTemplate | arn:aws:lambda:region:account-id:function:my-function:my-alias
VpcZoneIdentifier
A list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created.
string[]? VpcZoneIdentifier { get; }Property Value
- string[]
Remarks
If this resource specifies public subnets and is also in a VPC that is defined in the same stack template, you must use the DependsOn attribute to declare a dependency on the VPC-gateway attachment .
When you update <code>VPCZoneIdentifier</code> , this retains the same Auto Scaling group and replaces old instances with new ones, according to the specified subnets. You can optionally specify how CloudFormation handles these updates by using an <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html">UpdatePolicy attribute</a> .
Required to launch instances into a nondefault VPC. If you specify VPCZoneIdentifier with AvailabilityZones , the subnets that you specify for this property must reside in those Availability Zones.