software.amazon.awscdk.services.autoscaling

Class AutoScalingGroup.Builder

java.lang.Object

software.amazon.awscdk.services.autoscaling.AutoScalingGroup.Builder

Enclosing class:

AutoScalingGroup

public static final class AutoScalingGroup.Builder
extends java.lang.Object

A fluent builder for AutoScalingGroup.

Method Summary

Modifier and Type	Method and Description
AutoScalingGroup.Builder	allowAllOutbound(java.lang.Boolean allowAllOutbound) Whether the instances can initiate connections to anywhere by default.
AutoScalingGroup.Builder	associatePublicIpAddress(java.lang.Boolean associatePublicIpAddress) Whether instances in the Auto Scaling Group should have public IP addresses associated with them.
AutoScalingGroup.Builder	autoScalingGroupName(java.lang.String autoScalingGroupName) The name of the Auto Scaling group.
AutoScalingGroup.Builder	blockDevices(java.util.List<? extends BlockDevice> blockDevices) Specifies how block devices are exposed to the instance.
AutoScalingGroup	build()
AutoScalingGroup.Builder	cooldown(Duration cooldown) Default scaling cooldown for this AutoScalingGroup.
static AutoScalingGroup.Builder	create(software.constructs.Construct scope, java.lang.String id)
AutoScalingGroup.Builder	desiredCapacity(java.lang.Number desiredCapacity) Initial amount of instances in the fleet.
AutoScalingGroup.Builder	groupMetrics(java.util.List<? extends GroupMetrics> groupMetrics) Enable monitoring for group metrics, these metrics describe the group rather than any of its instances.
AutoScalingGroup.Builder	healthCheck(HealthCheck healthCheck) Configuration for health checks.
AutoScalingGroup.Builder	ignoreUnmodifiedSizeProperties(java.lang.Boolean ignoreUnmodifiedSizeProperties) If the ASG has scheduled actions, don't reset unchanged group sizes.
AutoScalingGroup.Builder	init(CloudFormationInit init) Apply the given CloudFormation Init configuration to the instances in the AutoScalingGroup at startup.
AutoScalingGroup.Builder	initOptions(ApplyCloudFormationInitOptions initOptions) Use the given options for applying CloudFormation Init.
AutoScalingGroup.Builder	instanceMonitoring(Monitoring instanceMonitoring) Controls whether instances in this group are launched with detailed or basic monitoring.
AutoScalingGroup.Builder	instanceType(InstanceType instanceType) Type of instance to launch.
AutoScalingGroup.Builder	keyName(java.lang.String keyName) Name of SSH keypair to grant access to instances.
AutoScalingGroup.Builder	launchTemplate(ILaunchTemplate launchTemplate) Launch template to use.
AutoScalingGroup.Builder	machineImage(IMachineImage machineImage) AMI to launch.
AutoScalingGroup.Builder	maxCapacity(java.lang.Number maxCapacity) Maximum number of instances in the fleet.
AutoScalingGroup.Builder	maxInstanceLifetime(Duration maxInstanceLifetime) The maximum amount of time that an instance can be in service.
AutoScalingGroup.Builder	minCapacity(java.lang.Number minCapacity) Minimum number of instances in the fleet.
AutoScalingGroup.Builder	mixedInstancesPolicy(MixedInstancesPolicy mixedInstancesPolicy) Mixed Instances Policy to use.
AutoScalingGroup.Builder	newInstancesProtectedFromScaleIn(java.lang.Boolean newInstancesProtectedFromScaleIn) Whether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.
AutoScalingGroup.Builder	notifications(java.util.List<? extends NotificationConfiguration> notifications) Configure autoscaling group to send notifications about fleet changes to an SNS topic(s).
AutoScalingGroup.Builder	notificationsTopic(ITopic notificationsTopic) Deprecated. use `notifications`
AutoScalingGroup.Builder	replacingUpdateMinSuccessfulInstancesPercent(java.lang.Number replacingUpdateMinSuccessfulInstancesPercent) Deprecated. Use `signals` instead
AutoScalingGroup.Builder	requireImdsv2(java.lang.Boolean requireImdsv2) Whether IMDSv2 should be required on launched instances.
AutoScalingGroup.Builder	resourceSignalCount(java.lang.Number resourceSignalCount) Deprecated. Use `signals` instead.
AutoScalingGroup.Builder	resourceSignalTimeout(Duration resourceSignalTimeout) Deprecated. Use `signals` instead.
AutoScalingGroup.Builder	role(IRole role) An IAM role to associate with the instance profile assigned to this Auto Scaling Group.
AutoScalingGroup.Builder	rollingUpdateConfiguration(RollingUpdateConfiguration rollingUpdateConfiguration) Deprecated. Use `updatePolicy` instead
AutoScalingGroup.Builder	securityGroup(ISecurityGroup securityGroup) Security group to launch the instances in.
AutoScalingGroup.Builder	signals(Signals signals) Configure waiting for signals during deployment.
AutoScalingGroup.Builder	spotPrice(java.lang.String spotPrice) The maximum hourly price (in USD) to be paid for any Spot Instance launched to fulfill the request.
AutoScalingGroup.Builder	terminationPolicies(java.util.List<? extends TerminationPolicy> terminationPolicies) A policy or a list of policies that are used to select the instances to terminate.
AutoScalingGroup.Builder	updatePolicy(UpdatePolicy updatePolicy) What to do when an AutoScalingGroup's instance configuration is changed.
AutoScalingGroup.Builder	updateType(UpdateType updateType) Deprecated. Use `updatePolicy` instead
AutoScalingGroup.Builder	userData(UserData userData) Specific UserData to use.
AutoScalingGroup.Builder	vpc(IVpc vpc) VPC to launch these instances in.
AutoScalingGroup.Builder	vpcSubnets(SubnetSelection vpcSubnets) Where to place instances within the VPC.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static AutoScalingGroup.Builder create(software.constructs.Construct scope,
                                              java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of AutoScalingGroup.Builder.

allowAllOutbound

public AutoScalingGroup.Builder allowAllOutbound(java.lang.Boolean allowAllOutbound)

Whether the instances can initiate connections to anywhere by default.

Default: true

Parameters:

allowAllOutbound - Whether the instances can initiate connections to anywhere by default. This parameter is required.

Returns:

this

associatePublicIpAddress

public AutoScalingGroup.Builder associatePublicIpAddress(java.lang.Boolean associatePublicIpAddress)

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

Default: - Use subnet setting.

Parameters:

associatePublicIpAddress - Whether instances in the Auto Scaling Group should have public IP addresses associated with them. This parameter is required.

Returns:

this

autoScalingGroupName

public AutoScalingGroup.Builder autoScalingGroupName(java.lang.String autoScalingGroupName)

The name of the Auto Scaling group.

This name must be unique per Region per account.

Default: - Auto generated by CloudFormation

Parameters:

autoScalingGroupName - The name of the Auto Scaling group. This parameter is required.

Returns:

this

blockDevices

public AutoScalingGroup.Builder blockDevices(java.util.List<? extends BlockDevice> 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.

Default: - Uses the block device mapping of the AMI

Parameters:

blockDevices - Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes. This parameter is required.

Returns:

this

See Also:

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

cooldown

public AutoScalingGroup.Builder cooldown(Duration cooldown)

Default scaling cooldown for this AutoScalingGroup.

Default: Duration.minutes(5)

Parameters:

cooldown - Default scaling cooldown for this AutoScalingGroup. This parameter is required.

Returns:

this

desiredCapacity

public AutoScalingGroup.Builder desiredCapacity(java.lang.Number 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.

Default: minCapacity, and leave unchanged during deployment

Parameters:

desiredCapacity - Initial amount of instances in the fleet. This parameter is required.

Returns:

this

See Also:

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

groupMetrics

public AutoScalingGroup.Builder groupMetrics(java.util.List<? extends GroupMetrics> 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.

Default: - no group metrics will be reported

Parameters:

groupMetrics - Enable monitoring for group metrics, these metrics describe the group rather than any of its instances. This parameter is required.

Returns:

this

healthCheck

public AutoScalingGroup.Builder healthCheck(HealthCheck healthCheck)

Configuration for health checks.

Default: - HealthCheck.ec2 with no grace period

Parameters:

healthCheck - Configuration for health checks. This parameter is required.

Returns:

this

ignoreUnmodifiedSizeProperties

public AutoScalingGroup.Builder ignoreUnmodifiedSizeProperties(java.lang.Boolean 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.

Default: true

Parameters:

ignoreUnmodifiedSizeProperties - If the ASG has scheduled actions, don't reset unchanged group sizes. This parameter is required.

Returns:

this

instanceMonitoring

public AutoScalingGroup.Builder instanceMonitoring(Monitoring 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.

Default: - Monitoring.DETAILED

Parameters:

instanceMonitoring - Controls whether instances in this group are launched with detailed or basic monitoring. This parameter is required.

Returns:

this

See Also:

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

keyName

public AutoScalingGroup.Builder keyName(java.lang.String keyName)

Name of SSH keypair to grant access to instances.

Default: - No SSH access will be possible.

Parameters:

keyName - Name of SSH keypair to grant access to instances. This parameter is required.

Returns:

this

maxCapacity

public AutoScalingGroup.Builder maxCapacity(java.lang.Number maxCapacity)

Maximum number of instances in the fleet.

Default: desiredCapacity

Parameters:

maxCapacity - Maximum number of instances in the fleet. This parameter is required.

Returns:

this

maxInstanceLifetime

public AutoScalingGroup.Builder maxInstanceLifetime(Duration 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.

Default: none

Parameters:

maxInstanceLifetime - The maximum amount of time that an instance can be in service. This parameter is required.

Returns:

this

See Also:

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

minCapacity

public AutoScalingGroup.Builder minCapacity(java.lang.Number minCapacity)

Minimum number of instances in the fleet.

Default: 1

Parameters:

minCapacity - Minimum number of instances in the fleet. This parameter is required.

Returns:

this

newInstancesProtectedFromScaleIn

public AutoScalingGroup.Builder newInstancesProtectedFromScaleIn(java.lang.Boolean 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.

Default: false

Parameters:

newInstancesProtectedFromScaleIn - Whether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. This parameter is required.

Returns:

this

notifications

public AutoScalingGroup.Builder notifications(java.util.List<? extends NotificationConfiguration> notifications)

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

Default: - No fleet change notifications will be sent.

Parameters:

notifications - Configure autoscaling group to send notifications about fleet changes to an SNS topic(s). This parameter is required.

Returns:

this

See Also:

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

notificationsTopic

@Deprecated
public AutoScalingGroup.Builder notificationsTopic(ITopic notificationsTopic)

Deprecated. use `notifications`

(deprecated) SNS topic to send notifications about fleet changes.

Default: - No fleet change notifications will be sent.

Parameters:

notificationsTopic - SNS topic to send notifications about fleet changes. This parameter is required.

Returns:

this

replacingUpdateMinSuccessfulInstancesPercent

@Deprecated
public AutoScalingGroup.Builder replacingUpdateMinSuccessfulInstancesPercent(java.lang.Number replacingUpdateMinSuccessfulInstancesPercent)

Deprecated. Use `signals` instead

(deprecated) Configuration for replacing updates.

Only used if updateType == UpdateType.ReplacingUpdate. Specifies how many instances must signal success for the update to succeed.

Default: minSuccessfulInstancesPercent

Parameters:

replacingUpdateMinSuccessfulInstancesPercent - Configuration for replacing updates. This parameter is required.

Returns:

this

resourceSignalCount

@Deprecated
public AutoScalingGroup.Builder resourceSignalCount(java.lang.Number resourceSignalCount)

Deprecated. Use `signals` instead.

(deprecated) How many ResourceSignal calls CloudFormation expects before the resource is considered created.

Default: 1 if resourceSignalTimeout is set, 0 otherwise

Parameters:

resourceSignalCount - How many ResourceSignal calls CloudFormation expects before the resource is considered created. This parameter is required.

Returns:

this

resourceSignalTimeout

@Deprecated
public AutoScalingGroup.Builder resourceSignalTimeout(Duration resourceSignalTimeout)

Deprecated. Use `signals` instead.

(deprecated) The length of time to wait for the resourceSignalCount.

The maximum value is 43200 (12 hours).

Default: Duration.minutes(5) if resourceSignalCount is set, N/A otherwise

Parameters:

resourceSignalTimeout - The length of time to wait for the resourceSignalCount. This parameter is required.

Returns:

this

rollingUpdateConfiguration

@Deprecated
public AutoScalingGroup.Builder rollingUpdateConfiguration(RollingUpdateConfiguration rollingUpdateConfiguration)

Deprecated. Use `updatePolicy` instead

(deprecated) Configuration for rolling updates.

Only used if updateType == UpdateType.RollingUpdate.

Default: - RollingUpdateConfiguration with defaults.

Parameters:

rollingUpdateConfiguration - Configuration for rolling updates. This parameter is required.

Returns:

this

signals

public AutoScalingGroup.Builder signals(Signals 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

Default: - Do not wait for signals

Parameters:

signals - Configure waiting for signals during deployment. This parameter is required.

Returns:

this

spotPrice

public AutoScalingGroup.Builder spotPrice(java.lang.String 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.

Default: none

Parameters:

spotPrice - The maximum hourly price (in USD) to be paid for any Spot Instance launched to fulfill the request. This parameter is required.

Returns:

this

terminationPolicies

public AutoScalingGroup.Builder terminationPolicies(java.util.List<? extends TerminationPolicy> 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.

Default: - `TerminationPolicy.DEFAULT`

Parameters:

terminationPolicies - A policy or a list of policies that are used to select the instances to terminate. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html

updatePolicy

public AutoScalingGroup.Builder updatePolicy(UpdatePolicy 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.

Default: - `UpdatePolicy.rollingUpdate()` if using `init`, `UpdatePolicy.none()` otherwise

Parameters:

updatePolicy - What to do when an AutoScalingGroup's instance configuration is changed. This parameter is required.

Returns:

this

updateType

@Deprecated
public AutoScalingGroup.Builder updateType(UpdateType updateType)

Deprecated. Use `updatePolicy` instead

(deprecated) 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: UpdateType.None

Parameters:

updateType - What to do when an AutoScalingGroup's instance configuration is changed. This parameter is required.

Returns:

this

vpcSubnets

public AutoScalingGroup.Builder vpcSubnets(SubnetSelection vpcSubnets)

Where to place instances within the VPC.

Default: - All Private subnets.

Parameters:

vpcSubnets - Where to place instances within the VPC. This parameter is required.

Returns:

this

vpc

public AutoScalingGroup.Builder vpc(IVpc vpc)

VPC to launch these instances in.

Parameters:

vpc - VPC to launch these instances in. This parameter is required.

Returns:

this

init

public AutoScalingGroup.Builder init(CloudFormationInit init)

Apply the given CloudFormation Init configuration to the instances in the AutoScalingGroup at startup.

If you specify init, you must also specify signals to configure the number of instances to wait for and the timeout for waiting for the init process.

Default: - no CloudFormation init

Parameters:

init - Apply the given CloudFormation Init configuration to the instances in the AutoScalingGroup at startup. This parameter is required.

Returns:

this

initOptions

public AutoScalingGroup.Builder initOptions(ApplyCloudFormationInitOptions initOptions)

Use the given options for applying CloudFormation Init.

Describes the configsets to use and the timeout to wait

Default: - default options

Parameters:

initOptions - Use the given options for applying CloudFormation Init. This parameter is required.

Returns:

this

instanceType

public AutoScalingGroup.Builder instanceType(InstanceType instanceType)

Type of instance to launch.

launchTemplate must not be specified when this property is specified.

Default: - Do not provide any instance type

Parameters:

instanceType - Type of instance to launch. This parameter is required.

Returns:

this

launchTemplate

public AutoScalingGroup.Builder launchTemplate(ILaunchTemplate launchTemplate)

Launch template to use.

Launch configuration related settings and MixedInstancesPolicy must not be specified when a launch template is specified.

Default: - Do not provide any launch template

Parameters:

launchTemplate - Launch template to use. This parameter is required.

Returns:

this

machineImage

public AutoScalingGroup.Builder machineImage(IMachineImage machineImage)

AMI to launch.

launchTemplate must not be specified when this property is specified.

Default: - Do not provide any machine image

Parameters:

machineImage - AMI to launch. This parameter is required.

Returns:

this

mixedInstancesPolicy

public AutoScalingGroup.Builder mixedInstancesPolicy(MixedInstancesPolicy mixedInstancesPolicy)

Mixed Instances Policy to use.

Launch configuration related settings and Launch Template must not be specified when a MixedInstancesPolicy is specified.

Default: - Do not provide any MixedInstancesPolicy

Parameters:

mixedInstancesPolicy - Mixed Instances Policy to use. This parameter is required.

Returns:

this

requireImdsv2

public AutoScalingGroup.Builder requireImdsv2(java.lang.Boolean requireImdsv2)

Whether IMDSv2 should be required on launched instances.

Default: false

Parameters:

requireImdsv2 - Whether IMDSv2 should be required on launched instances. This parameter is required.

Returns:

this

role

public AutoScalingGroup.Builder role(IRole role)

An IAM role to associate with the instance profile assigned to this Auto Scaling Group.

The role must be assumable by the service principal ec2.amazonaws.com:

launchTemplate must not be specified when this property is specified.

Default: A role will automatically be created, it can be accessed via the `role` property

Example:

 Role role = Role.Builder.create(this, "MyRole")
         .assumedBy(new ServicePrincipal("ec2.amazonaws.com"))
         .build();
 

Parameters:

role - An IAM role to associate with the instance profile assigned to this Auto Scaling Group. This parameter is required.

Returns:

this

securityGroup

public AutoScalingGroup.Builder securityGroup(ISecurityGroup securityGroup)

Security group to launch the instances in.

launchTemplate must not be specified when this property is specified.

Default: - A SecurityGroup will be created if none is specified.

Parameters:

securityGroup - Security group to launch the instances in. This parameter is required.

Returns:

this

userData

public AutoScalingGroup.Builder userData(UserData userData)

Specific UserData to use.

The UserData may still be mutated after creation.

launchTemplate must not be specified when this property is specified.

Default: - A UserData object appropriate for the MachineImage's Operating System is created.

Parameters:

userData - Specific UserData to use. This parameter is required.

Returns:

this

build

public AutoScalingGroup build()