Package software.amazon.awscdk.services.autoscaling

Class AutoScalingGroup.Builder

java.lang.Object
software.amazon.awscdk.services.autoscaling.AutoScalingGroup.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<AutoScalingGroup>
Enclosing class:
AutoScalingGroup
@Stability(Stable) public static final class AutoScalingGroup.Builder extends Object implements software.amazon.jsii.Builder<AutoScalingGroup>
A fluent builder for AutoScalingGroup.

  • Method Details

    • create

      @Stability(Stable) public static AutoScalingGroup.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of AutoScalingGroup.Builder.

    • allowAllOutbound

      @Stability(Stable) public AutoScalingGroup.Builder allowAllOutbound(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

      @Stability(Stable) public AutoScalingGroup.Builder associatePublicIpAddress(Boolean 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

      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

      @Stability(Stable) public AutoScalingGroup.Builder autoScalingGroupName(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

      @Stability(Stable) public AutoScalingGroup.Builder blockDevices(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.

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

      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:

    • capacityRebalance

      @Stability(Stable) public AutoScalingGroup.Builder capacityRebalance(Boolean 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.

      Default: false

      Parameters:
      capacityRebalance - Indicates whether Capacity Rebalancing is enabled. This parameter is required.
      Returns:
      this
      See Also:

    • cooldown

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

    • defaultInstanceWarmup

      @Stability(Stable) public AutoScalingGroup.Builder defaultInstanceWarmup(Duration 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

      Default: None

      Parameters:
      defaultInstanceWarmup - The amount of time, in seconds, until a newly launched instance can contribute to the Amazon CloudWatch metrics. This parameter is required.
      Returns:
      this
      See Also:

    • desiredCapacity

      @Stability(Stable) public AutoScalingGroup.Builder desiredCapacity(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:

    • groupMetrics

      @Stability(Stable) public AutoScalingGroup.Builder groupMetrics(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

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

      @Stability(Stable) public AutoScalingGroup.Builder ignoreUnmodifiedSizeProperties(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

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

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

      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:

    • keyName

      @Stability(Stable) public AutoScalingGroup.Builder keyName(String keyName)
      Name of SSH keypair to grant access to instances.

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

      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

      @Stability(Stable) public AutoScalingGroup.Builder maxCapacity(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

      @Stability(Stable) 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:

    • minCapacity

      @Stability(Stable) public AutoScalingGroup.Builder minCapacity(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

      @Stability(Stable) public AutoScalingGroup.Builder newInstancesProtectedFromScaleIn(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

      @Stability(Stable) public AutoScalingGroup.Builder notifications(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:

    • signals

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

      @Stability(Stable) public AutoScalingGroup.Builder spotPrice(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.

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

      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

    • ssmSessionPermissions

      @Stability(Stable) public AutoScalingGroup.Builder ssmSessionPermissions(Boolean 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.

      Default: false

      Parameters:
      ssmSessionPermissions - Add SSM session permissions to the instance role. This parameter is required.
      Returns:
      this

    • terminationPolicies

      @Stability(Stable) public AutoScalingGroup.Builder terminationPolicies(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:

    • terminationPolicyCustomLambdaFunctionArn

      @Stability(Stable) public AutoScalingGroup.Builder terminationPolicyCustomLambdaFunctionArn(String 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.

      Default: - No lambda function Arn will be supplied

      Parameters:
      terminationPolicyCustomLambdaFunctionArn - A lambda function Arn that can be used as a custom termination policy to select the instances to terminate. This parameter is required.
      Returns:
      this
      See Also:

    • updatePolicy

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

    • vpcSubnets

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

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

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

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

      @Stability(Stable) public AutoScalingGroup.Builder instanceType(InstanceType instanceType)
      Type of instance to launch.

      launchTemplate and mixedInstancesPolicy 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

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

      @Stability(Stable) public AutoScalingGroup.Builder machineImage(IMachineImage machineImage)
      AMI to launch.

      launchTemplate and mixedInstancesPolicy 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

    • maxHealthyPercentage

      @Stability(Stable) public AutoScalingGroup.Builder maxHealthyPercentage(Number maxHealthyPercentage)
      Specifies the upper threshold as a percentage of the desired capacity of the Auto Scaling group.

      It represents the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when replacing instances.

      Value range is 0 to 100. After it's set, both minHealthyPercentage and maxHealthyPercentage to -1 will clear the previously set value.

      Both or neither of minHealthyPercentage and maxHealthyPercentage must be specified, and the difference between them cannot be greater than 100. A large range increases the number of instances that can be replaced at the same time.

      Default: - No instance maintenance policy.

      Parameters:
      maxHealthyPercentage - Specifies the upper threshold as a percentage of the desired capacity of the Auto Scaling group. This parameter is required.
      Returns:
      this
      See Also:

    • minHealthyPercentage

      @Stability(Stable) public AutoScalingGroup.Builder minHealthyPercentage(Number minHealthyPercentage)
      Specifies the lower threshold as a percentage of the desired capacity of the Auto Scaling group.

      It represents the minimum percentage of the group to keep in service, healthy, and ready to use to support your workload when replacing instances.

      Value range is 0 to 100. After it's set, both minHealthyPercentage and maxHealthyPercentage to -1 will clear the previously set value.

      Both or neither of minHealthyPercentage and maxHealthyPercentage must be specified, and the difference between them cannot be greater than 100. A large range increases the number of instances that can be replaced at the same time.

      Default: - No instance maintenance policy.

      Parameters:
      minHealthyPercentage - Specifies the lower threshold as a percentage of the desired capacity of the Auto Scaling group. This parameter is required.
      Returns:
      this
      See Also:

    • mixedInstancesPolicy

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

      @Stability(Stable) public AutoScalingGroup.Builder requireImdsv2(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

      @Stability(Stable) 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 and mixedInstancesPolicy 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

      @Stability(Stable) public AutoScalingGroup.Builder securityGroup(ISecurityGroup securityGroup)
      Security group to launch the instances in.

      launchTemplate and mixedInstancesPolicy 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

      @Stability(Stable) public AutoScalingGroup.Builder userData(UserData userData)
      Specific UserData to use.

      The UserData may still be mutated after creation.

      launchTemplate and mixedInstancesPolicy 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

      @Stability(Stable) public AutoScalingGroup build()
      Specified by:
      build in interface software.amazon.jsii.Builder<AutoScalingGroup>
      Returns:
      a newly built instance of AutoScalingGroup.