Package software.amazon.awscdk.services.eks

Class AutoScalingGroupCapacityOptions.Builder

java.lang.Object

software.amazon.awscdk.services.eks.AutoScalingGroupCapacityOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AutoScalingGroupCapacityOptions>

Enclosing interface:

AutoScalingGroupCapacityOptions

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

A builder for AutoScalingGroupCapacityOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AutoScalingGroupCapacityOptions.Builder	allowAllOutbound(Boolean allowAllOutbound)	Sets the value of CommonAutoScalingGroupProps.getAllowAllOutbound()
AutoScalingGroupCapacityOptions.Builder	associatePublicIpAddress(Boolean associatePublicIpAddress)	Sets the value of CommonAutoScalingGroupProps.getAssociatePublicIpAddress()
AutoScalingGroupCapacityOptions.Builder	autoScalingGroupName(String autoScalingGroupName)	Sets the value of CommonAutoScalingGroupProps.getAutoScalingGroupName()
AutoScalingGroupCapacityOptions.Builder	blockDevices(List<? extends BlockDevice> blockDevices)	Sets the value of CommonAutoScalingGroupProps.getBlockDevices()
AutoScalingGroupCapacityOptions.Builder	bootstrapEnabled(Boolean bootstrapEnabled)	Sets the value of AutoScalingGroupCapacityOptions.getBootstrapEnabled()
AutoScalingGroupCapacityOptions.Builder	bootstrapOptions(BootstrapOptions bootstrapOptions)	Sets the value of AutoScalingGroupCapacityOptions.getBootstrapOptions()
AutoScalingGroupCapacityOptions	build()	Builds the configured instance.
AutoScalingGroupCapacityOptions.Builder	capacityRebalance(Boolean capacityRebalance)	Sets the value of CommonAutoScalingGroupProps.getCapacityRebalance()
AutoScalingGroupCapacityOptions.Builder	cooldown(Duration cooldown)	Sets the value of CommonAutoScalingGroupProps.getCooldown()
AutoScalingGroupCapacityOptions.Builder	defaultInstanceWarmup(Duration defaultInstanceWarmup)	Sets the value of CommonAutoScalingGroupProps.getDefaultInstanceWarmup()
AutoScalingGroupCapacityOptions.Builder	desiredCapacity(Number desiredCapacity)	Sets the value of CommonAutoScalingGroupProps.getDesiredCapacity()
AutoScalingGroupCapacityOptions.Builder	groupMetrics(List<? extends GroupMetrics> groupMetrics)	Sets the value of CommonAutoScalingGroupProps.getGroupMetrics()
AutoScalingGroupCapacityOptions.Builder	healthCheck(HealthCheck healthCheck)	Sets the value of CommonAutoScalingGroupProps.getHealthCheck()
AutoScalingGroupCapacityOptions.Builder	ignoreUnmodifiedSizeProperties(Boolean ignoreUnmodifiedSizeProperties)	Sets the value of CommonAutoScalingGroupProps.getIgnoreUnmodifiedSizeProperties()
AutoScalingGroupCapacityOptions.Builder	instanceMonitoring(Monitoring instanceMonitoring)	Sets the value of CommonAutoScalingGroupProps.getInstanceMonitoring()
AutoScalingGroupCapacityOptions.Builder	instanceType(InstanceType instanceType)	Sets the value of AutoScalingGroupCapacityOptions.getInstanceType()
AutoScalingGroupCapacityOptions.Builder	keyName(String keyName)	Deprecated. - Use `keyPair` instead - https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2-readme.html#using-an-existing-ec2-key-pair
AutoScalingGroupCapacityOptions.Builder	keyPair(IKeyPair keyPair)	Sets the value of CommonAutoScalingGroupProps.getKeyPair()
AutoScalingGroupCapacityOptions.Builder	machineImageType(MachineImageType machineImageType)	Sets the value of AutoScalingGroupCapacityOptions.getMachineImageType()
AutoScalingGroupCapacityOptions.Builder	mapRole(Boolean mapRole)	Sets the value of AutoScalingGroupCapacityOptions.getMapRole()
AutoScalingGroupCapacityOptions.Builder	maxCapacity(Number maxCapacity)	Sets the value of CommonAutoScalingGroupProps.getMaxCapacity()
AutoScalingGroupCapacityOptions.Builder	maxInstanceLifetime(Duration maxInstanceLifetime)	Sets the value of CommonAutoScalingGroupProps.getMaxInstanceLifetime()
AutoScalingGroupCapacityOptions.Builder	minCapacity(Number minCapacity)	Sets the value of CommonAutoScalingGroupProps.getMinCapacity()
AutoScalingGroupCapacityOptions.Builder	newInstancesProtectedFromScaleIn(Boolean newInstancesProtectedFromScaleIn)	Sets the value of CommonAutoScalingGroupProps.getNewInstancesProtectedFromScaleIn()
AutoScalingGroupCapacityOptions.Builder	notifications(List<? extends NotificationConfiguration> notifications)	Sets the value of CommonAutoScalingGroupProps.getNotifications()
AutoScalingGroupCapacityOptions.Builder	signals(Signals signals)	Sets the value of CommonAutoScalingGroupProps.getSignals()
AutoScalingGroupCapacityOptions.Builder	spotInterruptHandler(Boolean spotInterruptHandler)	Sets the value of AutoScalingGroupCapacityOptions.getSpotInterruptHandler()
AutoScalingGroupCapacityOptions.Builder	spotPrice(String spotPrice)	Sets the value of CommonAutoScalingGroupProps.getSpotPrice()
AutoScalingGroupCapacityOptions.Builder	ssmSessionPermissions(Boolean ssmSessionPermissions)	Sets the value of CommonAutoScalingGroupProps.getSsmSessionPermissions()
AutoScalingGroupCapacityOptions.Builder	terminationPolicies(List<? extends TerminationPolicy> terminationPolicies)	Sets the value of CommonAutoScalingGroupProps.getTerminationPolicies()
AutoScalingGroupCapacityOptions.Builder	terminationPolicyCustomLambdaFunctionArn(String terminationPolicyCustomLambdaFunctionArn)	Sets the value of CommonAutoScalingGroupProps.getTerminationPolicyCustomLambdaFunctionArn()
AutoScalingGroupCapacityOptions.Builder	updatePolicy(UpdatePolicy updatePolicy)	Sets the value of CommonAutoScalingGroupProps.getUpdatePolicy()
AutoScalingGroupCapacityOptions.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

instanceType

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

Sets the value of AutoScalingGroupCapacityOptions.getInstanceType()

Parameters:

instanceType - Instance type of the instances to start. This parameter is required.

Returns:

this

bootstrapEnabled

@Stability(Stable)
public AutoScalingGroupCapacityOptions.Builder bootstrapEnabled(Boolean bootstrapEnabled)

Sets the value of AutoScalingGroupCapacityOptions.getBootstrapEnabled()

Parameters:

bootstrapEnabled - Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke /etc/eks/bootstrap.sh) and associate it with the EKS cluster. If you wish to provide a custom user data script, set this to false and manually invoke autoscalingGroup.addUserData().

Returns:

this

bootstrapOptions

@Stability(Stable)
public AutoScalingGroupCapacityOptions.Builder bootstrapOptions(BootstrapOptions bootstrapOptions)

Sets the value of AutoScalingGroupCapacityOptions.getBootstrapOptions()

Parameters:

bootstrapOptions - EKS node bootstrapping options.

Returns:

this

machineImageType

@Stability(Stable)
public AutoScalingGroupCapacityOptions.Builder machineImageType(MachineImageType machineImageType)

Sets the value of AutoScalingGroupCapacityOptions.getMachineImageType()

Parameters:

machineImageType - Machine image type.

Returns:

this

mapRole

@Stability(Stable)
public AutoScalingGroupCapacityOptions.Builder mapRole(Boolean mapRole)

Sets the value of AutoScalingGroupCapacityOptions.getMapRole()

Parameters:

mapRole - Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC. This cannot be explicitly set to true if the cluster has kubectl disabled.

Returns:

this

spotInterruptHandler

@Stability(Stable)
public AutoScalingGroupCapacityOptions.Builder spotInterruptHandler(Boolean spotInterruptHandler)

Sets the value of AutoScalingGroupCapacityOptions.getSpotInterruptHandler()

Parameters:

spotInterruptHandler - Installs the AWS spot instance interrupt handler on the cluster if it's not already added. Only relevant if spotPrice is used.

Returns:

this

allowAllOutbound

@Stability(Stable)
public AutoScalingGroupCapacityOptions.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 AutoScalingGroupCapacityOptions.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. launchTemplate and mixedInstancesPolicy must not be specified when this property is specified

Returns:

this

autoScalingGroupName

@Stability(Stable)
public AutoScalingGroupCapacityOptions.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 AutoScalingGroupCapacityOptions.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.

launchTemplate and mixedInstancesPolicy must not be specified when this property is specified

Returns:

this

capacityRebalance

@Stability(Stable)
public AutoScalingGroupCapacityOptions.Builder capacityRebalance(Boolean capacityRebalance)

Sets the value of CommonAutoScalingGroupProps.getCapacityRebalance()

Parameters:

capacityRebalance - Indicates whether Capacity Rebalancing is enabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of interruption. After launching a new instance, it then terminates an old instance.

Returns:

this

cooldown

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

Sets the value of CommonAutoScalingGroupProps.getCooldown()

Parameters:

cooldown - Default scaling cooldown for this AutoScalingGroup.

Returns:

this

defaultInstanceWarmup

@Stability(Stable)
public AutoScalingGroupCapacityOptions.Builder defaultInstanceWarmup(Duration defaultInstanceWarmup)

Sets the value of CommonAutoScalingGroupProps.getDefaultInstanceWarmup()

Parameters:

defaultInstanceWarmup - The amount of time, in seconds, until a newly launched instance can contribute to the Amazon CloudWatch metrics. This delay lets an instance finish initializing before Amazon EC2 Auto Scaling aggregates instance metrics, resulting in more reliable usage data. Set this value equal to the amount of time that it takes for resource consumption to become stable after an instance reaches the InService state.

To optimize the performance of scaling policies that scale continuously, such as target tracking and step scaling policies, we strongly recommend that you enable the default instance warmup, even if its value is set to 0 seconds

Default instance warmup will not be added if no value is specified

Returns:

this

desiredCapacity

@Stability(Stable)
public AutoScalingGroupCapacityOptions.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 AutoScalingGroupCapacityOptions.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 AutoScalingGroupCapacityOptions.Builder healthCheck(HealthCheck healthCheck)

Sets the value of CommonAutoScalingGroupProps.getHealthCheck()

Parameters:

healthCheck - Configuration for health checks.

Returns:

this

ignoreUnmodifiedSizeProperties

@Stability(Stable)
public AutoScalingGroupCapacityOptions.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 AutoScalingGroupCapacityOptions.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.

launchTemplate and mixedInstancesPolicy must not be specified when this property is specified

Returns:

this

keyName

@Stability(Deprecated)
@Deprecated
public AutoScalingGroupCapacityOptions.Builder keyName(String keyName)

Deprecated.

- Use `keyPair` instead - https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2-readme.html#using-an-existing-ec2-key-pair

Sets the value of CommonAutoScalingGroupProps.getKeyName()

Parameters:

keyName - Name of SSH keypair to grant access to instances. launchTemplate and mixedInstancesPolicy must not be specified when this property is specified

You can either specify keyPair or keyName, not both.

Returns:

this

keyPair

@Stability(Stable)
public AutoScalingGroupCapacityOptions.Builder keyPair(IKeyPair keyPair)

Sets the value of CommonAutoScalingGroupProps.getKeyPair()

Parameters:

keyPair - The SSH keypair to grant access to the instance. Feature flag AUTOSCALING_GENERATE_LAUNCH_TEMPLATE must be enabled to use this property.

launchTemplate and mixedInstancesPolicy must not be specified when this property is specified.

You can either specify keyPair or keyName, not both.

Returns:

this

maxCapacity

@Stability(Stable)
public AutoScalingGroupCapacityOptions.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 AutoScalingGroupCapacityOptions.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 AutoScalingGroupCapacityOptions.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 AutoScalingGroupCapacityOptions.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 AutoScalingGroupCapacityOptions.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

signals

@Stability(Stable)
public AutoScalingGroupCapacityOptions.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 AutoScalingGroupCapacityOptions.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.

launchTemplate and mixedInstancesPolicy must not be specified when this property is specified

Returns:

this

ssmSessionPermissions

@Stability(Stable)
public AutoScalingGroupCapacityOptions.Builder ssmSessionPermissions(Boolean ssmSessionPermissions)

Sets the value of CommonAutoScalingGroupProps.getSsmSessionPermissions()

Parameters:

ssmSessionPermissions - Add SSM session permissions to the instance role. Setting this to true adds the necessary permissions to connect to the instance using SSM Session Manager. You can do this from the AWS Console.

NOTE: Setting this flag to true may not be enough by itself. You must also use an AMI that comes with the SSM Agent, or install the SSM Agent yourself. See Working with SSM Agent in the SSM Developer Guide.

Returns:

this

terminationPolicies

@Stability(Stable)
public AutoScalingGroupCapacityOptions.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

terminationPolicyCustomLambdaFunctionArn

@Stability(Stable)
public AutoScalingGroupCapacityOptions.Builder terminationPolicyCustomLambdaFunctionArn(String terminationPolicyCustomLambdaFunctionArn)

Sets the value of CommonAutoScalingGroupProps.getTerminationPolicyCustomLambdaFunctionArn()

Parameters:

terminationPolicyCustomLambdaFunctionArn - A lambda function Arn that can be used as a custom termination policy to select the instances to terminate. This property must be specified if the TerminationPolicy.CUSTOM_LAMBDA_FUNCTION is used.

Returns:

this

updatePolicy

@Stability(Stable)
public AutoScalingGroupCapacityOptions.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

vpcSubnets

@Stability(Stable)
public AutoScalingGroupCapacityOptions.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 AutoScalingGroupCapacityOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of AutoScalingGroupCapacityOptions

Throws:

NullPointerException - if any required attribute was not provided