software.amazon.awscdk.services.autoscaling

Interface CommonAutoScalingGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

AddCapacityOptions, AutoScalingGroupCapacityOptions, AutoScalingGroupProps

All Known Implementing Classes:

AddCapacityOptions.Jsii$Proxy, AutoScalingGroupCapacityOptions.Jsii$Proxy, AutoScalingGroupProps.Jsii$Proxy, CommonAutoScalingGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:55:01.120Z")
 @Stability(value=Experimental)
public interface CommonAutoScalingGroupProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Basic properties of an AutoScalingGroup, except the exact machines to run and where they should run.

Constructs that want to create AutoScalingGroups can inherit this interface and specialize the essential parts in various ways.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CommonAutoScalingGroupProps.Builder A builder for CommonAutoScalingGroupProps
static class	CommonAutoScalingGroupProps.Jsii$Proxy An implementation for CommonAutoScalingGroupProps

Method Summary

Modifier and Type	Method and Description
static CommonAutoScalingGroupProps.Builder	builder()
default Boolean	getAllowAllOutbound() (experimental) Whether the instances can initiate connections to anywhere by default.
default Boolean	getAssociatePublicIpAddress() (experimental) Whether instances in the Auto Scaling Group should have public IP addresses associated with them.
default String	getAutoScalingGroupName() (experimental) The name of the Auto Scaling group.
default List<BlockDevice>	getBlockDevices() (experimental) Specifies how block devices are exposed to the instance.
default Duration	getCooldown() (experimental) Default scaling cooldown for this AutoScalingGroup.
default Number	getDesiredCapacity() (experimental) Initial amount of instances in the fleet.
default List<GroupMetrics>	getGroupMetrics() (experimental) Enable monitoring for group metrics, these metrics describe the group rather than any of its instances.
default HealthCheck	getHealthCheck() (experimental) Configuration for health checks.
default Boolean	getIgnoreUnmodifiedSizeProperties() (experimental) If the ASG has scheduled actions, don't reset unchanged group sizes.
default Monitoring	getInstanceMonitoring() (experimental) Controls whether instances in this group are launched with detailed or basic monitoring.
default String	getKeyName() (experimental) Name of SSH keypair to grant access to instances.
default Number	getMaxCapacity() (experimental) Maximum number of instances in the fleet.
default Duration	getMaxInstanceLifetime() (experimental) The maximum amount of time that an instance can be in service.
default Number	getMinCapacity() (experimental) Minimum number of instances in the fleet.
default Boolean	getNewInstancesProtectedFromScaleIn() (experimental) Whether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.
default List<NotificationConfiguration>	getNotifications() (experimental) Configure autoscaling group to send notifications about fleet changes to an SNS topic(s).
default Signals	getSignals() (experimental) Configure waiting for signals during deployment.
default String	getSpotPrice() (experimental) The maximum hourly price (in USD) to be paid for any Spot Instance launched to fulfill the request.
default UpdatePolicy	getUpdatePolicy() (experimental) What to do when an AutoScalingGroup's instance configuration is changed.
default SubnetSelection	getVpcSubnets() (experimental) Where to place instances within the VPC.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAllowAllOutbound

@Stability(value=Experimental)
 @Nullable
default Boolean getAllowAllOutbound()

(experimental) Whether the instances can initiate connections to anywhere by default.

Default: true

getAssociatePublicIpAddress

@Stability(value=Experimental)
 @Nullable
default Boolean getAssociatePublicIpAddress()

(experimental) Whether instances in the Auto Scaling Group should have public IP addresses associated with them.

Default: - Use subnet setting.

getAutoScalingGroupName

@Stability(value=Experimental)
 @Nullable
default String getAutoScalingGroupName()

(experimental) The name of the Auto Scaling group.

This name must be unique per Region per account.

Default: - Auto generated by CloudFormation

getBlockDevices

@Stability(value=Experimental)
 @Nullable
default List<BlockDevice> getBlockDevices()

(experimental) Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes.

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 Also:

https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html

getCooldown

@Stability(value=Experimental)
 @Nullable
default Duration getCooldown()

(experimental) Default scaling cooldown for this AutoScalingGroup.

Default: Duration.minutes(5)

getDesiredCapacity

@Stability(value=Experimental)
 @Nullable
default Number getDesiredCapacity()

(experimental) Initial amount of instances in the fleet.

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

See Also:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-desiredcapacity

getGroupMetrics

@Stability(value=Experimental)
 @Nullable
default List<GroupMetrics> getGroupMetrics()

(experimental) Enable monitoring for group metrics, these metrics describe the group rather than any of its instances.

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

getHealthCheck

@Stability(value=Experimental)
 @Nullable
default HealthCheck getHealthCheck()

(experimental) Configuration for health checks.

Default: - HealthCheck.ec2 with no grace period

getIgnoreUnmodifiedSizeProperties

@Stability(value=Experimental)
 @Nullable
default Boolean getIgnoreUnmodifiedSizeProperties()

(experimental) If the ASG has scheduled actions, don't reset unchanged group sizes.

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

getInstanceMonitoring

@Stability(value=Experimental)
 @Nullable
default Monitoring getInstanceMonitoring()

(experimental) Controls whether instances in this group are launched with detailed or basic monitoring.

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

See Also:

https://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html#enable-as-instance-metrics

getKeyName

@Stability(value=Experimental)
 @Nullable
default String getKeyName()

(experimental) Name of SSH keypair to grant access to instances.

Default: - No SSH access will be possible.

getMaxCapacity

@Stability(value=Experimental)
 @Nullable
default Number getMaxCapacity()

(experimental) Maximum number of instances in the fleet.

Default: desiredCapacity

getMaxInstanceLifetime

@Stability(value=Experimental)
 @Nullable
default Duration getMaxInstanceLifetime()

(experimental) The maximum amount of time that an instance can be in service.

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 Also:

https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html

getMinCapacity

@Stability(value=Experimental)
 @Nullable
default Number getMinCapacity()

(experimental) Minimum number of instances in the fleet.

Default: 1

getNewInstancesProtectedFromScaleIn

@Stability(value=Experimental)
 @Nullable
default Boolean getNewInstancesProtectedFromScaleIn()

(experimental) Whether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.

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

getNotifications

@Stability(value=Experimental)
 @Nullable
default List<NotificationConfiguration> getNotifications()

(experimental) Configure autoscaling group to send notifications about fleet changes to an SNS topic(s).

Default: - No fleet change notifications will be sent.

See Also:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-notificationconfigurations

getSignals

@Stability(value=Experimental)
 @Nullable
default Signals getSignals()

(experimental) Configure waiting for signals during deployment.

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:

https://github.com/awslabs/aws-cloudformation-templates/blob/master/aws/services/AutoScaling/AutoScalingRollingUpdates.yaml

Default: - Do not wait for signals

getSpotPrice

@Stability(value=Experimental)
 @Nullable
default String getSpotPrice()

(experimental) The maximum hourly price (in USD) 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 market price.

Default: none

getUpdatePolicy

@Stability(value=Experimental)
 @Nullable
default UpdatePolicy getUpdatePolicy()

(experimental) What to do when an AutoScalingGroup's instance configuration is changed.

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

getVpcSubnets

@Stability(value=Experimental)
 @Nullable
default SubnetSelection getVpcSubnets()

(experimental) Where to place instances within the VPC.

Default: - All Private subnets.

builder

@Stability(value=Experimental)
static CommonAutoScalingGroupProps.Builder builder()

Returns:

a CommonAutoScalingGroupProps.Builder of CommonAutoScalingGroupProps