UpdateAutoScalingGroupRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.autoscaling.model.AutoScalingRequest
    - - software.amazon.awssdk.services.autoscaling.model.UpdateAutoScalingGroupRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<UpdateAutoScalingGroupRequest.Builder,UpdateAutoScalingGroupRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateAutoScalingGroupRequest
extends AutoScalingRequest
implements ToCopyableBuilder<UpdateAutoScalingGroupRequest.Builder,UpdateAutoScalingGroupRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface UpdateAutoScalingGroupRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`UpdateAutoScalingGroupRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`autoScalingGroupName()` The name of the Auto Scaling group.
`List<String>`	`availabilityZones()` One or more Availability Zones for the group.
`static UpdateAutoScalingGroupRequest.Builder`	`builder()`
`Integer`	`defaultCooldown()` The amount of time, in seconds, after a scaling activity completes before another scaling activity can start.
`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.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAvailabilityZones()` Returns true if the AvailabilityZones property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasTerminationPolicies()` Returns true if the TerminationPolicies property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`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.
`String`	`healthCheckType()` The service to use for the health checks.
`String`	`launchConfigurationName()` The name of the launch configuration.
`LaunchTemplateSpecification`	`launchTemplate()` The launch template and version to use to specify the updates.
`Integer`	`maxInstanceLifetime()` The maximum amount of time, in seconds, that an instance can be in service.
`Integer`	`maxSize()` The maximum size of the Auto Scaling group.
`Integer`	`minSize()` The minimum size of the Auto Scaling group.
`MixedInstancesPolicy`	`mixedInstancesPolicy()` An embedded object that specifies a mixed instances policy.
`Boolean`	`newInstancesProtectedFromScaleIn()` Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.
`String`	`placementGroup()` The name of the placement group into which to launch your instances, if any.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends UpdateAutoScalingGroupRequest.Builder>`	`serializableBuilderClass()`
`String`	`serviceLinkedRoleARN()` The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf.
`List<String>`	`terminationPolicies()` A standalone termination policy or a list of termination policies used to select the instance to terminate.
`UpdateAutoScalingGroupRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`vpcZoneIdentifier()` A comma-separated list of subnet IDs for virtual private cloud (VPC).

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - autoScalingGroupName
```
public String autoScalingGroupName()
```
    The name of the Auto Scaling group.
    
    Returns:
    
    The name of the Auto Scaling group.
  - launchConfigurationName
```
public String launchConfigurationName()
```
    The name of the launch configuration. If you specify LaunchConfigurationName in your update request, you can't specify LaunchTemplate or MixedInstancesPolicy.
    
    Returns:
    
    The name of the launch configuration. If you specify LaunchConfigurationName in your update request, you can't specify LaunchTemplate or MixedInstancesPolicy.
  - launchTemplate
```
public 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.
    
    For more information, see LaunchTemplateSpecification in the Amazon EC2 Auto Scaling API Reference.
    
    Returns:
    
    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.
    
    For more information, see LaunchTemplateSpecification in the Amazon EC2 Auto Scaling API Reference.
  - mixedInstancesPolicy
```
public MixedInstancesPolicy mixedInstancesPolicy()
```
    An embedded object that specifies a mixed instances policy.
    
    In your call to UpdateAutoScalingGroup, you can make changes to the policy that is specified. All optional parameters are left unchanged if not specified.
    
    For more information, see MixedInstancesPolicy in the Amazon EC2 Auto Scaling API Reference and Auto Scaling Groups with Multiple Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User Guide.
    
    Returns:
    
    An embedded object that specifies a mixed instances policy.
    
    In your call to UpdateAutoScalingGroup, you can make changes to the policy that is specified. All optional parameters are left unchanged if not specified.
    
    For more information, see MixedInstancesPolicy in the Amazon EC2 Auto Scaling API Reference and Auto Scaling Groups with Multiple Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User Guide.
  - minSize
```
public Integer minSize()
```
    The minimum size of the Auto Scaling group.
    
    Returns:
    
    The minimum size of the Auto Scaling group.
  - maxSize
```
public 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 maximum instance weight (weights that define how many capacity units each instance contributes to the capacity of the group).
    
    Returns:
    
    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 maximum instance weight (weights that define how many capacity units each instance contributes to the capacity of the group).
  - desiredCapacity
```
public 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.
    
    Returns:
    
    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.
  - defaultCooldown
```
public Integer defaultCooldown()
```
    The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default value is 300.
    
    This setting applies when using simple scaling policies, but not when using other scaling policies or scheduled scaling. For more information, see Scaling Cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
    
    Returns:
    
    The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default value is 300.
    
    This setting applies when using simple scaling policies, but not when using other scaling policies or scheduled scaling. For more information, see Scaling Cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
  - hasAvailabilityZones
```
public boolean hasAvailabilityZones()
```
    Returns true if the AvailabilityZones property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - availabilityZones
```
public List<String> availabilityZones()
```
    One or more Availability Zones for the group.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasAvailabilityZones() to see if a value was sent in this field.
    
    Returns:
    
    One or more Availability Zones for the group.
  - healthCheckType
```
public String healthCheckType()
```
    The service to use for the health checks. The valid values are EC2 and ELB. If you configure an Auto Scaling group to use ELB health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks.
    
    Returns:
    
    The service to use for the health checks. The valid values are EC2 and ELB. If you configure an Auto Scaling group to use ELB health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks.
  - healthCheckGracePeriod
```
public 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. The default value is 0.
    
    For more information, see Health Check Grace Period in the Amazon EC2 Auto Scaling User Guide.
    
    Required if you are adding an ELB health check.
    
    Returns:
    
    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. The default value is 0.
    
    For more information, see Health Check Grace Period in the Amazon EC2 Auto Scaling User Guide.
    
    Required if you are adding an ELB health check.
  - placementGroup
```
public String placementGroup()
```
    The name of the placement group into which to launch your instances, if any. A placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a placement group. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.
    
    Returns:
    
    The name of the placement group into which to launch your instances, if any. A placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a placement group. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.
  - vpcZoneIdentifier
```
public String vpcZoneIdentifier()
```
    A comma-separated list of subnet IDs for virtual private cloud (VPC).
    
    If you specify VPCZoneIdentifier with AvailabilityZones, the subnets that you specify for this parameter must reside in those Availability Zones.
    
    Returns:
    
    A comma-separated list of subnet IDs for virtual private cloud (VPC).
    
    If you specify VPCZoneIdentifier with AvailabilityZones, the subnets that you specify for this parameter must reside in those Availability Zones.
  - hasTerminationPolicies
```
public boolean hasTerminationPolicies()
```
    Returns true if the TerminationPolicies property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - terminationPolicies
```
public List<String> terminationPolicies()
```
    A standalone termination policy or a list of termination policies used to select the instance to terminate. The policies are executed in the order that they are listed.
    
    For more information, see Controlling Which Instances Auto Scaling Terminates During Scale In in the Amazon EC2 Auto Scaling User Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTerminationPolicies() to see if a value was sent in this field.
    
    Returns:
    
    A standalone termination policy or a list of termination policies used to select the instance to terminate. The policies are executed in the order that they are listed.
    
    For more information, see Controlling Which Instances Auto Scaling Terminates During Scale In in the Amazon EC2 Auto Scaling User Guide.
  - newInstancesProtectedFromScaleIn
```
public 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 Instance Protection in the Amazon EC2 Auto Scaling User Guide.
    
    Returns:
    
    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 Instance Protection in the Amazon EC2 Auto Scaling User Guide.
  - serviceLinkedRoleARN
```
public String serviceLinkedRoleARN()
```
    The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf. For more information, see Service-Linked Roles in the Amazon EC2 Auto Scaling User Guide.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf. For more information, see Service-Linked Roles in the Amazon EC2 Auto Scaling User Guide.
  - maxInstanceLifetime
```
public Integer maxInstanceLifetime()
```
    The maximum amount of time, in seconds, that an instance can be in service. The default is null.
    
    This parameter is optional, but if you specify a value for it, you must specify a value of at least 604,800 seconds (7 days). 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.
    
    Valid Range: Minimum value of 0.
    
    Returns:
    
    The maximum amount of time, in seconds, that an instance can be in service. The default is null.
    
    This parameter is optional, but if you specify a value for it, you must specify a value of at least 604,800 seconds (7 days). 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.
    
    Valid Range: Minimum value of 0.
  - toBuilder
```
public UpdateAutoScalingGroupRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UpdateAutoScalingGroupRequest.Builder,UpdateAutoScalingGroupRequest>
    
    Specified by:
    
    toBuilder in class AutoScalingRequest
  - builder
```
public static UpdateAutoScalingGroupRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UpdateAutoScalingGroupRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class UpdateAutoScalingGroupRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

autoScalingGroupName

launchConfigurationName

launchTemplate

mixedInstancesPolicy

minSize

maxSize

desiredCapacity

defaultCooldown

hasAvailabilityZones

availabilityZones

healthCheckType

healthCheckGracePeriod

placementGroup

vpcZoneIdentifier

hasTerminationPolicies

terminationPolicies

newInstancesProtectedFromScaleIn

serviceLinkedRoleARN

maxInstanceLifetime

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields