Package software.amazon.awscdk.services.autoscaling

Class AutoScalingGroupProps.Builder

java.lang.Object

software.amazon.awscdk.services.autoscaling.AutoScalingGroupProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AutoScalingGroupProps>

Enclosing interface:

AutoScalingGroupProps

@Stability(Stable)
public static final class AutoScalingGroupProps.Builder
extends Object
implements software.amazon.jsii.Builder<AutoScalingGroupProps>

A builder for AutoScalingGroupProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AutoScalingGroupProps.Builder	allowAllOutbound(Boolean allowAllOutbound)	Sets the value of CommonAutoScalingGroupProps.getAllowAllOutbound()
AutoScalingGroupProps.Builder	associatePublicIpAddress(Boolean associatePublicIpAddress)	Sets the value of CommonAutoScalingGroupProps.getAssociatePublicIpAddress()
AutoScalingGroupProps.Builder	autoScalingGroupName(String autoScalingGroupName)	Sets the value of CommonAutoScalingGroupProps.getAutoScalingGroupName()
AutoScalingGroupProps.Builder	blockDevices(List<? extends BlockDevice> blockDevices)	Sets the value of CommonAutoScalingGroupProps.getBlockDevices()
AutoScalingGroupProps	build()	Builds the configured instance.
AutoScalingGroupProps.Builder	cooldown(Duration cooldown)	Sets the value of CommonAutoScalingGroupProps.getCooldown()
AutoScalingGroupProps.Builder	desiredCapacity(Number desiredCapacity)	Sets the value of CommonAutoScalingGroupProps.getDesiredCapacity()
AutoScalingGroupProps.Builder	groupMetrics(List<? extends GroupMetrics> groupMetrics)	Sets the value of CommonAutoScalingGroupProps.getGroupMetrics()
AutoScalingGroupProps.Builder	healthCheck(HealthCheck healthCheck)	Sets the value of CommonAutoScalingGroupProps.getHealthCheck()
AutoScalingGroupProps.Builder	ignoreUnmodifiedSizeProperties(Boolean ignoreUnmodifiedSizeProperties)	Sets the value of CommonAutoScalingGroupProps.getIgnoreUnmodifiedSizeProperties()
AutoScalingGroupProps.Builder	init(CloudFormationInit init)	Sets the value of AutoScalingGroupProps.getInit()
AutoScalingGroupProps.Builder	initOptions(ApplyCloudFormationInitOptions initOptions)	Sets the value of AutoScalingGroupProps.getInitOptions()
AutoScalingGroupProps.Builder	instanceMonitoring(Monitoring instanceMonitoring)	Sets the value of CommonAutoScalingGroupProps.getInstanceMonitoring()
AutoScalingGroupProps.Builder	instanceType(InstanceType instanceType)	Sets the value of AutoScalingGroupProps.getInstanceType()
AutoScalingGroupProps.Builder	keyName(String keyName)	Sets the value of CommonAutoScalingGroupProps.getKeyName()
AutoScalingGroupProps.Builder	launchTemplate(ILaunchTemplate launchTemplate)	Sets the value of AutoScalingGroupProps.getLaunchTemplate()
AutoScalingGroupProps.Builder	machineImage(IMachineImage machineImage)	Sets the value of AutoScalingGroupProps.getMachineImage()
AutoScalingGroupProps.Builder	maxCapacity(Number maxCapacity)	Sets the value of CommonAutoScalingGroupProps.getMaxCapacity()
AutoScalingGroupProps.Builder	maxInstanceLifetime(Duration maxInstanceLifetime)	Sets the value of CommonAutoScalingGroupProps.getMaxInstanceLifetime()
AutoScalingGroupProps.Builder	minCapacity(Number minCapacity)	Sets the value of CommonAutoScalingGroupProps.getMinCapacity()
AutoScalingGroupProps.Builder	mixedInstancesPolicy(MixedInstancesPolicy mixedInstancesPolicy)	Sets the value of AutoScalingGroupProps.getMixedInstancesPolicy()
AutoScalingGroupProps.Builder	newInstancesProtectedFromScaleIn(Boolean newInstancesProtectedFromScaleIn)	Sets the value of CommonAutoScalingGroupProps.getNewInstancesProtectedFromScaleIn()
AutoScalingGroupProps.Builder	notifications(List<? extends NotificationConfiguration> notifications)	Sets the value of CommonAutoScalingGroupProps.getNotifications()
AutoScalingGroupProps.Builder	notificationsTopic(ITopic notificationsTopic)	Deprecated. use `notifications`
AutoScalingGroupProps.Builder	replacingUpdateMinSuccessfulInstancesPercent(Number replacingUpdateMinSuccessfulInstancesPercent)	Deprecated. Use `signals` instead
AutoScalingGroupProps.Builder	requireImdsv2(Boolean requireImdsv2)	Sets the value of AutoScalingGroupProps.getRequireImdsv2()
AutoScalingGroupProps.Builder	resourceSignalCount(Number resourceSignalCount)	Deprecated. Use `signals` instead.
AutoScalingGroupProps.Builder	resourceSignalTimeout(Duration resourceSignalTimeout)	Deprecated. Use `signals` instead.
AutoScalingGroupProps.Builder	role(IRole role)	Sets the value of AutoScalingGroupProps.getRole()
AutoScalingGroupProps.Builder	rollingUpdateConfiguration(RollingUpdateConfiguration rollingUpdateConfiguration)	Deprecated. Use `updatePolicy` instead
AutoScalingGroupProps.Builder	securityGroup(ISecurityGroup securityGroup)	Sets the value of AutoScalingGroupProps.getSecurityGroup()
AutoScalingGroupProps.Builder	signals(Signals signals)	Sets the value of CommonAutoScalingGroupProps.getSignals()
AutoScalingGroupProps.Builder	spotPrice(String spotPrice)	Sets the value of CommonAutoScalingGroupProps.getSpotPrice()
AutoScalingGroupProps.Builder	terminationPolicies(List<? extends TerminationPolicy> terminationPolicies)	Sets the value of CommonAutoScalingGroupProps.getTerminationPolicies()
AutoScalingGroupProps.Builder	updatePolicy(UpdatePolicy updatePolicy)	Sets the value of CommonAutoScalingGroupProps.getUpdatePolicy()
AutoScalingGroupProps.Builder	updateType(UpdateType updateType)	Deprecated. Use `updatePolicy` instead
AutoScalingGroupProps.Builder	userData(UserData userData)	Sets the value of AutoScalingGroupProps.getUserData()
AutoScalingGroupProps.Builder	vpc(IVpc vpc)	Sets the value of AutoScalingGroupProps.getVpc()
AutoScalingGroupProps.Builder	vpcSubnets(SubnetSelection vpcSubnets)	Sets the value of CommonAutoScalingGroupProps.getVpcSubnets()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

vpc

@Stability(Stable)
public AutoScalingGroupProps.Builder vpc(IVpc vpc)

Sets the value of AutoScalingGroupProps.getVpc()

Parameters:

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

Returns:

this

init

@Stability(Stable)
public AutoScalingGroupProps.Builder init(CloudFormationInit init)

Sets the value of AutoScalingGroupProps.getInit()

Parameters:

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.

Returns:

this

initOptions

@Stability(Stable)
public AutoScalingGroupProps.Builder initOptions(ApplyCloudFormationInitOptions initOptions)

Sets the value of AutoScalingGroupProps.getInitOptions()

Parameters:

initOptions - Use the given options for applying CloudFormation Init. Describes the configsets to use and the timeout to wait

Returns:

this

instanceType

@Stability(Stable)
public AutoScalingGroupProps.Builder instanceType(InstanceType instanceType)

Sets the value of AutoScalingGroupProps.getInstanceType()

Parameters:

instanceType - Type of instance to launch. launchTemplate must not be specified when this property is specified.

Returns:

this

launchTemplate

@Stability(Stable)
public AutoScalingGroupProps.Builder launchTemplate(ILaunchTemplate launchTemplate)

Sets the value of AutoScalingGroupProps.getLaunchTemplate()

Parameters:

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

Returns:

this

machineImage

@Stability(Stable)
public AutoScalingGroupProps.Builder machineImage(IMachineImage machineImage)

Sets the value of AutoScalingGroupProps.getMachineImage()

Parameters:

machineImage - AMI to launch. launchTemplate must not be specified when this property is specified.

Returns:

this

mixedInstancesPolicy

@Stability(Stable)
public AutoScalingGroupProps.Builder mixedInstancesPolicy(MixedInstancesPolicy mixedInstancesPolicy)

Sets the value of AutoScalingGroupProps.getMixedInstancesPolicy()

Parameters:

mixedInstancesPolicy - Mixed Instances Policy to use. Launch configuration related settings and Launch Template must not be specified when a MixedInstancesPolicy is specified.

Returns:

this

requireImdsv2

@Stability(Stable)
public AutoScalingGroupProps.Builder requireImdsv2(Boolean requireImdsv2)

Sets the value of AutoScalingGroupProps.getRequireImdsv2()

Parameters:

requireImdsv2 - Whether IMDSv2 should be required on launched instances.

Returns:

this

role

@Stability(Stable)
public AutoScalingGroupProps.Builder role(IRole role)

Sets the value of AutoScalingGroupProps.getRole()

Parameters:

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.

Returns:

this

securityGroup

@Stability(Stable)
public AutoScalingGroupProps.Builder securityGroup(ISecurityGroup securityGroup)

Sets the value of AutoScalingGroupProps.getSecurityGroup()

Parameters:

securityGroup - Security group to launch the instances in. launchTemplate must not be specified when this property is specified.

Returns:

this

userData

@Stability(Stable)
public AutoScalingGroupProps.Builder userData(UserData userData)

Sets the value of AutoScalingGroupProps.getUserData()

Parameters:

userData - Specific UserData to use. The UserData may still be mutated after creation.

launchTemplate must not be specified when this property is specified.

Returns:

this

allowAllOutbound

@Stability(Stable)
public AutoScalingGroupProps.Builder allowAllOutbound(Boolean allowAllOutbound)

Sets the value of CommonAutoScalingGroupProps.getAllowAllOutbound()

Parameters:

allowAllOutbound - Whether the instances can initiate connections to anywhere by default.

Returns:

this

associatePublicIpAddress

@Stability(Stable)
public AutoScalingGroupProps.Builder associatePublicIpAddress(Boolean associatePublicIpAddress)

Sets the value of CommonAutoScalingGroupProps.getAssociatePublicIpAddress()

Parameters:

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

Returns:

this

autoScalingGroupName

@Stability(Stable)
public AutoScalingGroupProps.Builder autoScalingGroupName(String autoScalingGroupName)

Sets the value of CommonAutoScalingGroupProps.getAutoScalingGroupName()

Parameters:

autoScalingGroupName - The name of the Auto Scaling group. This name must be unique per Region per account.

Returns:

this

blockDevices

@Stability(Stable)
public AutoScalingGroupProps.Builder blockDevices(List<? extends BlockDevice> blockDevices)

Sets the value of CommonAutoScalingGroupProps.getBlockDevices()

Parameters:

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.

Returns:

this

cooldown

@Stability(Stable)
public AutoScalingGroupProps.Builder cooldown(Duration cooldown)

Sets the value of CommonAutoScalingGroupProps.getCooldown()

Parameters:

cooldown - Default scaling cooldown for this AutoScalingGroup.

Returns:

this

desiredCapacity

@Stability(Stable)
public AutoScalingGroupProps.Builder desiredCapacity(Number desiredCapacity)

Sets the value of CommonAutoScalingGroupProps.getDesiredCapacity()

Parameters:

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.

Returns:

this

groupMetrics

@Stability(Stable)
public AutoScalingGroupProps.Builder groupMetrics(List<? extends GroupMetrics> groupMetrics)

Sets the value of CommonAutoScalingGroupProps.getGroupMetrics()

Parameters:

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.

Returns:

this

healthCheck

@Stability(Stable)
public AutoScalingGroupProps.Builder healthCheck(HealthCheck healthCheck)

Sets the value of CommonAutoScalingGroupProps.getHealthCheck()

Parameters:

healthCheck - Configuration for health checks.

Returns:

this

ignoreUnmodifiedSizeProperties

@Stability(Stable)
public AutoScalingGroupProps.Builder ignoreUnmodifiedSizeProperties(Boolean ignoreUnmodifiedSizeProperties)

Sets the value of CommonAutoScalingGroupProps.getIgnoreUnmodifiedSizeProperties()

Parameters:

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.

Returns:

this

instanceMonitoring

@Stability(Stable)
public AutoScalingGroupProps.Builder instanceMonitoring(Monitoring instanceMonitoring)

Sets the value of CommonAutoScalingGroupProps.getInstanceMonitoring()

Parameters:

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.

Returns:

this

keyName

@Stability(Stable)
public AutoScalingGroupProps.Builder keyName(String keyName)

Sets the value of CommonAutoScalingGroupProps.getKeyName()

Parameters:

keyName - Name of SSH keypair to grant access to instances.

Returns:

this

maxCapacity

@Stability(Stable)
public AutoScalingGroupProps.Builder maxCapacity(Number maxCapacity)

Sets the value of CommonAutoScalingGroupProps.getMaxCapacity()

Parameters:

maxCapacity - Maximum number of instances in the fleet.

Returns:

this

maxInstanceLifetime

@Stability(Stable)
public AutoScalingGroupProps.Builder maxInstanceLifetime(Duration maxInstanceLifetime)

Sets the value of CommonAutoScalingGroupProps.getMaxInstanceLifetime()

Parameters:

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.

Returns:

this

minCapacity

@Stability(Stable)
public AutoScalingGroupProps.Builder minCapacity(Number minCapacity)

Sets the value of CommonAutoScalingGroupProps.getMinCapacity()

Parameters:

minCapacity - Minimum number of instances in the fleet.

Returns:

this

newInstancesProtectedFromScaleIn

@Stability(Stable)
public AutoScalingGroupProps.Builder newInstancesProtectedFromScaleIn(Boolean newInstancesProtectedFromScaleIn)

Sets the value of CommonAutoScalingGroupProps.getNewInstancesProtectedFromScaleIn()

Parameters:

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.

Returns:

this

notifications

@Stability(Stable)
public AutoScalingGroupProps.Builder notifications(List<? extends NotificationConfiguration> notifications)

Sets the value of CommonAutoScalingGroupProps.getNotifications()

Parameters:

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

Returns:

this

notificationsTopic

@Stability(Deprecated)
@Deprecated
public AutoScalingGroupProps.Builder notificationsTopic(ITopic notificationsTopic)

Deprecated.

use `notifications`

Sets the value of CommonAutoScalingGroupProps.getNotificationsTopic()

Parameters:

notificationsTopic - SNS topic to send notifications about fleet changes.

Returns:

this

replacingUpdateMinSuccessfulInstancesPercent

@Stability(Deprecated)
@Deprecated
public AutoScalingGroupProps.Builder replacingUpdateMinSuccessfulInstancesPercent(Number replacingUpdateMinSuccessfulInstancesPercent)

Deprecated.

Use `signals` instead

Sets the value of CommonAutoScalingGroupProps.getReplacingUpdateMinSuccessfulInstancesPercent()

Parameters:

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

Returns:

this

resourceSignalCount

@Stability(Deprecated)
@Deprecated
public AutoScalingGroupProps.Builder resourceSignalCount(Number resourceSignalCount)

Deprecated.

Use `signals` instead.

Sets the value of CommonAutoScalingGroupProps.getResourceSignalCount()

Parameters:

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

Returns:

this

resourceSignalTimeout

@Stability(Deprecated)
@Deprecated
public AutoScalingGroupProps.Builder resourceSignalTimeout(Duration resourceSignalTimeout)

Deprecated.

Use `signals` instead.

Sets the value of CommonAutoScalingGroupProps.getResourceSignalTimeout()

Parameters:

resourceSignalTimeout - The length of time to wait for the resourceSignalCount. The maximum value is 43200 (12 hours).

Returns:

this

rollingUpdateConfiguration

@Stability(Deprecated)
@Deprecated
public AutoScalingGroupProps.Builder rollingUpdateConfiguration(RollingUpdateConfiguration rollingUpdateConfiguration)

Deprecated.

Use `updatePolicy` instead

Sets the value of CommonAutoScalingGroupProps.getRollingUpdateConfiguration()

Parameters:

rollingUpdateConfiguration - Configuration for rolling updates. Only used if updateType == UpdateType.RollingUpdate.

Returns:

this

signals

@Stability(Stable)
public AutoScalingGroupProps.Builder signals(Signals signals)

Sets the value of CommonAutoScalingGroupProps.getSignals()

Parameters:

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

Returns:

this

spotPrice

@Stability(Stable)
public AutoScalingGroupProps.Builder spotPrice(String spotPrice)

Sets the value of CommonAutoScalingGroupProps.getSpotPrice()

Parameters:

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.

Returns:

this

terminationPolicies

@Stability(Stable)
public AutoScalingGroupProps.Builder terminationPolicies(List<? extends TerminationPolicy> terminationPolicies)

Sets the value of CommonAutoScalingGroupProps.getTerminationPolicies()

Parameters:

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.

Returns:

this

updatePolicy

@Stability(Stable)
public AutoScalingGroupProps.Builder updatePolicy(UpdatePolicy updatePolicy)

Sets the value of CommonAutoScalingGroupProps.getUpdatePolicy()

Parameters:

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.

Returns:

this

updateType

@Stability(Deprecated)
@Deprecated
public AutoScalingGroupProps.Builder updateType(UpdateType updateType)

Deprecated.

Use `updatePolicy` instead

Sets the value of CommonAutoScalingGroupProps.getUpdateType()

Parameters:

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.

Returns:

this

vpcSubnets

@Stability(Stable)
public AutoScalingGroupProps.Builder vpcSubnets(SubnetSelection vpcSubnets)

Sets the value of CommonAutoScalingGroupProps.getVpcSubnets()

Parameters:

vpcSubnets - Where to place instances within the VPC.

Returns:

this

build

@Stability(Stable)
public AutoScalingGroupProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<AutoScalingGroupProps>

Returns:

a new instance of AutoScalingGroupProps

Throws:

NullPointerException - if any required attribute was not provided