software.amazon.awssdk.services.autoscaling.model

Class UpdateAutoScalingGroupRequest

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

Method Summary

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 number of EC2 instances that should be running in the Auto Scaling group.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
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	maxSize() The maximum size of the Auto Scaling group.
Integer	minSize() The minimum size of the Auto Scaling group.
MixedInstancesPolicy	mixedInstancesPolicy() The mixed instances policy to use to specify the updates.
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, if you are launching into a 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 this parameter, you can't specify a launch template or a mixed instances policy.

Returns:

The name of the launch configuration. If you specify this parameter, you can't specify a launch template or a mixed instances policy.

launchTemplate

public LaunchTemplateSpecification launchTemplate()

The launch template and version to use to specify the updates. If you specify this parameter, you can't specify a launch configuration or a mixed instances policy.

Returns:

The launch template and version to use to specify the updates. If you specify this parameter, you can't specify a launch configuration or a mixed instances policy.

mixedInstancesPolicy

public MixedInstancesPolicy mixedInstancesPolicy()

The mixed instances policy to use to specify the updates. If you specify this parameter, you can't specify a launch configuration or a launch template.

For more information, see Using Multiple Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User Guide.

Returns:

The mixed instances policy to use to specify the updates. If you specify this parameter, you can't specify a launch configuration or a launch template.

For more information, see Using 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.

Returns:

The maximum size of the Auto Scaling group.

desiredCapacity

public Integer desiredCapacity()

The number of EC2 instances that should be running in the Auto Scaling group. 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 number of EC2 instances that should be running in the Auto Scaling group. 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.

For more information, see Scaling Cooldowns 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.

For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.

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.

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.

Returns:

The service to use for the health checks. The valid values are EC2 and ELB.

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 Checks for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.

Conditional: This parameter is 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 Checks for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.

Conditional: This parameter is 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, if you are launching into a 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, if you are launching into a VPC.

If you specify VPCZoneIdentifier with AvailabilityZones, the subnets that you specify for this parameter must reside in those Availability Zones.

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.

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.

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 Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

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