AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

UpdateAutoScalingGroupInput

import "github.com/aws/aws-sdk-go/service/autoscaling"

type UpdateAutoScalingGroupInput struct { AutoScalingGroupName *string `min:"1" type:"string" required:"true"` AvailabilityZones []*string `min:"1" type:"list"` DefaultCooldown *int64 `type:"integer"` DesiredCapacity *int64 `type:"integer"` HealthCheckGracePeriod *int64 `type:"integer"` HealthCheckType *string `min:"1" type:"string"` LaunchConfigurationName *string `min:"1" type:"string"` LaunchTemplate *LaunchTemplateSpecification `type:"structure"` MaxSize *int64 `type:"integer"` MinSize *int64 `type:"integer"` MixedInstancesPolicy *MixedInstancesPolicy `type:"structure"` NewInstancesProtectedFromScaleIn *bool `type:"boolean"` PlacementGroup *string `min:"1" type:"string"` ServiceLinkedRoleARN *string `min:"1" type:"string"` TerminationPolicies []*string `type:"list"` VPCZoneIdentifier *string `min:"1" type:"string"` }

AutoScalingGroupName

Type: *string

The name of the Auto Scaling group.

AutoScalingGroupName is a required field

AvailabilityZones

Type: []*string

One or more Availability Zones for the group.

DefaultCooldown

Type: *int64

The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default is 300.

For more information, see Scaling Cooldowns (https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html) in the Amazon EC2 Auto Scaling User Guide.

DesiredCapacity

Type: *int64

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.

HealthCheckGracePeriod

Type: *int64

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 is 0.

For more information, see Health Checks (https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html) in the Amazon EC2 Auto Scaling User Guide.

HealthCheckType

Type: *string

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

LaunchConfigurationName

Type: *string

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

LaunchTemplate

Describes a launch template and the launch template version.

The launch template that is specified must be configured for use with an Auto Scaling group. For more information, see Creating a Launch Template for an Auto Scaling group (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the Amazon EC2 Auto Scaling User Guide.

MaxSize

Type: *int64

The maximum size of the Auto Scaling group.

MinSize

Type: *int64

The minimum size of the Auto Scaling group.

MixedInstancesPolicy

Describes a mixed instances policy for an Auto Scaling group. With mixed instances, your Auto Scaling group can provision a combination of On-Demand Instances and Spot Instances across multiple instance types. For more information, see Using Multiple Instance Types and Purchase Options (https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroup.html#asg-purchase-options) in the Amazon EC2 Auto Scaling User Guide.

When you create your Auto Scaling group, you can specify a launch configuration or template as a parameter for the top-level object, or you can specify a mixed instances policy, but not both at the same time.

NewInstancesProtectedFromScaleIn

Type: *bool

Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.

For more information about preventing instances from terminating on scale in, see Instance Protection (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection) in the Amazon EC2 Auto Scaling User Guide.

PlacementGroup

Type: *string

The name of the placement group into which to launch your instances, if any. For more information, see Placement Groups (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in the Amazon EC2 User Guide for Linux Instances.

ServiceLinkedRoleARN

Type: *string

The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf.

TerminationPolicies

Type: []*string

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 (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html) in the Amazon EC2 Auto Scaling User Guide.

VPCZoneIdentifier

Type: *string

The ID of the subnet, if you are launching into a VPC. You can specify several subnets in a comma-separated list.

When you specify VPCZoneIdentifier with AvailabilityZones, ensure that the subnets' Availability Zones match the values you specify for AvailabilityZones.

For more information, see Launching Auto Scaling Instances in a VPC (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html) in the Amazon EC2 Auto Scaling User Guide.

Method

GoString

func (s UpdateAutoScalingGroupInput) GoString() string

GoString returns the string representation

SetAutoScalingGroupName

func (s *UpdateAutoScalingGroupInput) SetAutoScalingGroupName(v string) *UpdateAutoScalingGroupInput

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

SetAvailabilityZones

func (s *UpdateAutoScalingGroupInput) SetAvailabilityZones(v []*string) *UpdateAutoScalingGroupInput

SetAvailabilityZones sets the AvailabilityZones field's value.

SetDefaultCooldown

func (s *UpdateAutoScalingGroupInput) SetDefaultCooldown(v int64) *UpdateAutoScalingGroupInput

SetDefaultCooldown sets the DefaultCooldown field's value.

SetDesiredCapacity

func (s *UpdateAutoScalingGroupInput) SetDesiredCapacity(v int64) *UpdateAutoScalingGroupInput

SetDesiredCapacity sets the DesiredCapacity field's value.

SetHealthCheckGracePeriod

func (s *UpdateAutoScalingGroupInput) SetHealthCheckGracePeriod(v int64) *UpdateAutoScalingGroupInput

SetHealthCheckGracePeriod sets the HealthCheckGracePeriod field's value.

SetHealthCheckType

func (s *UpdateAutoScalingGroupInput) SetHealthCheckType(v string) *UpdateAutoScalingGroupInput

SetHealthCheckType sets the HealthCheckType field's value.

SetLaunchConfigurationName

func (s *UpdateAutoScalingGroupInput) SetLaunchConfigurationName(v string) *UpdateAutoScalingGroupInput

SetLaunchConfigurationName sets the LaunchConfigurationName field's value.

SetLaunchTemplate

func (s *UpdateAutoScalingGroupInput) SetLaunchTemplate(v *LaunchTemplateSpecification) *UpdateAutoScalingGroupInput

SetLaunchTemplate sets the LaunchTemplate field's value.

SetMaxSize

func (s *UpdateAutoScalingGroupInput) SetMaxSize(v int64) *UpdateAutoScalingGroupInput

SetMaxSize sets the MaxSize field's value.

SetMinSize

func (s *UpdateAutoScalingGroupInput) SetMinSize(v int64) *UpdateAutoScalingGroupInput

SetMinSize sets the MinSize field's value.

SetMixedInstancesPolicy

func (s *UpdateAutoScalingGroupInput) SetMixedInstancesPolicy(v *MixedInstancesPolicy) *UpdateAutoScalingGroupInput

SetMixedInstancesPolicy sets the MixedInstancesPolicy field's value.

SetNewInstancesProtectedFromScaleIn

func (s *UpdateAutoScalingGroupInput) SetNewInstancesProtectedFromScaleIn(v bool) *UpdateAutoScalingGroupInput

SetNewInstancesProtectedFromScaleIn sets the NewInstancesProtectedFromScaleIn field's value.

SetPlacementGroup

func (s *UpdateAutoScalingGroupInput) SetPlacementGroup(v string) *UpdateAutoScalingGroupInput

SetPlacementGroup sets the PlacementGroup field's value.

SetServiceLinkedRoleARN

func (s *UpdateAutoScalingGroupInput) SetServiceLinkedRoleARN(v string) *UpdateAutoScalingGroupInput

SetServiceLinkedRoleARN sets the ServiceLinkedRoleARN field's value.

SetTerminationPolicies

func (s *UpdateAutoScalingGroupInput) SetTerminationPolicies(v []*string) *UpdateAutoScalingGroupInput

SetTerminationPolicies sets the TerminationPolicies field's value.

SetVPCZoneIdentifier

func (s *UpdateAutoScalingGroupInput) SetVPCZoneIdentifier(v string) *UpdateAutoScalingGroupInput

SetVPCZoneIdentifier sets the VPCZoneIdentifier field's value.

String

func (s UpdateAutoScalingGroupInput) String() string

String returns the string representation

Validate

func (s *UpdateAutoScalingGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: