Class CommonAutoScalingGroupProps
Basic properties of an AutoScalingGroup, except the exact machines to run and where they should run.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.AutoScaling
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CommonAutoScalingGroupProps : Object, ICommonAutoScalingGroupProps
Syntax (vb)
Public Class CommonAutoScalingGroupProps
Inherits Object
Implements 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;
using Amazon.CDK.AWS.AutoScaling;
using Amazon.CDK.AWS.EC2;
using Amazon.CDK.AWS.SNS;
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
} },
CapacityRebalance = false,
Cooldown = Duration.Minutes(30),
DefaultInstanceWarmup = 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
} },
Signals = signals,
SpotPrice = "spotPrice",
SsmSessionPermissions = false,
TerminationPolicies = new [] { TerminationPolicy.ALLOCATION_STRATEGY },
TerminationPolicyCustomLambdaFunctionArn = "terminationPolicyCustomLambdaFunctionArn",
UpdatePolicy = updatePolicy,
VpcSubnets = new SubnetSelection {
AvailabilityZones = new [] { "availabilityZones" },
OnePerAz = false,
SubnetFilters = new [] { subnetFilter },
SubnetGroupName = "subnetGroupName",
Subnets = new [] { subnet },
SubnetType = SubnetType.PRIVATE_ISOLATED
}
};
Synopsis
Constructors
CommonAutoScalingGroupProps() |
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. |
CapacityRebalance | Indicates whether Capacity Rebalancing is enabled. |
Cooldown | Default scaling cooldown for this AutoScalingGroup. |
DefaultInstanceWarmup | The amount of time, in seconds, until a newly launched instance can contribute to the Amazon CloudWatch metrics. |
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). |
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. |
SsmSessionPermissions | Add SSM session permissions to the instance role. |
TerminationPolicies | A policy or a list of policies that are used to select the instances to terminate. |
TerminationPolicyCustomLambdaFunctionArn | A lambda function Arn that can be used as a custom termination policy to select the instances to terminate. |
UpdatePolicy | What to do when an AutoScalingGroup's instance configuration is changed. |
VpcSubnets | Where to place instances within the VPC. |
Constructors
CommonAutoScalingGroupProps()
public CommonAutoScalingGroupProps()
Properties
AllowAllOutbound
Whether the instances can initiate connections to anywhere by default.
public Nullable<bool> AllowAllOutbound { get; set; }
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.
public Nullable<bool> AssociatePublicIpAddress { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
launchTemplate
and mixedInstancesPolicy
must not be specified when this property is specified
Default: - Use subnet setting.
AutoScalingGroupName
The name of the Auto Scaling group.
public string AutoScalingGroupName { get; set; }
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.
public IBlockDevice[] BlockDevices { get; set; }
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.
launchTemplate
and mixedInstancesPolicy
must not be specified when this property is specified
Default: - Uses the block device mapping of the AMI
See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html
CapacityRebalance
Indicates whether Capacity Rebalancing is enabled.
public Nullable<bool> CapacityRebalance { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
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.
Default: false
Cooldown
Default scaling cooldown for this AutoScalingGroup.
public Duration Cooldown { get; set; }
Property Value
Remarks
Default: Duration.minutes(5)
DefaultInstanceWarmup
The amount of time, in seconds, until a newly launched instance can contribute to the Amazon CloudWatch metrics.
public Duration DefaultInstanceWarmup { get; set; }
Property Value
Remarks
This delay lets an instance finish initializing before Amazon EC2 Auto Scaling aggregates instance metrics, resulting in more reliable usage data. Set this value equal to the amount of time that it takes for resource consumption to become stable after an instance reaches the InService state.
To optimize the performance of scaling policies that scale continuously, such as target tracking and step scaling policies, we strongly recommend that you enable the default instance warmup, even if its value is set to 0 seconds
Default instance warmup will not be added if no value is specified
Default: None
See: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-default-instance-warmup.html
DesiredCapacity
Initial amount of instances in the fleet.
public Nullable<double> DesiredCapacity { get; set; }
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.
public GroupMetrics[] GroupMetrics { get; set; }
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.
public HealthCheck HealthCheck { get; set; }
Property Value
Remarks
Default: - HealthCheck.ec2 with no grace period
IgnoreUnmodifiedSizeProperties
If the ASG has scheduled actions, don't reset unchanged group sizes.
public Nullable<bool> IgnoreUnmodifiedSizeProperties { get; set; }
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.
public Nullable<Monitoring> InstanceMonitoring { get; set; }
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.
launchTemplate
and mixedInstancesPolicy
must not be specified when this property is specified
Default: - Monitoring.DETAILED
KeyName
Name of SSH keypair to grant access to instances.
public string KeyName { get; set; }
Property Value
System.String
Remarks
launchTemplate
and mixedInstancesPolicy
must not be specified when this property is specified
Default: - No SSH access will be possible.
MaxCapacity
Maximum number of instances in the fleet.
public Nullable<double> MaxCapacity { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: desiredCapacity
MaxInstanceLifetime
The maximum amount of time that an instance can be in service.
public Duration MaxInstanceLifetime { get; set; }
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.
public Nullable<double> MinCapacity { get; set; }
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.
public Nullable<bool> NewInstancesProtectedFromScaleIn { get; set; }
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).
public INotificationConfiguration[] Notifications { get; set; }
Property Value
Remarks
Default: - No fleet change notifications will be sent.
Signals
Configure waiting for signals during deployment.
public Signals Signals { get; set; }
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.
public string SpotPrice { get; set; }
Property Value
System.String
Remarks
Spot Instances are launched when the price you specify exceeds the current Spot market price.
launchTemplate
and mixedInstancesPolicy
must not be specified when this property is specified
Default: none
SsmSessionPermissions
Add SSM session permissions to the instance role.
public Nullable<bool> SsmSessionPermissions { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Setting this to true
adds the necessary permissions to connect
to the instance using SSM Session Manager. You can do this
from the AWS Console.
NOTE: Setting this flag to true
may not be enough by itself.
You must also use an AMI that comes with the SSM Agent, or install
the SSM Agent yourself. See
Working with SSM Agent
in the SSM Developer Guide.
Default: false
TerminationPolicies
A policy or a list of policies that are used to select the instances to terminate.
public TerminationPolicy[] TerminationPolicies { get; set; }
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
TerminationPolicyCustomLambdaFunctionArn
A lambda function Arn that can be used as a custom termination policy to select the instances to terminate.
public string TerminationPolicyCustomLambdaFunctionArn { get; set; }
Property Value
System.String
Remarks
This property must be specified if the TerminationPolicy.CUSTOM_LAMBDA_FUNCTION is used.
Default: - No lambda function Arn will be supplied
See: https://docs.aws.amazon.com/autoscaling/ec2/userguide/lambda-custom-termination-policy.html
UpdatePolicy
What to do when an AutoScalingGroup's instance configuration is changed.
public UpdatePolicy UpdatePolicy { get; set; }
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
VpcSubnets
Where to place instances within the VPC.
public ISubnetSelection VpcSubnets { get; set; }
Property Value
Remarks
Default: - All Private subnets.