Package software.amazon.awssdk.services.autoscaling.model

Interface UpdateAutoScalingGroupRequest.Builder

All Superinterfaces:
AutoScalingRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<UpdateAutoScalingGroupRequest.Builder,UpdateAutoScalingGroupRequest>, SdkBuilder<UpdateAutoScalingGroupRequest.Builder,UpdateAutoScalingGroupRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdateAutoScalingGroupRequest
public static interface UpdateAutoScalingGroupRequest.Builder extends AutoScalingRequest.Builder, SdkPojo, CopyableBuilder<UpdateAutoScalingGroupRequest.Builder,UpdateAutoScalingGroupRequest>

  • Method Details

    • autoScalingGroupName

      UpdateAutoScalingGroupRequest.Builder autoScalingGroupName(String autoScalingGroupName)

      The name of the Auto Scaling group.

      Parameters:
      autoScalingGroupName - The name of the Auto Scaling group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • launchConfigurationName

      UpdateAutoScalingGroupRequest.Builder launchConfigurationName(String launchConfigurationName)

      The name of the launch configuration. If you specify LaunchConfigurationName in your update request, you can't specify LaunchTemplate or MixedInstancesPolicy.

      Parameters:
      launchConfigurationName - The name of the launch configuration. If you specify LaunchConfigurationName in your update request, you can't specify LaunchTemplate or MixedInstancesPolicy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • launchTemplate

      UpdateAutoScalingGroupRequest.Builder launchTemplate(LaunchTemplateSpecification launchTemplate)

      The launch template and version to use to specify the updates. If you specify LaunchTemplate in your update request, you can't specify LaunchConfigurationName or MixedInstancesPolicy.

      Parameters:
      launchTemplate - The launch template and version to use to specify the updates. If you specify LaunchTemplate in your update request, you can't specify LaunchConfigurationName or MixedInstancesPolicy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • launchTemplate

      default UpdateAutoScalingGroupRequest.Builder launchTemplate(Consumer<LaunchTemplateSpecification.Builder> launchTemplate)

      The launch template and version to use to specify the updates. If you specify LaunchTemplate in your update request, you can't specify LaunchConfigurationName or MixedInstancesPolicy.

      This is a convenience method that creates an instance of the LaunchTemplateSpecification.Builder avoiding the need to create one manually via LaunchTemplateSpecification.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to launchTemplate(LaunchTemplateSpecification).

      Parameters:
      launchTemplate - a consumer that will call methods on LaunchTemplateSpecification.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • mixedInstancesPolicy

      UpdateAutoScalingGroupRequest.Builder mixedInstancesPolicy(MixedInstancesPolicy mixedInstancesPolicy)

      The mixed instances policy. For more information, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide.

      Parameters:
      mixedInstancesPolicy - The mixed instances policy. For more information, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • mixedInstancesPolicy

      default UpdateAutoScalingGroupRequest.Builder mixedInstancesPolicy(Consumer<MixedInstancesPolicy.Builder> mixedInstancesPolicy)

      The mixed instances policy. For more information, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide.

      This is a convenience method that creates an instance of the MixedInstancesPolicy.Builder avoiding the need to create one manually via MixedInstancesPolicy.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to mixedInstancesPolicy(MixedInstancesPolicy).

      Parameters:
      mixedInstancesPolicy - a consumer that will call methods on MixedInstancesPolicy.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • minSize

      UpdateAutoScalingGroupRequest.Builder minSize(Integer minSize)

      The minimum size of the Auto Scaling group.

      Parameters:
      minSize - The minimum size of the Auto Scaling group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxSize

      UpdateAutoScalingGroupRequest.Builder maxSize(Integer maxSize)

      The maximum size of the Auto Scaling group.

      With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above MaxSize to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go above MaxSize by more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group).

      Parameters:
      maxSize - The maximum size of the Auto Scaling group.

      With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above MaxSize to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go above MaxSize by more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group).

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • desiredCapacity

      UpdateAutoScalingGroupRequest.Builder desiredCapacity(Integer desiredCapacity)

      The desired capacity is the initial capacity of the Auto Scaling group after this operation completes and the capacity it attempts to maintain. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group.

      Parameters:
      desiredCapacity - The desired capacity is the initial capacity of the Auto Scaling group after this operation completes and the capacity it attempts to maintain. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • defaultCooldown

      UpdateAutoScalingGroupRequest.Builder defaultCooldown(Integer defaultCooldown)

      Only needed if you use simple scaling policies.

      The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

      Parameters:
      defaultCooldown - Only needed if you use simple scaling policies.

      The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • availabilityZones

      UpdateAutoScalingGroupRequest.Builder availabilityZones(Collection<String> availabilityZones)

      One or more Availability Zones for the group.

      Parameters:
      availabilityZones - One or more Availability Zones for the group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • availabilityZones

      UpdateAutoScalingGroupRequest.Builder availabilityZones(String... availabilityZones)

      One or more Availability Zones for the group.

      Parameters:
      availabilityZones - One or more Availability Zones for the group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • healthCheckType

      UpdateAutoScalingGroupRequest.Builder healthCheckType(String healthCheckType)

      A comma-separated value string of one or more health check types.

      The valid values are EC2, EBS, ELB, and VPC_LATTICE. EC2 is the default health check and cannot be disabled. For more information, see Health checks for instances in an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

      Only specify EC2 if you must clear a value that was previously set.

      Parameters:
      healthCheckType - A comma-separated value string of one or more health check types.

      The valid values are EC2, EBS, ELB, and VPC_LATTICE. EC2 is the default health check and cannot be disabled. For more information, see Health checks for instances in an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

      Only specify EC2 if you must clear a value that was previously set.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • healthCheckGracePeriod

      UpdateAutoScalingGroupRequest.Builder healthCheckGracePeriod(Integer healthCheckGracePeriod)

      The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed health check. This is useful if your instances do not immediately pass their health checks after they enter the InService state. For more information, see Set the health check grace period for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

      Parameters:
      healthCheckGracePeriod - The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed health check. This is useful if your instances do not immediately pass their health checks after they enter the InService state. For more information, see Set the health check grace period for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • placementGroup

      UpdateAutoScalingGroupRequest.Builder placementGroup(String placementGroup)

      The name of an existing placement group into which to launch your instances. For more information, see Placement groups in the Amazon EC2 User Guide for Linux Instances.

      A cluster placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group.

      Parameters:
      placementGroup - The name of an existing placement group into which to launch your instances. For more information, see Placement groups in the Amazon EC2 User Guide for Linux Instances.

      A cluster placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcZoneIdentifier

      UpdateAutoScalingGroupRequest.Builder vpcZoneIdentifier(String vpcZoneIdentifier)

      A comma-separated list of subnet IDs for a virtual private cloud (VPC). If you specify VPCZoneIdentifier with AvailabilityZones, the subnets that you specify must reside in those Availability Zones.

      Parameters:
      vpcZoneIdentifier - A comma-separated list of subnet IDs for a virtual private cloud (VPC). If you specify VPCZoneIdentifier with AvailabilityZones, the subnets that you specify must reside in those Availability Zones.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • terminationPolicies

      UpdateAutoScalingGroupRequest.Builder terminationPolicies(Collection<String> 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. For more information, see Configure termination policies for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

      Valid values: Default | AllocationStrategy | ClosestToNextInstanceHour | NewestInstance | OldestInstance | OldestLaunchConfiguration | OldestLaunchTemplate | arn:aws:lambda:region:account-id:function:my-function:my-alias

      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. For more information, see Configure termination policies for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

      Valid values: Default | AllocationStrategy | ClosestToNextInstanceHour | NewestInstance | OldestInstance | OldestLaunchConfiguration | OldestLaunchTemplate | arn:aws:lambda:region:account-id:function:my-function:my-alias

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • terminationPolicies

      UpdateAutoScalingGroupRequest.Builder terminationPolicies(String... 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. For more information, see Configure termination policies for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

      Valid values: Default | AllocationStrategy | ClosestToNextInstanceHour | NewestInstance | OldestInstance | OldestLaunchConfiguration | OldestLaunchTemplate | arn:aws:lambda:region:account-id:function:my-function:my-alias

      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. For more information, see Configure termination policies for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

      Valid values: Default | AllocationStrategy | ClosestToNextInstanceHour | NewestInstance | OldestInstance | OldestLaunchConfiguration | OldestLaunchTemplate | arn:aws:lambda:region:account-id:function:my-function:my-alias

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • newInstancesProtectedFromScaleIn

      UpdateAutoScalingGroupRequest.Builder newInstancesProtectedFromScaleIn(Boolean newInstancesProtectedFromScaleIn)

      Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see Use instance scale-in protection in the Amazon EC2 Auto Scaling User Guide.

      Parameters:
      newInstancesProtectedFromScaleIn - Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see Use instance scale-in protection in the Amazon EC2 Auto Scaling User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serviceLinkedRoleARN

      UpdateAutoScalingGroupRequest.Builder serviceLinkedRoleARN(String serviceLinkedRoleARN)

      The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other Amazon Web Services on your behalf. For more information, see Service-linked roles in the Amazon EC2 Auto Scaling User Guide.

      Parameters:
      serviceLinkedRoleARN - The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other Amazon Web Services on your behalf. For more information, see Service-linked roles in the Amazon EC2 Auto Scaling User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxInstanceLifetime

      UpdateAutoScalingGroupRequest.Builder maxInstanceLifetime(Integer maxInstanceLifetime)

      The maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). To clear a previously set value, specify a new value of 0. For more information, see Replacing Auto Scaling instances based on maximum instance lifetime in the Amazon EC2 Auto Scaling User Guide.

      Parameters:
      maxInstanceLifetime - The maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). To clear a previously set value, specify a new value of 0. For more information, see Replacing Auto Scaling instances based on maximum instance lifetime in the Amazon EC2 Auto Scaling User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capacityRebalance

      UpdateAutoScalingGroupRequest.Builder capacityRebalance(Boolean capacityRebalance)

      Enables or disables Capacity Rebalancing. For more information, see Use Capacity Rebalancing to handle Amazon EC2 Spot Interruptions in the Amazon EC2 Auto Scaling User Guide.

      Parameters:
      capacityRebalance - Enables or disables Capacity Rebalancing. For more information, see Use Capacity Rebalancing to handle Amazon EC2 Spot Interruptions in the Amazon EC2 Auto Scaling User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • context

      UpdateAutoScalingGroupRequest.Builder context(String context)

      Reserved.

      Parameters:
      context - Reserved.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • desiredCapacityType

      UpdateAutoScalingGroupRequest.Builder desiredCapacityType(String desiredCapacityType)

      The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports DesiredCapacityType for attribute-based instance type selection only. For more information, see Create a mixed instances group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide.

      By default, Amazon EC2 Auto Scaling specifies units, which translates into number of instances.

      Valid values: units | vcpu | memory-mib

      Parameters:
      desiredCapacityType - The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports DesiredCapacityType for attribute-based instance type selection only. For more information, see Create a mixed instances group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide.

      By default, Amazon EC2 Auto Scaling specifies units, which translates into number of instances.

      Valid values: units | vcpu | memory-mib

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • defaultInstanceWarmup

      UpdateAutoScalingGroupRequest.Builder defaultInstanceWarmup(Integer defaultInstanceWarmup)

      The amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the InService state.

      During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see Set the default instance warmup for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

      To manage various warm-up settings at the group level, we recommend that you set the default instance warmup, even if it is set to 0 seconds. To remove a value that you previously set, include the property but specify -1 for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of 0 or other nominal value.

      Parameters:
      defaultInstanceWarmup - The amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the InService state.

      During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see Set the default instance warmup for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

      To manage various warm-up settings at the group level, we recommend that you set the default instance warmup, even if it is set to 0 seconds. To remove a value that you previously set, include the property but specify -1 for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of 0 or other nominal value.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instanceMaintenancePolicy

      UpdateAutoScalingGroupRequest.Builder instanceMaintenancePolicy(InstanceMaintenancePolicy instanceMaintenancePolicy)

      An instance maintenance policy. For more information, see Set instance maintenance policy in the Amazon EC2 Auto Scaling User Guide.

      Parameters:
      instanceMaintenancePolicy - An instance maintenance policy. For more information, see Set instance maintenance policy in the Amazon EC2 Auto Scaling User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instanceMaintenancePolicy

      default UpdateAutoScalingGroupRequest.Builder instanceMaintenancePolicy(Consumer<InstanceMaintenancePolicy.Builder> instanceMaintenancePolicy)

      An instance maintenance policy. For more information, see Set instance maintenance policy in the Amazon EC2 Auto Scaling User Guide.

      This is a convenience method that creates an instance of the InstanceMaintenancePolicy.Builder avoiding the need to create one manually via InstanceMaintenancePolicy.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to instanceMaintenancePolicy(InstanceMaintenancePolicy).

      Parameters:
      instanceMaintenancePolicy - a consumer that will call methods on InstanceMaintenancePolicy.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      UpdateAutoScalingGroupRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdateAutoScalingGroupRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.