@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
date="2023-03-14T16:25:33.729Z")
public interface CommonAutoScalingGroupProps
Constructs that want to create AutoScalingGroups can inherit this interface and specialize the essential parts in various ways.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.autoscaling.*;
import software.amazon.awscdk.services.ec2.*;
import software.amazon.awscdk.services.sns.*;
import software.amazon.awscdk.core.*;
BlockDeviceVolume blockDeviceVolume;
GroupMetrics groupMetrics;
HealthCheck healthCheck;
ScalingEvents scalingEvents;
Signals signals;
Subnet subnet;
SubnetFilter subnetFilter;
Topic topic;
UpdatePolicy updatePolicy;
CommonAutoScalingGroupProps commonAutoScalingGroupProps = CommonAutoScalingGroupProps.builder()
.allowAllOutbound(false)
.associatePublicIpAddress(false)
.autoScalingGroupName("autoScalingGroupName")
.blockDevices(List.of(BlockDevice.builder()
.deviceName("deviceName")
.volume(blockDeviceVolume)
// the properties below are optional
.mappingEnabled(false)
.build()))
.cooldown(Duration.minutes(30))
.desiredCapacity(123)
.groupMetrics(List.of(groupMetrics))
.healthCheck(healthCheck)
.ignoreUnmodifiedSizeProperties(false)
.instanceMonitoring(Monitoring.BASIC)
.keyName("keyName")
.maxCapacity(123)
.maxInstanceLifetime(Duration.minutes(30))
.minCapacity(123)
.newInstancesProtectedFromScaleIn(false)
.notifications(List.of(NotificationConfiguration.builder()
.topic(topic)
// the properties below are optional
.scalingEvents(scalingEvents)
.build()))
.notificationsTopic(topic)
.replacingUpdateMinSuccessfulInstancesPercent(123)
.resourceSignalCount(123)
.resourceSignalTimeout(Duration.minutes(30))
.rollingUpdateConfiguration(RollingUpdateConfiguration.builder()
.maxBatchSize(123)
.minInstancesInService(123)
.minSuccessfulInstancesPercent(123)
.pauseTime(Duration.minutes(30))
.suspendProcesses(List.of(ScalingProcess.LAUNCH))
.waitOnResourceSignals(false)
.build())
.signals(signals)
.spotPrice("spotPrice")
.terminationPolicies(List.of(TerminationPolicy.ALLOCATION_STRATEGY))
.updatePolicy(updatePolicy)
.updateType(UpdateType.NONE)
.vpcSubnets(SubnetSelection.builder()
.availabilityZones(List.of("availabilityZones"))
.onePerAz(false)
.subnetFilters(List.of(subnetFilter))
.subnetGroupName("subnetGroupName")
.subnetName("subnetName")
.subnets(List.of(subnet))
.subnetType(SubnetType.ISOLATED)
.build())
.build();
| Modifier and Type | Interface and Description |
|---|---|
static class |
CommonAutoScalingGroupProps.Builder
A builder for
CommonAutoScalingGroupProps |
static class |
CommonAutoScalingGroupProps.Jsii$Proxy
An implementation for
CommonAutoScalingGroupProps |
| Modifier and Type | Method and Description |
|---|---|
static CommonAutoScalingGroupProps.Builder |
builder() |
default java.lang.Boolean |
getAllowAllOutbound()
Whether the instances can initiate connections to anywhere by default.
|
default java.lang.Boolean |
getAssociatePublicIpAddress()
Whether instances in the Auto Scaling Group should have public IP addresses associated with them.
|
default java.lang.String |
getAutoScalingGroupName()
The name of the Auto Scaling group.
|
default java.util.List<BlockDevice> |
getBlockDevices()
Specifies how block devices are exposed to the instance.
|
default Duration |
getCooldown()
Default scaling cooldown for this AutoScalingGroup.
|
default java.lang.Number |
getDesiredCapacity()
Initial amount of instances in the fleet.
|
default java.util.List<GroupMetrics> |
getGroupMetrics()
Enable monitoring for group metrics, these metrics describe the group rather than any of its instances.
|
default HealthCheck |
getHealthCheck()
Configuration for health checks.
|
default java.lang.Boolean |
getIgnoreUnmodifiedSizeProperties()
If the ASG has scheduled actions, don't reset unchanged group sizes.
|
default Monitoring |
getInstanceMonitoring()
Controls whether instances in this group are launched with detailed or basic monitoring.
|
default java.lang.String |
getKeyName()
Name of SSH keypair to grant access to instances.
|
default java.lang.Number |
getMaxCapacity()
Maximum number of instances in the fleet.
|
default Duration |
getMaxInstanceLifetime()
The maximum amount of time that an instance can be in service.
|
default java.lang.Number |
getMinCapacity()
Minimum number of instances in the fleet.
|
default java.lang.Boolean |
getNewInstancesProtectedFromScaleIn()
Whether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.
|
default java.util.List<NotificationConfiguration> |
getNotifications()
Configure autoscaling group to send notifications about fleet changes to an SNS topic(s).
|
default ITopic |
getNotificationsTopic()
Deprecated.
use `notifications`
|
default java.lang.Number |
getReplacingUpdateMinSuccessfulInstancesPercent()
Deprecated.
Use `signals` instead
|
default java.lang.Number |
getResourceSignalCount()
Deprecated.
Use `signals` instead.
|
default Duration |
getResourceSignalTimeout()
Deprecated.
Use `signals` instead.
|
default RollingUpdateConfiguration |
getRollingUpdateConfiguration()
Deprecated.
Use `updatePolicy` instead
|
default Signals |
getSignals()
Configure waiting for signals during deployment.
|
default java.lang.String |
getSpotPrice()
The maximum hourly price (in USD) to be paid for any Spot Instance launched to fulfill the request.
|
default java.util.List<TerminationPolicy> |
getTerminationPolicies()
A policy or a list of policies that are used to select the instances to terminate.
|
default UpdatePolicy |
getUpdatePolicy()
What to do when an AutoScalingGroup's instance configuration is changed.
|
default UpdateType |
getUpdateType()
Deprecated.
Use `updatePolicy` instead
|
default SubnetSelection |
getVpcSubnets()
Where to place instances within the VPC.
|
default java.lang.Boolean getAllowAllOutbound()
Default: true
default java.lang.Boolean getAssociatePublicIpAddress()
Default: - Use subnet setting.
default java.lang.String getAutoScalingGroupName()
This name must be unique per Region per account.
Default: - Auto generated by CloudFormation
default java.util.List<BlockDevice> getBlockDevices()
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
default Duration getCooldown()
Default: Duration.minutes(5)
default java.lang.Number getDesiredCapacity()
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
default java.util.List<GroupMetrics> getGroupMetrics()
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
default HealthCheck getHealthCheck()
Default: - HealthCheck.ec2 with no grace period
default java.lang.Boolean getIgnoreUnmodifiedSizeProperties()
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
default Monitoring getInstanceMonitoring()
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
default java.lang.String getKeyName()
Default: - No SSH access will be possible.
default java.lang.Number getMaxCapacity()
Default: desiredCapacity
default Duration getMaxInstanceLifetime()
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
default java.lang.Number getMinCapacity()
Default: 1
default java.lang.Boolean getNewInstancesProtectedFromScaleIn()
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
default java.util.List<NotificationConfiguration> getNotifications()
Default: - No fleet change notifications will be sent.
@Deprecated default ITopic getNotificationsTopic()
Default: - No fleet change notifications will be sent.
@Deprecated default java.lang.Number getReplacingUpdateMinSuccessfulInstancesPercent()
Only used if updateType == UpdateType.ReplacingUpdate. Specifies how many instances must signal success for the update to succeed.
Default: minSuccessfulInstancesPercent
@Deprecated default java.lang.Number getResourceSignalCount()
Default: 1 if resourceSignalTimeout is set, 0 otherwise
@Deprecated default Duration getResourceSignalTimeout()
The maximum value is 43200 (12 hours).
Default: Duration.minutes(5) if resourceSignalCount is set, N/A otherwise
@Deprecated default RollingUpdateConfiguration getRollingUpdateConfiguration()
Only used if updateType == UpdateType.RollingUpdate.
Default: - RollingUpdateConfiguration with defaults.
default Signals getSignals()
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
default java.lang.String getSpotPrice()
Spot Instances are launched when the price you specify exceeds the current Spot market price.
Default: none
default java.util.List<TerminationPolicy> getTerminationPolicies()
The policies are executed in the order that you list them.
Default: - `TerminationPolicy.DEFAULT`
default UpdatePolicy getUpdatePolicy()
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
@Deprecated default UpdateType getUpdateType()
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
default SubnetSelection getVpcSubnets()
Default: - All Private subnets.
static CommonAutoScalingGroupProps.Builder builder()