public static final class CommonAutoScalingGroupProps.Builder
extends java.lang.Object
CommonAutoScalingGroupProps| Constructor and Description |
|---|
Builder() |
public CommonAutoScalingGroupProps.Builder allowAllOutbound(java.lang.Boolean allowAllOutbound)
CommonAutoScalingGroupProps.getAllowAllOutbound()allowAllOutbound - Whether the instances can initiate connections to anywhere by default.thispublic CommonAutoScalingGroupProps.Builder associatePublicIpAddress(java.lang.Boolean associatePublicIpAddress)
CommonAutoScalingGroupProps.getAssociatePublicIpAddress()associatePublicIpAddress - Whether instances in the Auto Scaling Group should have public IP addresses associated with them.thispublic CommonAutoScalingGroupProps.Builder autoScalingGroupName(java.lang.String autoScalingGroupName)
CommonAutoScalingGroupProps.getAutoScalingGroupName()autoScalingGroupName - The name of the Auto Scaling group.
This name must be unique per Region per account.thispublic CommonAutoScalingGroupProps.Builder blockDevices(java.util.List<? extends BlockDevice> blockDevices)
CommonAutoScalingGroupProps.getBlockDevices()blockDevices - 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.thispublic CommonAutoScalingGroupProps.Builder cooldown(Duration cooldown)
CommonAutoScalingGroupProps.getCooldown()cooldown - Default scaling cooldown for this AutoScalingGroup.thispublic CommonAutoScalingGroupProps.Builder desiredCapacity(java.lang.Number desiredCapacity)
CommonAutoScalingGroupProps.getDesiredCapacity()desiredCapacity - 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.thispublic CommonAutoScalingGroupProps.Builder groupMetrics(java.util.List<? extends GroupMetrics> groupMetrics)
CommonAutoScalingGroupProps.getGroupMetrics()groupMetrics - 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.thispublic CommonAutoScalingGroupProps.Builder healthCheck(HealthCheck healthCheck)
CommonAutoScalingGroupProps.getHealthCheck()healthCheck - Configuration for health checks.thispublic CommonAutoScalingGroupProps.Builder ignoreUnmodifiedSizeProperties(java.lang.Boolean ignoreUnmodifiedSizeProperties)
CommonAutoScalingGroupProps.getIgnoreUnmodifiedSizeProperties()ignoreUnmodifiedSizeProperties - 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.thispublic CommonAutoScalingGroupProps.Builder instanceMonitoring(Monitoring instanceMonitoring)
CommonAutoScalingGroupProps.getInstanceMonitoring()instanceMonitoring - 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.thispublic CommonAutoScalingGroupProps.Builder keyName(java.lang.String keyName)
CommonAutoScalingGroupProps.getKeyName()keyName - Name of SSH keypair to grant access to instances.thispublic CommonAutoScalingGroupProps.Builder maxCapacity(java.lang.Number maxCapacity)
CommonAutoScalingGroupProps.getMaxCapacity()maxCapacity - Maximum number of instances in the fleet.thispublic CommonAutoScalingGroupProps.Builder maxInstanceLifetime(Duration maxInstanceLifetime)
CommonAutoScalingGroupProps.getMaxInstanceLifetime()maxInstanceLifetime - 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.
thispublic CommonAutoScalingGroupProps.Builder minCapacity(java.lang.Number minCapacity)
CommonAutoScalingGroupProps.getMinCapacity()minCapacity - Minimum number of instances in the fleet.thispublic CommonAutoScalingGroupProps.Builder newInstancesProtectedFromScaleIn(java.lang.Boolean newInstancesProtectedFromScaleIn)
CommonAutoScalingGroupProps.getNewInstancesProtectedFromScaleIn()newInstancesProtectedFromScaleIn - 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.
thispublic CommonAutoScalingGroupProps.Builder notifications(java.util.List<? extends NotificationConfiguration> notifications)
CommonAutoScalingGroupProps.getNotifications()notifications - Configure autoscaling group to send notifications about fleet changes to an SNS topic(s).this@Deprecated public CommonAutoScalingGroupProps.Builder notificationsTopic(ITopic notificationsTopic)
CommonAutoScalingGroupProps.getNotificationsTopic()notificationsTopic - SNS topic to send notifications about fleet changes.this@Deprecated public CommonAutoScalingGroupProps.Builder replacingUpdateMinSuccessfulInstancesPercent(java.lang.Number replacingUpdateMinSuccessfulInstancesPercent)
replacingUpdateMinSuccessfulInstancesPercent - Configuration for replacing updates.
Only used if updateType == UpdateType.ReplacingUpdate. Specifies how
many instances must signal success for the update to succeed.this@Deprecated public CommonAutoScalingGroupProps.Builder resourceSignalCount(java.lang.Number resourceSignalCount)
CommonAutoScalingGroupProps.getResourceSignalCount()resourceSignalCount - How many ResourceSignal calls CloudFormation expects before the resource is considered created.this@Deprecated public CommonAutoScalingGroupProps.Builder resourceSignalTimeout(Duration resourceSignalTimeout)
CommonAutoScalingGroupProps.getResourceSignalTimeout()resourceSignalTimeout - The length of time to wait for the resourceSignalCount.
The maximum value is 43200 (12 hours).this@Deprecated public CommonAutoScalingGroupProps.Builder rollingUpdateConfiguration(RollingUpdateConfiguration rollingUpdateConfiguration)
CommonAutoScalingGroupProps.getRollingUpdateConfiguration()rollingUpdateConfiguration - Configuration for rolling updates.
Only used if updateType == UpdateType.RollingUpdate.thispublic CommonAutoScalingGroupProps.Builder signals(Signals signals)
CommonAutoScalingGroupProps.getSignals()signals - 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
thispublic CommonAutoScalingGroupProps.Builder spotPrice(java.lang.String spotPrice)
CommonAutoScalingGroupProps.getSpotPrice()spotPrice - 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.thispublic CommonAutoScalingGroupProps.Builder terminationPolicies(java.util.List<? extends TerminationPolicy> terminationPolicies)
CommonAutoScalingGroupProps.getTerminationPolicies()terminationPolicies - A policy or a list of policies that are used to select the instances to terminate.
The policies are executed in the order that you list them.thispublic CommonAutoScalingGroupProps.Builder updatePolicy(UpdatePolicy updatePolicy)
CommonAutoScalingGroupProps.getUpdatePolicy()updatePolicy - 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.this@Deprecated public CommonAutoScalingGroupProps.Builder updateType(UpdateType updateType)
CommonAutoScalingGroupProps.getUpdateType()updateType - 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.thispublic CommonAutoScalingGroupProps.Builder vpcSubnets(SubnetSelection vpcSubnets)
CommonAutoScalingGroupProps.getVpcSubnets()vpcSubnets - Where to place instances within the VPC.thispublic CommonAutoScalingGroupProps build()
CommonAutoScalingGroupPropsjava.lang.NullPointerException - if any required attribute was not provided