Interface ICommonAutoScalingGroupProps
Basic properties of an AutoScalingGroup, except the exact machines to run and where they should run.
Namespace: Amazon.CDK.AWS.AutoScaling
Assembly: Amazon.CDK.AWS.AutoScaling.dll
Syntax (csharp)
public interface ICommonAutoScalingGroupProps
Syntax (vb)
Public Interface ICommonAutoScalingGroupProps
Remarks
Constructs that want to create AutoScalingGroups can inherit this interface and specialize the essential parts in various ways.
ExampleMetadata: fixture=_generated
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;
using Amazon.CDK.AWS.EC2;
using Amazon.CDK.AWS.SNS;
using Amazon.CDK;
BlockDeviceVolume blockDeviceVolume;
GroupMetrics groupMetrics;
HealthCheck healthCheck;
ScalingEvents scalingEvents;
Signals signals;
Subnet subnet;
SubnetFilter subnetFilter;
Topic topic;
UpdatePolicy updatePolicy;
var commonAutoScalingGroupProps = new CommonAutoScalingGroupProps {
AllowAllOutbound = false,
AssociatePublicIpAddress = false,
AutoScalingGroupName = "autoScalingGroupName",
BlockDevices = new [] { new BlockDevice {
DeviceName = "deviceName",
Volume = blockDeviceVolume,
// the properties below are optional
MappingEnabled = false
} },
Cooldown = Duration.Minutes(30),
DesiredCapacity = 123,
GroupMetrics = new [] { groupMetrics },
HealthCheck = healthCheck,
IgnoreUnmodifiedSizeProperties = false,
InstanceMonitoring = Monitoring.BASIC,
KeyName = "keyName",
MaxCapacity = 123,
MaxInstanceLifetime = Duration.Minutes(30),
MinCapacity = 123,
NewInstancesProtectedFromScaleIn = false,
Notifications = new [] { new NotificationConfiguration {
Topic = topic,
// the properties below are optional
ScalingEvents = scalingEvents
} },
NotificationsTopic = topic,
ReplacingUpdateMinSuccessfulInstancesPercent = 123,
ResourceSignalCount = 123,
ResourceSignalTimeout = Duration.Minutes(30),
RollingUpdateConfiguration = new RollingUpdateConfiguration {
MaxBatchSize = 123,
MinInstancesInService = 123,
MinSuccessfulInstancesPercent = 123,
PauseTime = Duration.Minutes(30),
SuspendProcesses = new [] { ScalingProcess.LAUNCH },
WaitOnResourceSignals = false
},
Signals = signals,
SpotPrice = "spotPrice",
TerminationPolicies = new [] { TerminationPolicy.ALLOCATION_STRATEGY },
UpdatePolicy = updatePolicy,
UpdateType = UpdateType.NONE,
VpcSubnets = new SubnetSelection {
AvailabilityZones = new [] { "availabilityZones" },
OnePerAz = false,
SubnetFilters = new [] { subnetFilter },
SubnetGroupName = "subnetGroupName",
SubnetName = "subnetName",
Subnets = new [] { subnet },
SubnetType = SubnetType.ISOLATED
}
};
Synopsis
Properties
AllowAllOutbound | Whether the instances can initiate connections to anywhere by default. |
AssociatePublicIpAddress | Whether instances in the Auto Scaling Group should have public IP addresses associated with them. |
AutoScalingGroupName | The name of the Auto Scaling group. |
BlockDevices | Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes. |
Cooldown | Default scaling cooldown for this AutoScalingGroup. |
DesiredCapacity | Initial amount of instances in the fleet. |
GroupMetrics | Enable monitoring for group metrics, these metrics describe the group rather than any of its instances. |
HealthCheck | Configuration for health checks. |
IgnoreUnmodifiedSizeProperties | If the ASG has scheduled actions, don't reset unchanged group sizes. |
InstanceMonitoring | Controls whether instances in this group are launched with detailed or basic monitoring. |
KeyName | Name of SSH keypair to grant access to instances. |
MaxCapacity | Maximum number of instances in the fleet. |
MaxInstanceLifetime | The maximum amount of time that an instance can be in service. |
MinCapacity | Minimum number of instances in the fleet. |
NewInstancesProtectedFromScaleIn | Whether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. |
Notifications | Configure autoscaling group to send notifications about fleet changes to an SNS topic(s). |
NotificationsTopic | (deprecated) SNS topic to send notifications about fleet changes. |
ReplacingUpdateMinSuccessfulInstancesPercent | (deprecated) Configuration for replacing updates. |
ResourceSignalCount | (deprecated) How many ResourceSignal calls CloudFormation expects before the resource is considered created. |
ResourceSignalTimeout | (deprecated) The length of time to wait for the resourceSignalCount. |
RollingUpdateConfiguration | (deprecated) Configuration for rolling updates. |
Signals | Configure waiting for signals during deployment. |
SpotPrice | The maximum hourly price (in USD) to be paid for any Spot Instance launched to fulfill the request. |
TerminationPolicies | A policy or a list of policies that are used to select the instances to terminate. |
UpdatePolicy | What to do when an AutoScalingGroup's instance configuration is changed. |
UpdateType | (deprecated) What to do when an AutoScalingGroup's instance configuration is changed. |
VpcSubnets | Where to place instances within the VPC. |
Properties
AllowAllOutbound
Whether the instances can initiate connections to anywhere by default.
virtual Nullable<bool> AllowAllOutbound { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: true
AssociatePublicIpAddress
Whether instances in the Auto Scaling Group should have public IP addresses associated with them.
virtual Nullable<bool> AssociatePublicIpAddress { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: - Use subnet setting.
AutoScalingGroupName
The name of the Auto Scaling group.
virtual string AutoScalingGroupName { get; }
Property Value
System.String
Remarks
This name must be unique per Region per account.
Default: - Auto generated by CloudFormation
BlockDevices
Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes.
virtual IBlockDevice[] BlockDevices { get; }
Property Value
Remarks
Each instance that is launched has an associated root device volume, either an Amazon EBS volume or an instance store volume. You can use block device mappings to specify additional EBS volumes or instance store volumes to attach to an instance when it is launched.
Default: - Uses the block device mapping of the AMI
See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html
Cooldown
Default scaling cooldown for this AutoScalingGroup.
virtual Duration Cooldown { get; }
Property Value
Remarks
Default: Duration.minutes(5)
DesiredCapacity
Initial amount of instances in the fleet.
virtual Nullable<double> DesiredCapacity { get; }
Property Value
System.Nullable<System.Double>
Remarks
If this is set to a number, every deployment will reset the amount of instances to this number. It is recommended to leave this value blank.
Default: minCapacity, and leave unchanged during deployment
GroupMetrics
Enable monitoring for group metrics, these metrics describe the group rather than any of its instances.
virtual GroupMetrics[] GroupMetrics { get; }
Property Value
Remarks
To report all group metrics use GroupMetrics.all()
Group metrics are reported in a granularity of 1 minute at no additional charge.
Default: - no group metrics will be reported
HealthCheck
Configuration for health checks.
virtual HealthCheck HealthCheck { get; }
Property Value
Remarks
Default: - HealthCheck.ec2 with no grace period
IgnoreUnmodifiedSizeProperties
If the ASG has scheduled actions, don't reset unchanged group sizes.
virtual Nullable<bool> IgnoreUnmodifiedSizeProperties { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
Only used if the ASG has scheduled actions (which may scale your ASG up or down regardless of cdk deployments). If true, the size of the group will only be reset if it has been changed in the CDK app. If false, the sizes will always be changed back to what they were in the CDK app on deployment.
Default: true
InstanceMonitoring
Controls whether instances in this group are launched with detailed or basic monitoring.
virtual Nullable<Monitoring> InstanceMonitoring { get; }
Property Value
System.Nullable<Monitoring>
Remarks
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.
Default: - Monitoring.DETAILED
KeyName
Name of SSH keypair to grant access to instances.
virtual string KeyName { get; }
Property Value
System.String
Remarks
Default: - No SSH access will be possible.
MaxCapacity
Maximum number of instances in the fleet.
virtual Nullable<double> MaxCapacity { get; }
Property Value
System.Nullable<System.Double>
Remarks
Default: desiredCapacity
MaxInstanceLifetime
The maximum amount of time that an instance can be in service.
virtual Duration MaxInstanceLifetime { get; }
Property Value
Remarks
The maximum duration applies to all current and future instances in the group. As an instance approaches its maximum duration, it is terminated and replaced, and cannot be used again.
You must specify a value of at least 604,800 seconds (7 days). To clear a previously set value, leave this property undefined.
Default: none
See: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html
MinCapacity
Minimum number of instances in the fleet.
virtual Nullable<double> MinCapacity { get; }
Property Value
System.Nullable<System.Double>
Remarks
Default: 1
NewInstancesProtectedFromScaleIn
Whether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.
virtual Nullable<bool> NewInstancesProtectedFromScaleIn { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
By default, Auto Scaling can terminate an instance at any time after launch when scaling in an Auto Scaling Group, subject to the group's termination policy. However, you may wish to protect newly-launched instances from being scaled in if they are going to run critical applications that should not be prematurely terminated.
This flag must be enabled if the Auto Scaling Group will be associated with an ECS Capacity Provider with managed termination protection.
Default: false
Notifications
Configure autoscaling group to send notifications about fleet changes to an SNS topic(s).
virtual INotificationConfiguration[] Notifications { get; }
Property Value
Remarks
Default: - No fleet change notifications will be sent.
NotificationsTopic
(deprecated) SNS topic to send notifications about fleet changes.
virtual ITopic NotificationsTopic { get; }
Property Value
Remarks
Default: - No fleet change notifications will be sent.
Stability: Deprecated
ReplacingUpdateMinSuccessfulInstancesPercent
(deprecated) Configuration for replacing updates.
virtual Nullable<double> ReplacingUpdateMinSuccessfulInstancesPercent { get; }
Property Value
System.Nullable<System.Double>
Remarks
Only used if updateType == UpdateType.ReplacingUpdate. Specifies how many instances must signal success for the update to succeed.
Default: minSuccessfulInstancesPercent
Stability: Deprecated
ResourceSignalCount
(deprecated) How many ResourceSignal calls CloudFormation expects before the resource is considered created.
virtual Nullable<double> ResourceSignalCount { get; }
Property Value
System.Nullable<System.Double>
Remarks
Default: 1 if resourceSignalTimeout is set, 0 otherwise
Stability: Deprecated
ResourceSignalTimeout
(deprecated) The length of time to wait for the resourceSignalCount.
virtual Duration ResourceSignalTimeout { get; }
Property Value
Remarks
The maximum value is 43200 (12 hours).
Default: Duration.minutes(5) if resourceSignalCount is set, N/A otherwise
Stability: Deprecated
RollingUpdateConfiguration
(deprecated) Configuration for rolling updates.
virtual IRollingUpdateConfiguration RollingUpdateConfiguration { get; }
Property Value
Remarks
Only used if updateType == UpdateType.RollingUpdate.
Default: - RollingUpdateConfiguration with defaults.
Stability: Deprecated
Signals
Configure waiting for signals during deployment.
virtual Signals Signals { get; }
Property Value
Remarks
Use this to pause the CloudFormation deployment to wait for the instances
in the AutoScalingGroup to report successful startup during
creation and updates. The UserData script needs to invoke cfn-signal
with a success or failure code after it is done setting up the instance.
Without waiting for signals, the CloudFormation deployment will proceed as soon as the AutoScalingGroup has been created or updated but before the instances in the group have been started.
For example, to have instances wait for an Elastic Load Balancing health check before they signal success, add a health-check verification by using the cfn-init helper script. For an example, see the verify_instance_health command in the Auto Scaling rolling updates sample template:
Default: - Do not wait for signals
SpotPrice
The maximum hourly price (in USD) to be paid for any Spot Instance launched to fulfill the request.
virtual string SpotPrice { get; }
Property Value
System.String
Remarks
Spot Instances are launched when the price you specify exceeds the current Spot market price.
Default: none
TerminationPolicies
A policy or a list of policies that are used to select the instances to terminate.
virtual TerminationPolicy[] TerminationPolicies { get; }
Property Value
Remarks
The policies are executed in the order that you list them.
Default: - TerminationPolicy.DEFAULT
See: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html
UpdatePolicy
What to do when an AutoScalingGroup's instance configuration is changed.
virtual UpdatePolicy UpdatePolicy { get; }
Property Value
Remarks
This is applied when any of the settings on the ASG are changed that affect how the instances should be created (VPC, instance type, startup scripts, etc.). It indicates how the existing instances should be replaced with new instances matching the new config. By default, nothing is done and only new instances are launched with the new config.
Default: - UpdatePolicy.rollingUpdate()
if using init
, UpdatePolicy.none()
otherwise
UpdateType
(deprecated) What to do when an AutoScalingGroup's instance configuration is changed.
virtual Nullable<UpdateType> UpdateType { get; }
Property Value
System.Nullable<UpdateType>
Remarks
This is applied when any of the settings on the ASG are changed that affect how the instances should be created (VPC, instance type, startup scripts, etc.). It indicates how the existing instances should be replaced with new instances matching the new config. By default, nothing is done and only new instances are launched with the new config.
Default: UpdateType.None
Stability: Deprecated
VpcSubnets
Where to place instances within the VPC.
virtual ISubnetSelection VpcSubnets { get; }
Property Value
Remarks
Default: - All Private subnets.