autoscaling

package
v1.44.310 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 27, 2023 License: Apache-2.0 Imports: 10 Imported by: 1,767

Documentation

Overview

Package autoscaling provides the client and types for making API requests to Auto Scaling.

Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances based on user-defined scaling policies, scheduled actions, and health checks.

For more information, see the Amazon EC2 Auto Scaling User Guide (https://docs.aws.amazon.com/autoscaling/ec2/userguide/) and the Amazon EC2 Auto Scaling API Reference (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/Welcome.html).

See https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01 for more information on this service.

See autoscaling package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/autoscaling/

Using the Client

To contact Auto Scaling with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Auto Scaling client AutoScaling for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/autoscaling/#New

Index

Examples

Constants

View Source
const (
	// AcceleratorManufacturerNvidia is a AcceleratorManufacturer enum value
	AcceleratorManufacturerNvidia = "nvidia"

	// AcceleratorManufacturerAmd is a AcceleratorManufacturer enum value
	AcceleratorManufacturerAmd = "amd"

	// AcceleratorManufacturerAmazonWebServices is a AcceleratorManufacturer enum value
	AcceleratorManufacturerAmazonWebServices = "amazon-web-services"

	// AcceleratorManufacturerXilinx is a AcceleratorManufacturer enum value
	AcceleratorManufacturerXilinx = "xilinx"
)
View Source
const (
	// AcceleratorNameA100 is a AcceleratorName enum value
	AcceleratorNameA100 = "a100"

	// AcceleratorNameV100 is a AcceleratorName enum value
	AcceleratorNameV100 = "v100"

	// AcceleratorNameK80 is a AcceleratorName enum value
	AcceleratorNameK80 = "k80"

	// AcceleratorNameT4 is a AcceleratorName enum value
	AcceleratorNameT4 = "t4"

	// AcceleratorNameM60 is a AcceleratorName enum value
	AcceleratorNameM60 = "m60"

	// AcceleratorNameRadeonProV520 is a AcceleratorName enum value
	AcceleratorNameRadeonProV520 = "radeon-pro-v520"

	// AcceleratorNameVu9p is a AcceleratorName enum value
	AcceleratorNameVu9p = "vu9p"
)
View Source
const (
	// AcceleratorTypeGpu is a AcceleratorType enum value
	AcceleratorTypeGpu = "gpu"

	// AcceleratorTypeFpga is a AcceleratorType enum value
	AcceleratorTypeFpga = "fpga"

	// AcceleratorTypeInference is a AcceleratorType enum value
	AcceleratorTypeInference = "inference"
)
View Source
const (
	// BareMetalIncluded is a BareMetal enum value
	BareMetalIncluded = "included"

	// BareMetalExcluded is a BareMetal enum value
	BareMetalExcluded = "excluded"

	// BareMetalRequired is a BareMetal enum value
	BareMetalRequired = "required"
)
View Source
const (
	// BurstablePerformanceIncluded is a BurstablePerformance enum value
	BurstablePerformanceIncluded = "included"

	// BurstablePerformanceExcluded is a BurstablePerformance enum value
	BurstablePerformanceExcluded = "excluded"

	// BurstablePerformanceRequired is a BurstablePerformance enum value
	BurstablePerformanceRequired = "required"
)
View Source
const (
	// CpuManufacturerIntel is a CpuManufacturer enum value
	CpuManufacturerIntel = "intel"

	// CpuManufacturerAmd is a CpuManufacturer enum value
	CpuManufacturerAmd = "amd"

	// CpuManufacturerAmazonWebServices is a CpuManufacturer enum value
	CpuManufacturerAmazonWebServices = "amazon-web-services"
)
View Source
const (
	// InstanceGenerationCurrent is a InstanceGeneration enum value
	InstanceGenerationCurrent = "current"

	// InstanceGenerationPrevious is a InstanceGeneration enum value
	InstanceGenerationPrevious = "previous"
)
View Source
const (
	// InstanceMetadataEndpointStateDisabled is a InstanceMetadataEndpointState enum value
	InstanceMetadataEndpointStateDisabled = "disabled"

	// InstanceMetadataEndpointStateEnabled is a InstanceMetadataEndpointState enum value
	InstanceMetadataEndpointStateEnabled = "enabled"
)
View Source
const (
	// InstanceMetadataHttpTokensStateOptional is a InstanceMetadataHttpTokensState enum value
	InstanceMetadataHttpTokensStateOptional = "optional"

	// InstanceMetadataHttpTokensStateRequired is a InstanceMetadataHttpTokensState enum value
	InstanceMetadataHttpTokensStateRequired = "required"
)
View Source
const (
	// InstanceRefreshStatusPending is a InstanceRefreshStatus enum value
	InstanceRefreshStatusPending = "Pending"

	// InstanceRefreshStatusInProgress is a InstanceRefreshStatus enum value
	InstanceRefreshStatusInProgress = "InProgress"

	// InstanceRefreshStatusSuccessful is a InstanceRefreshStatus enum value
	InstanceRefreshStatusSuccessful = "Successful"

	// InstanceRefreshStatusFailed is a InstanceRefreshStatus enum value
	InstanceRefreshStatusFailed = "Failed"

	// InstanceRefreshStatusCancelling is a InstanceRefreshStatus enum value
	InstanceRefreshStatusCancelling = "Cancelling"

	// InstanceRefreshStatusCancelled is a InstanceRefreshStatus enum value
	InstanceRefreshStatusCancelled = "Cancelled"

	// InstanceRefreshStatusRollbackInProgress is a InstanceRefreshStatus enum value
	InstanceRefreshStatusRollbackInProgress = "RollbackInProgress"

	// InstanceRefreshStatusRollbackFailed is a InstanceRefreshStatus enum value
	InstanceRefreshStatusRollbackFailed = "RollbackFailed"

	// InstanceRefreshStatusRollbackSuccessful is a InstanceRefreshStatus enum value
	InstanceRefreshStatusRollbackSuccessful = "RollbackSuccessful"
)
View Source
const (
	// LifecycleStatePending is a LifecycleState enum value
	LifecycleStatePending = "Pending"

	// LifecycleStatePendingWait is a LifecycleState enum value
	LifecycleStatePendingWait = "Pending:Wait"

	// LifecycleStatePendingProceed is a LifecycleState enum value
	LifecycleStatePendingProceed = "Pending:Proceed"

	// LifecycleStateQuarantined is a LifecycleState enum value
	LifecycleStateQuarantined = "Quarantined"

	// LifecycleStateInService is a LifecycleState enum value
	LifecycleStateInService = "InService"

	// LifecycleStateTerminating is a LifecycleState enum value
	LifecycleStateTerminating = "Terminating"

	// LifecycleStateTerminatingWait is a LifecycleState enum value
	LifecycleStateTerminatingWait = "Terminating:Wait"

	// LifecycleStateTerminatingProceed is a LifecycleState enum value
	LifecycleStateTerminatingProceed = "Terminating:Proceed"

	// LifecycleStateTerminated is a LifecycleState enum value
	LifecycleStateTerminated = "Terminated"

	// LifecycleStateDetaching is a LifecycleState enum value
	LifecycleStateDetaching = "Detaching"

	// LifecycleStateDetached is a LifecycleState enum value
	LifecycleStateDetached = "Detached"

	// LifecycleStateEnteringStandby is a LifecycleState enum value
	LifecycleStateEnteringStandby = "EnteringStandby"

	// LifecycleStateStandby is a LifecycleState enum value
	LifecycleStateStandby = "Standby"

	// LifecycleStateWarmedPending is a LifecycleState enum value
	LifecycleStateWarmedPending = "Warmed:Pending"

	// LifecycleStateWarmedPendingWait is a LifecycleState enum value
	LifecycleStateWarmedPendingWait = "Warmed:Pending:Wait"

	// LifecycleStateWarmedPendingProceed is a LifecycleState enum value
	LifecycleStateWarmedPendingProceed = "Warmed:Pending:Proceed"

	// LifecycleStateWarmedTerminating is a LifecycleState enum value
	LifecycleStateWarmedTerminating = "Warmed:Terminating"

	// LifecycleStateWarmedTerminatingWait is a LifecycleState enum value
	LifecycleStateWarmedTerminatingWait = "Warmed:Terminating:Wait"

	// LifecycleStateWarmedTerminatingProceed is a LifecycleState enum value
	LifecycleStateWarmedTerminatingProceed = "Warmed:Terminating:Proceed"

	// LifecycleStateWarmedTerminated is a LifecycleState enum value
	LifecycleStateWarmedTerminated = "Warmed:Terminated"

	// LifecycleStateWarmedStopped is a LifecycleState enum value
	LifecycleStateWarmedStopped = "Warmed:Stopped"

	// LifecycleStateWarmedRunning is a LifecycleState enum value
	LifecycleStateWarmedRunning = "Warmed:Running"

	// LifecycleStateWarmedHibernated is a LifecycleState enum value
	LifecycleStateWarmedHibernated = "Warmed:Hibernated"
)
View Source
const (
	// LocalStorageIncluded is a LocalStorage enum value
	LocalStorageIncluded = "included"

	// LocalStorageExcluded is a LocalStorage enum value
	LocalStorageExcluded = "excluded"

	// LocalStorageRequired is a LocalStorage enum value
	LocalStorageRequired = "required"
)
View Source
const (
	// LocalStorageTypeHdd is a LocalStorageType enum value
	LocalStorageTypeHdd = "hdd"

	// LocalStorageTypeSsd is a LocalStorageType enum value
	LocalStorageTypeSsd = "ssd"
)
View Source
const (
	// MetricStatisticAverage is a MetricStatistic enum value
	MetricStatisticAverage = "Average"

	// MetricStatisticMinimum is a MetricStatistic enum value
	MetricStatisticMinimum = "Minimum"

	// MetricStatisticMaximum is a MetricStatistic enum value
	MetricStatisticMaximum = "Maximum"

	// MetricStatisticSampleCount is a MetricStatistic enum value
	MetricStatisticSampleCount = "SampleCount"

	// MetricStatisticSum is a MetricStatistic enum value
	MetricStatisticSum = "Sum"
)
View Source
const (
	// MetricTypeAsgaverageCpuutilization is a MetricType enum value
	MetricTypeAsgaverageCpuutilization = "ASGAverageCPUUtilization"

	// MetricTypeAsgaverageNetworkIn is a MetricType enum value
	MetricTypeAsgaverageNetworkIn = "ASGAverageNetworkIn"

	// MetricTypeAsgaverageNetworkOut is a MetricType enum value
	MetricTypeAsgaverageNetworkOut = "ASGAverageNetworkOut"

	// MetricTypeAlbrequestCountPerTarget is a MetricType enum value
	MetricTypeAlbrequestCountPerTarget = "ALBRequestCountPerTarget"
)
View Source
const (
	// PredefinedLoadMetricTypeAsgtotalCpuutilization is a PredefinedLoadMetricType enum value
	PredefinedLoadMetricTypeAsgtotalCpuutilization = "ASGTotalCPUUtilization"

	// PredefinedLoadMetricTypeAsgtotalNetworkIn is a PredefinedLoadMetricType enum value
	PredefinedLoadMetricTypeAsgtotalNetworkIn = "ASGTotalNetworkIn"

	// PredefinedLoadMetricTypeAsgtotalNetworkOut is a PredefinedLoadMetricType enum value
	PredefinedLoadMetricTypeAsgtotalNetworkOut = "ASGTotalNetworkOut"

	// PredefinedLoadMetricTypeAlbtargetGroupRequestCount is a PredefinedLoadMetricType enum value
	PredefinedLoadMetricTypeAlbtargetGroupRequestCount = "ALBTargetGroupRequestCount"
)
View Source
const (
	// PredefinedMetricPairTypeAsgcpuutilization is a PredefinedMetricPairType enum value
	PredefinedMetricPairTypeAsgcpuutilization = "ASGCPUUtilization"

	// PredefinedMetricPairTypeAsgnetworkIn is a PredefinedMetricPairType enum value
	PredefinedMetricPairTypeAsgnetworkIn = "ASGNetworkIn"

	// PredefinedMetricPairTypeAsgnetworkOut is a PredefinedMetricPairType enum value
	PredefinedMetricPairTypeAsgnetworkOut = "ASGNetworkOut"

	// PredefinedMetricPairTypeAlbrequestCount is a PredefinedMetricPairType enum value
	PredefinedMetricPairTypeAlbrequestCount = "ALBRequestCount"
)
View Source
const (
	// PredefinedScalingMetricTypeAsgaverageCpuutilization is a PredefinedScalingMetricType enum value
	PredefinedScalingMetricTypeAsgaverageCpuutilization = "ASGAverageCPUUtilization"

	// PredefinedScalingMetricTypeAsgaverageNetworkIn is a PredefinedScalingMetricType enum value
	PredefinedScalingMetricTypeAsgaverageNetworkIn = "ASGAverageNetworkIn"

	// PredefinedScalingMetricTypeAsgaverageNetworkOut is a PredefinedScalingMetricType enum value
	PredefinedScalingMetricTypeAsgaverageNetworkOut = "ASGAverageNetworkOut"

	// PredefinedScalingMetricTypeAlbrequestCountPerTarget is a PredefinedScalingMetricType enum value
	PredefinedScalingMetricTypeAlbrequestCountPerTarget = "ALBRequestCountPerTarget"
)
View Source
const (
	// PredictiveScalingMaxCapacityBreachBehaviorHonorMaxCapacity is a PredictiveScalingMaxCapacityBreachBehavior enum value
	PredictiveScalingMaxCapacityBreachBehaviorHonorMaxCapacity = "HonorMaxCapacity"

	// PredictiveScalingMaxCapacityBreachBehaviorIncreaseMaxCapacity is a PredictiveScalingMaxCapacityBreachBehavior enum value
	PredictiveScalingMaxCapacityBreachBehaviorIncreaseMaxCapacity = "IncreaseMaxCapacity"
)
View Source
const (
	// PredictiveScalingModeForecastAndScale is a PredictiveScalingMode enum value
	PredictiveScalingModeForecastAndScale = "ForecastAndScale"

	// PredictiveScalingModeForecastOnly is a PredictiveScalingMode enum value
	PredictiveScalingModeForecastOnly = "ForecastOnly"
)
View Source
const (
	// ScaleInProtectedInstancesRefresh is a ScaleInProtectedInstances enum value
	ScaleInProtectedInstancesRefresh = "Refresh"

	// ScaleInProtectedInstancesIgnore is a ScaleInProtectedInstances enum value
	ScaleInProtectedInstancesIgnore = "Ignore"

	// ScaleInProtectedInstancesWait is a ScaleInProtectedInstances enum value
	ScaleInProtectedInstancesWait = "Wait"
)
View Source
const (
	// ScalingActivityStatusCodePendingSpotBidPlacement is a ScalingActivityStatusCode enum value
	ScalingActivityStatusCodePendingSpotBidPlacement = "PendingSpotBidPlacement"

	// ScalingActivityStatusCodeWaitingForSpotInstanceRequestId is a ScalingActivityStatusCode enum value
	ScalingActivityStatusCodeWaitingForSpotInstanceRequestId = "WaitingForSpotInstanceRequestId"

	// ScalingActivityStatusCodeWaitingForSpotInstanceId is a ScalingActivityStatusCode enum value
	ScalingActivityStatusCodeWaitingForSpotInstanceId = "WaitingForSpotInstanceId"

	// ScalingActivityStatusCodeWaitingForInstanceId is a ScalingActivityStatusCode enum value
	ScalingActivityStatusCodeWaitingForInstanceId = "WaitingForInstanceId"

	// ScalingActivityStatusCodePreInService is a ScalingActivityStatusCode enum value
	ScalingActivityStatusCodePreInService = "PreInService"

	// ScalingActivityStatusCodeInProgress is a ScalingActivityStatusCode enum value
	ScalingActivityStatusCodeInProgress = "InProgress"

	// ScalingActivityStatusCodeWaitingForElbconnectionDraining is a ScalingActivityStatusCode enum value
	ScalingActivityStatusCodeWaitingForElbconnectionDraining = "WaitingForELBConnectionDraining"

	// ScalingActivityStatusCodeMidLifecycleAction is a ScalingActivityStatusCode enum value
	ScalingActivityStatusCodeMidLifecycleAction = "MidLifecycleAction"

	// ScalingActivityStatusCodeWaitingForInstanceWarmup is a ScalingActivityStatusCode enum value
	ScalingActivityStatusCodeWaitingForInstanceWarmup = "WaitingForInstanceWarmup"

	// ScalingActivityStatusCodeSuccessful is a ScalingActivityStatusCode enum value
	ScalingActivityStatusCodeSuccessful = "Successful"

	// ScalingActivityStatusCodeFailed is a ScalingActivityStatusCode enum value
	ScalingActivityStatusCodeFailed = "Failed"

	// ScalingActivityStatusCodeCancelled is a ScalingActivityStatusCode enum value
	ScalingActivityStatusCodeCancelled = "Cancelled"

	// ScalingActivityStatusCodeWaitingForConnectionDraining is a ScalingActivityStatusCode enum value
	ScalingActivityStatusCodeWaitingForConnectionDraining = "WaitingForConnectionDraining"
)
View Source
const (
	// StandbyInstancesTerminate is a StandbyInstances enum value
	StandbyInstancesTerminate = "Terminate"

	// StandbyInstancesIgnore is a StandbyInstances enum value
	StandbyInstancesIgnore = "Ignore"

	// StandbyInstancesWait is a StandbyInstances enum value
	StandbyInstancesWait = "Wait"
)
View Source
const (
	// WarmPoolStateStopped is a WarmPoolState enum value
	WarmPoolStateStopped = "Stopped"

	// WarmPoolStateRunning is a WarmPoolState enum value
	WarmPoolStateRunning = "Running"

	// WarmPoolStateHibernated is a WarmPoolState enum value
	WarmPoolStateHibernated = "Hibernated"
)
View Source
const (

	// ErrCodeActiveInstanceRefreshNotFoundFault for service response error code
	// "ActiveInstanceRefreshNotFound".
	//
	// The request failed because an active instance refresh or rollback for the
	// specified Auto Scaling group was not found.
	ErrCodeActiveInstanceRefreshNotFoundFault = "ActiveInstanceRefreshNotFound"

	// ErrCodeAlreadyExistsFault for service response error code
	// "AlreadyExists".
	//
	// You already have an Auto Scaling group or launch configuration with this
	// name.
	ErrCodeAlreadyExistsFault = "AlreadyExists"

	// ErrCodeInstanceRefreshInProgressFault for service response error code
	// "InstanceRefreshInProgress".
	//
	// The request failed because an active instance refresh already exists for
	// the specified Auto Scaling group.
	ErrCodeInstanceRefreshInProgressFault = "InstanceRefreshInProgress"

	// ErrCodeInvalidNextToken for service response error code
	// "InvalidNextToken".
	//
	// The NextToken value is not valid.
	ErrCodeInvalidNextToken = "InvalidNextToken"

	// ErrCodeIrreversibleInstanceRefreshFault for service response error code
	// "IrreversibleInstanceRefresh".
	//
	// The request failed because a desired configuration was not found or an incompatible
	// launch template (uses a Systems Manager parameter instead of an AMI ID) or
	// launch template version ($Latest or $Default) is present on the Auto Scaling
	// group.
	ErrCodeIrreversibleInstanceRefreshFault = "IrreversibleInstanceRefresh"

	// ErrCodeLimitExceededFault for service response error code
	// "LimitExceeded".
	//
	// You have already reached a limit for your Amazon EC2 Auto Scaling resources
	// (for example, Auto Scaling groups, launch configurations, or lifecycle hooks).
	// For more information, see DescribeAccountLimits (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DescribeAccountLimits.html)
	// in the Amazon EC2 Auto Scaling API Reference.
	ErrCodeLimitExceededFault = "LimitExceeded"

	// ErrCodeResourceContentionFault for service response error code
	// "ResourceContention".
	//
	// You already have a pending update to an Amazon EC2 Auto Scaling resource
	// (for example, an Auto Scaling group, instance, or load balancer).
	ErrCodeResourceContentionFault = "ResourceContention"

	// ErrCodeResourceInUseFault for service response error code
	// "ResourceInUse".
	//
	// The operation can't be performed because the resource is in use.
	ErrCodeResourceInUseFault = "ResourceInUse"

	// ErrCodeScalingActivityInProgressFault for service response error code
	// "ScalingActivityInProgress".
	//
	// The operation can't be performed because there are scaling activities in
	// progress.
	ErrCodeScalingActivityInProgressFault = "ScalingActivityInProgress"

	// ErrCodeServiceLinkedRoleFailure for service response error code
	// "ServiceLinkedRoleFailure".
	//
	// The service-linked role is not yet ready for use.
	ErrCodeServiceLinkedRoleFailure = "ServiceLinkedRoleFailure"
)
View Source
const (
	ServiceName = "autoscaling"  // Name of service.
	EndpointsID = ServiceName    // ID to lookup a service endpoint with.
	ServiceID   = "Auto Scaling" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source
const (
	// RefreshStrategyRolling is a RefreshStrategy enum value
	RefreshStrategyRolling = "Rolling"
)
View Source
const (
	// WarmPoolStatusPendingDelete is a WarmPoolStatus enum value
	WarmPoolStatusPendingDelete = "PendingDelete"
)

Variables

This section is empty.

Functions

func AcceleratorManufacturer_Values added in v1.41.12

func AcceleratorManufacturer_Values() []string

AcceleratorManufacturer_Values returns all elements of the AcceleratorManufacturer enum

func AcceleratorName_Values added in v1.41.12

func AcceleratorName_Values() []string

AcceleratorName_Values returns all elements of the AcceleratorName enum

func AcceleratorType_Values added in v1.41.12

func AcceleratorType_Values() []string

AcceleratorType_Values returns all elements of the AcceleratorType enum

func BareMetal_Values added in v1.41.12

func BareMetal_Values() []string

BareMetal_Values returns all elements of the BareMetal enum

func BurstablePerformance_Values added in v1.41.12

func BurstablePerformance_Values() []string

BurstablePerformance_Values returns all elements of the BurstablePerformance enum

func CpuManufacturer_Values added in v1.41.12

func CpuManufacturer_Values() []string

CpuManufacturer_Values returns all elements of the CpuManufacturer enum

func InstanceGeneration_Values added in v1.41.12

func InstanceGeneration_Values() []string

InstanceGeneration_Values returns all elements of the InstanceGeneration enum

func InstanceMetadataEndpointState_Values added in v1.34.3

func InstanceMetadataEndpointState_Values() []string

InstanceMetadataEndpointState_Values returns all elements of the InstanceMetadataEndpointState enum

func InstanceMetadataHttpTokensState_Values added in v1.34.3

func InstanceMetadataHttpTokensState_Values() []string

InstanceMetadataHttpTokensState_Values returns all elements of the InstanceMetadataHttpTokensState enum

func InstanceRefreshStatus_Values added in v1.34.3

func InstanceRefreshStatus_Values() []string

InstanceRefreshStatus_Values returns all elements of the InstanceRefreshStatus enum

func LifecycleState_Values added in v1.34.3

func LifecycleState_Values() []string

LifecycleState_Values returns all elements of the LifecycleState enum

func LocalStorageType_Values added in v1.41.12

func LocalStorageType_Values() []string

LocalStorageType_Values returns all elements of the LocalStorageType enum

func LocalStorage_Values added in v1.41.12

func LocalStorage_Values() []string

LocalStorage_Values returns all elements of the LocalStorage enum

func MetricStatistic_Values added in v1.34.3

func MetricStatistic_Values() []string

MetricStatistic_Values returns all elements of the MetricStatistic enum

func MetricType_Values added in v1.34.3

func MetricType_Values() []string

MetricType_Values returns all elements of the MetricType enum

func PredefinedLoadMetricType_Values added in v1.38.43

func PredefinedLoadMetricType_Values() []string

PredefinedLoadMetricType_Values returns all elements of the PredefinedLoadMetricType enum

func PredefinedMetricPairType_Values added in v1.38.43

func PredefinedMetricPairType_Values() []string

PredefinedMetricPairType_Values returns all elements of the PredefinedMetricPairType enum

func PredefinedScalingMetricType_Values added in v1.38.43

func PredefinedScalingMetricType_Values() []string

PredefinedScalingMetricType_Values returns all elements of the PredefinedScalingMetricType enum

func PredictiveScalingMaxCapacityBreachBehavior_Values added in v1.38.43

func PredictiveScalingMaxCapacityBreachBehavior_Values() []string

PredictiveScalingMaxCapacityBreachBehavior_Values returns all elements of the PredictiveScalingMaxCapacityBreachBehavior enum

func PredictiveScalingMode_Values added in v1.38.43

func PredictiveScalingMode_Values() []string

PredictiveScalingMode_Values returns all elements of the PredictiveScalingMode enum

func RefreshStrategy_Values added in v1.34.3

func RefreshStrategy_Values() []string

RefreshStrategy_Values returns all elements of the RefreshStrategy enum

func ScaleInProtectedInstances_Values added in v1.44.199

func ScaleInProtectedInstances_Values() []string

ScaleInProtectedInstances_Values returns all elements of the ScaleInProtectedInstances enum

func ScalingActivityStatusCode_Values added in v1.34.3

func ScalingActivityStatusCode_Values() []string

ScalingActivityStatusCode_Values returns all elements of the ScalingActivityStatusCode enum

func StandbyInstances_Values added in v1.44.199

func StandbyInstances_Values() []string

StandbyInstances_Values returns all elements of the StandbyInstances enum

func WarmPoolState_Values added in v1.38.16

func WarmPoolState_Values() []string

WarmPoolState_Values returns all elements of the WarmPoolState enum

func WarmPoolStatus_Values added in v1.38.16

func WarmPoolStatus_Values() []string

WarmPoolStatus_Values returns all elements of the WarmPoolStatus enum

Types

type AcceleratorCountRequest added in v1.41.12

type AcceleratorCountRequest struct {

	// The maximum value.
	Max *int64 `type:"integer"`

	// The minimum value.
	Min *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Specifies the minimum and maximum for the AcceleratorCount object when you specify InstanceRequirements for an Auto Scaling group.

func (AcceleratorCountRequest) GoString added in v1.41.12

func (s AcceleratorCountRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AcceleratorCountRequest) SetMax added in v1.41.12

SetMax sets the Max field's value.

func (*AcceleratorCountRequest) SetMin added in v1.41.12

SetMin sets the Min field's value.

func (AcceleratorCountRequest) String added in v1.41.12

func (s AcceleratorCountRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AcceleratorTotalMemoryMiBRequest added in v1.41.12

type AcceleratorTotalMemoryMiBRequest struct {

	// The memory maximum in MiB.
	Max *int64 `type:"integer"`

	// The memory minimum in MiB.
	Min *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Specifies the minimum and maximum for the AcceleratorTotalMemoryMiB object when you specify InstanceRequirements for an Auto Scaling group.

func (AcceleratorTotalMemoryMiBRequest) GoString added in v1.41.12

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AcceleratorTotalMemoryMiBRequest) SetMax added in v1.41.12

SetMax sets the Max field's value.

func (*AcceleratorTotalMemoryMiBRequest) SetMin added in v1.41.12

SetMin sets the Min field's value.

func (AcceleratorTotalMemoryMiBRequest) String added in v1.41.12

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Activity

type Activity struct {

	// The ID of the activity.
	//
	// ActivityId is a required field
	ActivityId *string `type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the Auto Scaling group.
	AutoScalingGroupARN *string `min:"1" type:"string"`

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// The state of the Auto Scaling group, which is either InService or Deleted.
	AutoScalingGroupState *string `min:"1" type:"string"`

	// The reason the activity began.
	//
	// Cause is a required field
	Cause *string `min:"1" type:"string" required:"true"`

	// A friendly, more verbose description of the activity.
	Description *string `type:"string"`

	// The details about the activity.
	Details *string `type:"string"`

	// The end time of the activity.
	EndTime *time.Time `type:"timestamp"`

	// A value between 0 and 100 that indicates the progress of the activity.
	Progress *int64 `type:"integer"`

	// The start time of the activity.
	//
	// StartTime is a required field
	StartTime *time.Time `type:"timestamp" required:"true"`

	// The current status of the activity.
	//
	// StatusCode is a required field
	StatusCode *string `type:"string" required:"true" enum:"ScalingActivityStatusCode"`

	// A friendly, more verbose description of the activity status.
	StatusMessage *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes scaling activity, which is a long-running process that represents a change to your Auto Scaling group, such as changing its size or replacing an instance.

func (Activity) GoString added in v0.6.5

func (s Activity) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Activity) SetActivityId added in v1.5.0

func (s *Activity) SetActivityId(v string) *Activity

SetActivityId sets the ActivityId field's value.

func (*Activity) SetAutoScalingGroupARN added in v1.37.17

func (s *Activity) SetAutoScalingGroupARN(v string) *Activity

SetAutoScalingGroupARN sets the AutoScalingGroupARN field's value.

func (*Activity) SetAutoScalingGroupName added in v1.5.0

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

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*Activity) SetAutoScalingGroupState added in v1.37.17

func (s *Activity) SetAutoScalingGroupState(v string) *Activity

SetAutoScalingGroupState sets the AutoScalingGroupState field's value.

func (*Activity) SetCause added in v1.5.0

func (s *Activity) SetCause(v string) *Activity

SetCause sets the Cause field's value.

func (*Activity) SetDescription added in v1.5.0

func (s *Activity) SetDescription(v string) *Activity

SetDescription sets the Description field's value.

func (*Activity) SetDetails added in v1.5.0

func (s *Activity) SetDetails(v string) *Activity

SetDetails sets the Details field's value.

func (*Activity) SetEndTime added in v1.5.0

func (s *Activity) SetEndTime(v time.Time) *Activity

SetEndTime sets the EndTime field's value.

func (*Activity) SetProgress added in v1.5.0

func (s *Activity) SetProgress(v int64) *Activity

SetProgress sets the Progress field's value.

func (*Activity) SetStartTime added in v1.5.0

func (s *Activity) SetStartTime(v time.Time) *Activity

SetStartTime sets the StartTime field's value.

func (*Activity) SetStatusCode added in v1.5.0

func (s *Activity) SetStatusCode(v string) *Activity

SetStatusCode sets the StatusCode field's value.

func (*Activity) SetStatusMessage added in v1.5.0

func (s *Activity) SetStatusMessage(v string) *Activity

SetStatusMessage sets the StatusMessage field's value.

func (Activity) String added in v0.6.5

func (s Activity) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdjustmentType

type AdjustmentType struct {

	// The policy adjustment type. The valid values are ChangeInCapacity, ExactCapacity,
	// and PercentChangeInCapacity.
	AdjustmentType *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes a policy adjustment type.

func (AdjustmentType) GoString added in v0.6.5

func (s AdjustmentType) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdjustmentType) SetAdjustmentType added in v1.5.0

func (s *AdjustmentType) SetAdjustmentType(v string) *AdjustmentType

SetAdjustmentType sets the AdjustmentType field's value.

func (AdjustmentType) String added in v0.6.5

func (s AdjustmentType) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Alarm

type Alarm struct {

	// The Amazon Resource Name (ARN) of the alarm.
	AlarmARN *string `min:"1" type:"string"`

	// The name of the alarm.
	AlarmName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes an alarm.

func (Alarm) GoString added in v0.6.5

func (s Alarm) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Alarm) SetAlarmARN added in v1.5.0

func (s *Alarm) SetAlarmARN(v string) *Alarm

SetAlarmARN sets the AlarmARN field's value.

func (*Alarm) SetAlarmName added in v1.5.0

func (s *Alarm) SetAlarmName(v string) *Alarm

SetAlarmName sets the AlarmName field's value.

func (Alarm) String added in v0.6.5

func (s Alarm) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AttachInstancesInput

type AttachInstancesInput struct {

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// The IDs of the instances. You can specify up to 20 instances.
	InstanceIds []*string `type:"list"`
	// contains filtered or unexported fields
}

func (AttachInstancesInput) GoString added in v0.6.5

func (s AttachInstancesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttachInstancesInput) SetAutoScalingGroupName added in v1.5.0

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

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*AttachInstancesInput) SetInstanceIds added in v1.5.0

func (s *AttachInstancesInput) SetInstanceIds(v []*string) *AttachInstancesInput

SetInstanceIds sets the InstanceIds field's value.

func (AttachInstancesInput) String added in v0.6.5

func (s AttachInstancesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttachInstancesInput) Validate added in v1.1.21

func (s *AttachInstancesInput) Validate() error

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

type AttachInstancesOutput

type AttachInstancesOutput struct {
	// contains filtered or unexported fields
}

func (AttachInstancesOutput) GoString added in v0.6.5

func (s AttachInstancesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AttachInstancesOutput) String added in v0.6.5

func (s AttachInstancesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AttachLoadBalancerTargetGroupsInput added in v1.4.1

type AttachLoadBalancerTargetGroupsInput struct {

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// The Amazon Resource Names (ARNs) of the target groups. You can specify up
	// to 10 target groups. To get the ARN of a target group, use the Elastic Load
	// Balancing DescribeTargetGroups (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html)
	// API operation.
	//
	// TargetGroupARNs is a required field
	TargetGroupARNs []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (AttachLoadBalancerTargetGroupsInput) GoString added in v1.4.1

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttachLoadBalancerTargetGroupsInput) SetAutoScalingGroupName added in v1.5.0

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*AttachLoadBalancerTargetGroupsInput) SetTargetGroupARNs added in v1.5.0

SetTargetGroupARNs sets the TargetGroupARNs field's value.

func (AttachLoadBalancerTargetGroupsInput) String added in v1.4.1

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttachLoadBalancerTargetGroupsInput) Validate added in v1.4.1

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

type AttachLoadBalancerTargetGroupsOutput added in v1.4.1

type AttachLoadBalancerTargetGroupsOutput struct {
	// contains filtered or unexported fields
}

func (AttachLoadBalancerTargetGroupsOutput) GoString added in v1.4.1

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AttachLoadBalancerTargetGroupsOutput) String added in v1.4.1

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AttachLoadBalancersInput added in v0.6.2

type AttachLoadBalancersInput struct {

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// The names of the load balancers. You can specify up to 10 load balancers.
	//
	// LoadBalancerNames is a required field
	LoadBalancerNames []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (AttachLoadBalancersInput) GoString added in v0.6.5

func (s AttachLoadBalancersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttachLoadBalancersInput) SetAutoScalingGroupName added in v1.5.0

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

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*AttachLoadBalancersInput) SetLoadBalancerNames added in v1.5.0

func (s *AttachLoadBalancersInput) SetLoadBalancerNames(v []*string) *AttachLoadBalancersInput

SetLoadBalancerNames sets the LoadBalancerNames field's value.

func (AttachLoadBalancersInput) String added in v0.6.5

func (s AttachLoadBalancersInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttachLoadBalancersInput) Validate added in v1.1.21

func (s *AttachLoadBalancersInput) Validate() error

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

type AttachLoadBalancersOutput added in v0.6.2

type AttachLoadBalancersOutput struct {
	// contains filtered or unexported fields
}

func (AttachLoadBalancersOutput) GoString added in v0.6.5

func (s AttachLoadBalancersOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AttachLoadBalancersOutput) String added in v0.6.5

func (s AttachLoadBalancersOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AttachTrafficSourcesInput added in v1.44.156

type AttachTrafficSourcesInput struct {

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// The unique identifiers of one or more traffic sources. You can specify up
	// to 10 traffic sources.
	//
	// TrafficSources is a required field
	TrafficSources []*TrafficSourceIdentifier `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (AttachTrafficSourcesInput) GoString added in v1.44.156

func (s AttachTrafficSourcesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttachTrafficSourcesInput) SetAutoScalingGroupName added in v1.44.156

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

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*AttachTrafficSourcesInput) SetTrafficSources added in v1.44.156

SetTrafficSources sets the TrafficSources field's value.

func (AttachTrafficSourcesInput) String added in v1.44.156

func (s AttachTrafficSourcesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttachTrafficSourcesInput) Validate added in v1.44.156

func (s *AttachTrafficSourcesInput) Validate() error

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

type AttachTrafficSourcesOutput added in v1.44.156

type AttachTrafficSourcesOutput struct {
	// contains filtered or unexported fields
}

func (AttachTrafficSourcesOutput) GoString added in v1.44.156

func (s AttachTrafficSourcesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AttachTrafficSourcesOutput) String added in v1.44.156

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AutoScaling

type AutoScaling struct {
	*client.Client
}

AutoScaling provides the API operation methods for making requests to Auto Scaling. See this package's package overview docs for details on the service.

AutoScaling methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *AutoScaling

New creates a new instance of the AutoScaling client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a AutoScaling client from just a session.
svc := autoscaling.New(mySession)

// Create a AutoScaling client with additional configuration
svc := autoscaling.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*AutoScaling) AttachInstances

func (c *AutoScaling) AttachInstances(input *AttachInstancesInput) (*AttachInstancesOutput, error)

AttachInstances API operation for Auto Scaling.

Attaches one or more EC2 instances to the specified Auto Scaling group.

When you attach instances, Amazon EC2 Auto Scaling increases the desired capacity of the group by the number of instances being attached. If the number of instances being attached plus the desired capacity of the group exceeds the maximum size of the group, the operation fails.

If there is a Classic Load Balancer attached to your Auto Scaling group, the instances are also registered with the load balancer. If there are target groups attached to your Auto Scaling group, the instances are also registered with the target groups.

For more information, see Attach EC2 instances to your Auto Scaling group (https://docs.aws.amazon.com/autoscaling/ec2/userguide/attach-instance-asg.html) in the Amazon EC2 Auto Scaling User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation AttachInstances for usage and error information.

Returned Error Codes:

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

  • ErrCodeServiceLinkedRoleFailure "ServiceLinkedRoleFailure" The service-linked role is not yet ready for use.

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/AttachInstances

Example (Shared00)

To attach an instance to an Auto Scaling group This example attaches the specified instance to the specified Auto Scaling group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.AttachInstancesInput{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
		InstanceIds: []*string{
			aws.String("i-93633f9b"),
		},
	}

	result, err := svc.AttachInstances(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			case autoscaling.ErrCodeServiceLinkedRoleFailure:
				fmt.Println(autoscaling.ErrCodeServiceLinkedRoleFailure, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) AttachInstancesRequest

func (c *AutoScaling) AttachInstancesRequest(input *AttachInstancesInput) (req *request.Request, output *AttachInstancesOutput)

AttachInstancesRequest generates a "aws/request.Request" representing the client's request for the AttachInstances operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AttachInstances for more information on using the AttachInstances API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AttachInstancesRequest method.
req, resp := client.AttachInstancesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/AttachInstances

func (*AutoScaling) AttachInstancesWithContext added in v1.8.0

func (c *AutoScaling) AttachInstancesWithContext(ctx aws.Context, input *AttachInstancesInput, opts ...request.Option) (*AttachInstancesOutput, error)

AttachInstancesWithContext is the same as AttachInstances with the addition of the ability to pass a context and additional request options.

See AttachInstances for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) AttachLoadBalancerTargetGroups added in v1.4.1

func (c *AutoScaling) AttachLoadBalancerTargetGroups(input *AttachLoadBalancerTargetGroupsInput) (*AttachLoadBalancerTargetGroupsOutput, error)

AttachLoadBalancerTargetGroups API operation for Auto Scaling.

This API operation is superseded by AttachTrafficSources, which can attach multiple traffic sources types. We recommend using AttachTrafficSources to simplify how you manage traffic sources. However, we continue to support AttachLoadBalancerTargetGroups. You can use both the original AttachLoadBalancerTargetGroups API operation and AttachTrafficSources on the same Auto Scaling group.

Attaches one or more target groups to the specified Auto Scaling group.

This operation is used with the following load balancer types:

  • Application Load Balancer - Operates at the application layer (layer 7) and supports HTTP and HTTPS.

  • Network Load Balancer - Operates at the transport layer (layer 4) and supports TCP, TLS, and UDP.

  • Gateway Load Balancer - Operates at the network layer (layer 3).

To describe the target groups for an Auto Scaling group, call the DescribeLoadBalancerTargetGroups API. To detach the target group from the Auto Scaling group, call the DetachLoadBalancerTargetGroups API.

This operation is additive and does not detach existing target groups or Classic Load Balancers from the Auto Scaling group.

For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group (https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) in the Amazon EC2 Auto Scaling User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation AttachLoadBalancerTargetGroups for usage and error information.

Returned Error Codes:

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

  • ErrCodeServiceLinkedRoleFailure "ServiceLinkedRoleFailure" The service-linked role is not yet ready for use.

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/AttachLoadBalancerTargetGroups

Example (Shared00)

To attach a target group to an Auto Scaling group This example attaches the specified target group to the specified Auto Scaling group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.AttachLoadBalancerTargetGroupsInput{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
		TargetGroupARNs: []*string{
			aws.String("arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"),
		},
	}

	result, err := svc.AttachLoadBalancerTargetGroups(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			case autoscaling.ErrCodeServiceLinkedRoleFailure:
				fmt.Println(autoscaling.ErrCodeServiceLinkedRoleFailure, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) AttachLoadBalancerTargetGroupsRequest added in v1.4.1

func (c *AutoScaling) AttachLoadBalancerTargetGroupsRequest(input *AttachLoadBalancerTargetGroupsInput) (req *request.Request, output *AttachLoadBalancerTargetGroupsOutput)

AttachLoadBalancerTargetGroupsRequest generates a "aws/request.Request" representing the client's request for the AttachLoadBalancerTargetGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AttachLoadBalancerTargetGroups for more information on using the AttachLoadBalancerTargetGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AttachLoadBalancerTargetGroupsRequest method.
req, resp := client.AttachLoadBalancerTargetGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/AttachLoadBalancerTargetGroups

func (*AutoScaling) AttachLoadBalancerTargetGroupsWithContext added in v1.8.0

func (c *AutoScaling) AttachLoadBalancerTargetGroupsWithContext(ctx aws.Context, input *AttachLoadBalancerTargetGroupsInput, opts ...request.Option) (*AttachLoadBalancerTargetGroupsOutput, error)

AttachLoadBalancerTargetGroupsWithContext is the same as AttachLoadBalancerTargetGroups with the addition of the ability to pass a context and additional request options.

See AttachLoadBalancerTargetGroups for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) AttachLoadBalancers added in v0.6.2

func (c *AutoScaling) AttachLoadBalancers(input *AttachLoadBalancersInput) (*AttachLoadBalancersOutput, error)

AttachLoadBalancers API operation for Auto Scaling.

This API operation is superseded by AttachTrafficSources, which can attach multiple traffic sources types. We recommend using AttachTrafficSources to simplify how you manage traffic sources. However, we continue to support AttachLoadBalancers. You can use both the original AttachLoadBalancers API operation and AttachTrafficSources on the same Auto Scaling group.

Attaches one or more Classic Load Balancers to the specified Auto Scaling group. Amazon EC2 Auto Scaling registers the running instances with these Classic Load Balancers.

To describe the load balancers for an Auto Scaling group, call the DescribeLoadBalancers API. To detach a load balancer from the Auto Scaling group, call the DetachLoadBalancers API.

This operation is additive and does not detach existing Classic Load Balancers or target groups from the Auto Scaling group.

For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group (https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) in the Amazon EC2 Auto Scaling User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation AttachLoadBalancers for usage and error information.

Returned Error Codes:

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

  • ErrCodeServiceLinkedRoleFailure "ServiceLinkedRoleFailure" The service-linked role is not yet ready for use.

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/AttachLoadBalancers

Example (Shared00)

To attach a load balancer to an Auto Scaling group This example attaches the specified load balancer to the specified Auto Scaling group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.AttachLoadBalancersInput{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
		LoadBalancerNames: []*string{
			aws.String("my-load-balancer"),
		},
	}

	result, err := svc.AttachLoadBalancers(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			case autoscaling.ErrCodeServiceLinkedRoleFailure:
				fmt.Println(autoscaling.ErrCodeServiceLinkedRoleFailure, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) AttachLoadBalancersRequest added in v0.6.2

func (c *AutoScaling) AttachLoadBalancersRequest(input *AttachLoadBalancersInput) (req *request.Request, output *AttachLoadBalancersOutput)

AttachLoadBalancersRequest generates a "aws/request.Request" representing the client's request for the AttachLoadBalancers operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AttachLoadBalancers for more information on using the AttachLoadBalancers API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AttachLoadBalancersRequest method.
req, resp := client.AttachLoadBalancersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/AttachLoadBalancers

func (*AutoScaling) AttachLoadBalancersWithContext added in v1.8.0

func (c *AutoScaling) AttachLoadBalancersWithContext(ctx aws.Context, input *AttachLoadBalancersInput, opts ...request.Option) (*AttachLoadBalancersOutput, error)

AttachLoadBalancersWithContext is the same as AttachLoadBalancers with the addition of the ability to pass a context and additional request options.

See AttachLoadBalancers for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) AttachTrafficSources added in v1.44.156

func (c *AutoScaling) AttachTrafficSources(input *AttachTrafficSourcesInput) (*AttachTrafficSourcesOutput, error)

AttachTrafficSources API operation for Auto Scaling.

Attaches one or more traffic sources to the specified Auto Scaling group.

You can use any of the following as traffic sources for an Auto Scaling group:

  • Application Load Balancer

  • Classic Load Balancer

  • Gateway Load Balancer

  • Network Load Balancer

  • VPC Lattice

This operation is additive and does not detach existing traffic sources from the Auto Scaling group.

After the operation completes, use the DescribeTrafficSources API to return details about the state of the attachments between traffic sources and your Auto Scaling group. To detach a traffic source from the Auto Scaling group, call the DetachTrafficSources API.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation AttachTrafficSources for usage and error information.

Returned Error Codes:

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

  • ErrCodeServiceLinkedRoleFailure "ServiceLinkedRoleFailure" The service-linked role is not yet ready for use.

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/AttachTrafficSources

Example (Shared00)

To attach a target group to an Auto Scaling group This example attaches the specified target group to the specified Auto Scaling group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.AttachTrafficSourcesInput{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
		TrafficSources: []*autoscaling.TrafficSourceIdentifier{
			{
				Identifier: aws.String("arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"),
			},
		},
	}

	result, err := svc.AttachTrafficSources(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			case autoscaling.ErrCodeServiceLinkedRoleFailure:
				fmt.Println(autoscaling.ErrCodeServiceLinkedRoleFailure, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) AttachTrafficSourcesRequest added in v1.44.156

func (c *AutoScaling) AttachTrafficSourcesRequest(input *AttachTrafficSourcesInput) (req *request.Request, output *AttachTrafficSourcesOutput)

AttachTrafficSourcesRequest generates a "aws/request.Request" representing the client's request for the AttachTrafficSources operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AttachTrafficSources for more information on using the AttachTrafficSources API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AttachTrafficSourcesRequest method.
req, resp := client.AttachTrafficSourcesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/AttachTrafficSources

func (*AutoScaling) AttachTrafficSourcesWithContext added in v1.44.156

func (c *AutoScaling) AttachTrafficSourcesWithContext(ctx aws.Context, input *AttachTrafficSourcesInput, opts ...request.Option) (*AttachTrafficSourcesOutput, error)

AttachTrafficSourcesWithContext is the same as AttachTrafficSources with the addition of the ability to pass a context and additional request options.

See AttachTrafficSources for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) BatchDeleteScheduledAction added in v1.15.12

func (c *AutoScaling) BatchDeleteScheduledAction(input *BatchDeleteScheduledActionInput) (*BatchDeleteScheduledActionOutput, error)

BatchDeleteScheduledAction API operation for Auto Scaling.

Deletes one or more scheduled actions for the specified Auto Scaling group.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation BatchDeleteScheduledAction for usage and error information.

Returned Error Codes:

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/BatchDeleteScheduledAction

func (*AutoScaling) BatchDeleteScheduledActionRequest added in v1.15.12

func (c *AutoScaling) BatchDeleteScheduledActionRequest(input *BatchDeleteScheduledActionInput) (req *request.Request, output *BatchDeleteScheduledActionOutput)

BatchDeleteScheduledActionRequest generates a "aws/request.Request" representing the client's request for the BatchDeleteScheduledAction operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchDeleteScheduledAction for more information on using the BatchDeleteScheduledAction API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the BatchDeleteScheduledActionRequest method.
req, resp := client.BatchDeleteScheduledActionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/BatchDeleteScheduledAction

func (*AutoScaling) BatchDeleteScheduledActionWithContext added in v1.15.12

func (c *AutoScaling) BatchDeleteScheduledActionWithContext(ctx aws.Context, input *BatchDeleteScheduledActionInput, opts ...request.Option) (*BatchDeleteScheduledActionOutput, error)

BatchDeleteScheduledActionWithContext is the same as BatchDeleteScheduledAction with the addition of the ability to pass a context and additional request options.

See BatchDeleteScheduledAction for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) BatchPutScheduledUpdateGroupAction added in v1.15.12

BatchPutScheduledUpdateGroupAction API operation for Auto Scaling.

Creates or updates one or more scheduled scaling actions for an Auto Scaling group.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation BatchPutScheduledUpdateGroupAction for usage and error information.

Returned Error Codes:

  • ErrCodeAlreadyExistsFault "AlreadyExists" You already have an Auto Scaling group or launch configuration with this name.

  • ErrCodeLimitExceededFault "LimitExceeded" You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DescribeAccountLimits.html) in the Amazon EC2 Auto Scaling API Reference.

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/BatchPutScheduledUpdateGroupAction

func (*AutoScaling) BatchPutScheduledUpdateGroupActionRequest added in v1.15.12

func (c *AutoScaling) BatchPutScheduledUpdateGroupActionRequest(input *BatchPutScheduledUpdateGroupActionInput) (req *request.Request, output *BatchPutScheduledUpdateGroupActionOutput)

BatchPutScheduledUpdateGroupActionRequest generates a "aws/request.Request" representing the client's request for the BatchPutScheduledUpdateGroupAction operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchPutScheduledUpdateGroupAction for more information on using the BatchPutScheduledUpdateGroupAction API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the BatchPutScheduledUpdateGroupActionRequest method.
req, resp := client.BatchPutScheduledUpdateGroupActionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/BatchPutScheduledUpdateGroupAction

func (*AutoScaling) BatchPutScheduledUpdateGroupActionWithContext added in v1.15.12

func (c *AutoScaling) BatchPutScheduledUpdateGroupActionWithContext(ctx aws.Context, input *BatchPutScheduledUpdateGroupActionInput, opts ...request.Option) (*BatchPutScheduledUpdateGroupActionOutput, error)

BatchPutScheduledUpdateGroupActionWithContext is the same as BatchPutScheduledUpdateGroupAction with the addition of the ability to pass a context and additional request options.

See BatchPutScheduledUpdateGroupAction for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) CancelInstanceRefresh added in v1.32.3

func (c *AutoScaling) CancelInstanceRefresh(input *CancelInstanceRefreshInput) (*CancelInstanceRefreshOutput, error)

CancelInstanceRefresh API operation for Auto Scaling.

Cancels an instance refresh or rollback that is in progress. If an instance refresh or rollback is not in progress, an ActiveInstanceRefreshNotFound error occurs.

This operation is part of the instance refresh feature (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html) in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.

When you cancel an instance refresh, this does not roll back any changes that it made. Use the RollbackInstanceRefresh API to roll back instead.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation CancelInstanceRefresh for usage and error information.

Returned Error Codes:

  • ErrCodeLimitExceededFault "LimitExceeded" You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DescribeAccountLimits.html) in the Amazon EC2 Auto Scaling API Reference.

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

  • ErrCodeActiveInstanceRefreshNotFoundFault "ActiveInstanceRefreshNotFound" The request failed because an active instance refresh or rollback for the specified Auto Scaling group was not found.

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/CancelInstanceRefresh

Example (Shared00)

To cancel an instance refresh This example cancels an instance refresh operation in progress.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.CancelInstanceRefreshInput{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
	}

	result, err := svc.CancelInstanceRefresh(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeLimitExceededFault:
				fmt.Println(autoscaling.ErrCodeLimitExceededFault, aerr.Error())
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			case autoscaling.ErrCodeActiveInstanceRefreshNotFoundFault:
				fmt.Println(autoscaling.ErrCodeActiveInstanceRefreshNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) CancelInstanceRefreshRequest added in v1.32.3

func (c *AutoScaling) CancelInstanceRefreshRequest(input *CancelInstanceRefreshInput) (req *request.Request, output *CancelInstanceRefreshOutput)

CancelInstanceRefreshRequest generates a "aws/request.Request" representing the client's request for the CancelInstanceRefresh operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CancelInstanceRefresh for more information on using the CancelInstanceRefresh API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CancelInstanceRefreshRequest method.
req, resp := client.CancelInstanceRefreshRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/CancelInstanceRefresh

func (*AutoScaling) CancelInstanceRefreshWithContext added in v1.32.3

func (c *AutoScaling) CancelInstanceRefreshWithContext(ctx aws.Context, input *CancelInstanceRefreshInput, opts ...request.Option) (*CancelInstanceRefreshOutput, error)

CancelInstanceRefreshWithContext is the same as CancelInstanceRefresh with the addition of the ability to pass a context and additional request options.

See CancelInstanceRefresh for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) CompleteLifecycleAction

func (c *AutoScaling) CompleteLifecycleAction(input *CompleteLifecycleActionInput) (*CompleteLifecycleActionOutput, error)

CompleteLifecycleAction API operation for Auto Scaling.

Completes the lifecycle action for the specified token or instance with the specified result.

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:

(Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.

(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.

(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.

Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.

If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state.

If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call.

For more information, see Complete a lifecycle action (https://docs.aws.amazon.com/autoscaling/ec2/userguide/completing-lifecycle-hooks.html) in the Amazon EC2 Auto Scaling User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation CompleteLifecycleAction for usage and error information.

Returned Error Codes:

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/CompleteLifecycleAction

Example (Shared00)

To complete the lifecycle action This example notifies Auto Scaling that the specified lifecycle action is complete so that it can finish launching or terminating the instance.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.CompleteLifecycleActionInput{
		AutoScalingGroupName:  aws.String("my-auto-scaling-group"),
		LifecycleActionResult: aws.String("CONTINUE"),
		LifecycleActionToken:  aws.String("bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635"),
		LifecycleHookName:     aws.String("my-lifecycle-hook"),
	}

	result, err := svc.CompleteLifecycleAction(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) CompleteLifecycleActionRequest

func (c *AutoScaling) CompleteLifecycleActionRequest(input *CompleteLifecycleActionInput) (req *request.Request, output *CompleteLifecycleActionOutput)

CompleteLifecycleActionRequest generates a "aws/request.Request" representing the client's request for the CompleteLifecycleAction operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CompleteLifecycleAction for more information on using the CompleteLifecycleAction API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CompleteLifecycleActionRequest method.
req, resp := client.CompleteLifecycleActionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/CompleteLifecycleAction

func (*AutoScaling) CompleteLifecycleActionWithContext added in v1.8.0

func (c *AutoScaling) CompleteLifecycleActionWithContext(ctx aws.Context, input *CompleteLifecycleActionInput, opts ...request.Option) (*CompleteLifecycleActionOutput, error)

CompleteLifecycleActionWithContext is the same as CompleteLifecycleAction with the addition of the ability to pass a context and additional request options.

See CompleteLifecycleAction for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) CreateAutoScalingGroup

func (c *AutoScaling) CreateAutoScalingGroup(input *CreateAutoScalingGroupInput) (*CreateAutoScalingGroupOutput, error)

CreateAutoScalingGroup API operation for Auto Scaling.

We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.

Creates an Auto Scaling group with the specified name and attributes.

If you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit, call the DescribeAccountLimits API. For information about updating this limit, see Quotas for Amazon EC2 Auto Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-quotas.html) in the Amazon EC2 Auto Scaling User Guide.

For introductory exercises for creating an Auto Scaling group, see Getting started with Amazon EC2 Auto Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/GettingStartedTutorial.html) and Tutorial: Set up a scaled and load-balanced application (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-register-lbs-with-asg.html) in the Amazon EC2 Auto Scaling User Guide. For more information, see Auto Scaling groups (https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroup.html) in the Amazon EC2 Auto Scaling User Guide.

Every Auto Scaling group has three size properties (DesiredCapacity, MaxSize, and MinSize). Usually, you set these sizes based on a specific number of instances. However, if you configure a mixed instances policy that defines weights for the instance types, you must specify these sizes with the same units that you use for weighting instances.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation CreateAutoScalingGroup for usage and error information.

Returned Error Codes:

  • ErrCodeAlreadyExistsFault "AlreadyExists" You already have an Auto Scaling group or launch configuration with this name.

  • ErrCodeLimitExceededFault "LimitExceeded" You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DescribeAccountLimits.html) in the Amazon EC2 Auto Scaling API Reference.

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

  • ErrCodeServiceLinkedRoleFailure "ServiceLinkedRoleFailure" The service-linked role is not yet ready for use.

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/CreateAutoScalingGroup

Example (Shared00)

To create an Auto Scaling group This example creates an Auto Scaling group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.CreateAutoScalingGroupInput{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
		LaunchTemplate: &autoscaling.LaunchTemplateSpecification{
			LaunchTemplateName: aws.String("my-template-for-auto-scaling"),
			Version:            aws.String("$Latest"),
		},
		MaxInstanceLifetime: aws.Int64(2592000),
		MaxSize:             aws.Int64(3),
		MinSize:             aws.Int64(1),
		VPCZoneIdentifier:   aws.String("subnet-057fa0918fEXAMPLE"),
	}

	result, err := svc.CreateAutoScalingGroup(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeAlreadyExistsFault:
				fmt.Println(autoscaling.ErrCodeAlreadyExistsFault, aerr.Error())
			case autoscaling.ErrCodeLimitExceededFault:
				fmt.Println(autoscaling.ErrCodeLimitExceededFault, aerr.Error())
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			case autoscaling.ErrCodeServiceLinkedRoleFailure:
				fmt.Println(autoscaling.ErrCodeServiceLinkedRoleFailure, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

Example (Shared01)

To create an Auto Scaling group with an attached target group This example creates an Auto Scaling group and attaches the specified target group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.CreateAutoScalingGroupInput{
		AutoScalingGroupName:   aws.String("my-auto-scaling-group"),
		HealthCheckGracePeriod: aws.Int64(300),
		HealthCheckType:        aws.String("ELB"),
		LaunchTemplate: &autoscaling.LaunchTemplateSpecification{
			LaunchTemplateName: aws.String("my-template-for-auto-scaling"),
			Version:            aws.String("$Latest"),
		},
		MaxSize: aws.Int64(3),
		MinSize: aws.Int64(1),
		TargetGroupARNs: []*string{
			aws.String("arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"),
		},
		VPCZoneIdentifier: aws.String("subnet-057fa0918fEXAMPLE, subnet-610acd08EXAMPLE"),
	}

	result, err := svc.CreateAutoScalingGroup(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeAlreadyExistsFault:
				fmt.Println(autoscaling.ErrCodeAlreadyExistsFault, aerr.Error())
			case autoscaling.ErrCodeLimitExceededFault:
				fmt.Println(autoscaling.ErrCodeLimitExceededFault, aerr.Error())
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			case autoscaling.ErrCodeServiceLinkedRoleFailure:
				fmt.Println(autoscaling.ErrCodeServiceLinkedRoleFailure, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

Example (Shared02)

To create an Auto Scaling group with a mixed instances policy This example creates an Auto Scaling group with a mixed instances policy. It specifies the c5.large, c5a.large, and c6g.large instance types and defines a different launch template for the c6g.large instance type.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.CreateAutoScalingGroupInput{
		AutoScalingGroupName: aws.String("my-asg"),
		DesiredCapacity:      aws.Int64(3),
		MaxSize:              aws.Int64(5),
		MinSize:              aws.Int64(1),
		MixedInstancesPolicy: &autoscaling.MixedInstancesPolicy{
			InstancesDistribution: &autoscaling.InstancesDistribution{
				OnDemandBaseCapacity:                aws.Int64(1),
				OnDemandPercentageAboveBaseCapacity: aws.Int64(50),
				SpotAllocationStrategy:              aws.String("capacity-optimized"),
			},
			LaunchTemplate: &autoscaling.LaunchTemplate{
				LaunchTemplateSpecification: &autoscaling.LaunchTemplateSpecification{
					LaunchTemplateName: aws.String("my-launch-template-for-x86"),
					Version:            aws.String("$Latest"),
				},
				Overrides: []*autoscaling.LaunchTemplateOverrides{
					{
						InstanceType: aws.String("c6g.large"),
						LaunchTemplateSpecification: &autoscaling.LaunchTemplateSpecification{
							LaunchTemplateName: aws.String("my-launch-template-for-arm"),
							Version:            aws.String("$Latest"),
						},
					},
					{
						InstanceType: aws.String("c5.large"),
					},
					{
						InstanceType: aws.String("c5a.large"),
					},
				},
			},
		},
		VPCZoneIdentifier: aws.String("subnet-057fa0918fEXAMPLE, subnet-610acd08EXAMPLE"),
	}

	result, err := svc.CreateAutoScalingGroup(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeAlreadyExistsFault:
				fmt.Println(autoscaling.ErrCodeAlreadyExistsFault, aerr.Error())
			case autoscaling.ErrCodeLimitExceededFault:
				fmt.Println(autoscaling.ErrCodeLimitExceededFault, aerr.Error())
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			case autoscaling.ErrCodeServiceLinkedRoleFailure:
				fmt.Println(autoscaling.ErrCodeServiceLinkedRoleFailure, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) CreateAutoScalingGroupRequest

func (c *AutoScaling) CreateAutoScalingGroupRequest(input *CreateAutoScalingGroupInput) (req *request.Request, output *CreateAutoScalingGroupOutput)

CreateAutoScalingGroupRequest generates a "aws/request.Request" representing the client's request for the CreateAutoScalingGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateAutoScalingGroup for more information on using the CreateAutoScalingGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateAutoScalingGroupRequest method.
req, resp := client.CreateAutoScalingGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/CreateAutoScalingGroup

func (*AutoScaling) CreateAutoScalingGroupWithContext added in v1.8.0

func (c *AutoScaling) CreateAutoScalingGroupWithContext(ctx aws.Context, input *CreateAutoScalingGroupInput, opts ...request.Option) (*CreateAutoScalingGroupOutput, error)

CreateAutoScalingGroupWithContext is the same as CreateAutoScalingGroup with the addition of the ability to pass a context and additional request options.

See CreateAutoScalingGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) CreateLaunchConfiguration

func (c *AutoScaling) CreateLaunchConfiguration(input *CreateLaunchConfigurationInput) (*CreateLaunchConfigurationOutput, error)

CreateLaunchConfiguration API operation for Auto Scaling.

Creates a launch configuration.

If you exceed your maximum limit of launch configurations, the call fails. To query this limit, call the DescribeAccountLimits API. For information about updating this limit, see Quotas for Amazon EC2 Auto Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-quotas.html) in the Amazon EC2 Auto Scaling User Guide.

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

Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a launch template or a launch configuration. We strongly recommend that you do not use launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2. For information about using launch templates, see Launch templates (https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-templates.html) in the Amazon EC2 Auto Scaling User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation CreateLaunchConfiguration for usage and error information.

Returned Error Codes:

  • ErrCodeAlreadyExistsFault "AlreadyExists" You already have an Auto Scaling group or launch configuration with this name.

  • ErrCodeLimitExceededFault "LimitExceeded" You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DescribeAccountLimits.html) in the Amazon EC2 Auto Scaling API Reference.

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/CreateLaunchConfiguration

Example (Shared00)

To create a launch configuration This example creates a launch configuration.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.CreateLaunchConfigurationInput{
		IamInstanceProfile:      aws.String("my-iam-role"),
		ImageId:                 aws.String("ami-12345678"),
		InstanceType:            aws.String("m3.medium"),
		LaunchConfigurationName: aws.String("my-launch-config"),
		SecurityGroups: []*string{
			aws.String("sg-eb2af88e"),
		},
	}

	result, err := svc.CreateLaunchConfiguration(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeAlreadyExistsFault:
				fmt.Println(autoscaling.ErrCodeAlreadyExistsFault, aerr.Error())
			case autoscaling.ErrCodeLimitExceededFault:
				fmt.Println(autoscaling.ErrCodeLimitExceededFault, aerr.Error())
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) CreateLaunchConfigurationRequest

func (c *AutoScaling) CreateLaunchConfigurationRequest(input *CreateLaunchConfigurationInput) (req *request.Request, output *CreateLaunchConfigurationOutput)

CreateLaunchConfigurationRequest generates a "aws/request.Request" representing the client's request for the CreateLaunchConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateLaunchConfiguration for more information on using the CreateLaunchConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateLaunchConfigurationRequest method.
req, resp := client.CreateLaunchConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/CreateLaunchConfiguration

func (*AutoScaling) CreateLaunchConfigurationWithContext added in v1.8.0

func (c *AutoScaling) CreateLaunchConfigurationWithContext(ctx aws.Context, input *CreateLaunchConfigurationInput, opts ...request.Option) (*CreateLaunchConfigurationOutput, error)

CreateLaunchConfigurationWithContext is the same as CreateLaunchConfiguration with the addition of the ability to pass a context and additional request options.

See CreateLaunchConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) CreateOrUpdateTags

func (c *AutoScaling) CreateOrUpdateTags(input *CreateOrUpdateTagsInput) (*CreateOrUpdateTagsOutput, error)

CreateOrUpdateTags API operation for Auto Scaling.

Creates or updates tags for the specified Auto Scaling group.

When you specify a tag with a key that already exists, the operation overwrites the previous tag definition, and you do not get an error message.

For more information, see Tag Auto Scaling groups and instances (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html) in the Amazon EC2 Auto Scaling User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation CreateOrUpdateTags for usage and error information.

Returned Error Codes:

  • ErrCodeLimitExceededFault "LimitExceeded" You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DescribeAccountLimits.html) in the Amazon EC2 Auto Scaling API Reference.

  • ErrCodeAlreadyExistsFault "AlreadyExists" You already have an Auto Scaling group or launch configuration with this name.

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

  • ErrCodeResourceInUseFault "ResourceInUse" The operation can't be performed because the resource is in use.

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/CreateOrUpdateTags

Example (Shared00)

To create or update tags for an Auto Scaling group This example adds two tags to the specified Auto Scaling group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.CreateOrUpdateTagsInput{
		Tags: []*autoscaling.Tag{
			{
				Key:               aws.String("Role"),
				PropagateAtLaunch: aws.Bool(true),
				ResourceId:        aws.String("my-auto-scaling-group"),
				ResourceType:      aws.String("auto-scaling-group"),
				Value:             aws.String("WebServer"),
			},
			{
				Key:               aws.String("Dept"),
				PropagateAtLaunch: aws.Bool(true),
				ResourceId:        aws.String("my-auto-scaling-group"),
				ResourceType:      aws.String("auto-scaling-group"),
				Value:             aws.String("Research"),
			},
		},
	}

	result, err := svc.CreateOrUpdateTags(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeLimitExceededFault:
				fmt.Println(autoscaling.ErrCodeLimitExceededFault, aerr.Error())
			case autoscaling.ErrCodeAlreadyExistsFault:
				fmt.Println(autoscaling.ErrCodeAlreadyExistsFault, aerr.Error())
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			case autoscaling.ErrCodeResourceInUseFault:
				fmt.Println(autoscaling.ErrCodeResourceInUseFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) CreateOrUpdateTagsRequest

func (c *AutoScaling) CreateOrUpdateTagsRequest(input *CreateOrUpdateTagsInput) (req *request.Request, output *CreateOrUpdateTagsOutput)

CreateOrUpdateTagsRequest generates a "aws/request.Request" representing the client's request for the CreateOrUpdateTags operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateOrUpdateTags for more information on using the CreateOrUpdateTags API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateOrUpdateTagsRequest method.
req, resp := client.CreateOrUpdateTagsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/CreateOrUpdateTags

func (*AutoScaling) CreateOrUpdateTagsWithContext added in v1.8.0

func (c *AutoScaling) CreateOrUpdateTagsWithContext(ctx aws.Context, input *CreateOrUpdateTagsInput, opts ...request.Option) (*CreateOrUpdateTagsOutput, error)

CreateOrUpdateTagsWithContext is the same as CreateOrUpdateTags with the addition of the ability to pass a context and additional request options.

See CreateOrUpdateTags for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DeleteAutoScalingGroup

func (c *AutoScaling) DeleteAutoScalingGroup(input *DeleteAutoScalingGroupInput) (*DeleteAutoScalingGroupOutput, error)

DeleteAutoScalingGroup API operation for Auto Scaling.

Deletes the specified Auto Scaling group.

If the group has instances or scaling activities in progress, you must specify the option to force the deletion in order for it to succeed. The force delete operation will also terminate the EC2 instances. If the group has a warm pool, the force delete option also deletes the warm pool.

To remove instances from the Auto Scaling group before deleting it, call the DetachInstances API with the list of instances and the option to decrement the desired capacity. This ensures that Amazon EC2 Auto Scaling does not launch replacement instances.

To terminate all instances before deleting the Auto Scaling group, call the UpdateAutoScalingGroup API and set the minimum size and desired capacity of the Auto Scaling group to zero.

If the group has scaling policies, deleting the group deletes the policies, the underlying alarm actions, and any alarm that no longer has an associated action.

For more information, see Delete your Auto Scaling infrastructure (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-process-shutdown.html) in the Amazon EC2 Auto Scaling User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation DeleteAutoScalingGroup for usage and error information.

Returned Error Codes:

  • ErrCodeScalingActivityInProgressFault "ScalingActivityInProgress" The operation can't be performed because there are scaling activities in progress.

  • ErrCodeResourceInUseFault "ResourceInUse" The operation can't be performed because the resource is in use.

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DeleteAutoScalingGroup

Example (Shared00)

To delete an Auto Scaling group This example deletes the specified Auto Scaling group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.DeleteAutoScalingGroupInput{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
	}

	result, err := svc.DeleteAutoScalingGroup(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeScalingActivityInProgressFault:
				fmt.Println(autoscaling.ErrCodeScalingActivityInProgressFault, aerr.Error())
			case autoscaling.ErrCodeResourceInUseFault:
				fmt.Println(autoscaling.ErrCodeResourceInUseFault, aerr.Error())
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

Example (Shared01)

To delete an Auto Scaling group and all its instances This example deletes the specified Auto Scaling group and all its instances.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.DeleteAutoScalingGroupInput{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
		ForceDelete:          aws.Bool(true),
	}

	result, err := svc.DeleteAutoScalingGroup(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeScalingActivityInProgressFault:
				fmt.Println(autoscaling.ErrCodeScalingActivityInProgressFault, aerr.Error())
			case autoscaling.ErrCodeResourceInUseFault:
				fmt.Println(autoscaling.ErrCodeResourceInUseFault, aerr.Error())
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) DeleteAutoScalingGroupRequest

func (c *AutoScaling) DeleteAutoScalingGroupRequest(input *DeleteAutoScalingGroupInput) (req *request.Request, output *DeleteAutoScalingGroupOutput)

DeleteAutoScalingGroupRequest generates a "aws/request.Request" representing the client's request for the DeleteAutoScalingGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteAutoScalingGroup for more information on using the DeleteAutoScalingGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteAutoScalingGroupRequest method.
req, resp := client.DeleteAutoScalingGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DeleteAutoScalingGroup

func (*AutoScaling) DeleteAutoScalingGroupWithContext added in v1.8.0

func (c *AutoScaling) DeleteAutoScalingGroupWithContext(ctx aws.Context, input *DeleteAutoScalingGroupInput, opts ...request.Option) (*DeleteAutoScalingGroupOutput, error)

DeleteAutoScalingGroupWithContext is the same as DeleteAutoScalingGroup with the addition of the ability to pass a context and additional request options.

See DeleteAutoScalingGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DeleteLaunchConfiguration

func (c *AutoScaling) DeleteLaunchConfiguration(input *DeleteLaunchConfigurationInput) (*DeleteLaunchConfigurationOutput, error)

DeleteLaunchConfiguration API operation for Auto Scaling.

Deletes the specified launch configuration.

The launch configuration must not be attached to an Auto Scaling group. When this call completes, the launch configuration is no longer available for use.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation DeleteLaunchConfiguration for usage and error information.

Returned Error Codes:

  • ErrCodeResourceInUseFault "ResourceInUse" The operation can't be performed because the resource is in use.

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DeleteLaunchConfiguration

Example (Shared00)

To delete a launch configuration This example deletes the specified launch configuration.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.DeleteLaunchConfigurationInput{
		LaunchConfigurationName: aws.String("my-launch-config"),
	}

	result, err := svc.DeleteLaunchConfiguration(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeResourceInUseFault:
				fmt.Println(autoscaling.ErrCodeResourceInUseFault, aerr.Error())
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) DeleteLaunchConfigurationRequest

func (c *AutoScaling) DeleteLaunchConfigurationRequest(input *DeleteLaunchConfigurationInput) (req *request.Request, output *DeleteLaunchConfigurationOutput)

DeleteLaunchConfigurationRequest generates a "aws/request.Request" representing the client's request for the DeleteLaunchConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteLaunchConfiguration for more information on using the DeleteLaunchConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteLaunchConfigurationRequest method.
req, resp := client.DeleteLaunchConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DeleteLaunchConfiguration

func (*AutoScaling) DeleteLaunchConfigurationWithContext added in v1.8.0

func (c *AutoScaling) DeleteLaunchConfigurationWithContext(ctx aws.Context, input *DeleteLaunchConfigurationInput, opts ...request.Option) (*DeleteLaunchConfigurationOutput, error)

DeleteLaunchConfigurationWithContext is the same as DeleteLaunchConfiguration with the addition of the ability to pass a context and additional request options.

See DeleteLaunchConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DeleteLifecycleHook

func (c *AutoScaling) DeleteLifecycleHook(input *DeleteLifecycleHookInput) (*DeleteLifecycleHookOutput, error)

DeleteLifecycleHook API operation for Auto Scaling.

Deletes the specified lifecycle hook.

If there are any outstanding lifecycle actions, they are completed first (ABANDON for launching instances, CONTINUE for terminating instances).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation DeleteLifecycleHook for usage and error information.

Returned Error Codes:

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DeleteLifecycleHook

Example (Shared00)

To delete a lifecycle hook This example deletes the specified lifecycle hook.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.DeleteLifecycleHookInput{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
		LifecycleHookName:    aws.String("my-lifecycle-hook"),
	}

	result, err := svc.DeleteLifecycleHook(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) DeleteLifecycleHookRequest

func (c *AutoScaling) DeleteLifecycleHookRequest(input *DeleteLifecycleHookInput) (req *request.Request, output *DeleteLifecycleHookOutput)

DeleteLifecycleHookRequest generates a "aws/request.Request" representing the client's request for the DeleteLifecycleHook operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteLifecycleHook for more information on using the DeleteLifecycleHook API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteLifecycleHookRequest method.
req, resp := client.DeleteLifecycleHookRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DeleteLifecycleHook

func (*AutoScaling) DeleteLifecycleHookWithContext added in v1.8.0

func (c *AutoScaling) DeleteLifecycleHookWithContext(ctx aws.Context, input *DeleteLifecycleHookInput, opts ...request.Option) (*DeleteLifecycleHookOutput, error)

DeleteLifecycleHookWithContext is the same as DeleteLifecycleHook with the addition of the ability to pass a context and additional request options.

See DeleteLifecycleHook for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DeleteNotificationConfiguration

DeleteNotificationConfiguration API operation for Auto Scaling.

Deletes the specified notification.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation DeleteNotificationConfiguration for usage and error information.

Returned Error Codes:

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DeleteNotificationConfiguration

Example (Shared00)

To delete an Auto Scaling notification This example deletes the specified notification from the specified Auto Scaling group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.DeleteNotificationConfigurationInput{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
		TopicARN:             aws.String("arn:aws:sns:us-west-2:123456789012:my-sns-topic"),
	}

	result, err := svc.DeleteNotificationConfiguration(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) DeleteNotificationConfigurationRequest

func (c *AutoScaling) DeleteNotificationConfigurationRequest(input *DeleteNotificationConfigurationInput) (req *request.Request, output *DeleteNotificationConfigurationOutput)

DeleteNotificationConfigurationRequest generates a "aws/request.Request" representing the client's request for the DeleteNotificationConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteNotificationConfiguration for more information on using the DeleteNotificationConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteNotificationConfigurationRequest method.
req, resp := client.DeleteNotificationConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DeleteNotificationConfiguration

func (*AutoScaling) DeleteNotificationConfigurationWithContext added in v1.8.0

func (c *AutoScaling) DeleteNotificationConfigurationWithContext(ctx aws.Context, input *DeleteNotificationConfigurationInput, opts ...request.Option) (*DeleteNotificationConfigurationOutput, error)

DeleteNotificationConfigurationWithContext is the same as DeleteNotificationConfiguration with the addition of the ability to pass a context and additional request options.

See DeleteNotificationConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DeletePolicy

func (c *AutoScaling) DeletePolicy(input *DeletePolicyInput) (*DeletePolicyOutput, error)

DeletePolicy API operation for Auto Scaling.

Deletes the specified scaling policy.

Deleting either a step scaling policy or a simple scaling policy deletes the underlying alarm action, but does not delete the alarm, even if it no longer has an associated action.

For more information, see Deleting a scaling policy (https://docs.aws.amazon.com/autoscaling/ec2/userguide/deleting-scaling-policy.html) in the Amazon EC2 Auto Scaling User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation DeletePolicy for usage and error information.

Returned Error Codes:

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

  • ErrCodeServiceLinkedRoleFailure "ServiceLinkedRoleFailure" The service-linked role is not yet ready for use.

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DeletePolicy

Example (Shared00)

To delete an Auto Scaling policy This example deletes the specified Auto Scaling policy.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.DeletePolicyInput{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
		PolicyName:           aws.String("my-step-scale-out-policy"),
	}

	result, err := svc.DeletePolicy(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			case autoscaling.ErrCodeServiceLinkedRoleFailure:
				fmt.Println(autoscaling.ErrCodeServiceLinkedRoleFailure, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) DeletePolicyRequest

func (c *AutoScaling) DeletePolicyRequest(input *DeletePolicyInput) (req *request.Request, output *DeletePolicyOutput)

DeletePolicyRequest generates a "aws/request.Request" representing the client's request for the DeletePolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeletePolicy for more information on using the DeletePolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeletePolicyRequest method.
req, resp := client.DeletePolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DeletePolicy

func (*AutoScaling) DeletePolicyWithContext added in v1.8.0

func (c *AutoScaling) DeletePolicyWithContext(ctx aws.Context, input *DeletePolicyInput, opts ...request.Option) (*DeletePolicyOutput, error)

DeletePolicyWithContext is the same as DeletePolicy with the addition of the ability to pass a context and additional request options.

See DeletePolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DeleteScheduledAction

func (c *AutoScaling) DeleteScheduledAction(input *DeleteScheduledActionInput) (*DeleteScheduledActionOutput, error)

DeleteScheduledAction API operation for Auto Scaling.

Deletes the specified scheduled action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation DeleteScheduledAction for usage and error information.

Returned Error Codes:

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DeleteScheduledAction

Example (Shared00)

To delete a scheduled action from an Auto Scaling group This example deletes the specified scheduled action from the specified Auto Scaling group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.DeleteScheduledActionInput{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
		ScheduledActionName:  aws.String("my-scheduled-action"),
	}

	result, err := svc.DeleteScheduledAction(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) DeleteScheduledActionRequest

func (c *AutoScaling) DeleteScheduledActionRequest(input *DeleteScheduledActionInput) (req *request.Request, output *DeleteScheduledActionOutput)

DeleteScheduledActionRequest generates a "aws/request.Request" representing the client's request for the DeleteScheduledAction operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteScheduledAction for more information on using the DeleteScheduledAction API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteScheduledActionRequest method.
req, resp := client.DeleteScheduledActionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DeleteScheduledAction

func (*AutoScaling) DeleteScheduledActionWithContext added in v1.8.0

func (c *AutoScaling) DeleteScheduledActionWithContext(ctx aws.Context, input *DeleteScheduledActionInput, opts ...request.Option) (*DeleteScheduledActionOutput, error)

DeleteScheduledActionWithContext is the same as DeleteScheduledAction with the addition of the ability to pass a context and additional request options.

See DeleteScheduledAction for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DeleteTags

func (c *AutoScaling) DeleteTags(input *DeleteTagsInput) (*DeleteTagsOutput, error)

DeleteTags API operation for Auto Scaling.

Deletes the specified tags.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation DeleteTags for usage and error information.

Returned Error Codes:

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

  • ErrCodeResourceInUseFault "ResourceInUse" The operation can't be performed because the resource is in use.

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DeleteTags

Example (Shared00)

To delete a tag from an Auto Scaling group This example deletes the specified tag from the specified Auto Scaling group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.DeleteTagsInput{
		Tags: []*autoscaling.Tag{
			{
				Key:          aws.String("Dept"),
				ResourceId:   aws.String("my-auto-scaling-group"),
				ResourceType: aws.String("auto-scaling-group"),
				Value:        aws.String("Research"),
			},
		},
	}

	result, err := svc.DeleteTags(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			case autoscaling.ErrCodeResourceInUseFault:
				fmt.Println(autoscaling.ErrCodeResourceInUseFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) DeleteTagsRequest

func (c *AutoScaling) DeleteTagsRequest(input *DeleteTagsInput) (req *request.Request, output *DeleteTagsOutput)

DeleteTagsRequest generates a "aws/request.Request" representing the client's request for the DeleteTags operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteTags for more information on using the DeleteTags API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteTagsRequest method.
req, resp := client.DeleteTagsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DeleteTags

func (*AutoScaling) DeleteTagsWithContext added in v1.8.0

func (c *AutoScaling) DeleteTagsWithContext(ctx aws.Context, input *DeleteTagsInput, opts ...request.Option) (*DeleteTagsOutput, error)

DeleteTagsWithContext is the same as DeleteTags with the addition of the ability to pass a context and additional request options.

See DeleteTags for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DeleteWarmPool added in v1.38.16

func (c *AutoScaling) DeleteWarmPool(input *DeleteWarmPoolInput) (*DeleteWarmPoolOutput, error)

DeleteWarmPool API operation for Auto Scaling.

Deletes the warm pool for the specified Auto Scaling group.

For more information, see Warm pools for Amazon EC2 Auto Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html) in the Amazon EC2 Auto Scaling User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation DeleteWarmPool for usage and error information.

Returned Error Codes:

  • ErrCodeLimitExceededFault "LimitExceeded" You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DescribeAccountLimits.html) in the Amazon EC2 Auto Scaling API Reference.

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

  • ErrCodeScalingActivityInProgressFault "ScalingActivityInProgress" The operation can't be performed because there are scaling activities in progress.

  • ErrCodeResourceInUseFault "ResourceInUse" The operation can't be performed because the resource is in use.

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DeleteWarmPool

func (*AutoScaling) DeleteWarmPoolRequest added in v1.38.16

func (c *AutoScaling) DeleteWarmPoolRequest(input *DeleteWarmPoolInput) (req *request.Request, output *DeleteWarmPoolOutput)

DeleteWarmPoolRequest generates a "aws/request.Request" representing the client's request for the DeleteWarmPool operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteWarmPool for more information on using the DeleteWarmPool API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteWarmPoolRequest method.
req, resp := client.DeleteWarmPoolRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DeleteWarmPool

func (*AutoScaling) DeleteWarmPoolWithContext added in v1.38.16

func (c *AutoScaling) DeleteWarmPoolWithContext(ctx aws.Context, input *DeleteWarmPoolInput, opts ...request.Option) (*DeleteWarmPoolOutput, error)

DeleteWarmPoolWithContext is the same as DeleteWarmPool with the addition of the ability to pass a context and additional request options.

See DeleteWarmPool for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DescribeAccountLimits

func (c *AutoScaling) DescribeAccountLimits(input *DescribeAccountLimitsInput) (*DescribeAccountLimitsOutput, error)

DescribeAccountLimits API operation for Auto Scaling.

Describes the current Amazon EC2 Auto Scaling resource quotas for your account.

When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of Auto Scaling groups and launch configurations that you can create in a given Region. For more information, see Quotas for Amazon EC2 Auto Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-quotas.html) in the Amazon EC2 Auto Scaling User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation DescribeAccountLimits for usage and error information.

Returned Error Codes:

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeAccountLimits

Example (Shared00)

To describe your Auto Scaling account limits This example describes the Amazon EC2 Auto Scaling service quotas for your account.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.DescribeAccountLimitsInput{}

	result, err := svc.DescribeAccountLimits(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) DescribeAccountLimitsRequest

func (c *AutoScaling) DescribeAccountLimitsRequest(input *DescribeAccountLimitsInput) (req *request.Request, output *DescribeAccountLimitsOutput)

DescribeAccountLimitsRequest generates a "aws/request.Request" representing the client's request for the DescribeAccountLimits operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAccountLimits for more information on using the DescribeAccountLimits API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeAccountLimitsRequest method.
req, resp := client.DescribeAccountLimitsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeAccountLimits

func (*AutoScaling) DescribeAccountLimitsWithContext added in v1.8.0

func (c *AutoScaling) DescribeAccountLimitsWithContext(ctx aws.Context, input *DescribeAccountLimitsInput, opts ...request.Option) (*DescribeAccountLimitsOutput, error)

DescribeAccountLimitsWithContext is the same as DescribeAccountLimits with the addition of the ability to pass a context and additional request options.

See DescribeAccountLimits for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DescribeAdjustmentTypes

func (c *AutoScaling) DescribeAdjustmentTypes(input *DescribeAdjustmentTypesInput) (*DescribeAdjustmentTypesOutput, error)

DescribeAdjustmentTypes API operation for Auto Scaling.

Describes the available adjustment types for step scaling and simple scaling policies.

The following adjustment types are supported:

  • ChangeInCapacity

  • ExactCapacity

  • PercentChangeInCapacity

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation DescribeAdjustmentTypes for usage and error information.

Returned Error Codes:

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeAdjustmentTypes

Example (Shared00)

To describe the Amazon EC2 Auto Scaling adjustment types This example describes the available adjustment types.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.DescribeAdjustmentTypesInput{}

	result, err := svc.DescribeAdjustmentTypes(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) DescribeAdjustmentTypesRequest

func (c *AutoScaling) DescribeAdjustmentTypesRequest(input *DescribeAdjustmentTypesInput) (req *request.Request, output *DescribeAdjustmentTypesOutput)

DescribeAdjustmentTypesRequest generates a "aws/request.Request" representing the client's request for the DescribeAdjustmentTypes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAdjustmentTypes for more information on using the DescribeAdjustmentTypes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeAdjustmentTypesRequest method.
req, resp := client.DescribeAdjustmentTypesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeAdjustmentTypes

func (*AutoScaling) DescribeAdjustmentTypesWithContext added in v1.8.0

func (c *AutoScaling) DescribeAdjustmentTypesWithContext(ctx aws.Context, input *DescribeAdjustmentTypesInput, opts ...request.Option) (*DescribeAdjustmentTypesOutput, error)

DescribeAdjustmentTypesWithContext is the same as DescribeAdjustmentTypes with the addition of the ability to pass a context and additional request options.

See DescribeAdjustmentTypes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DescribeAutoScalingGroups

func (c *AutoScaling) DescribeAutoScalingGroups(input *DescribeAutoScalingGroupsInput) (*DescribeAutoScalingGroupsOutput, error)

DescribeAutoScalingGroups API operation for Auto Scaling.

Gets information about the Auto Scaling groups in the account and Region.

If you specify Auto Scaling group names, the output includes information for only the specified Auto Scaling groups. If you specify filters, the output includes information for only those Auto Scaling groups that meet the filter criteria. If you do not specify group names or filters, the output includes information for all Auto Scaling groups.

This operation also returns information about instances in Auto Scaling groups. To retrieve information about the instances in a warm pool, you must call the DescribeWarmPool API.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation DescribeAutoScalingGroups for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidNextToken "InvalidNextToken" The NextToken value is not valid.

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeAutoScalingGroups

Example (Shared00)

To describe an Auto Scaling group This example describes the specified Auto Scaling group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.DescribeAutoScalingGroupsInput{
		AutoScalingGroupNames: []*string{
			aws.String("my-auto-scaling-group"),
		},
	}

	result, err := svc.DescribeAutoScalingGroups(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeInvalidNextToken:
				fmt.Println(autoscaling.ErrCodeInvalidNextToken, aerr.Error())
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) DescribeAutoScalingGroupsPages

func (c *AutoScaling) DescribeAutoScalingGroupsPages(input *DescribeAutoScalingGroupsInput, fn func(*DescribeAutoScalingGroupsOutput, bool) bool) error

DescribeAutoScalingGroupsPages iterates over the pages of a DescribeAutoScalingGroups operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeAutoScalingGroups method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeAutoScalingGroups operation.
pageNum := 0
err := client.DescribeAutoScalingGroupsPages(params,
    func(page *autoscaling.DescribeAutoScalingGroupsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*AutoScaling) DescribeAutoScalingGroupsPagesWithContext added in v1.8.0

func (c *AutoScaling) DescribeAutoScalingGroupsPagesWithContext(ctx aws.Context, input *DescribeAutoScalingGroupsInput, fn func(*DescribeAutoScalingGroupsOutput, bool) bool, opts ...request.Option) error

DescribeAutoScalingGroupsPagesWithContext same as DescribeAutoScalingGroupsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DescribeAutoScalingGroupsRequest

func (c *AutoScaling) DescribeAutoScalingGroupsRequest(input *DescribeAutoScalingGroupsInput) (req *request.Request, output *DescribeAutoScalingGroupsOutput)

DescribeAutoScalingGroupsRequest generates a "aws/request.Request" representing the client's request for the DescribeAutoScalingGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAutoScalingGroups for more information on using the DescribeAutoScalingGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeAutoScalingGroupsRequest method.
req, resp := client.DescribeAutoScalingGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeAutoScalingGroups

func (*AutoScaling) DescribeAutoScalingGroupsWithContext added in v1.8.0

func (c *AutoScaling) DescribeAutoScalingGroupsWithContext(ctx aws.Context, input *DescribeAutoScalingGroupsInput, opts ...request.Option) (*DescribeAutoScalingGroupsOutput, error)

DescribeAutoScalingGroupsWithContext is the same as DescribeAutoScalingGroups with the addition of the ability to pass a context and additional request options.

See DescribeAutoScalingGroups for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DescribeAutoScalingInstances

func (c *AutoScaling) DescribeAutoScalingInstances(input *DescribeAutoScalingInstancesInput) (*DescribeAutoScalingInstancesOutput, error)

DescribeAutoScalingInstances API operation for Auto Scaling.

Gets information about the Auto Scaling instances in the account and Region.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation DescribeAutoScalingInstances for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidNextToken "InvalidNextToken" The NextToken value is not valid.

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeAutoScalingInstances

Example (Shared00)

To describe one or more Auto Scaling instances This example describes the specified Auto Scaling instance.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.DescribeAutoScalingInstancesInput{
		InstanceIds: []*string{
			aws.String("i-05b4f7d5be44822a6"),
		},
	}

	result, err := svc.DescribeAutoScalingInstances(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeInvalidNextToken:
				fmt.Println(autoscaling.ErrCodeInvalidNextToken, aerr.Error())
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) DescribeAutoScalingInstancesPages

func (c *AutoScaling) DescribeAutoScalingInstancesPages(input *DescribeAutoScalingInstancesInput, fn func(*DescribeAutoScalingInstancesOutput, bool) bool) error

DescribeAutoScalingInstancesPages iterates over the pages of a DescribeAutoScalingInstances operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeAutoScalingInstances method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeAutoScalingInstances operation.
pageNum := 0
err := client.DescribeAutoScalingInstancesPages(params,
    func(page *autoscaling.DescribeAutoScalingInstancesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*AutoScaling) DescribeAutoScalingInstancesPagesWithContext added in v1.8.0

func (c *AutoScaling) DescribeAutoScalingInstancesPagesWithContext(ctx aws.Context, input *DescribeAutoScalingInstancesInput, fn func(*DescribeAutoScalingInstancesOutput, bool) bool, opts ...request.Option) error

DescribeAutoScalingInstancesPagesWithContext same as DescribeAutoScalingInstancesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DescribeAutoScalingInstancesRequest

func (c *AutoScaling) DescribeAutoScalingInstancesRequest(input *DescribeAutoScalingInstancesInput) (req *request.Request, output *DescribeAutoScalingInstancesOutput)

DescribeAutoScalingInstancesRequest generates a "aws/request.Request" representing the client's request for the DescribeAutoScalingInstances operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAutoScalingInstances for more information on using the DescribeAutoScalingInstances API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeAutoScalingInstancesRequest method.
req, resp := client.DescribeAutoScalingInstancesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeAutoScalingInstances

func (*AutoScaling) DescribeAutoScalingInstancesWithContext added in v1.8.0

func (c *AutoScaling) DescribeAutoScalingInstancesWithContext(ctx aws.Context, input *DescribeAutoScalingInstancesInput, opts ...request.Option) (*DescribeAutoScalingInstancesOutput, error)

DescribeAutoScalingInstancesWithContext is the same as DescribeAutoScalingInstances with the addition of the ability to pass a context and additional request options.

See DescribeAutoScalingInstances for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DescribeAutoScalingNotificationTypes

DescribeAutoScalingNotificationTypes API operation for Auto Scaling.

Describes the notification types that are supported by Amazon EC2 Auto Scaling.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation DescribeAutoScalingNotificationTypes for usage and error information.

Returned Error Codes:

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeAutoScalingNotificationTypes

Example (Shared00)

To describe the Auto Scaling notification types This example describes the available notification types.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.DescribeAutoScalingNotificationTypesInput{}

	result, err := svc.DescribeAutoScalingNotificationTypes(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) DescribeAutoScalingNotificationTypesRequest

func (c *AutoScaling) DescribeAutoScalingNotificationTypesRequest(input *DescribeAutoScalingNotificationTypesInput) (req *request.Request, output *DescribeAutoScalingNotificationTypesOutput)

DescribeAutoScalingNotificationTypesRequest generates a "aws/request.Request" representing the client's request for the DescribeAutoScalingNotificationTypes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAutoScalingNotificationTypes for more information on using the DescribeAutoScalingNotificationTypes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeAutoScalingNotificationTypesRequest method.
req, resp := client.DescribeAutoScalingNotificationTypesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeAutoScalingNotificationTypes

func (*AutoScaling) DescribeAutoScalingNotificationTypesWithContext added in v1.8.0

func (c *AutoScaling) DescribeAutoScalingNotificationTypesWithContext(ctx aws.Context, input *DescribeAutoScalingNotificationTypesInput, opts ...request.Option) (*DescribeAutoScalingNotificationTypesOutput, error)

DescribeAutoScalingNotificationTypesWithContext is the same as DescribeAutoScalingNotificationTypes with the addition of the ability to pass a context and additional request options.

See DescribeAutoScalingNotificationTypes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DescribeInstanceRefreshes added in v1.32.3

func (c *AutoScaling) DescribeInstanceRefreshes(input *DescribeInstanceRefreshesInput) (*DescribeInstanceRefreshesOutput, error)

DescribeInstanceRefreshes API operation for Auto Scaling.

Gets information about the instance refreshes for the specified Auto Scaling group.

This operation is part of the instance refresh feature (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html) in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.

To help you determine the status of an instance refresh, Amazon EC2 Auto Scaling returns information about the instance refreshes you previously initiated, including their status, start time, end time, the percentage of the instance refresh that is complete, and the number of instances remaining to update before the instance refresh is complete. If a rollback is initiated while an instance refresh is in progress, Amazon EC2 Auto Scaling also returns information about the rollback of the instance refresh.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation DescribeInstanceRefreshes for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidNextToken "InvalidNextToken" The NextToken value is not valid.

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeInstanceRefreshes

Example (Shared00)

To list instance refreshes This example describes the instance refreshes for the specified Auto Scaling group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.DescribeInstanceRefreshesInput{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
	}

	result, err := svc.DescribeInstanceRefreshes(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeInvalidNextToken:
				fmt.Println(autoscaling.ErrCodeInvalidNextToken, aerr.Error())
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) DescribeInstanceRefreshesRequest added in v1.32.3

func (c *AutoScaling) DescribeInstanceRefreshesRequest(input *DescribeInstanceRefreshesInput) (req *request.Request, output *DescribeInstanceRefreshesOutput)

DescribeInstanceRefreshesRequest generates a "aws/request.Request" representing the client's request for the DescribeInstanceRefreshes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeInstanceRefreshes for more information on using the DescribeInstanceRefreshes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeInstanceRefreshesRequest method.
req, resp := client.DescribeInstanceRefreshesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeInstanceRefreshes

func (*AutoScaling) DescribeInstanceRefreshesWithContext added in v1.32.3

func (c *AutoScaling) DescribeInstanceRefreshesWithContext(ctx aws.Context, input *DescribeInstanceRefreshesInput, opts ...request.Option) (*DescribeInstanceRefreshesOutput, error)

DescribeInstanceRefreshesWithContext is the same as DescribeInstanceRefreshes with the addition of the ability to pass a context and additional request options.

See DescribeInstanceRefreshes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DescribeLaunchConfigurations

func (c *AutoScaling) DescribeLaunchConfigurations(input *DescribeLaunchConfigurationsInput) (*DescribeLaunchConfigurationsOutput, error)

DescribeLaunchConfigurations API operation for Auto Scaling.

Gets information about the launch configurations in the account and Region.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation DescribeLaunchConfigurations for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidNextToken "InvalidNextToken" The NextToken value is not valid.

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeLaunchConfigurations

Example (Shared00)

To describe Auto Scaling launch configurations This example describes the specified launch configuration.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.DescribeLaunchConfigurationsInput{
		LaunchConfigurationNames: []*string{
			aws.String("my-launch-config"),
		},
	}

	result, err := svc.DescribeLaunchConfigurations(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeInvalidNextToken:
				fmt.Println(autoscaling.ErrCodeInvalidNextToken, aerr.Error())
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) DescribeLaunchConfigurationsPages

func (c *AutoScaling) DescribeLaunchConfigurationsPages(input *DescribeLaunchConfigurationsInput, fn func(*DescribeLaunchConfigurationsOutput, bool) bool) error

DescribeLaunchConfigurationsPages iterates over the pages of a DescribeLaunchConfigurations operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeLaunchConfigurations method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeLaunchConfigurations operation.
pageNum := 0
err := client.DescribeLaunchConfigurationsPages(params,
    func(page *autoscaling.DescribeLaunchConfigurationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*AutoScaling) DescribeLaunchConfigurationsPagesWithContext added in v1.8.0

func (c *AutoScaling) DescribeLaunchConfigurationsPagesWithContext(ctx aws.Context, input *DescribeLaunchConfigurationsInput, fn func(*DescribeLaunchConfigurationsOutput, bool) bool, opts ...request.Option) error

DescribeLaunchConfigurationsPagesWithContext same as DescribeLaunchConfigurationsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DescribeLaunchConfigurationsRequest

func (c *AutoScaling) DescribeLaunchConfigurationsRequest(input *DescribeLaunchConfigurationsInput) (req *request.Request, output *DescribeLaunchConfigurationsOutput)

DescribeLaunchConfigurationsRequest generates a "aws/request.Request" representing the client's request for the DescribeLaunchConfigurations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeLaunchConfigurations for more information on using the DescribeLaunchConfigurations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeLaunchConfigurationsRequest method.
req, resp := client.DescribeLaunchConfigurationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeLaunchConfigurations

func (*AutoScaling) DescribeLaunchConfigurationsWithContext added in v1.8.0

func (c *AutoScaling) DescribeLaunchConfigurationsWithContext(ctx aws.Context, input *DescribeLaunchConfigurationsInput, opts ...request.Option) (*DescribeLaunchConfigurationsOutput, error)

DescribeLaunchConfigurationsWithContext is the same as DescribeLaunchConfigurations with the addition of the ability to pass a context and additional request options.

See DescribeLaunchConfigurations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DescribeLifecycleHookTypes

func (c *AutoScaling) DescribeLifecycleHookTypes(input *DescribeLifecycleHookTypesInput) (*DescribeLifecycleHookTypesOutput, error)

DescribeLifecycleHookTypes API operation for Auto Scaling.

Describes the available types of lifecycle hooks.

The following hook types are supported:

  • autoscaling:EC2_INSTANCE_LAUNCHING

  • autoscaling:EC2_INSTANCE_TERMINATING

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation DescribeLifecycleHookTypes for usage and error information.

Returned Error Codes:

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeLifecycleHookTypes

Example (Shared00)

To describe the available types of lifecycle hooks This example describes the available lifecycle hook types.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.DescribeLifecycleHookTypesInput{}

	result, err := svc.DescribeLifecycleHookTypes(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) DescribeLifecycleHookTypesRequest

func (c *AutoScaling) DescribeLifecycleHookTypesRequest(input *DescribeLifecycleHookTypesInput) (req *request.Request, output *DescribeLifecycleHookTypesOutput)

DescribeLifecycleHookTypesRequest generates a "aws/request.Request" representing the client's request for the DescribeLifecycleHookTypes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeLifecycleHookTypes for more information on using the DescribeLifecycleHookTypes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeLifecycleHookTypesRequest method.
req, resp := client.DescribeLifecycleHookTypesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeLifecycleHookTypes

func (*AutoScaling) DescribeLifecycleHookTypesWithContext added in v1.8.0

func (c *AutoScaling) DescribeLifecycleHookTypesWithContext(ctx aws.Context, input *DescribeLifecycleHookTypesInput, opts ...request.Option) (*DescribeLifecycleHookTypesOutput, error)

DescribeLifecycleHookTypesWithContext is the same as DescribeLifecycleHookTypes with the addition of the ability to pass a context and additional request options.

See DescribeLifecycleHookTypes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DescribeLifecycleHooks

func (c *AutoScaling) DescribeLifecycleHooks(input *DescribeLifecycleHooksInput) (*DescribeLifecycleHooksOutput, error)

DescribeLifecycleHooks API operation for Auto Scaling.

Gets information about the lifecycle hooks for the specified Auto Scaling group.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation DescribeLifecycleHooks for usage and error information.

Returned Error Codes:

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeLifecycleHooks

Example (Shared00)

To describe your lifecycle hooks This example describes the lifecycle hooks for the specified Auto Scaling group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.DescribeLifecycleHooksInput{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
	}

	result, err := svc.DescribeLifecycleHooks(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) DescribeLifecycleHooksRequest

func (c *AutoScaling) DescribeLifecycleHooksRequest(input *DescribeLifecycleHooksInput) (req *request.Request, output *DescribeLifecycleHooksOutput)

DescribeLifecycleHooksRequest generates a "aws/request.Request" representing the client's request for the DescribeLifecycleHooks operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeLifecycleHooks for more information on using the DescribeLifecycleHooks API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeLifecycleHooksRequest method.
req, resp := client.DescribeLifecycleHooksRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeLifecycleHooks

func (*AutoScaling) DescribeLifecycleHooksWithContext added in v1.8.0

func (c *AutoScaling) DescribeLifecycleHooksWithContext(ctx aws.Context, input *DescribeLifecycleHooksInput, opts ...request.Option) (*DescribeLifecycleHooksOutput, error)

DescribeLifecycleHooksWithContext is the same as DescribeLifecycleHooks with the addition of the ability to pass a context and additional request options.

See DescribeLifecycleHooks for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DescribeLoadBalancerTargetGroups added in v1.4.1

DescribeLoadBalancerTargetGroups API operation for Auto Scaling.

This API operation is superseded by DescribeTrafficSources, which can describe multiple traffic sources types. We recommend using DetachTrafficSources to simplify how you manage traffic sources. However, we continue to support DescribeLoadBalancerTargetGroups. You can use both the original DescribeLoadBalancerTargetGroups API operation and DescribeTrafficSources on the same Auto Scaling group.

Gets information about the Elastic Load Balancing target groups for the specified Auto Scaling group.

To determine the attachment status of the target group, use the State element in the response. When you attach a target group to an Auto Scaling group, the initial State value is Adding. The state transitions to Added after all Auto Scaling instances are registered with the target group. If Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to InService after at least one Auto Scaling instance passes the health check. When the target group is in the InService state, Amazon EC2 Auto Scaling can terminate and replace any instances that are reported as unhealthy. If no registered instances pass the health checks, the target group doesn't enter the InService state.

Target groups also have an InService state if you attach them in the CreateAutoScalingGroup API call. If your target group state is InService, but it is not working properly, check the scaling activities by calling DescribeScalingActivities and take any corrective actions necessary.

For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling: Health checks (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ts-as-healthchecks.html) in the Amazon EC2 Auto Scaling User Guide. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group (https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) in the Amazon EC2 Auto Scaling User Guide.

You can use this operation to describe target groups that were attached by using AttachLoadBalancerTargetGroups, but not for target groups that were attached by using AttachTrafficSources.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation DescribeLoadBalancerTargetGroups for usage and error information.

Returned Error Codes:

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

  • ErrCodeInvalidNextToken "InvalidNextToken" The NextToken value is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeLoadBalancerTargetGroups

Example (Shared00)

To describe the target groups for an Auto Scaling group This example describes the target groups attached to the specified Auto Scaling group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.DescribeLoadBalancerTargetGroupsInput{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
	}

	result, err := svc.DescribeLoadBalancerTargetGroups(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			case autoscaling.ErrCodeInvalidNextToken:
				fmt.Println(autoscaling.ErrCodeInvalidNextToken, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) DescribeLoadBalancerTargetGroupsRequest added in v1.4.1

func (c *AutoScaling) DescribeLoadBalancerTargetGroupsRequest(input *DescribeLoadBalancerTargetGroupsInput) (req *request.Request, output *DescribeLoadBalancerTargetGroupsOutput)

DescribeLoadBalancerTargetGroupsRequest generates a "aws/request.Request" representing the client's request for the DescribeLoadBalancerTargetGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeLoadBalancerTargetGroups for more information on using the DescribeLoadBalancerTargetGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeLoadBalancerTargetGroupsRequest method.
req, resp := client.DescribeLoadBalancerTargetGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeLoadBalancerTargetGroups

func (*AutoScaling) DescribeLoadBalancerTargetGroupsWithContext added in v1.8.0

func (c *AutoScaling) DescribeLoadBalancerTargetGroupsWithContext(ctx aws.Context, input *DescribeLoadBalancerTargetGroupsInput, opts ...request.Option) (*DescribeLoadBalancerTargetGroupsOutput, error)

DescribeLoadBalancerTargetGroupsWithContext is the same as DescribeLoadBalancerTargetGroups with the addition of the ability to pass a context and additional request options.

See DescribeLoadBalancerTargetGroups for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DescribeLoadBalancers added in v0.6.2

func (c *AutoScaling) DescribeLoadBalancers(input *DescribeLoadBalancersInput) (*DescribeLoadBalancersOutput, error)

DescribeLoadBalancers API operation for Auto Scaling.

This API operation is superseded by DescribeTrafficSources, which can describe multiple traffic sources types. We recommend using DescribeTrafficSources to simplify how you manage traffic sources. However, we continue to support DescribeLoadBalancers. You can use both the original DescribeLoadBalancers API operation and DescribeTrafficSources on the same Auto Scaling group.

Gets information about the load balancers for the specified Auto Scaling group.

This operation describes only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancers, use the DescribeLoadBalancerTargetGroups API instead.

To determine the attachment status of the load balancer, use the State element in the response. When you attach a load balancer to an Auto Scaling group, the initial State value is Adding. The state transitions to Added after all Auto Scaling instances are registered with the load balancer. If Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to InService after at least one Auto Scaling instance passes the health check. When the load balancer is in the InService state, Amazon EC2 Auto Scaling can terminate and replace any instances that are reported as unhealthy. If no registered instances pass the health checks, the load balancer doesn't enter the InService state.

Load balancers also have an InService state if you attach them in the CreateAutoScalingGroup API call. If your load balancer state is InService, but it is not working properly, check the scaling activities by calling DescribeScalingActivities and take any corrective actions necessary.

For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling: Health checks (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ts-as-healthchecks.html) in the Amazon EC2 Auto Scaling User Guide. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group (https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) in the Amazon EC2 Auto Scaling User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation DescribeLoadBalancers for usage and error information.

Returned Error Codes:

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

  • ErrCodeInvalidNextToken "InvalidNextToken" The NextToken value is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeLoadBalancers

Example (Shared00)

To describe the load balancers for an Auto Scaling group This example describes the load balancers attached to the specified Auto Scaling group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.DescribeLoadBalancersInput{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
	}

	result, err := svc.DescribeLoadBalancers(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			case autoscaling.ErrCodeInvalidNextToken:
				fmt.Println(autoscaling.ErrCodeInvalidNextToken, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) DescribeLoadBalancersRequest added in v0.6.2

func (c *AutoScaling) DescribeLoadBalancersRequest(input *DescribeLoadBalancersInput) (req *request.Request, output *DescribeLoadBalancersOutput)

DescribeLoadBalancersRequest generates a "aws/request.Request" representing the client's request for the DescribeLoadBalancers operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeLoadBalancers for more information on using the DescribeLoadBalancers API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeLoadBalancersRequest method.
req, resp := client.DescribeLoadBalancersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeLoadBalancers

func (*AutoScaling) DescribeLoadBalancersWithContext added in v1.8.0

func (c *AutoScaling) DescribeLoadBalancersWithContext(ctx aws.Context, input *DescribeLoadBalancersInput, opts ...request.Option) (*DescribeLoadBalancersOutput, error)

DescribeLoadBalancersWithContext is the same as DescribeLoadBalancers with the addition of the ability to pass a context and additional request options.

See DescribeLoadBalancers for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DescribeMetricCollectionTypes

func (c *AutoScaling) DescribeMetricCollectionTypes(input *DescribeMetricCollectionTypesInput) (*DescribeMetricCollectionTypesOutput, error)

DescribeMetricCollectionTypes API operation for Auto Scaling.

Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation DescribeMetricCollectionTypes for usage and error information.

Returned Error Codes:

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeMetricCollectionTypes

Example (Shared00)

To describe the Auto Scaling metric collection types This example describes the available metric collection types.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.DescribeMetricCollectionTypesInput{}

	result, err := svc.DescribeMetricCollectionTypes(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) DescribeMetricCollectionTypesRequest

func (c *AutoScaling) DescribeMetricCollectionTypesRequest(input *DescribeMetricCollectionTypesInput) (req *request.Request, output *DescribeMetricCollectionTypesOutput)

DescribeMetricCollectionTypesRequest generates a "aws/request.Request" representing the client's request for the DescribeMetricCollectionTypes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeMetricCollectionTypes for more information on using the DescribeMetricCollectionTypes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeMetricCollectionTypesRequest method.
req, resp := client.DescribeMetricCollectionTypesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeMetricCollectionTypes

func (*AutoScaling) DescribeMetricCollectionTypesWithContext added in v1.8.0

func (c *AutoScaling) DescribeMetricCollectionTypesWithContext(ctx aws.Context, input *DescribeMetricCollectionTypesInput, opts ...request.Option) (*DescribeMetricCollectionTypesOutput, error)

DescribeMetricCollectionTypesWithContext is the same as DescribeMetricCollectionTypes with the addition of the ability to pass a context and additional request options.

See DescribeMetricCollectionTypes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DescribeNotificationConfigurations

DescribeNotificationConfigurations API operation for Auto Scaling.

Gets information about the Amazon SNS notifications that are configured for one or more Auto Scaling groups.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation DescribeNotificationConfigurations for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidNextToken "InvalidNextToken" The NextToken value is not valid.

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeNotificationConfigurations

Example (Shared00)

To describe Auto Scaling notification configurations This example describes the notification configurations for the specified Auto Scaling group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.DescribeNotificationConfigurationsInput{
		AutoScalingGroupNames: []*string{
			aws.String("my-auto-scaling-group"),
		},
	}

	result, err := svc.DescribeNotificationConfigurations(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeInvalidNextToken:
				fmt.Println(autoscaling.ErrCodeInvalidNextToken, aerr.Error())
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) DescribeNotificationConfigurationsPages

func (c *AutoScaling) DescribeNotificationConfigurationsPages(input *DescribeNotificationConfigurationsInput, fn func(*DescribeNotificationConfigurationsOutput, bool) bool) error

DescribeNotificationConfigurationsPages iterates over the pages of a DescribeNotificationConfigurations operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeNotificationConfigurations method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeNotificationConfigurations operation.
pageNum := 0
err := client.DescribeNotificationConfigurationsPages(params,
    func(page *autoscaling.DescribeNotificationConfigurationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*AutoScaling) DescribeNotificationConfigurationsPagesWithContext added in v1.8.0

func (c *AutoScaling) DescribeNotificationConfigurationsPagesWithContext(ctx aws.Context, input *DescribeNotificationConfigurationsInput, fn func(*DescribeNotificationConfigurationsOutput, bool) bool, opts ...request.Option) error

DescribeNotificationConfigurationsPagesWithContext same as DescribeNotificationConfigurationsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DescribeNotificationConfigurationsRequest

func (c *AutoScaling) DescribeNotificationConfigurationsRequest(input *DescribeNotificationConfigurationsInput) (req *request.Request, output *DescribeNotificationConfigurationsOutput)

DescribeNotificationConfigurationsRequest generates a "aws/request.Request" representing the client's request for the DescribeNotificationConfigurations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeNotificationConfigurations for more information on using the DescribeNotificationConfigurations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeNotificationConfigurationsRequest method.
req, resp := client.DescribeNotificationConfigurationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeNotificationConfigurations

func (*AutoScaling) DescribeNotificationConfigurationsWithContext added in v1.8.0

func (c *AutoScaling) DescribeNotificationConfigurationsWithContext(ctx aws.Context, input *DescribeNotificationConfigurationsInput, opts ...request.Option) (*DescribeNotificationConfigurationsOutput, error)

DescribeNotificationConfigurationsWithContext is the same as DescribeNotificationConfigurations with the addition of the ability to pass a context and additional request options.

See DescribeNotificationConfigurations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DescribePolicies

func (c *AutoScaling) DescribePolicies(input *DescribePoliciesInput) (*DescribePoliciesOutput, error)

DescribePolicies API operation for Auto Scaling.

Gets information about the scaling policies in the account and Region.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation DescribePolicies for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidNextToken "InvalidNextToken" The NextToken value is not valid.

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

  • ErrCodeServiceLinkedRoleFailure "ServiceLinkedRoleFailure" The service-linked role is not yet ready for use.

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribePolicies

Example (Shared00)

To describe scaling policies This example describes the policies for the specified Auto Scaling group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.DescribePoliciesInput{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
	}

	result, err := svc.DescribePolicies(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeInvalidNextToken:
				fmt.Println(autoscaling.ErrCodeInvalidNextToken, aerr.Error())
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			case autoscaling.ErrCodeServiceLinkedRoleFailure:
				fmt.Println(autoscaling.ErrCodeServiceLinkedRoleFailure, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) DescribePoliciesPages

func (c *AutoScaling) DescribePoliciesPages(input *DescribePoliciesInput, fn func(*DescribePoliciesOutput, bool) bool) error

DescribePoliciesPages iterates over the pages of a DescribePolicies operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribePolicies method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribePolicies operation.
pageNum := 0
err := client.DescribePoliciesPages(params,
    func(page *autoscaling.DescribePoliciesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*AutoScaling) DescribePoliciesPagesWithContext added in v1.8.0

func (c *AutoScaling) DescribePoliciesPagesWithContext(ctx aws.Context, input *DescribePoliciesInput, fn func(*DescribePoliciesOutput, bool) bool, opts ...request.Option) error

DescribePoliciesPagesWithContext same as DescribePoliciesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DescribePoliciesRequest

func (c *AutoScaling) DescribePoliciesRequest(input *DescribePoliciesInput) (req *request.Request, output *DescribePoliciesOutput)

DescribePoliciesRequest generates a "aws/request.Request" representing the client's request for the DescribePolicies operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribePolicies for more information on using the DescribePolicies API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribePoliciesRequest method.
req, resp := client.DescribePoliciesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribePolicies

func (*AutoScaling) DescribePoliciesWithContext added in v1.8.0

func (c *AutoScaling) DescribePoliciesWithContext(ctx aws.Context, input *DescribePoliciesInput, opts ...request.Option) (*DescribePoliciesOutput, error)

DescribePoliciesWithContext is the same as DescribePolicies with the addition of the ability to pass a context and additional request options.

See DescribePolicies for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DescribeScalingActivities

func (c *AutoScaling) DescribeScalingActivities(input *DescribeScalingActivitiesInput) (*DescribeScalingActivitiesOutput, error)

DescribeScalingActivities API operation for Auto Scaling.

Gets information about the scaling activities in the account and Region.

When scaling events occur, you see a record of the scaling activity in the scaling activities. For more information, see Verifying a scaling activity for an Auto Scaling group (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-verify-scaling-activity.html) in the Amazon EC2 Auto Scaling User Guide.

If the scaling event succeeds, the value of the StatusCode element in the response is Successful. If an attempt to launch instances failed, the StatusCode value is Failed or Cancelled and the StatusMessage element in the response indicates the cause of the failure. For help interpreting the StatusMessage, see Troubleshooting Amazon EC2 Auto Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/CHAP_Troubleshooting.html) in the Amazon EC2 Auto Scaling User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation DescribeScalingActivities for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidNextToken "InvalidNextToken" The NextToken value is not valid.

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeScalingActivities

Example (Shared00)

To describe the scaling activities for an Auto Scaling group This example describes the scaling activities for the specified Auto Scaling group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.DescribeScalingActivitiesInput{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
	}

	result, err := svc.DescribeScalingActivities(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeInvalidNextToken:
				fmt.Println(autoscaling.ErrCodeInvalidNextToken, aerr.Error())
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) DescribeScalingActivitiesPages

func (c *AutoScaling) DescribeScalingActivitiesPages(input *DescribeScalingActivitiesInput, fn func(*DescribeScalingActivitiesOutput, bool) bool) error

DescribeScalingActivitiesPages iterates over the pages of a DescribeScalingActivities operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeScalingActivities method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeScalingActivities operation.
pageNum := 0
err := client.DescribeScalingActivitiesPages(params,
    func(page *autoscaling.DescribeScalingActivitiesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*AutoScaling) DescribeScalingActivitiesPagesWithContext added in v1.8.0

func (c *AutoScaling) DescribeScalingActivitiesPagesWithContext(ctx aws.Context, input *DescribeScalingActivitiesInput, fn func(*DescribeScalingActivitiesOutput, bool) bool, opts ...request.Option) error

DescribeScalingActivitiesPagesWithContext same as DescribeScalingActivitiesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DescribeScalingActivitiesRequest

func (c *AutoScaling) DescribeScalingActivitiesRequest(input *DescribeScalingActivitiesInput) (req *request.Request, output *DescribeScalingActivitiesOutput)

DescribeScalingActivitiesRequest generates a "aws/request.Request" representing the client's request for the DescribeScalingActivities operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeScalingActivities for more information on using the DescribeScalingActivities API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeScalingActivitiesRequest method.
req, resp := client.DescribeScalingActivitiesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeScalingActivities

func (*AutoScaling) DescribeScalingActivitiesWithContext added in v1.8.0

func (c *AutoScaling) DescribeScalingActivitiesWithContext(ctx aws.Context, input *DescribeScalingActivitiesInput, opts ...request.Option) (*DescribeScalingActivitiesOutput, error)

DescribeScalingActivitiesWithContext is the same as DescribeScalingActivities with the addition of the ability to pass a context and additional request options.

See DescribeScalingActivities for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DescribeScalingProcessTypes

func (c *AutoScaling) DescribeScalingProcessTypes(input *DescribeScalingProcessTypesInput) (*DescribeScalingProcessTypesOutput, error)

DescribeScalingProcessTypes API operation for Auto Scaling.

Describes the scaling process types for use with the ResumeProcesses and SuspendProcesses APIs.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation DescribeScalingProcessTypes for usage and error information.

Returned Error Codes:

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeScalingProcessTypes

Example (Shared00)

To describe the Auto Scaling process types This example describes the Auto Scaling process types.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.DescribeScalingProcessTypesInput{}

	result, err := svc.DescribeScalingProcessTypes(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) DescribeScalingProcessTypesRequest

func (c *AutoScaling) DescribeScalingProcessTypesRequest(input *DescribeScalingProcessTypesInput) (req *request.Request, output *DescribeScalingProcessTypesOutput)

DescribeScalingProcessTypesRequest generates a "aws/request.Request" representing the client's request for the DescribeScalingProcessTypes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeScalingProcessTypes for more information on using the DescribeScalingProcessTypes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeScalingProcessTypesRequest method.
req, resp := client.DescribeScalingProcessTypesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeScalingProcessTypes

func (*AutoScaling) DescribeScalingProcessTypesWithContext added in v1.8.0

func (c *AutoScaling) DescribeScalingProcessTypesWithContext(ctx aws.Context, input *DescribeScalingProcessTypesInput, opts ...request.Option) (*DescribeScalingProcessTypesOutput, error)

DescribeScalingProcessTypesWithContext is the same as DescribeScalingProcessTypes with the addition of the ability to pass a context and additional request options.

See DescribeScalingProcessTypes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DescribeScheduledActions

func (c *AutoScaling) DescribeScheduledActions(input *DescribeScheduledActionsInput) (*DescribeScheduledActionsOutput, error)

DescribeScheduledActions API operation for Auto Scaling.

Gets information about the scheduled actions that haven't run or that have not reached their end time.

To describe the scaling activities for scheduled actions that have already run, call the DescribeScalingActivities API.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation DescribeScheduledActions for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidNextToken "InvalidNextToken" The NextToken value is not valid.

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeScheduledActions

Example (Shared00)

To describe scheduled actions This example describes the scheduled actions for the specified Auto Scaling group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.DescribeScheduledActionsInput{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
	}

	result, err := svc.DescribeScheduledActions(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeInvalidNextToken:
				fmt.Println(autoscaling.ErrCodeInvalidNextToken, aerr.Error())
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) DescribeScheduledActionsPages

func (c *AutoScaling) DescribeScheduledActionsPages(input *DescribeScheduledActionsInput, fn func(*DescribeScheduledActionsOutput, bool) bool) error

DescribeScheduledActionsPages iterates over the pages of a DescribeScheduledActions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeScheduledActions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeScheduledActions operation.
pageNum := 0
err := client.DescribeScheduledActionsPages(params,
    func(page *autoscaling.DescribeScheduledActionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*AutoScaling) DescribeScheduledActionsPagesWithContext added in v1.8.0

func (c *AutoScaling) DescribeScheduledActionsPagesWithContext(ctx aws.Context, input *DescribeScheduledActionsInput, fn func(*DescribeScheduledActionsOutput, bool) bool, opts ...request.Option) error

DescribeScheduledActionsPagesWithContext same as DescribeScheduledActionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DescribeScheduledActionsRequest

func (c *AutoScaling) DescribeScheduledActionsRequest(input *DescribeScheduledActionsInput) (req *request.Request, output *DescribeScheduledActionsOutput)

DescribeScheduledActionsRequest generates a "aws/request.Request" representing the client's request for the DescribeScheduledActions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeScheduledActions for more information on using the DescribeScheduledActions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeScheduledActionsRequest method.
req, resp := client.DescribeScheduledActionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeScheduledActions

func (*AutoScaling) DescribeScheduledActionsWithContext added in v1.8.0

func (c *AutoScaling) DescribeScheduledActionsWithContext(ctx aws.Context, input *DescribeScheduledActionsInput, opts ...request.Option) (*DescribeScheduledActionsOutput, error)

DescribeScheduledActionsWithContext is the same as DescribeScheduledActions with the addition of the ability to pass a context and additional request options.

See DescribeScheduledActions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DescribeTags

func (c *AutoScaling) DescribeTags(input *DescribeTagsInput) (*DescribeTagsOutput, error)

DescribeTags API operation for Auto Scaling.

Describes the specified tags.

You can use filters to limit the results. For example, you can query for the tags for a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results.

You can also specify multiple filters. The result includes information for a particular tag only if it matches all the filters. If there's no match, no special message is returned.

For more information, see Tag Auto Scaling groups and instances (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html) in the Amazon EC2 Auto Scaling User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation DescribeTags for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidNextToken "InvalidNextToken" The NextToken value is not valid.

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeTags

Example (Shared00)

To describe tags This example describes the tags for the specified Auto Scaling group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.DescribeTagsInput{
		Filters: []*autoscaling.Filter{
			{
				Name: aws.String("auto-scaling-group"),
				Values: []*string{
					aws.String("my-auto-scaling-group"),
				},
			},
		},
	}

	result, err := svc.DescribeTags(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeInvalidNextToken:
				fmt.Println(autoscaling.ErrCodeInvalidNextToken, aerr.Error())
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) DescribeTagsPages

func (c *AutoScaling) DescribeTagsPages(input *DescribeTagsInput, fn func(*DescribeTagsOutput, bool) bool) error

DescribeTagsPages iterates over the pages of a DescribeTags operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeTags method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeTags operation.
pageNum := 0
err := client.DescribeTagsPages(params,
    func(page *autoscaling.DescribeTagsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*AutoScaling) DescribeTagsPagesWithContext added in v1.8.0

func (c *AutoScaling) DescribeTagsPagesWithContext(ctx aws.Context, input *DescribeTagsInput, fn func(*DescribeTagsOutput, bool) bool, opts ...request.Option) error

DescribeTagsPagesWithContext same as DescribeTagsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DescribeTagsRequest

func (c *AutoScaling) DescribeTagsRequest(input *DescribeTagsInput) (req *request.Request, output *DescribeTagsOutput)

DescribeTagsRequest generates a "aws/request.Request" representing the client's request for the DescribeTags operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeTags for more information on using the DescribeTags API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeTagsRequest method.
req, resp := client.DescribeTagsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeTags

func (*AutoScaling) DescribeTagsWithContext added in v1.8.0

func (c *AutoScaling) DescribeTagsWithContext(ctx aws.Context, input *DescribeTagsInput, opts ...request.Option) (*DescribeTagsOutput, error)

DescribeTagsWithContext is the same as DescribeTags with the addition of the ability to pass a context and additional request options.

See DescribeTags for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DescribeTerminationPolicyTypes

func (c *AutoScaling) DescribeTerminationPolicyTypes(input *DescribeTerminationPolicyTypesInput) (*DescribeTerminationPolicyTypesOutput, error)

DescribeTerminationPolicyTypes API operation for Auto Scaling.

Describes the termination policies supported by Amazon EC2 Auto Scaling.

For more information, see Work with Amazon EC2 Auto Scaling termination policies (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html) in the Amazon EC2 Auto Scaling User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation DescribeTerminationPolicyTypes for usage and error information.

Returned Error Codes:

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeTerminationPolicyTypes

Example (Shared00)

To describe termination policy types This example describes the available termination policy types.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.DescribeTerminationPolicyTypesInput{}

	result, err := svc.DescribeTerminationPolicyTypes(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) DescribeTerminationPolicyTypesRequest

func (c *AutoScaling) DescribeTerminationPolicyTypesRequest(input *DescribeTerminationPolicyTypesInput) (req *request.Request, output *DescribeTerminationPolicyTypesOutput)

DescribeTerminationPolicyTypesRequest generates a "aws/request.Request" representing the client's request for the DescribeTerminationPolicyTypes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeTerminationPolicyTypes for more information on using the DescribeTerminationPolicyTypes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeTerminationPolicyTypesRequest method.
req, resp := client.DescribeTerminationPolicyTypesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeTerminationPolicyTypes

func (*AutoScaling) DescribeTerminationPolicyTypesWithContext added in v1.8.0

func (c *AutoScaling) DescribeTerminationPolicyTypesWithContext(ctx aws.Context, input *DescribeTerminationPolicyTypesInput, opts ...request.Option) (*DescribeTerminationPolicyTypesOutput, error)

DescribeTerminationPolicyTypesWithContext is the same as DescribeTerminationPolicyTypes with the addition of the ability to pass a context and additional request options.

See DescribeTerminationPolicyTypes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DescribeTrafficSources added in v1.44.156

func (c *AutoScaling) DescribeTrafficSources(input *DescribeTrafficSourcesInput) (*DescribeTrafficSourcesOutput, error)

DescribeTrafficSources API operation for Auto Scaling.

Gets information about the traffic sources for the specified Auto Scaling group.

You can optionally provide a traffic source type. If you provide a traffic source type, then the results only include that traffic source type.

If you do not provide a traffic source type, then the results include all the traffic sources for the specified Auto Scaling group.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation DescribeTrafficSources for usage and error information.

Returned Error Codes:

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

  • ErrCodeInvalidNextToken "InvalidNextToken" The NextToken value is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeTrafficSources

Example (Shared00)

To describe the target groups for an Auto Scaling group This example describes the target groups attached to the specified Auto Scaling group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.DescribeTrafficSourcesInput{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
	}

	result, err := svc.DescribeTrafficSources(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			case autoscaling.ErrCodeInvalidNextToken:
				fmt.Println(autoscaling.ErrCodeInvalidNextToken, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) DescribeTrafficSourcesPages added in v1.44.233

func (c *AutoScaling) DescribeTrafficSourcesPages(input *DescribeTrafficSourcesInput, fn func(*DescribeTrafficSourcesOutput, bool) bool) error

DescribeTrafficSourcesPages iterates over the pages of a DescribeTrafficSources operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeTrafficSources method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeTrafficSources operation.
pageNum := 0
err := client.DescribeTrafficSourcesPages(params,
    func(page *autoscaling.DescribeTrafficSourcesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*AutoScaling) DescribeTrafficSourcesPagesWithContext added in v1.44.233

func (c *AutoScaling) DescribeTrafficSourcesPagesWithContext(ctx aws.Context, input *DescribeTrafficSourcesInput, fn func(*DescribeTrafficSourcesOutput, bool) bool, opts ...request.Option) error

DescribeTrafficSourcesPagesWithContext same as DescribeTrafficSourcesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DescribeTrafficSourcesRequest added in v1.44.156

func (c *AutoScaling) DescribeTrafficSourcesRequest(input *DescribeTrafficSourcesInput) (req *request.Request, output *DescribeTrafficSourcesOutput)

DescribeTrafficSourcesRequest generates a "aws/request.Request" representing the client's request for the DescribeTrafficSources operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeTrafficSources for more information on using the DescribeTrafficSources API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeTrafficSourcesRequest method.
req, resp := client.DescribeTrafficSourcesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeTrafficSources

func (*AutoScaling) DescribeTrafficSourcesWithContext added in v1.44.156

func (c *AutoScaling) DescribeTrafficSourcesWithContext(ctx aws.Context, input *DescribeTrafficSourcesInput, opts ...request.Option) (*DescribeTrafficSourcesOutput, error)

DescribeTrafficSourcesWithContext is the same as DescribeTrafficSources with the addition of the ability to pass a context and additional request options.

See DescribeTrafficSources for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DescribeWarmPool added in v1.38.16

func (c *AutoScaling) DescribeWarmPool(input *DescribeWarmPoolInput) (*DescribeWarmPoolOutput, error)

DescribeWarmPool API operation for Auto Scaling.

Gets information about a warm pool and its instances.

For more information, see Warm pools for Amazon EC2 Auto Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html) in the Amazon EC2 Auto Scaling User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation DescribeWarmPool for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidNextToken "InvalidNextToken" The NextToken value is not valid.

  • ErrCodeLimitExceededFault "LimitExceeded" You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DescribeAccountLimits.html) in the Amazon EC2 Auto Scaling API Reference.

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeWarmPool

func (*AutoScaling) DescribeWarmPoolPages added in v1.44.310

func (c *AutoScaling) DescribeWarmPoolPages(input *DescribeWarmPoolInput, fn func(*DescribeWarmPoolOutput, bool) bool) error

DescribeWarmPoolPages iterates over the pages of a DescribeWarmPool operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeWarmPool method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeWarmPool operation.
pageNum := 0
err := client.DescribeWarmPoolPages(params,
    func(page *autoscaling.DescribeWarmPoolOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*AutoScaling) DescribeWarmPoolPagesWithContext added in v1.44.310

func (c *AutoScaling) DescribeWarmPoolPagesWithContext(ctx aws.Context, input *DescribeWarmPoolInput, fn func(*DescribeWarmPoolOutput, bool) bool, opts ...request.Option) error

DescribeWarmPoolPagesWithContext same as DescribeWarmPoolPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DescribeWarmPoolRequest added in v1.38.16

func (c *AutoScaling) DescribeWarmPoolRequest(input *DescribeWarmPoolInput) (req *request.Request, output *DescribeWarmPoolOutput)

DescribeWarmPoolRequest generates a "aws/request.Request" representing the client's request for the DescribeWarmPool operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeWarmPool for more information on using the DescribeWarmPool API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeWarmPoolRequest method.
req, resp := client.DescribeWarmPoolRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeWarmPool

func (*AutoScaling) DescribeWarmPoolWithContext added in v1.38.16

func (c *AutoScaling) DescribeWarmPoolWithContext(ctx aws.Context, input *DescribeWarmPoolInput, opts ...request.Option) (*DescribeWarmPoolOutput, error)

DescribeWarmPoolWithContext is the same as DescribeWarmPool with the addition of the ability to pass a context and additional request options.

See DescribeWarmPool for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DetachInstances

func (c *AutoScaling) DetachInstances(input *DetachInstancesInput) (*DetachInstancesOutput, error)

DetachInstances API operation for Auto Scaling.

Removes one or more instances from the specified Auto Scaling group.

After the instances are detached, you can manage them independent of the Auto Scaling group.

If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are detached.

If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are deregistered from the load balancer. If there are target groups attached to the Auto Scaling group, the instances are deregistered from the target groups.

For more information, see Detach EC2 instances from your Auto Scaling group (https://docs.aws.amazon.com/autoscaling/ec2/userguide/detach-instance-asg.html) in the Amazon EC2 Auto Scaling User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation DetachInstances for usage and error information.

Returned Error Codes:

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DetachInstances

Example (Shared00)

To detach an instance from an Auto Scaling group This example detaches the specified instance from the specified Auto Scaling group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.DetachInstancesInput{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
		InstanceIds: []*string{
			aws.String("i-93633f9b"),
		},
		ShouldDecrementDesiredCapacity: aws.Bool(true),
	}

	result, err := svc.DetachInstances(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) DetachInstancesRequest

func (c *AutoScaling) DetachInstancesRequest(input *DetachInstancesInput) (req *request.Request, output *DetachInstancesOutput)

DetachInstancesRequest generates a "aws/request.Request" representing the client's request for the DetachInstances operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DetachInstances for more information on using the DetachInstances API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DetachInstancesRequest method.
req, resp := client.DetachInstancesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DetachInstances

func (*AutoScaling) DetachInstancesWithContext added in v1.8.0

func (c *AutoScaling) DetachInstancesWithContext(ctx aws.Context, input *DetachInstancesInput, opts ...request.Option) (*DetachInstancesOutput, error)

DetachInstancesWithContext is the same as DetachInstances with the addition of the ability to pass a context and additional request options.

See DetachInstances for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DetachLoadBalancerTargetGroups added in v1.4.1

func (c *AutoScaling) DetachLoadBalancerTargetGroups(input *DetachLoadBalancerTargetGroupsInput) (*DetachLoadBalancerTargetGroupsOutput, error)

DetachLoadBalancerTargetGroups API operation for Auto Scaling.

This API operation is superseded by DetachTrafficSources, which can detach multiple traffic sources types. We recommend using DetachTrafficSources to simplify how you manage traffic sources. However, we continue to support DetachLoadBalancerTargetGroups. You can use both the original DetachLoadBalancerTargetGroups API operation and DetachTrafficSources on the same Auto Scaling group.

Detaches one or more target groups from the specified Auto Scaling group.

When you detach a target group, it enters the Removing state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the target group using the DescribeLoadBalancerTargetGroups API call. The instances remain running.

You can use this operation to detach target groups that were attached by using AttachLoadBalancerTargetGroups, but not for target groups that were attached by using AttachTrafficSources.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation DetachLoadBalancerTargetGroups for usage and error information.

Returned Error Codes:

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DetachLoadBalancerTargetGroups

Example (Shared00)

To detach a target group from an Auto Scaling group This example detaches the specified target group from the specified Auto Scaling group

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.DetachLoadBalancerTargetGroupsInput{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
		TargetGroupARNs: []*string{
			aws.String("arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"),
		},
	}

	result, err := svc.DetachLoadBalancerTargetGroups(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) DetachLoadBalancerTargetGroupsRequest added in v1.4.1

func (c *AutoScaling) DetachLoadBalancerTargetGroupsRequest(input *DetachLoadBalancerTargetGroupsInput) (req *request.Request, output *DetachLoadBalancerTargetGroupsOutput)

DetachLoadBalancerTargetGroupsRequest generates a "aws/request.Request" representing the client's request for the DetachLoadBalancerTargetGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DetachLoadBalancerTargetGroups for more information on using the DetachLoadBalancerTargetGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DetachLoadBalancerTargetGroupsRequest method.
req, resp := client.DetachLoadBalancerTargetGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DetachLoadBalancerTargetGroups

func (*AutoScaling) DetachLoadBalancerTargetGroupsWithContext added in v1.8.0

func (c *AutoScaling) DetachLoadBalancerTargetGroupsWithContext(ctx aws.Context, input *DetachLoadBalancerTargetGroupsInput, opts ...request.Option) (*DetachLoadBalancerTargetGroupsOutput, error)

DetachLoadBalancerTargetGroupsWithContext is the same as DetachLoadBalancerTargetGroups with the addition of the ability to pass a context and additional request options.

See DetachLoadBalancerTargetGroups for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DetachLoadBalancers added in v0.6.2

func (c *AutoScaling) DetachLoadBalancers(input *DetachLoadBalancersInput) (*DetachLoadBalancersOutput, error)

DetachLoadBalancers API operation for Auto Scaling.

This API operation is superseded by DetachTrafficSources, which can detach multiple traffic sources types. We recommend using DetachTrafficSources to simplify how you manage traffic sources. However, we continue to support DetachLoadBalancers. You can use both the original DetachLoadBalancers API operation and DetachTrafficSources on the same Auto Scaling group.

Detaches one or more Classic Load Balancers from the specified Auto Scaling group.

This operation detaches only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancers, use the DetachLoadBalancerTargetGroups API instead.

When you detach a load balancer, it enters the Removing state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the load balancer using the DescribeLoadBalancers API call. The instances remain running.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation DetachLoadBalancers for usage and error information.

Returned Error Codes:

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DetachLoadBalancers

Example (Shared00)

To detach a load balancer from an Auto Scaling group This example detaches the specified load balancer from the specified Auto Scaling group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.DetachLoadBalancersInput{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
		LoadBalancerNames: []*string{
			aws.String("my-load-balancer"),
		},
	}

	result, err := svc.DetachLoadBalancers(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) DetachLoadBalancersRequest added in v0.6.2

func (c *AutoScaling) DetachLoadBalancersRequest(input *DetachLoadBalancersInput) (req *request.Request, output *DetachLoadBalancersOutput)

DetachLoadBalancersRequest generates a "aws/request.Request" representing the client's request for the DetachLoadBalancers operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DetachLoadBalancers for more information on using the DetachLoadBalancers API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DetachLoadBalancersRequest method.
req, resp := client.DetachLoadBalancersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DetachLoadBalancers

func (*AutoScaling) DetachLoadBalancersWithContext added in v1.8.0

func (c *AutoScaling) DetachLoadBalancersWithContext(ctx aws.Context, input *DetachLoadBalancersInput, opts ...request.Option) (*DetachLoadBalancersOutput, error)

DetachLoadBalancersWithContext is the same as DetachLoadBalancers with the addition of the ability to pass a context and additional request options.

See DetachLoadBalancers for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DetachTrafficSources added in v1.44.156

func (c *AutoScaling) DetachTrafficSources(input *DetachTrafficSourcesInput) (*DetachTrafficSourcesOutput, error)

DetachTrafficSources API operation for Auto Scaling.

Detaches one or more traffic sources from the specified Auto Scaling group.

When you detach a traffic source, it enters the Removing state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the traffic source using the DescribeTrafficSources API call. The instances continue to run.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation DetachTrafficSources for usage and error information.

Returned Error Codes:

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DetachTrafficSources

Example (Shared00)

To detach a target group from an Auto Scaling group This example detaches the specified target group from the specified Auto Scaling group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.DetachTrafficSourcesInput{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
		TrafficSources: []*autoscaling.TrafficSourceIdentifier{
			{
				Identifier: aws.String("arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"),
			},
		},
	}

	result, err := svc.DetachTrafficSources(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) DetachTrafficSourcesRequest added in v1.44.156

func (c *AutoScaling) DetachTrafficSourcesRequest(input *DetachTrafficSourcesInput) (req *request.Request, output *DetachTrafficSourcesOutput)

DetachTrafficSourcesRequest generates a "aws/request.Request" representing the client's request for the DetachTrafficSources operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DetachTrafficSources for more information on using the DetachTrafficSources API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DetachTrafficSourcesRequest method.
req, resp := client.DetachTrafficSourcesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DetachTrafficSources

func (*AutoScaling) DetachTrafficSourcesWithContext added in v1.44.156

func (c *AutoScaling) DetachTrafficSourcesWithContext(ctx aws.Context, input *DetachTrafficSourcesInput, opts ...request.Option) (*DetachTrafficSourcesOutput, error)

DetachTrafficSourcesWithContext is the same as DetachTrafficSources with the addition of the ability to pass a context and additional request options.

See DetachTrafficSources for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) DisableMetricsCollection

func (c *AutoScaling) DisableMetricsCollection(input *DisableMetricsCollectionInput) (*DisableMetricsCollectionOutput, error)

DisableMetricsCollection API operation for Auto Scaling.

Disables group metrics collection for the specified Auto Scaling group.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation DisableMetricsCollection for usage and error information.

Returned Error Codes:

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DisableMetricsCollection

Example (Shared00)

To disable metrics collection for an Auto Scaling group This example disables collecting data for the GroupDesiredCapacity metric for the specified Auto Scaling group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.DisableMetricsCollectionInput{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
		Metrics: []*string{
			aws.String("GroupDesiredCapacity"),
		},
	}

	result, err := svc.DisableMetricsCollection(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) DisableMetricsCollectionRequest

func (c *AutoScaling) DisableMetricsCollectionRequest(input *DisableMetricsCollectionInput) (req *request.Request, output *DisableMetricsCollectionOutput)

DisableMetricsCollectionRequest generates a "aws/request.Request" representing the client's request for the DisableMetricsCollection operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisableMetricsCollection for more information on using the DisableMetricsCollection API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DisableMetricsCollectionRequest method.
req, resp := client.DisableMetricsCollectionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DisableMetricsCollection

func (*AutoScaling) DisableMetricsCollectionWithContext added in v1.8.0

func (c *AutoScaling) DisableMetricsCollectionWithContext(ctx aws.Context, input *DisableMetricsCollectionInput, opts ...request.Option) (*DisableMetricsCollectionOutput, error)

DisableMetricsCollectionWithContext is the same as DisableMetricsCollection with the addition of the ability to pass a context and additional request options.

See DisableMetricsCollection for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) EnableMetricsCollection

func (c *AutoScaling) EnableMetricsCollection(input *EnableMetricsCollectionInput) (*EnableMetricsCollectionOutput, error)

EnableMetricsCollection API operation for Auto Scaling.

Enables group metrics collection for the specified Auto Scaling group.

You can use these metrics to track changes in an Auto Scaling group and to set alarms on threshold values. You can view group metrics using the Amazon EC2 Auto Scaling console or the CloudWatch console. For more information, see Monitor CloudWatch metrics for your Auto Scaling groups and instances (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-cloudwatch-monitoring.html) in the Amazon EC2 Auto Scaling User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation EnableMetricsCollection for usage and error information.

Returned Error Codes:

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/EnableMetricsCollection

Example (Shared00)

To enable metrics collection for an Auto Scaling group This example enables data collection for the specified Auto Scaling group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.EnableMetricsCollectionInput{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
		Granularity:          aws.String("1Minute"),
	}

	result, err := svc.EnableMetricsCollection(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) EnableMetricsCollectionRequest

func (c *AutoScaling) EnableMetricsCollectionRequest(input *EnableMetricsCollectionInput) (req *request.Request, output *EnableMetricsCollectionOutput)

EnableMetricsCollectionRequest generates a "aws/request.Request" representing the client's request for the EnableMetricsCollection operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See EnableMetricsCollection for more information on using the EnableMetricsCollection API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the EnableMetricsCollectionRequest method.
req, resp := client.EnableMetricsCollectionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/EnableMetricsCollection

func (*AutoScaling) EnableMetricsCollectionWithContext added in v1.8.0

func (c *AutoScaling) EnableMetricsCollectionWithContext(ctx aws.Context, input *EnableMetricsCollectionInput, opts ...request.Option) (*EnableMetricsCollectionOutput, error)

EnableMetricsCollectionWithContext is the same as EnableMetricsCollection with the addition of the ability to pass a context and additional request options.

See EnableMetricsCollection for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) EnterStandby

func (c *AutoScaling) EnterStandby(input *EnterStandbyInput) (*EnterStandbyOutput, error)

EnterStandby API operation for Auto Scaling.

Moves the specified instances into the standby state.

If you choose to decrement the desired capacity of the Auto Scaling group, the instances can enter standby as long as the desired capacity of the Auto Scaling group after the instances are placed into standby is equal to or greater than the minimum capacity of the group.

If you choose not to decrement the desired capacity of the Auto Scaling group, the Auto Scaling group launches new instances to replace the instances on standby.

For more information, see Temporarily removing instances from your Auto Scaling group (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-enter-exit-standby.html) in the Amazon EC2 Auto Scaling User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation EnterStandby for usage and error information.

Returned Error Codes:

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/EnterStandby

Example (Shared00)

To move instances into standby mode This example puts the specified instance into standby mode.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.EnterStandbyInput{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
		InstanceIds: []*string{
			aws.String("i-93633f9b"),
		},
		ShouldDecrementDesiredCapacity: aws.Bool(true),
	}

	result, err := svc.EnterStandby(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) EnterStandbyRequest

func (c *AutoScaling) EnterStandbyRequest(input *EnterStandbyInput) (req *request.Request, output *EnterStandbyOutput)

EnterStandbyRequest generates a "aws/request.Request" representing the client's request for the EnterStandby operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See EnterStandby for more information on using the EnterStandby API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the EnterStandbyRequest method.
req, resp := client.EnterStandbyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/EnterStandby

func (*AutoScaling) EnterStandbyWithContext added in v1.8.0

func (c *AutoScaling) EnterStandbyWithContext(ctx aws.Context, input *EnterStandbyInput, opts ...request.Option) (*EnterStandbyOutput, error)

EnterStandbyWithContext is the same as EnterStandby with the addition of the ability to pass a context and additional request options.

See EnterStandby for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) ExecutePolicy

func (c *AutoScaling) ExecutePolicy(input *ExecutePolicyInput) (*ExecutePolicyOutput, error)

ExecutePolicy API operation for Auto Scaling.

Executes the specified policy. This can be useful for testing the design of your scaling policy.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation ExecutePolicy for usage and error information.

Returned Error Codes:

  • ErrCodeScalingActivityInProgressFault "ScalingActivityInProgress" The operation can't be performed because there are scaling activities in progress.

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/ExecutePolicy

Example (Shared00)

To execute a scaling policy This example executes the specified policy.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.ExecutePolicyInput{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
		BreachThreshold:      aws.Float64(50.000000),
		MetricValue:          aws.Float64(59.000000),
		PolicyName:           aws.String("my-step-scale-out-policy"),
	}

	result, err := svc.ExecutePolicy(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeScalingActivityInProgressFault:
				fmt.Println(autoscaling.ErrCodeScalingActivityInProgressFault, aerr.Error())
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) ExecutePolicyRequest

func (c *AutoScaling) ExecutePolicyRequest(input *ExecutePolicyInput) (req *request.Request, output *ExecutePolicyOutput)

ExecutePolicyRequest generates a "aws/request.Request" representing the client's request for the ExecutePolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ExecutePolicy for more information on using the ExecutePolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ExecutePolicyRequest method.
req, resp := client.ExecutePolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/ExecutePolicy

func (*AutoScaling) ExecutePolicyWithContext added in v1.8.0

func (c *AutoScaling) ExecutePolicyWithContext(ctx aws.Context, input *ExecutePolicyInput, opts ...request.Option) (*ExecutePolicyOutput, error)

ExecutePolicyWithContext is the same as ExecutePolicy with the addition of the ability to pass a context and additional request options.

See ExecutePolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) ExitStandby

func (c *AutoScaling) ExitStandby(input *ExitStandbyInput) (*ExitStandbyOutput, error)

ExitStandby API operation for Auto Scaling.

Moves the specified instances out of the standby state.

After you put the instances back in service, the desired capacity is incremented.

For more information, see Temporarily removing instances from your Auto Scaling group (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-enter-exit-standby.html) in the Amazon EC2 Auto Scaling User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation ExitStandby for usage and error information.

Returned Error Codes:

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/ExitStandby

Example (Shared00)

To move instances out of standby mode This example moves the specified instance out of standby mode.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.ExitStandbyInput{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
		InstanceIds: []*string{
			aws.String("i-93633f9b"),
		},
	}

	result, err := svc.ExitStandby(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) ExitStandbyRequest

func (c *AutoScaling) ExitStandbyRequest(input *ExitStandbyInput) (req *request.Request, output *ExitStandbyOutput)

ExitStandbyRequest generates a "aws/request.Request" representing the client's request for the ExitStandby operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ExitStandby for more information on using the ExitStandby API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ExitStandbyRequest method.
req, resp := client.ExitStandbyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/ExitStandby

func (*AutoScaling) ExitStandbyWithContext added in v1.8.0

func (c *AutoScaling) ExitStandbyWithContext(ctx aws.Context, input *ExitStandbyInput, opts ...request.Option) (*ExitStandbyOutput, error)

ExitStandbyWithContext is the same as ExitStandby with the addition of the ability to pass a context and additional request options.

See ExitStandby for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) GetPredictiveScalingForecast added in v1.38.43

func (c *AutoScaling) GetPredictiveScalingForecast(input *GetPredictiveScalingForecastInput) (*GetPredictiveScalingForecastOutput, error)

GetPredictiveScalingForecast API operation for Auto Scaling.

Retrieves the forecast data for a predictive scaling policy.

Load forecasts are predictions of the hourly load values using historical load data from CloudWatch and an analysis of historical trends. Capacity forecasts are represented as predicted values for the minimum capacity that is needed on an hourly basis, based on the hourly load forecast.

A minimum of 24 hours of data is required to create the initial forecasts. However, having a full 14 days of historical data results in more accurate forecasts.

For more information, see Predictive scaling for Amazon EC2 Auto Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-predictive-scaling.html) in the Amazon EC2 Auto Scaling User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation GetPredictiveScalingForecast for usage and error information.

Returned Error Codes:

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/GetPredictiveScalingForecast

func (*AutoScaling) GetPredictiveScalingForecastRequest added in v1.38.43

func (c *AutoScaling) GetPredictiveScalingForecastRequest(input *GetPredictiveScalingForecastInput) (req *request.Request, output *GetPredictiveScalingForecastOutput)

GetPredictiveScalingForecastRequest generates a "aws/request.Request" representing the client's request for the GetPredictiveScalingForecast operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetPredictiveScalingForecast for more information on using the GetPredictiveScalingForecast API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetPredictiveScalingForecastRequest method.
req, resp := client.GetPredictiveScalingForecastRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/GetPredictiveScalingForecast

func (*AutoScaling) GetPredictiveScalingForecastWithContext added in v1.38.43

func (c *AutoScaling) GetPredictiveScalingForecastWithContext(ctx aws.Context, input *GetPredictiveScalingForecastInput, opts ...request.Option) (*GetPredictiveScalingForecastOutput, error)

GetPredictiveScalingForecastWithContext is the same as GetPredictiveScalingForecast with the addition of the ability to pass a context and additional request options.

See GetPredictiveScalingForecast for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) PutLifecycleHook

func (c *AutoScaling) PutLifecycleHook(input *PutLifecycleHookInput) (*PutLifecycleHookOutput, error)

PutLifecycleHook API operation for Auto Scaling.

Creates or updates a lifecycle hook for the specified Auto Scaling group.

Lifecycle hooks let you create solutions that are aware of events in the Auto Scaling instance lifecycle, and then perform a custom action on instances when the corresponding lifecycle event occurs.

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:

(Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.

(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.

(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.

Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.

If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state using the RecordLifecycleActionHeartbeat API call.

If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call.

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

If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails.

You can view the lifecycle hooks for an Auto Scaling group using the DescribeLifecycleHooks API call. If you are no longer using a lifecycle hook, you can delete it by calling the DeleteLifecycleHook API.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation PutLifecycleHook for usage and error information.

Returned Error Codes:

  • ErrCodeLimitExceededFault "LimitExceeded" You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DescribeAccountLimits.html) in the Amazon EC2 Auto Scaling API Reference.

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/PutLifecycleHook

Example (Shared00)

To create a launch lifecycle hook This example creates a lifecycle hook for instance launch.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.PutLifecycleHookInput{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
		DefaultResult:        aws.String("CONTINUE"),
		HeartbeatTimeout:     aws.Int64(300),
		LifecycleHookName:    aws.String("my-launch-lifecycle-hook"),
		LifecycleTransition:  aws.String("autoscaling:EC2_INSTANCE_LAUNCHING"),
	}

	result, err := svc.PutLifecycleHook(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeLimitExceededFault:
				fmt.Println(autoscaling.ErrCodeLimitExceededFault, aerr.Error())
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) PutLifecycleHookRequest

func (c *AutoScaling) PutLifecycleHookRequest(input *PutLifecycleHookInput) (req *request.Request, output *PutLifecycleHookOutput)

PutLifecycleHookRequest generates a "aws/request.Request" representing the client's request for the PutLifecycleHook operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutLifecycleHook for more information on using the PutLifecycleHook API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutLifecycleHookRequest method.
req, resp := client.PutLifecycleHookRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/PutLifecycleHook

func (*AutoScaling) PutLifecycleHookWithContext added in v1.8.0

func (c *AutoScaling) PutLifecycleHookWithContext(ctx aws.Context, input *PutLifecycleHookInput, opts ...request.Option) (*PutLifecycleHookOutput, error)

PutLifecycleHookWithContext is the same as PutLifecycleHook with the addition of the ability to pass a context and additional request options.

See PutLifecycleHook for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) PutNotificationConfiguration

func (c *AutoScaling) PutNotificationConfiguration(input *PutNotificationConfigurationInput) (*PutNotificationConfigurationOutput, error)

PutNotificationConfiguration API operation for Auto Scaling.

Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to the specified topic can have messages delivered to an endpoint such as a web server or an email address.

This configuration overwrites any existing configuration.

For more information, see Getting Amazon SNS notifications when your Auto Scaling group scales (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html) in the Amazon EC2 Auto Scaling User Guide.

If you exceed your maximum limit of SNS topics, which is 10 per Auto Scaling group, the call fails.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation PutNotificationConfiguration for usage and error information.

Returned Error Codes:

  • ErrCodeLimitExceededFault "LimitExceeded" You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DescribeAccountLimits.html) in the Amazon EC2 Auto Scaling API Reference.

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

  • ErrCodeServiceLinkedRoleFailure "ServiceLinkedRoleFailure" The service-linked role is not yet ready for use.

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/PutNotificationConfiguration

Example (Shared00)

To add an Auto Scaling notification This example adds the specified notification to the specified Auto Scaling group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.PutNotificationConfigurationInput{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
		NotificationTypes: []*string{
			aws.String("autoscaling:TEST_NOTIFICATION"),
		},
		TopicARN: aws.String("arn:aws:sns:us-west-2:123456789012:my-sns-topic"),
	}

	result, err := svc.PutNotificationConfiguration(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeLimitExceededFault:
				fmt.Println(autoscaling.ErrCodeLimitExceededFault, aerr.Error())
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			case autoscaling.ErrCodeServiceLinkedRoleFailure:
				fmt.Println(autoscaling.ErrCodeServiceLinkedRoleFailure, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) PutNotificationConfigurationRequest

func (c *AutoScaling) PutNotificationConfigurationRequest(input *PutNotificationConfigurationInput) (req *request.Request, output *PutNotificationConfigurationOutput)

PutNotificationConfigurationRequest generates a "aws/request.Request" representing the client's request for the PutNotificationConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutNotificationConfiguration for more information on using the PutNotificationConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutNotificationConfigurationRequest method.
req, resp := client.PutNotificationConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/PutNotificationConfiguration

func (*AutoScaling) PutNotificationConfigurationWithContext added in v1.8.0

func (c *AutoScaling) PutNotificationConfigurationWithContext(ctx aws.Context, input *PutNotificationConfigurationInput, opts ...request.Option) (*PutNotificationConfigurationOutput, error)

PutNotificationConfigurationWithContext is the same as PutNotificationConfiguration with the addition of the ability to pass a context and additional request options.

See PutNotificationConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) PutScalingPolicy

func (c *AutoScaling) PutScalingPolicy(input *PutScalingPolicyInput) (*PutScalingPolicyOutput, error)

PutScalingPolicy API operation for Auto Scaling.

Creates or updates a scaling policy for an Auto Scaling group. Scaling policies are used to scale an Auto Scaling group based on configurable metrics. If no policies are defined, the dynamic scaling and predictive scaling features are not used.

For more information about using dynamic scaling, see Target tracking scaling policies (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-target-tracking.html) and Step and simple scaling policies (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html) in the Amazon EC2 Auto Scaling User Guide.

For more information about using predictive scaling, see Predictive scaling for Amazon EC2 Auto Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-predictive-scaling.html) in the Amazon EC2 Auto Scaling User Guide.

You can view the scaling policies for an Auto Scaling group using the DescribePolicies API call. If you are no longer using a scaling policy, you can delete it by calling the DeletePolicy API.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation PutScalingPolicy for usage and error information.

Returned Error Codes:

  • ErrCodeLimitExceededFault "LimitExceeded" You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DescribeAccountLimits.html) in the Amazon EC2 Auto Scaling API Reference.

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

  • ErrCodeServiceLinkedRoleFailure "ServiceLinkedRoleFailure" The service-linked role is not yet ready for use.

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/PutScalingPolicy

Example (Shared00)

To add a scaling policy to an Auto Scaling group This example adds the specified policy to the specified Auto Scaling group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.PutScalingPolicyInput{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
		PolicyName:           aws.String("alb1000-target-tracking-scaling-policy"),
		PolicyType:           aws.String("TargetTrackingScaling"),
		TargetTrackingConfiguration: &autoscaling.TargetTrackingConfiguration{
			PredefinedMetricSpecification: &autoscaling.PredefinedMetricSpecification{
				PredefinedMetricType: aws.String("ALBRequestCountPerTarget"),
				ResourceLabel:        aws.String("app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff"),
			},
			TargetValue: aws.Float64(1000.000000),
		},
	}

	result, err := svc.PutScalingPolicy(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeLimitExceededFault:
				fmt.Println(autoscaling.ErrCodeLimitExceededFault, aerr.Error())
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			case autoscaling.ErrCodeServiceLinkedRoleFailure:
				fmt.Println(autoscaling.ErrCodeServiceLinkedRoleFailure, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) PutScalingPolicyRequest

func (c *AutoScaling) PutScalingPolicyRequest(input *PutScalingPolicyInput) (req *request.Request, output *PutScalingPolicyOutput)

PutScalingPolicyRequest generates a "aws/request.Request" representing the client's request for the PutScalingPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutScalingPolicy for more information on using the PutScalingPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutScalingPolicyRequest method.
req, resp := client.PutScalingPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/PutScalingPolicy

func (*AutoScaling) PutScalingPolicyWithContext added in v1.8.0

func (c *AutoScaling) PutScalingPolicyWithContext(ctx aws.Context, input *PutScalingPolicyInput, opts ...request.Option) (*PutScalingPolicyOutput, error)

PutScalingPolicyWithContext is the same as PutScalingPolicy with the addition of the ability to pass a context and additional request options.

See PutScalingPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) PutScheduledUpdateGroupAction

func (c *AutoScaling) PutScheduledUpdateGroupAction(input *PutScheduledUpdateGroupActionInput) (*PutScheduledUpdateGroupActionOutput, error)

PutScheduledUpdateGroupAction API operation for Auto Scaling.

Creates or updates a scheduled scaling action for an Auto Scaling group.

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

You can view the scheduled actions for an Auto Scaling group using the DescribeScheduledActions API call. If you are no longer using a scheduled action, you can delete it by calling the DeleteScheduledAction API.

If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error message.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation PutScheduledUpdateGroupAction for usage and error information.

Returned Error Codes:

  • ErrCodeAlreadyExistsFault "AlreadyExists" You already have an Auto Scaling group or launch configuration with this name.

  • ErrCodeLimitExceededFault "LimitExceeded" You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DescribeAccountLimits.html) in the Amazon EC2 Auto Scaling API Reference.

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/PutScheduledUpdateGroupAction

Example (Shared00)

To add a scheduled action to an Auto Scaling group This example adds the specified scheduled action to the specified Auto Scaling group.

package main

import (
	"fmt"
	"time"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func parseTime(layout, value string) *time.Time {
	t, err := time.Parse(layout, value)
	if err != nil {
		panic(err)
	}
	return &t
}

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.PutScheduledUpdateGroupActionInput{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
		DesiredCapacity:      aws.Int64(4),
		EndTime:              parseTime("2006-01-02T15:04:05.999999999Z", "2014-05-12T08:00:00Z"),
		MaxSize:              aws.Int64(6),
		MinSize:              aws.Int64(2),
		ScheduledActionName:  aws.String("my-scheduled-action"),
		StartTime:            parseTime("2006-01-02T15:04:05.999999999Z", "2014-05-12T08:00:00Z"),
	}

	result, err := svc.PutScheduledUpdateGroupAction(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeAlreadyExistsFault:
				fmt.Println(autoscaling.ErrCodeAlreadyExistsFault, aerr.Error())
			case autoscaling.ErrCodeLimitExceededFault:
				fmt.Println(autoscaling.ErrCodeLimitExceededFault, aerr.Error())
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) PutScheduledUpdateGroupActionRequest

func (c *AutoScaling) PutScheduledUpdateGroupActionRequest(input *PutScheduledUpdateGroupActionInput) (req *request.Request, output *PutScheduledUpdateGroupActionOutput)

PutScheduledUpdateGroupActionRequest generates a "aws/request.Request" representing the client's request for the PutScheduledUpdateGroupAction operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutScheduledUpdateGroupAction for more information on using the PutScheduledUpdateGroupAction API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutScheduledUpdateGroupActionRequest method.
req, resp := client.PutScheduledUpdateGroupActionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/PutScheduledUpdateGroupAction

func (*AutoScaling) PutScheduledUpdateGroupActionWithContext added in v1.8.0

func (c *AutoScaling) PutScheduledUpdateGroupActionWithContext(ctx aws.Context, input *PutScheduledUpdateGroupActionInput, opts ...request.Option) (*PutScheduledUpdateGroupActionOutput, error)

PutScheduledUpdateGroupActionWithContext is the same as PutScheduledUpdateGroupAction with the addition of the ability to pass a context and additional request options.

See PutScheduledUpdateGroupAction for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) PutWarmPool added in v1.38.16

func (c *AutoScaling) PutWarmPool(input *PutWarmPoolInput) (*PutWarmPoolOutput, error)

PutWarmPool API operation for Auto Scaling.

Creates or updates a warm pool for the specified Auto Scaling group. A warm pool is a pool of pre-initialized EC2 instances that sits alongside the Auto Scaling group. Whenever your application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new desired capacity. For more information and example configurations, see Warm pools for Amazon EC2 Auto Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html) in the Amazon EC2 Auto Scaling User Guide.

This operation must be called from the Region in which the Auto Scaling group was created. This operation cannot be called on an Auto Scaling group that has a mixed instances policy or a launch template or launch configuration that requests Spot Instances.

You can view the instances in the warm pool using the DescribeWarmPool API call. If you are no longer using a warm pool, you can delete it by calling the DeleteWarmPool API.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation PutWarmPool for usage and error information.

Returned Error Codes:

  • ErrCodeLimitExceededFault "LimitExceeded" You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DescribeAccountLimits.html) in the Amazon EC2 Auto Scaling API Reference.

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/PutWarmPool

Example (Shared00)

To create a warm pool for an Auto Scaling group This example creates a warm pool for the specified Auto Scaling group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.PutWarmPoolInput{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
		InstanceReusePolicy: &autoscaling.InstanceReusePolicy{
			ReuseOnScaleIn: aws.Bool(true),
		},
		MinSize:   aws.Int64(30),
		PoolState: aws.String("Hibernated"),
	}

	result, err := svc.PutWarmPool(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeLimitExceededFault:
				fmt.Println(autoscaling.ErrCodeLimitExceededFault, aerr.Error())
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) PutWarmPoolRequest added in v1.38.16

func (c *AutoScaling) PutWarmPoolRequest(input *PutWarmPoolInput) (req *request.Request, output *PutWarmPoolOutput)

PutWarmPoolRequest generates a "aws/request.Request" representing the client's request for the PutWarmPool operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutWarmPool for more information on using the PutWarmPool API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutWarmPoolRequest method.
req, resp := client.PutWarmPoolRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/PutWarmPool

func (*AutoScaling) PutWarmPoolWithContext added in v1.38.16

func (c *AutoScaling) PutWarmPoolWithContext(ctx aws.Context, input *PutWarmPoolInput, opts ...request.Option) (*PutWarmPoolOutput, error)

PutWarmPoolWithContext is the same as PutWarmPool with the addition of the ability to pass a context and additional request options.

See PutWarmPool for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) RecordLifecycleActionHeartbeat

func (c *AutoScaling) RecordLifecycleActionHeartbeat(input *RecordLifecycleActionHeartbeatInput) (*RecordLifecycleActionHeartbeatOutput, error)

RecordLifecycleActionHeartbeat API operation for Auto Scaling.

Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using the PutLifecycleHook API call.

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:

(Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.

(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.

(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.

Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.

If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state.

If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation RecordLifecycleActionHeartbeat for usage and error information.

Returned Error Codes:

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/RecordLifecycleActionHeartbeat

Example (Shared00)

To record a lifecycle action heartbeat This example records a lifecycle action heartbeat to keep the instance in a pending state.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.RecordLifecycleActionHeartbeatInput{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
		LifecycleActionToken: aws.String("bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635"),
		LifecycleHookName:    aws.String("my-lifecycle-hook"),
	}

	result, err := svc.RecordLifecycleActionHeartbeat(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) RecordLifecycleActionHeartbeatRequest

func (c *AutoScaling) RecordLifecycleActionHeartbeatRequest(input *RecordLifecycleActionHeartbeatInput) (req *request.Request, output *RecordLifecycleActionHeartbeatOutput)

RecordLifecycleActionHeartbeatRequest generates a "aws/request.Request" representing the client's request for the RecordLifecycleActionHeartbeat operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RecordLifecycleActionHeartbeat for more information on using the RecordLifecycleActionHeartbeat API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RecordLifecycleActionHeartbeatRequest method.
req, resp := client.RecordLifecycleActionHeartbeatRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/RecordLifecycleActionHeartbeat

func (*AutoScaling) RecordLifecycleActionHeartbeatWithContext added in v1.8.0

func (c *AutoScaling) RecordLifecycleActionHeartbeatWithContext(ctx aws.Context, input *RecordLifecycleActionHeartbeatInput, opts ...request.Option) (*RecordLifecycleActionHeartbeatOutput, error)

RecordLifecycleActionHeartbeatWithContext is the same as RecordLifecycleActionHeartbeat with the addition of the ability to pass a context and additional request options.

See RecordLifecycleActionHeartbeat for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) ResumeProcesses

func (c *AutoScaling) ResumeProcesses(input *ScalingProcessQuery) (*ResumeProcessesOutput, error)

ResumeProcesses API operation for Auto Scaling.

Resumes the specified suspended auto scaling processes, or all suspended process, for the specified Auto Scaling group.

For more information, see Suspending and resuming scaling processes (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html) in the Amazon EC2 Auto Scaling User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation ResumeProcesses for usage and error information.

Returned Error Codes:

  • ErrCodeResourceInUseFault "ResourceInUse" The operation can't be performed because the resource is in use.

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/ResumeProcesses

Example (Shared00)

To resume Auto Scaling processes This example resumes the specified suspended scaling process for the specified Auto Scaling group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.ScalingProcessQuery{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
		ScalingProcesses: []*string{
			aws.String("AlarmNotification"),
		},
	}

	result, err := svc.ResumeProcesses(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeResourceInUseFault:
				fmt.Println(autoscaling.ErrCodeResourceInUseFault, aerr.Error())
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) ResumeProcessesRequest

func (c *AutoScaling) ResumeProcessesRequest(input *ScalingProcessQuery) (req *request.Request, output *ResumeProcessesOutput)

ResumeProcessesRequest generates a "aws/request.Request" representing the client's request for the ResumeProcesses operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ResumeProcesses for more information on using the ResumeProcesses API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ResumeProcessesRequest method.
req, resp := client.ResumeProcessesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/ResumeProcesses

func (*AutoScaling) ResumeProcessesWithContext added in v1.8.0

func (c *AutoScaling) ResumeProcessesWithContext(ctx aws.Context, input *ScalingProcessQuery, opts ...request.Option) (*ResumeProcessesOutput, error)

ResumeProcessesWithContext is the same as ResumeProcesses with the addition of the ability to pass a context and additional request options.

See ResumeProcesses for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) RollbackInstanceRefresh added in v1.44.199

func (c *AutoScaling) RollbackInstanceRefresh(input *RollbackInstanceRefreshInput) (*RollbackInstanceRefreshOutput, error)

RollbackInstanceRefresh API operation for Auto Scaling.

Cancels an instance refresh that is in progress and rolls back any changes that it made. Amazon EC2 Auto Scaling replaces any instances that were replaced during the instance refresh. This restores your Auto Scaling group to the configuration that it was using before the start of the instance refresh.

This operation is part of the instance refresh feature (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html) in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.

A rollback is not supported in the following situations:

  • There is no desired configuration specified for the instance refresh.

  • The Auto Scaling group has a launch template that uses an Amazon Web Services Systems Manager parameter instead of an AMI ID for the ImageId property.

  • The Auto Scaling group uses the launch template's $Latest or $Default version.

When you receive a successful response from this operation, Amazon EC2 Auto Scaling immediately begins replacing instances. You can check the status of this operation through the DescribeInstanceRefreshes API operation.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation RollbackInstanceRefresh for usage and error information.

Returned Error Codes:

  • ErrCodeLimitExceededFault "LimitExceeded" You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DescribeAccountLimits.html) in the Amazon EC2 Auto Scaling API Reference.

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

  • ErrCodeActiveInstanceRefreshNotFoundFault "ActiveInstanceRefreshNotFound" The request failed because an active instance refresh or rollback for the specified Auto Scaling group was not found.

  • ErrCodeIrreversibleInstanceRefreshFault "IrreversibleInstanceRefresh" The request failed because a desired configuration was not found or an incompatible launch template (uses a Systems Manager parameter instead of an AMI ID) or launch template version ($Latest or $Default) is present on the Auto Scaling group.

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/RollbackInstanceRefresh

func (*AutoScaling) RollbackInstanceRefreshRequest added in v1.44.199

func (c *AutoScaling) RollbackInstanceRefreshRequest(input *RollbackInstanceRefreshInput) (req *request.Request, output *RollbackInstanceRefreshOutput)

RollbackInstanceRefreshRequest generates a "aws/request.Request" representing the client's request for the RollbackInstanceRefresh operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RollbackInstanceRefresh for more information on using the RollbackInstanceRefresh API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RollbackInstanceRefreshRequest method.
req, resp := client.RollbackInstanceRefreshRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/RollbackInstanceRefresh

func (*AutoScaling) RollbackInstanceRefreshWithContext added in v1.44.199

func (c *AutoScaling) RollbackInstanceRefreshWithContext(ctx aws.Context, input *RollbackInstanceRefreshInput, opts ...request.Option) (*RollbackInstanceRefreshOutput, error)

RollbackInstanceRefreshWithContext is the same as RollbackInstanceRefresh with the addition of the ability to pass a context and additional request options.

See RollbackInstanceRefresh for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) SetDesiredCapacity

func (c *AutoScaling) SetDesiredCapacity(input *SetDesiredCapacityInput) (*SetDesiredCapacityOutput, error)

SetDesiredCapacity API operation for Auto Scaling.

Sets the size of the specified Auto Scaling group.

If a scale-in activity occurs as a result of a new DesiredCapacity value that is lower than the current size of the group, the Auto Scaling group uses its termination policy to determine which instances to terminate.

For more information, see Manual scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-manual-scaling.html) in the Amazon EC2 Auto Scaling User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation SetDesiredCapacity for usage and error information.

Returned Error Codes:

  • ErrCodeScalingActivityInProgressFault "ScalingActivityInProgress" The operation can't be performed because there are scaling activities in progress.

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/SetDesiredCapacity

Example (Shared00)

To set the desired capacity for an Auto Scaling group This example sets the desired capacity for the specified Auto Scaling group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.SetDesiredCapacityInput{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
		DesiredCapacity:      aws.Int64(2),
		HonorCooldown:        aws.Bool(true),
	}

	result, err := svc.SetDesiredCapacity(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeScalingActivityInProgressFault:
				fmt.Println(autoscaling.ErrCodeScalingActivityInProgressFault, aerr.Error())
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) SetDesiredCapacityRequest

func (c *AutoScaling) SetDesiredCapacityRequest(input *SetDesiredCapacityInput) (req *request.Request, output *SetDesiredCapacityOutput)

SetDesiredCapacityRequest generates a "aws/request.Request" representing the client's request for the SetDesiredCapacity operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SetDesiredCapacity for more information on using the SetDesiredCapacity API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the SetDesiredCapacityRequest method.
req, resp := client.SetDesiredCapacityRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/SetDesiredCapacity

func (*AutoScaling) SetDesiredCapacityWithContext added in v1.8.0

func (c *AutoScaling) SetDesiredCapacityWithContext(ctx aws.Context, input *SetDesiredCapacityInput, opts ...request.Option) (*SetDesiredCapacityOutput, error)

SetDesiredCapacityWithContext is the same as SetDesiredCapacity with the addition of the ability to pass a context and additional request options.

See SetDesiredCapacity for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) SetInstanceHealth

func (c *AutoScaling) SetInstanceHealth(input *SetInstanceHealthInput) (*SetInstanceHealthOutput, error)

SetInstanceHealth API operation for Auto Scaling.

Sets the health status of the specified instance.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation SetInstanceHealth for usage and error information.

Returned Error Codes:

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/SetInstanceHealth

Example (Shared00)

To set the health status of an instance This example sets the health status of the specified instance to Unhealthy.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.SetInstanceHealthInput{
		HealthStatus: aws.String("Unhealthy"),
		InstanceId:   aws.String("i-93633f9b"),
	}

	result, err := svc.SetInstanceHealth(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) SetInstanceHealthRequest

func (c *AutoScaling) SetInstanceHealthRequest(input *SetInstanceHealthInput) (req *request.Request, output *SetInstanceHealthOutput)

SetInstanceHealthRequest generates a "aws/request.Request" representing the client's request for the SetInstanceHealth operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SetInstanceHealth for more information on using the SetInstanceHealth API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the SetInstanceHealthRequest method.
req, resp := client.SetInstanceHealthRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/SetInstanceHealth

func (*AutoScaling) SetInstanceHealthWithContext added in v1.8.0

func (c *AutoScaling) SetInstanceHealthWithContext(ctx aws.Context, input *SetInstanceHealthInput, opts ...request.Option) (*SetInstanceHealthOutput, error)

SetInstanceHealthWithContext is the same as SetInstanceHealth with the addition of the ability to pass a context and additional request options.

See SetInstanceHealth for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) SetInstanceProtection added in v1.0.4

func (c *AutoScaling) SetInstanceProtection(input *SetInstanceProtectionInput) (*SetInstanceProtectionOutput, error)

SetInstanceProtection API operation for Auto Scaling.

Updates the instance protection settings of the specified instances. This operation cannot be called on instances in a warm pool.

For more information about preventing instances that are part of an Auto Scaling group from terminating on scale in, see Using instance scale-in protection (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html) in the Amazon EC2 Auto Scaling User Guide.

If you exceed your maximum limit of instance IDs, which is 50 per Auto Scaling group, the call fails.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation SetInstanceProtection for usage and error information.

Returned Error Codes:

  • ErrCodeLimitExceededFault "LimitExceeded" You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DescribeAccountLimits.html) in the Amazon EC2 Auto Scaling API Reference.

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/SetInstanceProtection

Example (Shared00)

To enable instance protection for an instance This example enables instance protection for the specified instance.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.SetInstanceProtectionInput{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
		InstanceIds: []*string{
			aws.String("i-93633f9b"),
		},
		ProtectedFromScaleIn: aws.Bool(true),
	}

	result, err := svc.SetInstanceProtection(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeLimitExceededFault:
				fmt.Println(autoscaling.ErrCodeLimitExceededFault, aerr.Error())
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

Example (Shared01)

To disable instance protection for an instance This example disables instance protection for the specified instance.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.SetInstanceProtectionInput{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
		InstanceIds: []*string{
			aws.String("i-93633f9b"),
		},
		ProtectedFromScaleIn: aws.Bool(false),
	}

	result, err := svc.SetInstanceProtection(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeLimitExceededFault:
				fmt.Println(autoscaling.ErrCodeLimitExceededFault, aerr.Error())
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) SetInstanceProtectionRequest added in v1.0.4

func (c *AutoScaling) SetInstanceProtectionRequest(input *SetInstanceProtectionInput) (req *request.Request, output *SetInstanceProtectionOutput)

SetInstanceProtectionRequest generates a "aws/request.Request" representing the client's request for the SetInstanceProtection operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SetInstanceProtection for more information on using the SetInstanceProtection API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the SetInstanceProtectionRequest method.
req, resp := client.SetInstanceProtectionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/SetInstanceProtection

func (*AutoScaling) SetInstanceProtectionWithContext added in v1.8.0

func (c *AutoScaling) SetInstanceProtectionWithContext(ctx aws.Context, input *SetInstanceProtectionInput, opts ...request.Option) (*SetInstanceProtectionOutput, error)

SetInstanceProtectionWithContext is the same as SetInstanceProtection with the addition of the ability to pass a context and additional request options.

See SetInstanceProtection for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) StartInstanceRefresh added in v1.32.3

func (c *AutoScaling) StartInstanceRefresh(input *StartInstanceRefreshInput) (*StartInstanceRefreshOutput, error)

StartInstanceRefresh API operation for Auto Scaling.

Starts an instance refresh. During an instance refresh, Amazon EC2 Auto Scaling performs a rolling update of instances in an Auto Scaling group. Instances are terminated first and then replaced, which temporarily reduces the capacity available within your Auto Scaling group.

This operation is part of the instance refresh feature (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html) in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group. This feature is helpful, for example, when you have a new AMI or a new user data script. You just need to create a new launch template that specifies the new AMI or user data script. Then start an instance refresh to immediately begin the process of updating instances in the group.

If successful, the request's response contains a unique ID that you can use to track the progress of the instance refresh. To query its status, call the DescribeInstanceRefreshes API. To describe the instance refreshes that have already run, call the DescribeInstanceRefreshes API. To cancel an instance refresh that is in progress, use the CancelInstanceRefresh API.

An instance refresh might fail for several reasons, such as EC2 launch failures, misconfigured health checks, or not ignoring or allowing the termination of instances that are in Standby state or protected from scale in. You can monitor for failed EC2 launches using the scaling activities. To find the scaling activities, call the DescribeScalingActivities API.

If you enable auto rollback, your Auto Scaling group will be rolled back automatically when the instance refresh fails. You can enable this feature before starting an instance refresh by specifying the AutoRollback property in the instance refresh preferences. Otherwise, to roll back an instance refresh before it finishes, use the RollbackInstanceRefresh API.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation StartInstanceRefresh for usage and error information.

Returned Error Codes:

  • ErrCodeLimitExceededFault "LimitExceeded" You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DescribeAccountLimits.html) in the Amazon EC2 Auto Scaling API Reference.

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

  • ErrCodeInstanceRefreshInProgressFault "InstanceRefreshInProgress" The request failed because an active instance refresh already exists for the specified Auto Scaling group.

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/StartInstanceRefresh

Example (Shared00)

To start an instance refresh This example starts an instance refresh for the specified Auto Scaling group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.StartInstanceRefreshInput{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
		DesiredConfiguration: &autoscaling.DesiredConfiguration{
			LaunchTemplate: &autoscaling.LaunchTemplateSpecification{
				LaunchTemplateName: aws.String("my-template-for-auto-scaling"),
				Version:            aws.String("$Latest"),
			},
		},
		Preferences: &autoscaling.RefreshPreferences{
			InstanceWarmup:       aws.Int64(400),
			MinHealthyPercentage: aws.Int64(90),
			SkipMatching:         aws.Bool(true),
		},
	}

	result, err := svc.StartInstanceRefresh(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeLimitExceededFault:
				fmt.Println(autoscaling.ErrCodeLimitExceededFault, aerr.Error())
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			case autoscaling.ErrCodeInstanceRefreshInProgressFault:
				fmt.Println(autoscaling.ErrCodeInstanceRefreshInProgressFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) StartInstanceRefreshRequest added in v1.32.3

func (c *AutoScaling) StartInstanceRefreshRequest(input *StartInstanceRefreshInput) (req *request.Request, output *StartInstanceRefreshOutput)

StartInstanceRefreshRequest generates a "aws/request.Request" representing the client's request for the StartInstanceRefresh operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartInstanceRefresh for more information on using the StartInstanceRefresh API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartInstanceRefreshRequest method.
req, resp := client.StartInstanceRefreshRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/StartInstanceRefresh

func (*AutoScaling) StartInstanceRefreshWithContext added in v1.32.3

func (c *AutoScaling) StartInstanceRefreshWithContext(ctx aws.Context, input *StartInstanceRefreshInput, opts ...request.Option) (*StartInstanceRefreshOutput, error)

StartInstanceRefreshWithContext is the same as StartInstanceRefresh with the addition of the ability to pass a context and additional request options.

See StartInstanceRefresh for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) SuspendProcesses

func (c *AutoScaling) SuspendProcesses(input *ScalingProcessQuery) (*SuspendProcessesOutput, error)

SuspendProcesses API operation for Auto Scaling.

Suspends the specified auto scaling processes, or all processes, for the specified Auto Scaling group.

If you suspend either the Launch or Terminate process types, it can prevent other process types from functioning properly. For more information, see Suspending and resuming scaling processes (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html) in the Amazon EC2 Auto Scaling User Guide.

To resume processes that have been suspended, call the ResumeProcesses API.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation SuspendProcesses for usage and error information.

Returned Error Codes:

  • ErrCodeResourceInUseFault "ResourceInUse" The operation can't be performed because the resource is in use.

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/SuspendProcesses

Example (Shared00)

To suspend Auto Scaling processes This example suspends the specified scaling process for the specified Auto Scaling group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.ScalingProcessQuery{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
		ScalingProcesses: []*string{
			aws.String("AlarmNotification"),
		},
	}

	result, err := svc.SuspendProcesses(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeResourceInUseFault:
				fmt.Println(autoscaling.ErrCodeResourceInUseFault, aerr.Error())
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) SuspendProcessesRequest

func (c *AutoScaling) SuspendProcessesRequest(input *ScalingProcessQuery) (req *request.Request, output *SuspendProcessesOutput)

SuspendProcessesRequest generates a "aws/request.Request" representing the client's request for the SuspendProcesses operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SuspendProcesses for more information on using the SuspendProcesses API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the SuspendProcessesRequest method.
req, resp := client.SuspendProcessesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/SuspendProcesses

func (*AutoScaling) SuspendProcessesWithContext added in v1.8.0

func (c *AutoScaling) SuspendProcessesWithContext(ctx aws.Context, input *ScalingProcessQuery, opts ...request.Option) (*SuspendProcessesOutput, error)

SuspendProcessesWithContext is the same as SuspendProcesses with the addition of the ability to pass a context and additional request options.

See SuspendProcesses for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) TerminateInstanceInAutoScalingGroup

TerminateInstanceInAutoScalingGroup API operation for Auto Scaling.

Terminates the specified instance and optionally adjusts the desired group size. This operation cannot be called on instances in a warm pool.

This call simply makes a termination request. The instance is not terminated immediately. When an instance is terminated, the instance status changes to terminated. You can't connect to or start an instance after you've terminated it.

If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are terminated.

By default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you decrement the desired capacity, your Auto Scaling group can become unbalanced between Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might terminate instances in other zones. For more information, see Rebalancing activities (https://docs.aws.amazon.com/autoscaling/ec2/userguide/auto-scaling-benefits.html#AutoScalingBehavior.InstanceUsage) in the Amazon EC2 Auto Scaling User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation TerminateInstanceInAutoScalingGroup for usage and error information.

Returned Error Codes:

  • ErrCodeScalingActivityInProgressFault "ScalingActivityInProgress" The operation can't be performed because there are scaling activities in progress.

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/TerminateInstanceInAutoScalingGroup

Example (Shared00)

To terminate an instance in an Auto Scaling group This example terminates the specified instance from the specified Auto Scaling group without updating the size of the group. Auto Scaling launches a replacement instance after the specified instance terminates.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.TerminateInstanceInAutoScalingGroupInput{
		InstanceId:                     aws.String("i-93633f9b"),
		ShouldDecrementDesiredCapacity: aws.Bool(false),
	}

	result, err := svc.TerminateInstanceInAutoScalingGroup(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeScalingActivityInProgressFault:
				fmt.Println(autoscaling.ErrCodeScalingActivityInProgressFault, aerr.Error())
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) TerminateInstanceInAutoScalingGroupRequest

func (c *AutoScaling) TerminateInstanceInAutoScalingGroupRequest(input *TerminateInstanceInAutoScalingGroupInput) (req *request.Request, output *TerminateInstanceInAutoScalingGroupOutput)

TerminateInstanceInAutoScalingGroupRequest generates a "aws/request.Request" representing the client's request for the TerminateInstanceInAutoScalingGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TerminateInstanceInAutoScalingGroup for more information on using the TerminateInstanceInAutoScalingGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TerminateInstanceInAutoScalingGroupRequest method.
req, resp := client.TerminateInstanceInAutoScalingGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/TerminateInstanceInAutoScalingGroup

func (*AutoScaling) TerminateInstanceInAutoScalingGroupWithContext added in v1.8.0

func (c *AutoScaling) TerminateInstanceInAutoScalingGroupWithContext(ctx aws.Context, input *TerminateInstanceInAutoScalingGroupInput, opts ...request.Option) (*TerminateInstanceInAutoScalingGroupOutput, error)

TerminateInstanceInAutoScalingGroupWithContext is the same as TerminateInstanceInAutoScalingGroup with the addition of the ability to pass a context and additional request options.

See TerminateInstanceInAutoScalingGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) UpdateAutoScalingGroup

func (c *AutoScaling) UpdateAutoScalingGroup(input *UpdateAutoScalingGroupInput) (*UpdateAutoScalingGroupOutput, error)

UpdateAutoScalingGroup API operation for Auto Scaling.

We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.

Updates the configuration for the specified Auto Scaling group.

To update an Auto Scaling group, specify the name of the group and the property that you want to change. Any properties that you don't specify are not changed by this update request. The new settings take effect on any scaling activities after this call returns.

If you associate a new launch configuration or template with an Auto Scaling group, all new instances will get the updated configuration. Existing instances continue to run with the configuration that they were originally launched with. When you update a group to specify a mixed instances policy instead of a launch configuration or template, existing instances may be replaced to match the new purchasing options that you specified in the policy. For example, if the group currently has 100% On-Demand capacity and the policy specifies 50% Spot capacity, this means that half of your instances will be gradually terminated and relaunched as Spot Instances. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the old ones, so that updating your group does not compromise the performance or availability of your application.

Note the following about changing DesiredCapacity, MaxSize, or MinSize:

  • If a scale-in activity occurs as a result of a new DesiredCapacity value that is lower than the current size of the group, the Auto Scaling group uses its termination policy to determine which instances to terminate.

  • If you specify a new value for MinSize without specifying a value for DesiredCapacity, and the new MinSize is larger than the current size of the group, this sets the group's DesiredCapacity to the new MinSize value.

  • If you specify a new value for MaxSize without specifying a value for DesiredCapacity, and the new MaxSize is smaller than the current size of the group, this sets the group's DesiredCapacity to the new MaxSize value.

To see which properties have been set, call the DescribeAutoScalingGroups API. To view the scaling policies for an Auto Scaling group, call the DescribePolicies API. If the group has scaling policies, you can update them by calling the PutScalingPolicy API.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Auto Scaling's API operation UpdateAutoScalingGroup for usage and error information.

Returned Error Codes:

  • ErrCodeScalingActivityInProgressFault "ScalingActivityInProgress" The operation can't be performed because there are scaling activities in progress.

  • ErrCodeResourceContentionFault "ResourceContention" You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

  • ErrCodeServiceLinkedRoleFailure "ServiceLinkedRoleFailure" The service-linked role is not yet ready for use.

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/UpdateAutoScalingGroup

Example (Shared00)

To update an Auto Scaling group This example updates multiple properties at the same time.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/autoscaling"
)

func main() {
	svc := autoscaling.New(session.New())
	input := &autoscaling.UpdateAutoScalingGroupInput{
		AutoScalingGroupName: aws.String("my-auto-scaling-group"),
		LaunchTemplate: &autoscaling.LaunchTemplateSpecification{
			LaunchTemplateName: aws.String("my-template-for-auto-scaling"),
			Version:            aws.String("2"),
		},
		MaxSize:                          aws.Int64(5),
		MinSize:                          aws.Int64(1),
		NewInstancesProtectedFromScaleIn: aws.Bool(true),
	}

	result, err := svc.UpdateAutoScalingGroup(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case autoscaling.ErrCodeScalingActivityInProgressFault:
				fmt.Println(autoscaling.ErrCodeScalingActivityInProgressFault, aerr.Error())
			case autoscaling.ErrCodeResourceContentionFault:
				fmt.Println(autoscaling.ErrCodeResourceContentionFault, aerr.Error())
			case autoscaling.ErrCodeServiceLinkedRoleFailure:
				fmt.Println(autoscaling.ErrCodeServiceLinkedRoleFailure, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*AutoScaling) UpdateAutoScalingGroupRequest

func (c *AutoScaling) UpdateAutoScalingGroupRequest(input *UpdateAutoScalingGroupInput) (req *request.Request, output *UpdateAutoScalingGroupOutput)

UpdateAutoScalingGroupRequest generates a "aws/request.Request" representing the client's request for the UpdateAutoScalingGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateAutoScalingGroup for more information on using the UpdateAutoScalingGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateAutoScalingGroupRequest method.
req, resp := client.UpdateAutoScalingGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/UpdateAutoScalingGroup

func (*AutoScaling) UpdateAutoScalingGroupWithContext added in v1.8.0

func (c *AutoScaling) UpdateAutoScalingGroupWithContext(ctx aws.Context, input *UpdateAutoScalingGroupInput, opts ...request.Option) (*UpdateAutoScalingGroupOutput, error)

UpdateAutoScalingGroupWithContext is the same as UpdateAutoScalingGroup with the addition of the ability to pass a context and additional request options.

See UpdateAutoScalingGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) WaitUntilGroupExists added in v1.1.6

func (c *AutoScaling) WaitUntilGroupExists(input *DescribeAutoScalingGroupsInput) error

WaitUntilGroupExists uses the Auto Scaling API operation DescribeAutoScalingGroups to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*AutoScaling) WaitUntilGroupExistsWithContext added in v1.8.0

func (c *AutoScaling) WaitUntilGroupExistsWithContext(ctx aws.Context, input *DescribeAutoScalingGroupsInput, opts ...request.WaiterOption) error

WaitUntilGroupExistsWithContext is an extended version of WaitUntilGroupExists. With the support for passing in a context and options to configure the Waiter and the underlying request options.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) WaitUntilGroupInService added in v1.1.6

func (c *AutoScaling) WaitUntilGroupInService(input *DescribeAutoScalingGroupsInput) error

WaitUntilGroupInService uses the Auto Scaling API operation DescribeAutoScalingGroups to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*AutoScaling) WaitUntilGroupInServiceWithContext added in v1.8.0

func (c *AutoScaling) WaitUntilGroupInServiceWithContext(ctx aws.Context, input *DescribeAutoScalingGroupsInput, opts ...request.WaiterOption) error

WaitUntilGroupInServiceWithContext is an extended version of WaitUntilGroupInService. With the support for passing in a context and options to configure the Waiter and the underlying request options.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScaling) WaitUntilGroupNotExists added in v1.1.6

func (c *AutoScaling) WaitUntilGroupNotExists(input *DescribeAutoScalingGroupsInput) error

WaitUntilGroupNotExists uses the Auto Scaling API operation DescribeAutoScalingGroups to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*AutoScaling) WaitUntilGroupNotExistsWithContext added in v1.8.0

func (c *AutoScaling) WaitUntilGroupNotExistsWithContext(ctx aws.Context, input *DescribeAutoScalingGroupsInput, opts ...request.WaiterOption) error

WaitUntilGroupNotExistsWithContext is an extended version of WaitUntilGroupNotExists. With the support for passing in a context and options to configure the Waiter and the underlying request options.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type BaselineEbsBandwidthMbpsRequest added in v1.41.12

type BaselineEbsBandwidthMbpsRequest struct {

	// The maximum value in Mbps.
	Max *int64 `type:"integer"`

	// The minimum value in Mbps.
	Min *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Specifies the minimum and maximum for the BaselineEbsBandwidthMbps object when you specify InstanceRequirements for an Auto Scaling group.

func (BaselineEbsBandwidthMbpsRequest) GoString added in v1.41.12

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BaselineEbsBandwidthMbpsRequest) SetMax added in v1.41.12

SetMax sets the Max field's value.

func (*BaselineEbsBandwidthMbpsRequest) SetMin added in v1.41.12

SetMin sets the Min field's value.

func (BaselineEbsBandwidthMbpsRequest) String added in v1.41.12

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchDeleteScheduledActionInput added in v1.15.12

type BatchDeleteScheduledActionInput struct {

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// The names of the scheduled actions to delete. The maximum number allowed
	// is 50.
	//
	// ScheduledActionNames is a required field
	ScheduledActionNames []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchDeleteScheduledActionInput) GoString added in v1.15.12

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDeleteScheduledActionInput) SetAutoScalingGroupName added in v1.15.12

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*BatchDeleteScheduledActionInput) SetScheduledActionNames added in v1.15.12

SetScheduledActionNames sets the ScheduledActionNames field's value.

func (BatchDeleteScheduledActionInput) String added in v1.15.12

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDeleteScheduledActionInput) Validate added in v1.15.12

func (s *BatchDeleteScheduledActionInput) Validate() error

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

type BatchDeleteScheduledActionOutput added in v1.15.12

type BatchDeleteScheduledActionOutput struct {

	// The names of the scheduled actions that could not be deleted, including an
	// error message.
	FailedScheduledActions []*FailedScheduledUpdateGroupActionRequest `type:"list"`
	// contains filtered or unexported fields
}

func (BatchDeleteScheduledActionOutput) GoString added in v1.15.12

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDeleteScheduledActionOutput) SetFailedScheduledActions added in v1.15.12

SetFailedScheduledActions sets the FailedScheduledActions field's value.

func (BatchDeleteScheduledActionOutput) String added in v1.15.12

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchPutScheduledUpdateGroupActionInput added in v1.15.12

type BatchPutScheduledUpdateGroupActionInput struct {

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// One or more scheduled actions. The maximum number allowed is 50.
	//
	// ScheduledUpdateGroupActions is a required field
	ScheduledUpdateGroupActions []*ScheduledUpdateGroupActionRequest `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchPutScheduledUpdateGroupActionInput) GoString added in v1.15.12

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchPutScheduledUpdateGroupActionInput) SetAutoScalingGroupName added in v1.15.12

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*BatchPutScheduledUpdateGroupActionInput) SetScheduledUpdateGroupActions added in v1.15.12

SetScheduledUpdateGroupActions sets the ScheduledUpdateGroupActions field's value.

func (BatchPutScheduledUpdateGroupActionInput) String added in v1.15.12

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchPutScheduledUpdateGroupActionInput) Validate added in v1.15.12

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

type BatchPutScheduledUpdateGroupActionOutput added in v1.15.12

type BatchPutScheduledUpdateGroupActionOutput struct {

	// The names of the scheduled actions that could not be created or updated,
	// including an error message.
	FailedScheduledUpdateGroupActions []*FailedScheduledUpdateGroupActionRequest `type:"list"`
	// contains filtered or unexported fields
}

func (BatchPutScheduledUpdateGroupActionOutput) GoString added in v1.15.12

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchPutScheduledUpdateGroupActionOutput) SetFailedScheduledUpdateGroupActions added in v1.15.12

SetFailedScheduledUpdateGroupActions sets the FailedScheduledUpdateGroupActions field's value.

func (BatchPutScheduledUpdateGroupActionOutput) String added in v1.15.12

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BlockDeviceMapping

type BlockDeviceMapping struct {

	// The device name assigned to the volume (for example, /dev/sdh or xvdh). For
	// more information, see Device naming on Linux instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/device_naming.html)
	// in the Amazon EC2 User Guide for Linux Instances.
	//
	// To define a block device mapping, set the device name and exactly one of
	// the following properties: Ebs, NoDevice, or VirtualName.
	//
	// DeviceName is a required field
	DeviceName *string `min:"1" type:"string" required:"true"`

	// Information to attach an EBS volume to an instance at launch.
	Ebs *Ebs `type:"structure"`

	// Setting this value to true prevents a volume that is included in the block
	// device mapping of the AMI from being mapped to the specified device name
	// at launch.
	//
	// If NoDevice is true for the root device, instances might fail the EC2 health
	// check. In that case, Amazon EC2 Auto Scaling launches replacement instances.
	NoDevice *bool `type:"boolean"`

	// The name of the instance store volume (virtual device) to attach to an instance
	// at launch. The name must be in the form ephemeralX where X is a number starting
	// from zero (0), for example, ephemeral0.
	VirtualName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes a block device mapping.

func (BlockDeviceMapping) GoString added in v0.6.5

func (s BlockDeviceMapping) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BlockDeviceMapping) SetDeviceName added in v1.5.0

func (s *BlockDeviceMapping) SetDeviceName(v string) *BlockDeviceMapping

SetDeviceName sets the DeviceName field's value.

func (*BlockDeviceMapping) SetEbs added in v1.5.0

func (s *BlockDeviceMapping) SetEbs(v *Ebs) *BlockDeviceMapping

SetEbs sets the Ebs field's value.

func (*BlockDeviceMapping) SetNoDevice added in v1.5.0

func (s *BlockDeviceMapping) SetNoDevice(v bool) *BlockDeviceMapping

SetNoDevice sets the NoDevice field's value.

func (*BlockDeviceMapping) SetVirtualName added in v1.5.0

func (s *BlockDeviceMapping) SetVirtualName(v string) *BlockDeviceMapping

SetVirtualName sets the VirtualName field's value.

func (BlockDeviceMapping) String added in v0.6.5

func (s BlockDeviceMapping) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BlockDeviceMapping) Validate added in v1.1.21

func (s *BlockDeviceMapping) Validate() error

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

type CancelInstanceRefreshInput added in v1.32.3

type CancelInstanceRefreshInput struct {

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CancelInstanceRefreshInput) GoString added in v1.32.3

func (s CancelInstanceRefreshInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelInstanceRefreshInput) SetAutoScalingGroupName added in v1.32.3

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

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (CancelInstanceRefreshInput) String added in v1.32.3

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelInstanceRefreshInput) Validate added in v1.32.3

func (s *CancelInstanceRefreshInput) Validate() error

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

type CancelInstanceRefreshOutput added in v1.32.3

type CancelInstanceRefreshOutput struct {

	// The instance refresh ID associated with the request. This is the unique ID
	// assigned to the instance refresh when it was started.
	InstanceRefreshId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CancelInstanceRefreshOutput) GoString added in v1.32.3

func (s CancelInstanceRefreshOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelInstanceRefreshOutput) SetInstanceRefreshId added in v1.32.3

SetInstanceRefreshId sets the InstanceRefreshId field's value.

func (CancelInstanceRefreshOutput) String added in v1.32.3

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CapacityForecast added in v1.38.43

type CapacityForecast struct {

	// The timestamps for the data points, in UTC format.
	//
	// Timestamps is a required field
	Timestamps []*time.Time `type:"list" required:"true"`

	// The values of the data points.
	//
	// Values is a required field
	Values []*float64 `type:"list" required:"true"`
	// contains filtered or unexported fields
}

A GetPredictiveScalingForecast call returns the capacity forecast for a predictive scaling policy. This structure includes the data points for that capacity forecast, along with the timestamps of those data points.

func (CapacityForecast) GoString added in v1.38.43

func (s CapacityForecast) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CapacityForecast) SetTimestamps added in v1.38.43

func (s *CapacityForecast) SetTimestamps(v []*time.Time) *CapacityForecast

SetTimestamps sets the Timestamps field's value.

func (*CapacityForecast) SetValues added in v1.38.43

func (s *CapacityForecast) SetValues(v []*float64) *CapacityForecast

SetValues sets the Values field's value.

func (CapacityForecast) String added in v1.38.43

func (s CapacityForecast) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CompleteLifecycleActionInput

type CompleteLifecycleActionInput struct {

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// The ID of the instance.
	InstanceId *string `min:"1" type:"string"`

	// The action for the group to take. You can specify either CONTINUE or ABANDON.
	//
	// LifecycleActionResult is a required field
	LifecycleActionResult *string `type:"string" required:"true"`

	// A universally unique identifier (UUID) that identifies a specific lifecycle
	// action associated with an instance. Amazon EC2 Auto Scaling sends this token
	// to the notification target you specified when you created the lifecycle hook.
	LifecycleActionToken *string `min:"36" type:"string"`

	// The name of the lifecycle hook.
	//
	// LifecycleHookName is a required field
	LifecycleHookName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CompleteLifecycleActionInput) GoString added in v0.6.5

func (s CompleteLifecycleActionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CompleteLifecycleActionInput) SetAutoScalingGroupName added in v1.5.0

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

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*CompleteLifecycleActionInput) SetInstanceId added in v1.5.0

SetInstanceId sets the InstanceId field's value.

func (*CompleteLifecycleActionInput) SetLifecycleActionResult added in v1.5.0

func (s *CompleteLifecycleActionInput) SetLifecycleActionResult(v string) *CompleteLifecycleActionInput

SetLifecycleActionResult sets the LifecycleActionResult field's value.

func (*CompleteLifecycleActionInput) SetLifecycleActionToken added in v1.5.0

func (s *CompleteLifecycleActionInput) SetLifecycleActionToken(v string) *CompleteLifecycleActionInput

SetLifecycleActionToken sets the LifecycleActionToken field's value.

func (*CompleteLifecycleActionInput) SetLifecycleHookName added in v1.5.0

SetLifecycleHookName sets the LifecycleHookName field's value.

func (CompleteLifecycleActionInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CompleteLifecycleActionInput) Validate added in v1.1.21

func (s *CompleteLifecycleActionInput) Validate() error

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

type CompleteLifecycleActionOutput

type CompleteLifecycleActionOutput struct {
	// contains filtered or unexported fields
}

func (CompleteLifecycleActionOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (CompleteLifecycleActionOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateAutoScalingGroupInput

type CreateAutoScalingGroupInput struct {

	// The name of the Auto Scaling group. This name must be unique per Region per
	// account.
	//
	// The name can contain any ASCII character 33 to 126 including most punctuation
	// characters, digits, and upper and lowercased letters.
	//
	// You cannot use a colon (:) in the name.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// A list of Availability Zones where instances in the Auto Scaling group can
	// be created. Used for launching into the default VPC subnet in each Availability
	// Zone when not using the VPCZoneIdentifier property, or for attaching a network
	// interface when an existing network interface ID is specified in a launch
	// template.
	AvailabilityZones []*string `type:"list"`

	// Indicates whether Capacity Rebalancing is enabled. Otherwise, Capacity Rebalancing
	// is disabled. 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. For more information, see Use Capacity
	// Rebalancing to handle Amazon EC2 Spot Interruptions (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-capacity-rebalancing.html)
	// in the in the Amazon EC2 Auto Scaling User Guide.
	CapacityRebalance *bool `type:"boolean"`

	// Reserved.
	Context *string `type:"string"`

	// 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 (https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html)
	// in the Amazon EC2 Auto Scaling User Guide.
	//
	// Default: 300 seconds
	DefaultCooldown *int64 `type:"integer"`

	// 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 (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-default-instance-warmup.html)
	// 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.
	//
	// Default: None
	DefaultInstanceWarmup *int64 `type:"integer"`

	// The desired capacity is the initial capacity of the Auto Scaling group at
	// the time of its creation and the capacity it attempts to maintain. It can
	// scale beyond this capacity if you configure auto scaling. 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. If you do not specify a desired capacity,
	// the default is the minimum size of the group.
	DesiredCapacity *int64 `type:"integer"`

	// 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 Creating an Auto Scaling group
	// using attribute-based instance type selection (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html)
	// 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
	DesiredCapacityType *string `min:"1" type:"string"`

	// 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 (https://docs.aws.amazon.com/autoscaling/ec2/userguide/health-check-grace-period.html)
	// in the Amazon EC2 Auto Scaling User Guide.
	//
	// Default: 0 seconds
	HealthCheckGracePeriod *int64 `type:"integer"`

	// A comma-separated value string of one or more health check types.
	//
	// The valid values are EC2, ELB, and VPC_LATTICE. EC2 is the default health
	// check and cannot be disabled. For more information, see Health checks for
	// Auto Scaling instances (https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html)
	// in the Amazon EC2 Auto Scaling User Guide.
	//
	// Only specify EC2 if you must clear a value that was previously set.
	HealthCheckType *string `min:"1" type:"string"`

	// The ID of the instance used to base the launch configuration on. If specified,
	// Amazon EC2 Auto Scaling uses the configuration values from the specified
	// instance to create a new launch configuration. To get the instance ID, use
	// the Amazon EC2 DescribeInstances (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html)
	// API operation. For more information, see Creating an Auto Scaling group using
	// an EC2 instance (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-from-instance.html)
	// in the Amazon EC2 Auto Scaling User Guide.
	InstanceId *string `min:"1" type:"string"`

	// The name of the launch configuration to use to launch instances.
	//
	// Conditional: You must specify either a launch template (LaunchTemplate or
	// MixedInstancesPolicy) or a launch configuration (LaunchConfigurationName
	// or InstanceId).
	LaunchConfigurationName *string `min:"1" type:"string"`

	// Information used to specify the launch template and version to use to launch
	// instances.
	//
	// Conditional: You must specify either a launch template (LaunchTemplate or
	// MixedInstancesPolicy) or a launch configuration (LaunchConfigurationName
	// or InstanceId).
	//
	// 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.
	LaunchTemplate *LaunchTemplateSpecification `type:"structure"`

	// One or more lifecycle hooks to add to the Auto Scaling group before instances
	// are launched.
	LifecycleHookSpecificationList []*LifecycleHookSpecification `type:"list"`

	// A list of Classic Load Balancers associated with this Auto Scaling group.
	// For Application Load Balancers, Network Load Balancers, and Gateway Load
	// Balancers, specify the TargetGroupARNs property instead.
	LoadBalancerNames []*string `type:"list"`

	// 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). For more information, see
	// Replacing Auto Scaling instances based on maximum instance lifetime (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html)
	// in the Amazon EC2 Auto Scaling User Guide.
	MaxInstanceLifetime *int64 `type:"integer"`

	// The maximum size of the 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).
	//
	// MaxSize is a required field
	MaxSize *int64 `type:"integer" required:"true"`

	// The minimum size of the group.
	//
	// MinSize is a required field
	MinSize *int64 `type:"integer" required:"true"`

	// The mixed instances policy. For more information, see Auto Scaling groups
	// with multiple instance types and purchase options (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html)
	// in the Amazon EC2 Auto Scaling User Guide.
	MixedInstancesPolicy *MixedInstancesPolicy `type:"structure"`

	// 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 Using instance scale-in protection
	// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html)
	// in the Amazon EC2 Auto Scaling User Guide.
	NewInstancesProtectedFromScaleIn *bool `type:"boolean"`

	// The name of the placement group into which to launch your instances. 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.
	//
	// 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.
	PlacementGroup *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling
	// group uses to call other Amazon Web Services service on your behalf. By default,
	// Amazon EC2 Auto Scaling uses a service-linked role named AWSServiceRoleForAutoScaling,
	// which it creates if it does not exist. For more information, see Service-linked
	// roles (https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html)
	// in the Amazon EC2 Auto Scaling User Guide.
	ServiceLinkedRoleARN *string `min:"1" type:"string"`

	// One or more tags. You can tag your Auto Scaling group and propagate the tags
	// to the Amazon EC2 instances it launches. Tags are not propagated to Amazon
	// EBS volumes. To add tags to Amazon EBS volumes, specify the tags in a launch
	// template but use caution. If the launch template specifies an instance tag
	// with a key that is also specified for the Auto Scaling group, Amazon EC2
	// Auto Scaling overrides the value of that instance tag with the value specified
	// by the Auto Scaling group. For more information, see Tag Auto Scaling groups
	// and instances (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html)
	// in the Amazon EC2 Auto Scaling User Guide.
	Tags []*Tag `type:"list"`

	// The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups
	// to associate with the Auto Scaling group. Instances are registered as targets
	// with the target groups. The target groups receive incoming traffic and route
	// requests to one or more registered targets. For more information, see Use
	// Elastic Load Balancing to distribute traffic across the instances in your
	// Auto Scaling group (https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html)
	// in the Amazon EC2 Auto Scaling User Guide.
	TargetGroupARNs []*string `type:"list"`

	// A policy or a list of policies that are used to select the instance to terminate.
	// These policies are executed in the order that you list them. For more information,
	// see Work with Amazon EC2 Auto Scaling termination policies (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html)
	// 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
	TerminationPolicies []*string `type:"list"`

	// The list of traffic sources to attach to this Auto Scaling group. You can
	// use any of the following as traffic sources for an Auto Scaling group: Classic
	// Load Balancer, Application Load Balancer, Gateway Load Balancer, Network
	// Load Balancer, and VPC Lattice.
	TrafficSources []*TrafficSourceIdentifier `type:"list"`

	// A comma-separated list of subnet IDs for a virtual private cloud (VPC) where
	// instances in the Auto Scaling group can be created. If you specify VPCZoneIdentifier
	// with AvailabilityZones, the subnets that you specify must reside in those
	// Availability Zones.
	VPCZoneIdentifier *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateAutoScalingGroupInput) GoString added in v0.6.5

func (s CreateAutoScalingGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAutoScalingGroupInput) SetAutoScalingGroupName added in v1.5.0

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

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*CreateAutoScalingGroupInput) SetAvailabilityZones added in v1.5.0

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

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*CreateAutoScalingGroupInput) SetCapacityRebalance added in v1.35.21

func (s *CreateAutoScalingGroupInput) SetCapacityRebalance(v bool) *CreateAutoScalingGroupInput

SetCapacityRebalance sets the CapacityRebalance field's value.

func (*CreateAutoScalingGroupInput) SetContext added in v1.38.70

SetContext sets the Context field's value.

func (*CreateAutoScalingGroupInput) SetDefaultCooldown added in v1.5.0

SetDefaultCooldown sets the DefaultCooldown field's value.

func (*CreateAutoScalingGroupInput) SetDefaultInstanceWarmup added in v1.43.42

func (s *CreateAutoScalingGroupInput) SetDefaultInstanceWarmup(v int64) *CreateAutoScalingGroupInput

SetDefaultInstanceWarmup sets the DefaultInstanceWarmup field's value.

func (*CreateAutoScalingGroupInput) SetDesiredCapacity added in v1.5.0

SetDesiredCapacity sets the DesiredCapacity field's value.

func (*CreateAutoScalingGroupInput) SetDesiredCapacityType added in v1.41.12

func (s *CreateAutoScalingGroupInput) SetDesiredCapacityType(v string) *CreateAutoScalingGroupInput

SetDesiredCapacityType sets the DesiredCapacityType field's value.

func (*CreateAutoScalingGroupInput) SetHealthCheckGracePeriod added in v1.5.0

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

SetHealthCheckGracePeriod sets the HealthCheckGracePeriod field's value.

func (*CreateAutoScalingGroupInput) SetHealthCheckType added in v1.5.0

SetHealthCheckType sets the HealthCheckType field's value.

func (*CreateAutoScalingGroupInput) SetInstanceId added in v1.5.0

SetInstanceId sets the InstanceId field's value.

func (*CreateAutoScalingGroupInput) SetLaunchConfigurationName added in v1.5.0

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

SetLaunchConfigurationName sets the LaunchConfigurationName field's value.

func (*CreateAutoScalingGroupInput) SetLaunchTemplate added in v1.12.37

SetLaunchTemplate sets the LaunchTemplate field's value.

func (*CreateAutoScalingGroupInput) SetLifecycleHookSpecificationList added in v1.10.44

func (s *CreateAutoScalingGroupInput) SetLifecycleHookSpecificationList(v []*LifecycleHookSpecification) *CreateAutoScalingGroupInput

SetLifecycleHookSpecificationList sets the LifecycleHookSpecificationList field's value.

func (*CreateAutoScalingGroupInput) SetLoadBalancerNames added in v1.5.0

func (s *CreateAutoScalingGroupInput) SetLoadBalancerNames(v []*string) *CreateAutoScalingGroupInput

SetLoadBalancerNames sets the LoadBalancerNames field's value.

func (*CreateAutoScalingGroupInput) SetMaxInstanceLifetime added in v1.25.38

func (s *CreateAutoScalingGroupInput) SetMaxInstanceLifetime(v int64) *CreateAutoScalingGroupInput

SetMaxInstanceLifetime sets the MaxInstanceLifetime field's value.

func (*CreateAutoScalingGroupInput) SetMaxSize added in v1.5.0

SetMaxSize sets the MaxSize field's value.

func (*CreateAutoScalingGroupInput) SetMinSize added in v1.5.0

SetMinSize sets the MinSize field's value.

func (*CreateAutoScalingGroupInput) SetMixedInstancesPolicy added in v1.15.76

SetMixedInstancesPolicy sets the MixedInstancesPolicy field's value.

func (*CreateAutoScalingGroupInput) SetNewInstancesProtectedFromScaleIn added in v1.5.0

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

SetNewInstancesProtectedFromScaleIn sets the NewInstancesProtectedFromScaleIn field's value.

func (*CreateAutoScalingGroupInput) SetPlacementGroup added in v1.5.0

SetPlacementGroup sets the PlacementGroup field's value.

func (*CreateAutoScalingGroupInput) SetServiceLinkedRoleARN added in v1.13.1

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

SetServiceLinkedRoleARN sets the ServiceLinkedRoleARN field's value.

func (*CreateAutoScalingGroupInput) SetTags added in v1.5.0

SetTags sets the Tags field's value.

func (*CreateAutoScalingGroupInput) SetTargetGroupARNs added in v1.5.0

func (s *CreateAutoScalingGroupInput) SetTargetGroupARNs(v []*string) *CreateAutoScalingGroupInput

SetTargetGroupARNs sets the TargetGroupARNs field's value.

func (*CreateAutoScalingGroupInput) SetTerminationPolicies added in v1.5.0

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

SetTerminationPolicies sets the TerminationPolicies field's value.

func (*CreateAutoScalingGroupInput) SetTrafficSources added in v1.44.156

SetTrafficSources sets the TrafficSources field's value.

func (*CreateAutoScalingGroupInput) SetVPCZoneIdentifier added in v1.5.0

SetVPCZoneIdentifier sets the VPCZoneIdentifier field's value.

func (CreateAutoScalingGroupInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAutoScalingGroupInput) Validate added in v1.1.21

func (s *CreateAutoScalingGroupInput) Validate() error

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

type CreateAutoScalingGroupOutput

type CreateAutoScalingGroupOutput struct {
	// contains filtered or unexported fields
}

func (CreateAutoScalingGroupOutput) GoString added in v0.6.5

func (s CreateAutoScalingGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (CreateAutoScalingGroupOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateLaunchConfigurationInput

type CreateLaunchConfigurationInput struct {

	// Specifies whether to assign a public IPv4 address to the group's instances.
	// If the instance is launched into a default subnet, the default is to assign
	// a public IPv4 address, unless you disabled the option to assign a public
	// IPv4 address on the subnet. If the instance is launched into a nondefault
	// subnet, the default is not to assign a public IPv4 address, unless you enabled
	// the option to assign a public IPv4 address on the subnet.
	//
	// If you specify true, each instance in the Auto Scaling group receives a unique
	// public IPv4 address. 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.
	//
	// If you specify this property, you must specify at least one subnet for VPCZoneIdentifier
	// when you create your group.
	AssociatePublicIpAddress *bool `type:"boolean"`

	// The block device mapping entries that define the block devices to attach
	// to the instances at launch. By default, the block devices specified in the
	// block device mapping for the AMI are used. For more information, see Block
	// device mappings (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html)
	// in the Amazon EC2 User Guide for Linux Instances.
	BlockDeviceMappings []*BlockDeviceMapping `type:"list"`

	// Available for backward compatibility.
	ClassicLinkVPCId *string `min:"1" type:"string"`

	// Available for backward compatibility.
	ClassicLinkVPCSecurityGroups []*string `type:"list"`

	// Specifies whether the launch configuration is optimized for EBS I/O (true)
	// or not (false). The optimization provides dedicated throughput to Amazon
	// EBS and an optimized configuration stack to provide optimal I/O performance.
	// This optimization is not available with all instance types. Additional fees
	// are incurred when you enable EBS optimization for an instance type that is
	// not EBS-optimized by default. For more information, see Amazon EBS-optimized
	// instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html)
	// in the Amazon EC2 User Guide for Linux Instances.
	//
	// The default value is false.
	EbsOptimized *bool `type:"boolean"`

	// The name or the Amazon Resource Name (ARN) of the instance profile associated
	// with the IAM role for the instance. The instance profile contains the IAM
	// role. For more information, see IAM role for applications that run on Amazon
	// EC2 instances (https://docs.aws.amazon.com/autoscaling/ec2/userguide/us-iam-role.html)
	// in the Amazon EC2 Auto Scaling User Guide.
	IamInstanceProfile *string `min:"1" type:"string"`

	// The ID of the Amazon Machine Image (AMI) that was assigned during registration.
	// For more information, see Finding a Linux AMI (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html)
	// in the Amazon EC2 User Guide for Linux Instances.
	//
	// If you specify InstanceId, an ImageId is not required.
	ImageId *string `min:"1" type:"string"`

	// The ID of the instance to use to create the launch configuration. The new
	// launch configuration derives attributes from the instance, except for the
	// block device mapping.
	//
	// To create a launch configuration with a block device mapping or override
	// any other instance attributes, specify them as part of the same request.
	//
	// For more information, see Creating a launch configuration using an EC2 instance
	// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-lc-with-instanceID.html)
	// in the Amazon EC2 Auto Scaling User Guide.
	InstanceId *string `min:"1" type:"string"`

	// Controls whether instances in this group are launched with detailed (true)
	// or basic (false) monitoring.
	//
	// The default value is true (enabled).
	//
	// 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. For more information,
	// see Configure Monitoring for Auto Scaling Instances (https://docs.aws.amazon.com/autoscaling/latest/userguide/enable-as-instance-metrics.html)
	// in the Amazon EC2 Auto Scaling User Guide.
	InstanceMonitoring *InstanceMonitoring `type:"structure"`

	// Specifies the instance type of the EC2 instance. For information about available
	// instance types, see Available instance types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes)
	// in the Amazon EC2 User Guide for Linux Instances.
	//
	// If you specify InstanceId, an InstanceType is not required.
	InstanceType *string `min:"1" type:"string"`

	// The ID of the kernel associated with the AMI.
	//
	// We recommend that you use PV-GRUB instead of kernels and RAM disks. For more
	// information, see User provided kernels (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html)
	// in the Amazon EC2 User Guide for Linux Instances.
	KernelId *string `min:"1" type:"string"`

	// The name of the key pair. For more information, see Amazon EC2 key pairs
	// and Linux instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html)
	// in the Amazon EC2 User Guide for Linux Instances.
	KeyName *string `min:"1" type:"string"`

	// The name of the launch configuration. This name must be unique per Region
	// per account.
	//
	// LaunchConfigurationName is a required field
	LaunchConfigurationName *string `min:"1" type:"string" required:"true"`

	// The metadata options for the instances. For more information, see Configuring
	// the Instance Metadata Options (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-config.html#launch-configurations-imds)
	// in the Amazon EC2 Auto Scaling User Guide.
	MetadataOptions *InstanceMetadataOptions `type:"structure"`

	// The tenancy of the instance, either default or dedicated. An instance with
	// dedicated tenancy runs on isolated, single-tenant hardware and can only be
	// launched into a VPC. To launch dedicated instances into a shared tenancy
	// VPC (a VPC with the instance placement tenancy attribute set to default),
	// you must set the value of this property to dedicated. For more information,
	// see Configuring instance tenancy with Amazon EC2 Auto Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/auto-scaling-dedicated-instances.html)
	// in the Amazon EC2 Auto Scaling User Guide.
	//
	// If you specify PlacementTenancy, you must specify at least one subnet for
	// VPCZoneIdentifier when you create your group.
	//
	// Valid values: default | dedicated
	PlacementTenancy *string `min:"1" type:"string"`

	// The ID of the RAM disk to select.
	//
	// We recommend that you use PV-GRUB instead of kernels and RAM disks. For more
	// information, see User provided kernels (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html)
	// in the Amazon EC2 User Guide for Linux Instances.
	RamdiskId *string `min:"1" type:"string"`

	// A list that contains the security group IDs to assign to the instances in
	// the Auto Scaling group. For more information, see Control traffic to resources
	// using security groups (https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html)
	// in the Amazon Virtual Private Cloud User Guide.
	SecurityGroups []*string `type:"list"`

	// The maximum hourly price 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 price. For more information, see Request Spot Instances
	// for fault-tolerant and flexible applications (https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-template-spot-instances.html)
	// in the Amazon EC2 Auto Scaling User Guide.
	//
	// Valid Range: Minimum value of 0.001
	//
	// When you change your maximum price by creating a new launch configuration,
	// running instances will continue to run as long as the maximum price for those
	// running instances is higher than the current Spot price.
	SpotPrice *string `min:"1" type:"string"`

	// The user data to make available to the launched EC2 instances. For more information,
	// see Instance metadata and user data (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html)
	// (Linux) and Instance metadata and user data (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-instance-metadata.html)
	// (Windows). If you are using a command line tool, base64-encoding is performed
	// for you, and you can load the text from a file. Otherwise, you must provide
	// base64-encoded text. User data is limited to 16 KB.
	UserData *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateLaunchConfigurationInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLaunchConfigurationInput) SetAssociatePublicIpAddress added in v1.5.0

func (s *CreateLaunchConfigurationInput) SetAssociatePublicIpAddress(v bool) *CreateLaunchConfigurationInput

SetAssociatePublicIpAddress sets the AssociatePublicIpAddress field's value.

func (*CreateLaunchConfigurationInput) SetBlockDeviceMappings added in v1.5.0

SetBlockDeviceMappings sets the BlockDeviceMappings field's value.

func (*CreateLaunchConfigurationInput) SetClassicLinkVPCId added in v1.5.0

SetClassicLinkVPCId sets the ClassicLinkVPCId field's value.

func (*CreateLaunchConfigurationInput) SetClassicLinkVPCSecurityGroups added in v1.5.0

func (s *CreateLaunchConfigurationInput) SetClassicLinkVPCSecurityGroups(v []*string) *CreateLaunchConfigurationInput

SetClassicLinkVPCSecurityGroups sets the ClassicLinkVPCSecurityGroups field's value.

func (*CreateLaunchConfigurationInput) SetEbsOptimized added in v1.5.0

SetEbsOptimized sets the EbsOptimized field's value.

func (*CreateLaunchConfigurationInput) SetIamInstanceProfile added in v1.5.0

SetIamInstanceProfile sets the IamInstanceProfile field's value.

func (*CreateLaunchConfigurationInput) SetImageId added in v1.5.0

SetImageId sets the ImageId field's value.

func (*CreateLaunchConfigurationInput) SetInstanceId added in v1.5.0

SetInstanceId sets the InstanceId field's value.

func (*CreateLaunchConfigurationInput) SetInstanceMonitoring added in v1.5.0

SetInstanceMonitoring sets the InstanceMonitoring field's value.

func (*CreateLaunchConfigurationInput) SetInstanceType added in v1.5.0

SetInstanceType sets the InstanceType field's value.

func (*CreateLaunchConfigurationInput) SetKernelId added in v1.5.0

SetKernelId sets the KernelId field's value.

func (*CreateLaunchConfigurationInput) SetKeyName added in v1.5.0

SetKeyName sets the KeyName field's value.

func (*CreateLaunchConfigurationInput) SetLaunchConfigurationName added in v1.5.0

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

SetLaunchConfigurationName sets the LaunchConfigurationName field's value.

func (*CreateLaunchConfigurationInput) SetMetadataOptions added in v1.33.14

SetMetadataOptions sets the MetadataOptions field's value.

func (*CreateLaunchConfigurationInput) SetPlacementTenancy added in v1.5.0

SetPlacementTenancy sets the PlacementTenancy field's value.

func (*CreateLaunchConfigurationInput) SetRamdiskId added in v1.5.0

SetRamdiskId sets the RamdiskId field's value.

func (*CreateLaunchConfigurationInput) SetSecurityGroups added in v1.5.0

SetSecurityGroups sets the SecurityGroups field's value.

func (*CreateLaunchConfigurationInput) SetSpotPrice added in v1.5.0

SetSpotPrice sets the SpotPrice field's value.

func (*CreateLaunchConfigurationInput) SetUserData added in v1.5.0

SetUserData sets the UserData field's value.

func (CreateLaunchConfigurationInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLaunchConfigurationInput) Validate added in v1.1.21

func (s *CreateLaunchConfigurationInput) Validate() error

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

type CreateLaunchConfigurationOutput

type CreateLaunchConfigurationOutput struct {
	// contains filtered or unexported fields
}

func (CreateLaunchConfigurationOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (CreateLaunchConfigurationOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateOrUpdateTagsInput

type CreateOrUpdateTagsInput struct {

	// One or more tags.
	//
	// Tags is a required field
	Tags []*Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (CreateOrUpdateTagsInput) GoString added in v0.6.5

func (s CreateOrUpdateTagsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateOrUpdateTagsInput) SetTags added in v1.5.0

SetTags sets the Tags field's value.

func (CreateOrUpdateTagsInput) String added in v0.6.5

func (s CreateOrUpdateTagsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateOrUpdateTagsInput) Validate added in v1.1.21

func (s *CreateOrUpdateTagsInput) Validate() error

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

type CreateOrUpdateTagsOutput

type CreateOrUpdateTagsOutput struct {
	// contains filtered or unexported fields
}

func (CreateOrUpdateTagsOutput) GoString added in v0.6.5

func (s CreateOrUpdateTagsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (CreateOrUpdateTagsOutput) String added in v0.6.5

func (s CreateOrUpdateTagsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CustomizedMetricSpecification added in v1.10.9

type CustomizedMetricSpecification struct {

	// The dimensions of the metric.
	//
	// Conditional: If you published your metric with dimensions, you must specify
	// the same dimensions in your scaling policy.
	Dimensions []*MetricDimension `type:"list"`

	// The name of the metric. To get the exact metric name, namespace, and dimensions,
	// inspect the Metric (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html)
	// object that is returned by a call to ListMetrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html).
	MetricName *string `type:"string"`

	// The metrics to include in the target tracking scaling policy, as a metric
	// data query. This can include both raw metric and metric math expressions.
	Metrics []*TargetTrackingMetricDataQuery `type:"list"`

	// The namespace of the metric.
	Namespace *string `type:"string"`

	// The statistic of the metric.
	Statistic *string `type:"string" enum:"MetricStatistic"`

	// The unit of the metric. For a complete list of the units that CloudWatch
	// supports, see the MetricDatum (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html)
	// data type in the Amazon CloudWatch API Reference.
	Unit *string `type:"string"`
	// contains filtered or unexported fields
}

Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use with Amazon EC2 Auto Scaling.

To create your customized metric specification:

  • Add values for each required property from CloudWatch. You can use an existing metric, or a new metric that you create. To use your own metric, you must first publish the metric to CloudWatch. For more information, see Publish custom metrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html) in the Amazon CloudWatch User Guide.

  • Choose a metric that changes proportionally with capacity. The value of the metric should increase or decrease in inverse proportion to the number of capacity units. That is, the value of the metric should decrease when capacity increases.

For more information about the CloudWatch terminology below, see Amazon CloudWatch concepts (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html).

Each individual service provides information about the metrics, namespace, and dimensions they use. For more information, see Amazon Web Services services that publish CloudWatch metrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) in the Amazon CloudWatch User Guide.

func (CustomizedMetricSpecification) GoString added in v1.10.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CustomizedMetricSpecification) SetDimensions added in v1.10.9

SetDimensions sets the Dimensions field's value.

func (*CustomizedMetricSpecification) SetMetricName added in v1.10.9

SetMetricName sets the MetricName field's value.

func (*CustomizedMetricSpecification) SetMetrics added in v1.44.156

SetMetrics sets the Metrics field's value.

func (*CustomizedMetricSpecification) SetNamespace added in v1.10.9

SetNamespace sets the Namespace field's value.

func (*CustomizedMetricSpecification) SetStatistic added in v1.10.9

SetStatistic sets the Statistic field's value.

func (*CustomizedMetricSpecification) SetUnit added in v1.10.9

SetUnit sets the Unit field's value.

func (CustomizedMetricSpecification) String added in v1.10.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CustomizedMetricSpecification) Validate added in v1.10.9

func (s *CustomizedMetricSpecification) Validate() error

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

type DeleteAutoScalingGroupInput

type DeleteAutoScalingGroupInput struct {

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// Specifies that the group is to be deleted along with all instances associated
	// with the group, without waiting for all instances to be terminated. This
	// action also deletes any outstanding lifecycle actions associated with the
	// group.
	ForceDelete *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (DeleteAutoScalingGroupInput) GoString added in v0.6.5

func (s DeleteAutoScalingGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAutoScalingGroupInput) SetAutoScalingGroupName added in v1.5.0

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

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*DeleteAutoScalingGroupInput) SetForceDelete added in v1.5.0

SetForceDelete sets the ForceDelete field's value.

func (DeleteAutoScalingGroupInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAutoScalingGroupInput) Validate added in v1.1.21

func (s *DeleteAutoScalingGroupInput) Validate() error

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

type DeleteAutoScalingGroupOutput

type DeleteAutoScalingGroupOutput struct {
	// contains filtered or unexported fields
}

func (DeleteAutoScalingGroupOutput) GoString added in v0.6.5

func (s DeleteAutoScalingGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteAutoScalingGroupOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteLaunchConfigurationInput

type DeleteLaunchConfigurationInput struct {

	// The name of the launch configuration.
	//
	// LaunchConfigurationName is a required field
	LaunchConfigurationName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteLaunchConfigurationInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteLaunchConfigurationInput) SetLaunchConfigurationName added in v1.5.0

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

SetLaunchConfigurationName sets the LaunchConfigurationName field's value.

func (DeleteLaunchConfigurationInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteLaunchConfigurationInput) Validate added in v1.1.21

func (s *DeleteLaunchConfigurationInput) Validate() error

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

type DeleteLaunchConfigurationOutput

type DeleteLaunchConfigurationOutput struct {
	// contains filtered or unexported fields
}

func (DeleteLaunchConfigurationOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteLaunchConfigurationOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteLifecycleHookInput

type DeleteLifecycleHookInput struct {

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// The name of the lifecycle hook.
	//
	// LifecycleHookName is a required field
	LifecycleHookName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteLifecycleHookInput) GoString added in v0.6.5

func (s DeleteLifecycleHookInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteLifecycleHookInput) SetAutoScalingGroupName added in v1.5.0

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

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*DeleteLifecycleHookInput) SetLifecycleHookName added in v1.5.0

func (s *DeleteLifecycleHookInput) SetLifecycleHookName(v string) *DeleteLifecycleHookInput

SetLifecycleHookName sets the LifecycleHookName field's value.

func (DeleteLifecycleHookInput) String added in v0.6.5

func (s DeleteLifecycleHookInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteLifecycleHookInput) Validate added in v1.1.21

func (s *DeleteLifecycleHookInput) Validate() error

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

type DeleteLifecycleHookOutput

type DeleteLifecycleHookOutput struct {
	// contains filtered or unexported fields
}

func (DeleteLifecycleHookOutput) GoString added in v0.6.5

func (s DeleteLifecycleHookOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteLifecycleHookOutput) String added in v0.6.5

func (s DeleteLifecycleHookOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteNotificationConfigurationInput

type DeleteNotificationConfigurationInput struct {

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the Amazon SNS topic.
	//
	// TopicARN is a required field
	TopicARN *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteNotificationConfigurationInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteNotificationConfigurationInput) SetAutoScalingGroupName added in v1.5.0

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*DeleteNotificationConfigurationInput) SetTopicARN added in v1.5.0

SetTopicARN sets the TopicARN field's value.

func (DeleteNotificationConfigurationInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteNotificationConfigurationInput) Validate added in v1.1.21

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

type DeleteNotificationConfigurationOutput

type DeleteNotificationConfigurationOutput struct {
	// contains filtered or unexported fields
}

func (DeleteNotificationConfigurationOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteNotificationConfigurationOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeletePolicyInput

type DeletePolicyInput struct {

	// The name of the Auto Scaling group.
	AutoScalingGroupName *string `min:"1" type:"string"`

	// The name or Amazon Resource Name (ARN) of the policy.
	//
	// PolicyName is a required field
	PolicyName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeletePolicyInput) GoString added in v0.6.5

func (s DeletePolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeletePolicyInput) SetAutoScalingGroupName added in v1.5.0

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

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*DeletePolicyInput) SetPolicyName added in v1.5.0

func (s *DeletePolicyInput) SetPolicyName(v string) *DeletePolicyInput

SetPolicyName sets the PolicyName field's value.

func (DeletePolicyInput) String added in v0.6.5

func (s DeletePolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeletePolicyInput) Validate added in v1.1.21

func (s *DeletePolicyInput) Validate() error

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

type DeletePolicyOutput

type DeletePolicyOutput struct {
	// contains filtered or unexported fields
}

func (DeletePolicyOutput) GoString added in v0.6.5

func (s DeletePolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeletePolicyOutput) String added in v0.6.5

func (s DeletePolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteScheduledActionInput

type DeleteScheduledActionInput struct {

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// The name of the action to delete.
	//
	// ScheduledActionName is a required field
	ScheduledActionName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteScheduledActionInput) GoString added in v0.6.5

func (s DeleteScheduledActionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteScheduledActionInput) SetAutoScalingGroupName added in v1.5.0

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

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*DeleteScheduledActionInput) SetScheduledActionName added in v1.5.0

func (s *DeleteScheduledActionInput) SetScheduledActionName(v string) *DeleteScheduledActionInput

SetScheduledActionName sets the ScheduledActionName field's value.

func (DeleteScheduledActionInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteScheduledActionInput) Validate added in v1.1.21

func (s *DeleteScheduledActionInput) Validate() error

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

type DeleteScheduledActionOutput

type DeleteScheduledActionOutput struct {
	// contains filtered or unexported fields
}

func (DeleteScheduledActionOutput) GoString added in v0.6.5

func (s DeleteScheduledActionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteScheduledActionOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteTagsInput

type DeleteTagsInput struct {

	// One or more tags.
	//
	// Tags is a required field
	Tags []*Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteTagsInput) GoString added in v0.6.5

func (s DeleteTagsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteTagsInput) SetTags added in v1.5.0

func (s *DeleteTagsInput) SetTags(v []*Tag) *DeleteTagsInput

SetTags sets the Tags field's value.

func (DeleteTagsInput) String added in v0.6.5

func (s DeleteTagsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteTagsInput) Validate added in v1.1.21

func (s *DeleteTagsInput) Validate() error

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

type DeleteTagsOutput

type DeleteTagsOutput struct {
	// contains filtered or unexported fields
}

func (DeleteTagsOutput) GoString added in v0.6.5

func (s DeleteTagsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteTagsOutput) String added in v0.6.5

func (s DeleteTagsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteWarmPoolInput added in v1.38.16

type DeleteWarmPoolInput struct {

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// Specifies that the warm pool is to be deleted along with all of its associated
	// instances, without waiting for all instances to be terminated. This parameter
	// also deletes any outstanding lifecycle actions associated with the warm pool
	// instances.
	ForceDelete *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (DeleteWarmPoolInput) GoString added in v1.38.16

func (s DeleteWarmPoolInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteWarmPoolInput) SetAutoScalingGroupName added in v1.38.16

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

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*DeleteWarmPoolInput) SetForceDelete added in v1.38.16

func (s *DeleteWarmPoolInput) SetForceDelete(v bool) *DeleteWarmPoolInput

SetForceDelete sets the ForceDelete field's value.

func (DeleteWarmPoolInput) String added in v1.38.16

func (s DeleteWarmPoolInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteWarmPoolInput) Validate added in v1.38.16

func (s *DeleteWarmPoolInput) Validate() error

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

type DeleteWarmPoolOutput added in v1.38.16

type DeleteWarmPoolOutput struct {
	// contains filtered or unexported fields
}

func (DeleteWarmPoolOutput) GoString added in v1.38.16

func (s DeleteWarmPoolOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteWarmPoolOutput) String added in v1.38.16

func (s DeleteWarmPoolOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAccountLimitsInput

type DescribeAccountLimitsInput struct {
	// contains filtered or unexported fields
}

func (DescribeAccountLimitsInput) GoString added in v0.6.5

func (s DescribeAccountLimitsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DescribeAccountLimitsInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAccountLimitsOutput

type DescribeAccountLimitsOutput struct {

	// The maximum number of groups allowed for your account. The default is 200
	// groups per Region.
	MaxNumberOfAutoScalingGroups *int64 `type:"integer"`

	// The maximum number of launch configurations allowed for your account. The
	// default is 200 launch configurations per Region.
	MaxNumberOfLaunchConfigurations *int64 `type:"integer"`

	// The current number of groups for your account.
	NumberOfAutoScalingGroups *int64 `type:"integer"`

	// The current number of launch configurations for your account.
	NumberOfLaunchConfigurations *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (DescribeAccountLimitsOutput) GoString added in v0.6.5

func (s DescribeAccountLimitsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAccountLimitsOutput) SetMaxNumberOfAutoScalingGroups added in v1.5.0

func (s *DescribeAccountLimitsOutput) SetMaxNumberOfAutoScalingGroups(v int64) *DescribeAccountLimitsOutput

SetMaxNumberOfAutoScalingGroups sets the MaxNumberOfAutoScalingGroups field's value.

func (*DescribeAccountLimitsOutput) SetMaxNumberOfLaunchConfigurations added in v1.5.0

func (s *DescribeAccountLimitsOutput) SetMaxNumberOfLaunchConfigurations(v int64) *DescribeAccountLimitsOutput

SetMaxNumberOfLaunchConfigurations sets the MaxNumberOfLaunchConfigurations field's value.

func (*DescribeAccountLimitsOutput) SetNumberOfAutoScalingGroups added in v1.5.0

func (s *DescribeAccountLimitsOutput) SetNumberOfAutoScalingGroups(v int64) *DescribeAccountLimitsOutput

SetNumberOfAutoScalingGroups sets the NumberOfAutoScalingGroups field's value.

func (*DescribeAccountLimitsOutput) SetNumberOfLaunchConfigurations added in v1.5.0

func (s *DescribeAccountLimitsOutput) SetNumberOfLaunchConfigurations(v int64) *DescribeAccountLimitsOutput

SetNumberOfLaunchConfigurations sets the NumberOfLaunchConfigurations field's value.

func (DescribeAccountLimitsOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAdjustmentTypesInput

type DescribeAdjustmentTypesInput struct {
	// contains filtered or unexported fields
}

func (DescribeAdjustmentTypesInput) GoString added in v0.6.5

func (s DescribeAdjustmentTypesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DescribeAdjustmentTypesInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAdjustmentTypesOutput

type DescribeAdjustmentTypesOutput struct {

	// The policy adjustment types.
	AdjustmentTypes []*AdjustmentType `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeAdjustmentTypesOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAdjustmentTypesOutput) SetAdjustmentTypes added in v1.5.0

SetAdjustmentTypes sets the AdjustmentTypes field's value.

func (DescribeAdjustmentTypesOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAutoScalingGroupsInput

type DescribeAutoScalingGroupsInput struct {

	// The names of the Auto Scaling groups. By default, you can only specify up
	// to 50 names. You can optionally increase this limit using the MaxRecords
	// property.
	//
	// If you omit this property, all Auto Scaling groups are described.
	AutoScalingGroupNames []*string `type:"list"`

	// One or more filters to limit the results based on specific tags.
	Filters []*Filter `type:"list"`

	// The maximum number of items to return with this call. The default value is
	// 50 and the maximum value is 100.
	MaxRecords *int64 `type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeAutoScalingGroupsInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAutoScalingGroupsInput) SetAutoScalingGroupNames added in v1.5.0

func (s *DescribeAutoScalingGroupsInput) SetAutoScalingGroupNames(v []*string) *DescribeAutoScalingGroupsInput

SetAutoScalingGroupNames sets the AutoScalingGroupNames field's value.

func (*DescribeAutoScalingGroupsInput) SetFilters added in v1.41.3

SetFilters sets the Filters field's value.

func (*DescribeAutoScalingGroupsInput) SetMaxRecords added in v1.5.0

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeAutoScalingGroupsInput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeAutoScalingGroupsInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAutoScalingGroupsOutput

type DescribeAutoScalingGroupsOutput struct {

	// The groups.
	//
	// AutoScalingGroups is a required field
	AutoScalingGroups []*Group `type:"list" required:"true"`

	// A string that indicates that the response contains more items than can be
	// returned in a single response. To receive additional items, specify this
	// string for the NextToken value when requesting the next set of items. This
	// value is null when there are no more items to return.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeAutoScalingGroupsOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAutoScalingGroupsOutput) SetAutoScalingGroups added in v1.5.0

SetAutoScalingGroups sets the AutoScalingGroups field's value.

func (*DescribeAutoScalingGroupsOutput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeAutoScalingGroupsOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAutoScalingInstancesInput

type DescribeAutoScalingInstancesInput struct {

	// The IDs of the instances. If you omit this property, all Auto Scaling instances
	// are described. If you specify an ID that does not exist, it is ignored with
	// no error.
	//
	// Array Members: Maximum number of 50 items.
	InstanceIds []*string `type:"list"`

	// The maximum number of items to return with this call. The default value is
	// 50 and the maximum value is 50.
	MaxRecords *int64 `type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeAutoScalingInstancesInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAutoScalingInstancesInput) SetInstanceIds added in v1.5.0

SetInstanceIds sets the InstanceIds field's value.

func (*DescribeAutoScalingInstancesInput) SetMaxRecords added in v1.5.0

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeAutoScalingInstancesInput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeAutoScalingInstancesInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAutoScalingInstancesOutput

type DescribeAutoScalingInstancesOutput struct {

	// The instances.
	AutoScalingInstances []*InstanceDetails `type:"list"`

	// A string that indicates that the response contains more items than can be
	// returned in a single response. To receive additional items, specify this
	// string for the NextToken value when requesting the next set of items. This
	// value is null when there are no more items to return.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeAutoScalingInstancesOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAutoScalingInstancesOutput) SetAutoScalingInstances added in v1.5.0

SetAutoScalingInstances sets the AutoScalingInstances field's value.

func (*DescribeAutoScalingInstancesOutput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeAutoScalingInstancesOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAutoScalingNotificationTypesInput

type DescribeAutoScalingNotificationTypesInput struct {
	// contains filtered or unexported fields
}

func (DescribeAutoScalingNotificationTypesInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DescribeAutoScalingNotificationTypesInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAutoScalingNotificationTypesOutput

type DescribeAutoScalingNotificationTypesOutput struct {

	// The notification types.
	AutoScalingNotificationTypes []*string `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeAutoScalingNotificationTypesOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAutoScalingNotificationTypesOutput) SetAutoScalingNotificationTypes added in v1.5.0

SetAutoScalingNotificationTypes sets the AutoScalingNotificationTypes field's value.

func (DescribeAutoScalingNotificationTypesOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeInstanceRefreshesInput added in v1.32.3

type DescribeInstanceRefreshesInput struct {

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// One or more instance refresh IDs.
	InstanceRefreshIds []*string `type:"list"`

	// The maximum number of items to return with this call. The default value is
	// 50 and the maximum value is 100.
	MaxRecords *int64 `type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeInstanceRefreshesInput) GoString added in v1.32.3

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeInstanceRefreshesInput) SetAutoScalingGroupName added in v1.32.3

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*DescribeInstanceRefreshesInput) SetInstanceRefreshIds added in v1.32.3

SetInstanceRefreshIds sets the InstanceRefreshIds field's value.

func (*DescribeInstanceRefreshesInput) SetMaxRecords added in v1.32.3

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeInstanceRefreshesInput) SetNextToken added in v1.32.3

SetNextToken sets the NextToken field's value.

func (DescribeInstanceRefreshesInput) String added in v1.32.3

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeInstanceRefreshesInput) Validate added in v1.32.3

func (s *DescribeInstanceRefreshesInput) Validate() error

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

type DescribeInstanceRefreshesOutput added in v1.32.3

type DescribeInstanceRefreshesOutput struct {

	// The instance refreshes for the specified group, sorted by creation timestamp
	// in descending order.
	InstanceRefreshes []*InstanceRefresh `type:"list"`

	// A string that indicates that the response contains more items than can be
	// returned in a single response. To receive additional items, specify this
	// string for the NextToken value when requesting the next set of items. This
	// value is null when there are no more items to return.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeInstanceRefreshesOutput) GoString added in v1.32.3

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeInstanceRefreshesOutput) SetInstanceRefreshes added in v1.32.3

SetInstanceRefreshes sets the InstanceRefreshes field's value.

func (*DescribeInstanceRefreshesOutput) SetNextToken added in v1.32.3

SetNextToken sets the NextToken field's value.

func (DescribeInstanceRefreshesOutput) String added in v1.32.3

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeLaunchConfigurationsInput

type DescribeLaunchConfigurationsInput struct {

	// The launch configuration names. If you omit this property, all launch configurations
	// are described.
	//
	// Array Members: Maximum number of 50 items.
	LaunchConfigurationNames []*string `type:"list"`

	// The maximum number of items to return with this call. The default value is
	// 50 and the maximum value is 100.
	MaxRecords *int64 `type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeLaunchConfigurationsInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeLaunchConfigurationsInput) SetLaunchConfigurationNames added in v1.5.0

func (s *DescribeLaunchConfigurationsInput) SetLaunchConfigurationNames(v []*string) *DescribeLaunchConfigurationsInput

SetLaunchConfigurationNames sets the LaunchConfigurationNames field's value.

func (*DescribeLaunchConfigurationsInput) SetMaxRecords added in v1.5.0

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeLaunchConfigurationsInput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeLaunchConfigurationsInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeLaunchConfigurationsOutput

type DescribeLaunchConfigurationsOutput struct {

	// The launch configurations.
	//
	// LaunchConfigurations is a required field
	LaunchConfigurations []*LaunchConfiguration `type:"list" required:"true"`

	// A string that indicates that the response contains more items than can be
	// returned in a single response. To receive additional items, specify this
	// string for the NextToken value when requesting the next set of items. This
	// value is null when there are no more items to return.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeLaunchConfigurationsOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeLaunchConfigurationsOutput) SetLaunchConfigurations added in v1.5.0

SetLaunchConfigurations sets the LaunchConfigurations field's value.

func (*DescribeLaunchConfigurationsOutput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeLaunchConfigurationsOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeLifecycleHookTypesInput

type DescribeLifecycleHookTypesInput struct {
	// contains filtered or unexported fields
}

func (DescribeLifecycleHookTypesInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DescribeLifecycleHookTypesInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeLifecycleHookTypesOutput

type DescribeLifecycleHookTypesOutput struct {

	// The lifecycle hook types.
	LifecycleHookTypes []*string `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeLifecycleHookTypesOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeLifecycleHookTypesOutput) SetLifecycleHookTypes added in v1.5.0

SetLifecycleHookTypes sets the LifecycleHookTypes field's value.

func (DescribeLifecycleHookTypesOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeLifecycleHooksInput

type DescribeLifecycleHooksInput struct {

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// The names of one or more lifecycle hooks. If you omit this property, all
	// lifecycle hooks are described.
	LifecycleHookNames []*string `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeLifecycleHooksInput) GoString added in v0.6.5

func (s DescribeLifecycleHooksInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeLifecycleHooksInput) SetAutoScalingGroupName added in v1.5.0

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

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*DescribeLifecycleHooksInput) SetLifecycleHookNames added in v1.5.0

func (s *DescribeLifecycleHooksInput) SetLifecycleHookNames(v []*string) *DescribeLifecycleHooksInput

SetLifecycleHookNames sets the LifecycleHookNames field's value.

func (DescribeLifecycleHooksInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeLifecycleHooksInput) Validate added in v1.1.21

func (s *DescribeLifecycleHooksInput) Validate() error

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

type DescribeLifecycleHooksOutput

type DescribeLifecycleHooksOutput struct {

	// The lifecycle hooks for the specified group.
	LifecycleHooks []*LifecycleHook `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeLifecycleHooksOutput) GoString added in v0.6.5

func (s DescribeLifecycleHooksOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeLifecycleHooksOutput) SetLifecycleHooks added in v1.5.0

SetLifecycleHooks sets the LifecycleHooks field's value.

func (DescribeLifecycleHooksOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeLoadBalancerTargetGroupsInput added in v1.4.1

type DescribeLoadBalancerTargetGroupsInput struct {

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// The maximum number of items to return with this call. The default value is
	// 100 and the maximum value is 100.
	MaxRecords *int64 `type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeLoadBalancerTargetGroupsInput) GoString added in v1.4.1

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeLoadBalancerTargetGroupsInput) SetAutoScalingGroupName added in v1.5.0

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*DescribeLoadBalancerTargetGroupsInput) SetMaxRecords added in v1.5.0

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeLoadBalancerTargetGroupsInput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeLoadBalancerTargetGroupsInput) String added in v1.4.1

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeLoadBalancerTargetGroupsInput) Validate added in v1.4.1

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

type DescribeLoadBalancerTargetGroupsOutput added in v1.4.1

type DescribeLoadBalancerTargetGroupsOutput struct {

	// Information about the target groups.
	LoadBalancerTargetGroups []*LoadBalancerTargetGroupState `type:"list"`

	// A string that indicates that the response contains more items than can be
	// returned in a single response. To receive additional items, specify this
	// string for the NextToken value when requesting the next set of items. This
	// value is null when there are no more items to return.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeLoadBalancerTargetGroupsOutput) GoString added in v1.4.1

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeLoadBalancerTargetGroupsOutput) SetLoadBalancerTargetGroups added in v1.5.0

SetLoadBalancerTargetGroups sets the LoadBalancerTargetGroups field's value.

func (*DescribeLoadBalancerTargetGroupsOutput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeLoadBalancerTargetGroupsOutput) String added in v1.4.1

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeLoadBalancersInput added in v0.6.2

type DescribeLoadBalancersInput struct {

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// The maximum number of items to return with this call. The default value is
	// 100 and the maximum value is 100.
	MaxRecords *int64 `type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeLoadBalancersInput) GoString added in v0.6.5

func (s DescribeLoadBalancersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeLoadBalancersInput) SetAutoScalingGroupName added in v1.5.0

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

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*DescribeLoadBalancersInput) SetMaxRecords added in v1.5.0

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeLoadBalancersInput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeLoadBalancersInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeLoadBalancersInput) Validate added in v1.1.21

func (s *DescribeLoadBalancersInput) Validate() error

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

type DescribeLoadBalancersOutput added in v0.6.2

type DescribeLoadBalancersOutput struct {

	// The load balancers.
	LoadBalancers []*LoadBalancerState `type:"list"`

	// A string that indicates that the response contains more items than can be
	// returned in a single response. To receive additional items, specify this
	// string for the NextToken value when requesting the next set of items. This
	// value is null when there are no more items to return.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeLoadBalancersOutput) GoString added in v0.6.5

func (s DescribeLoadBalancersOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeLoadBalancersOutput) SetLoadBalancers added in v1.5.0

SetLoadBalancers sets the LoadBalancers field's value.

func (*DescribeLoadBalancersOutput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeLoadBalancersOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeMetricCollectionTypesInput

type DescribeMetricCollectionTypesInput struct {
	// contains filtered or unexported fields
}

func (DescribeMetricCollectionTypesInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DescribeMetricCollectionTypesInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeMetricCollectionTypesOutput

type DescribeMetricCollectionTypesOutput struct {

	// The granularities for the metrics.
	Granularities []*MetricGranularityType `type:"list"`

	// The metrics.
	Metrics []*MetricCollectionType `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeMetricCollectionTypesOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeMetricCollectionTypesOutput) SetGranularities added in v1.5.0

SetGranularities sets the Granularities field's value.

func (*DescribeMetricCollectionTypesOutput) SetMetrics added in v1.5.0

SetMetrics sets the Metrics field's value.

func (DescribeMetricCollectionTypesOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeNotificationConfigurationsInput

type DescribeNotificationConfigurationsInput struct {

	// The name of the Auto Scaling group.
	AutoScalingGroupNames []*string `type:"list"`

	// The maximum number of items to return with this call. The default value is
	// 50 and the maximum value is 100.
	MaxRecords *int64 `type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeNotificationConfigurationsInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeNotificationConfigurationsInput) SetAutoScalingGroupNames added in v1.5.0

SetAutoScalingGroupNames sets the AutoScalingGroupNames field's value.

func (*DescribeNotificationConfigurationsInput) SetMaxRecords added in v1.5.0

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeNotificationConfigurationsInput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeNotificationConfigurationsInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeNotificationConfigurationsOutput

type DescribeNotificationConfigurationsOutput struct {

	// A string that indicates that the response contains more items than can be
	// returned in a single response. To receive additional items, specify this
	// string for the NextToken value when requesting the next set of items. This
	// value is null when there are no more items to return.
	NextToken *string `type:"string"`

	// The notification configurations.
	//
	// NotificationConfigurations is a required field
	NotificationConfigurations []*NotificationConfiguration `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeNotificationConfigurationsOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeNotificationConfigurationsOutput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (*DescribeNotificationConfigurationsOutput) SetNotificationConfigurations added in v1.5.0

SetNotificationConfigurations sets the NotificationConfigurations field's value.

func (DescribeNotificationConfigurationsOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribePoliciesInput

type DescribePoliciesInput struct {

	// The name of the Auto Scaling group.
	AutoScalingGroupName *string `min:"1" type:"string"`

	// The maximum number of items to be returned with each call. The default value
	// is 50 and the maximum value is 100.
	MaxRecords *int64 `type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`

	// The names of one or more policies. If you omit this property, all policies
	// are described. If a group name is provided, the results are limited to that
	// group. If you specify an unknown policy name, it is ignored with no error.
	//
	// Array Members: Maximum number of 50 items.
	PolicyNames []*string `type:"list"`

	// One or more policy types. The valid values are SimpleScaling, StepScaling,
	// TargetTrackingScaling, and PredictiveScaling.
	PolicyTypes []*string `type:"list"`
	// contains filtered or unexported fields
}

func (DescribePoliciesInput) GoString added in v0.6.5

func (s DescribePoliciesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePoliciesInput) SetAutoScalingGroupName added in v1.5.0

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

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*DescribePoliciesInput) SetMaxRecords added in v1.5.0

func (s *DescribePoliciesInput) SetMaxRecords(v int64) *DescribePoliciesInput

SetMaxRecords sets the MaxRecords field's value.

func (*DescribePoliciesInput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (*DescribePoliciesInput) SetPolicyNames added in v1.5.0

func (s *DescribePoliciesInput) SetPolicyNames(v []*string) *DescribePoliciesInput

SetPolicyNames sets the PolicyNames field's value.

func (*DescribePoliciesInput) SetPolicyTypes added in v1.5.0

func (s *DescribePoliciesInput) SetPolicyTypes(v []*string) *DescribePoliciesInput

SetPolicyTypes sets the PolicyTypes field's value.

func (DescribePoliciesInput) String added in v0.6.5

func (s DescribePoliciesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePoliciesInput) Validate added in v1.1.21

func (s *DescribePoliciesInput) Validate() error

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

type DescribePoliciesOutput

type DescribePoliciesOutput struct {

	// A string that indicates that the response contains more items than can be
	// returned in a single response. To receive additional items, specify this
	// string for the NextToken value when requesting the next set of items. This
	// value is null when there are no more items to return.
	NextToken *string `type:"string"`

	// The scaling policies.
	ScalingPolicies []*ScalingPolicy `type:"list"`
	// contains filtered or unexported fields
}

func (DescribePoliciesOutput) GoString added in v0.6.5

func (s DescribePoliciesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePoliciesOutput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (*DescribePoliciesOutput) SetScalingPolicies added in v1.5.0

func (s *DescribePoliciesOutput) SetScalingPolicies(v []*ScalingPolicy) *DescribePoliciesOutput

SetScalingPolicies sets the ScalingPolicies field's value.

func (DescribePoliciesOutput) String added in v0.6.5

func (s DescribePoliciesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeScalingActivitiesInput

type DescribeScalingActivitiesInput struct {

	// The activity IDs of the desired scaling activities. If you omit this property,
	// all activities for the past six weeks are described. If unknown activities
	// are requested, they are ignored with no error. If you specify an Auto Scaling
	// group, the results are limited to that group.
	//
	// Array Members: Maximum number of 50 IDs.
	ActivityIds []*string `type:"list"`

	// The name of the Auto Scaling group.
	AutoScalingGroupName *string `min:"1" type:"string"`

	// Indicates whether to include scaling activity from deleted Auto Scaling groups.
	IncludeDeletedGroups *bool `type:"boolean"`

	// The maximum number of items to return with this call. The default value is
	// 100 and the maximum value is 100.
	MaxRecords *int64 `type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeScalingActivitiesInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeScalingActivitiesInput) SetActivityIds added in v1.5.0

SetActivityIds sets the ActivityIds field's value.

func (*DescribeScalingActivitiesInput) SetAutoScalingGroupName added in v1.5.0

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*DescribeScalingActivitiesInput) SetIncludeDeletedGroups added in v1.37.17

SetIncludeDeletedGroups sets the IncludeDeletedGroups field's value.

func (*DescribeScalingActivitiesInput) SetMaxRecords added in v1.5.0

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeScalingActivitiesInput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeScalingActivitiesInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeScalingActivitiesInput) Validate added in v1.1.21

func (s *DescribeScalingActivitiesInput) Validate() error

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

type DescribeScalingActivitiesOutput

type DescribeScalingActivitiesOutput struct {

	// The scaling activities. Activities are sorted by start time. Activities still
	// in progress are described first.
	//
	// Activities is a required field
	Activities []*Activity `type:"list" required:"true"`

	// A string that indicates that the response contains more items than can be
	// returned in a single response. To receive additional items, specify this
	// string for the NextToken value when requesting the next set of items. This
	// value is null when there are no more items to return.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeScalingActivitiesOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeScalingActivitiesOutput) SetActivities added in v1.5.0

SetActivities sets the Activities field's value.

func (*DescribeScalingActivitiesOutput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeScalingActivitiesOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeScalingProcessTypesInput

type DescribeScalingProcessTypesInput struct {
	// contains filtered or unexported fields
}

func (DescribeScalingProcessTypesInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DescribeScalingProcessTypesInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeScalingProcessTypesOutput

type DescribeScalingProcessTypesOutput struct {

	// The names of the process types.
	Processes []*ProcessType `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeScalingProcessTypesOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeScalingProcessTypesOutput) SetProcesses added in v1.5.0

SetProcesses sets the Processes field's value.

func (DescribeScalingProcessTypesOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeScheduledActionsInput

type DescribeScheduledActionsInput struct {

	// The name of the Auto Scaling group.
	AutoScalingGroupName *string `min:"1" type:"string"`

	// The latest scheduled start time to return. If scheduled action names are
	// provided, this property is ignored.
	EndTime *time.Time `type:"timestamp"`

	// The maximum number of items to return with this call. The default value is
	// 50 and the maximum value is 100.
	MaxRecords *int64 `type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`

	// The names of one or more scheduled actions. If you omit this property, all
	// scheduled actions are described. If you specify an unknown scheduled action,
	// it is ignored with no error.
	//
	// Array Members: Maximum number of 50 actions.
	ScheduledActionNames []*string `type:"list"`

	// The earliest scheduled start time to return. If scheduled action names are
	// provided, this property is ignored.
	StartTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

func (DescribeScheduledActionsInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeScheduledActionsInput) SetAutoScalingGroupName added in v1.5.0

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*DescribeScheduledActionsInput) SetEndTime added in v1.5.0

SetEndTime sets the EndTime field's value.

func (*DescribeScheduledActionsInput) SetMaxRecords added in v1.5.0

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeScheduledActionsInput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (*DescribeScheduledActionsInput) SetScheduledActionNames added in v1.5.0

func (s *DescribeScheduledActionsInput) SetScheduledActionNames(v []*string) *DescribeScheduledActionsInput

SetScheduledActionNames sets the ScheduledActionNames field's value.

func (*DescribeScheduledActionsInput) SetStartTime added in v1.5.0

SetStartTime sets the StartTime field's value.

func (DescribeScheduledActionsInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeScheduledActionsInput) Validate added in v1.1.21

func (s *DescribeScheduledActionsInput) Validate() error

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

type DescribeScheduledActionsOutput

type DescribeScheduledActionsOutput struct {

	// A string that indicates that the response contains more items than can be
	// returned in a single response. To receive additional items, specify this
	// string for the NextToken value when requesting the next set of items. This
	// value is null when there are no more items to return.
	NextToken *string `type:"string"`

	// The scheduled actions.
	ScheduledUpdateGroupActions []*ScheduledUpdateGroupAction `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeScheduledActionsOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeScheduledActionsOutput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (*DescribeScheduledActionsOutput) SetScheduledUpdateGroupActions added in v1.5.0

SetScheduledUpdateGroupActions sets the ScheduledUpdateGroupActions field's value.

func (DescribeScheduledActionsOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeTagsInput

type DescribeTagsInput struct {

	// One or more filters to scope the tags to return. The maximum number of filters
	// per filter type (for example, auto-scaling-group) is 1000.
	Filters []*Filter `type:"list"`

	// The maximum number of items to return with this call. The default value is
	// 50 and the maximum value is 100.
	MaxRecords *int64 `type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeTagsInput) GoString added in v0.6.5

func (s DescribeTagsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTagsInput) SetFilters added in v1.5.0

func (s *DescribeTagsInput) SetFilters(v []*Filter) *DescribeTagsInput

SetFilters sets the Filters field's value.

func (*DescribeTagsInput) SetMaxRecords added in v1.5.0

func (s *DescribeTagsInput) SetMaxRecords(v int64) *DescribeTagsInput

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeTagsInput) SetNextToken added in v1.5.0

func (s *DescribeTagsInput) SetNextToken(v string) *DescribeTagsInput

SetNextToken sets the NextToken field's value.

func (DescribeTagsInput) String added in v0.6.5

func (s DescribeTagsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeTagsOutput

type DescribeTagsOutput struct {

	// A string that indicates that the response contains more items than can be
	// returned in a single response. To receive additional items, specify this
	// string for the NextToken value when requesting the next set of items. This
	// value is null when there are no more items to return.
	NextToken *string `type:"string"`

	// One or more tags.
	Tags []*TagDescription `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeTagsOutput) GoString added in v0.6.5

func (s DescribeTagsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTagsOutput) SetNextToken added in v1.5.0

func (s *DescribeTagsOutput) SetNextToken(v string) *DescribeTagsOutput

SetNextToken sets the NextToken field's value.

func (*DescribeTagsOutput) SetTags added in v1.5.0

SetTags sets the Tags field's value.

func (DescribeTagsOutput) String added in v0.6.5

func (s DescribeTagsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeTerminationPolicyTypesInput

type DescribeTerminationPolicyTypesInput struct {
	// contains filtered or unexported fields
}

func (DescribeTerminationPolicyTypesInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DescribeTerminationPolicyTypesInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeTerminationPolicyTypesOutput

type DescribeTerminationPolicyTypesOutput struct {

	// The termination policies supported by Amazon EC2 Auto Scaling: OldestInstance,
	// OldestLaunchConfiguration, NewestInstance, ClosestToNextInstanceHour, Default,
	// OldestLaunchTemplate, and AllocationStrategy.
	TerminationPolicyTypes []*string `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeTerminationPolicyTypesOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTerminationPolicyTypesOutput) SetTerminationPolicyTypes added in v1.5.0

SetTerminationPolicyTypes sets the TerminationPolicyTypes field's value.

func (DescribeTerminationPolicyTypesOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeTrafficSourcesInput added in v1.44.156

type DescribeTrafficSourcesInput struct {

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// The maximum number of items to return with this call. The maximum value is
	// 50.
	MaxRecords *int64 `type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`

	// The traffic source type that you want to describe.
	//
	// The following lists the valid values:
	//
	//    * elb if the traffic source is a Classic Load Balancer.
	//
	//    * elbv2 if the traffic source is a Application Load Balancer, Gateway
	//    Load Balancer, or Network Load Balancer.
	//
	//    * vpc-lattice if the traffic source is VPC Lattice.
	TrafficSourceType *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeTrafficSourcesInput) GoString added in v1.44.156

func (s DescribeTrafficSourcesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTrafficSourcesInput) SetAutoScalingGroupName added in v1.44.156

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

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*DescribeTrafficSourcesInput) SetMaxRecords added in v1.44.156

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeTrafficSourcesInput) SetNextToken added in v1.44.156

SetNextToken sets the NextToken field's value.

func (*DescribeTrafficSourcesInput) SetTrafficSourceType added in v1.44.156

SetTrafficSourceType sets the TrafficSourceType field's value.

func (DescribeTrafficSourcesInput) String added in v1.44.156

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTrafficSourcesInput) Validate added in v1.44.156

func (s *DescribeTrafficSourcesInput) Validate() error

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

type DescribeTrafficSourcesOutput added in v1.44.156

type DescribeTrafficSourcesOutput struct {

	// This string indicates that the response contains more items than can be returned
	// in a single response. To receive additional items, specify this string for
	// the NextToken value when requesting the next set of items. This value is
	// null when there are no more items to return.
	NextToken *string `type:"string"`

	// Information about the traffic sources.
	TrafficSources []*TrafficSourceState `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeTrafficSourcesOutput) GoString added in v1.44.156

func (s DescribeTrafficSourcesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTrafficSourcesOutput) SetNextToken added in v1.44.156

SetNextToken sets the NextToken field's value.

func (*DescribeTrafficSourcesOutput) SetTrafficSources added in v1.44.156

SetTrafficSources sets the TrafficSources field's value.

func (DescribeTrafficSourcesOutput) String added in v1.44.156

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeWarmPoolInput added in v1.38.16

type DescribeWarmPoolInput struct {

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// The maximum number of instances to return with this call. The maximum value
	// is 50.
	MaxRecords *int64 `type:"integer"`

	// The token for the next set of instances to return. (You received this token
	// from a previous call.)
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeWarmPoolInput) GoString added in v1.38.16

func (s DescribeWarmPoolInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWarmPoolInput) SetAutoScalingGroupName added in v1.38.16

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

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*DescribeWarmPoolInput) SetMaxRecords added in v1.38.16

func (s *DescribeWarmPoolInput) SetMaxRecords(v int64) *DescribeWarmPoolInput

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeWarmPoolInput) SetNextToken added in v1.38.16

SetNextToken sets the NextToken field's value.

func (DescribeWarmPoolInput) String added in v1.38.16

func (s DescribeWarmPoolInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWarmPoolInput) Validate added in v1.38.16

func (s *DescribeWarmPoolInput) Validate() error

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

type DescribeWarmPoolOutput added in v1.38.16

type DescribeWarmPoolOutput struct {

	// The instances that are currently in the warm pool.
	Instances []*Instance `type:"list"`

	// This string indicates that the response contains more items than can be returned
	// in a single response. To receive additional items, specify this string for
	// the NextToken value when requesting the next set of items. This value is
	// null when there are no more items to return.
	NextToken *string `type:"string"`

	// The warm pool configuration details.
	WarmPoolConfiguration *WarmPoolConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeWarmPoolOutput) GoString added in v1.38.16

func (s DescribeWarmPoolOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWarmPoolOutput) SetInstances added in v1.38.16

SetInstances sets the Instances field's value.

func (*DescribeWarmPoolOutput) SetNextToken added in v1.38.16

SetNextToken sets the NextToken field's value.

func (*DescribeWarmPoolOutput) SetWarmPoolConfiguration added in v1.38.16

func (s *DescribeWarmPoolOutput) SetWarmPoolConfiguration(v *WarmPoolConfiguration) *DescribeWarmPoolOutput

SetWarmPoolConfiguration sets the WarmPoolConfiguration field's value.

func (DescribeWarmPoolOutput) String added in v1.38.16

func (s DescribeWarmPoolOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DesiredConfiguration added in v1.40.16

type DesiredConfiguration struct {

	// Describes the launch template and the version of the launch template that
	// Amazon EC2 Auto Scaling uses to launch Amazon EC2 instances. For more information
	// about launch templates, see Launch templates (https://docs.aws.amazon.com/autoscaling/ec2/userguide/LaunchTemplates.html)
	// in the Amazon EC2 Auto Scaling User Guide.
	LaunchTemplate *LaunchTemplateSpecification `type:"structure"`

	// Use this structure to launch multiple instance types and On-Demand Instances
	// and Spot Instances within a single Auto Scaling group.
	//
	// A mixed instances policy contains information that Amazon EC2 Auto Scaling
	// can use to launch instances and help optimize your costs. For more information,
	// see Auto Scaling groups with multiple instance types and purchase options
	// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html)
	// in the Amazon EC2 Auto Scaling User Guide.
	MixedInstancesPolicy *MixedInstancesPolicy `type:"structure"`
	// contains filtered or unexported fields
}

Describes the desired configuration for an instance refresh.

If you specify a desired configuration, you must specify either a LaunchTemplate or a MixedInstancesPolicy.

func (DesiredConfiguration) GoString added in v1.40.16

func (s DesiredConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DesiredConfiguration) SetLaunchTemplate added in v1.40.16

SetLaunchTemplate sets the LaunchTemplate field's value.

func (*DesiredConfiguration) SetMixedInstancesPolicy added in v1.40.16

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

SetMixedInstancesPolicy sets the MixedInstancesPolicy field's value.

func (DesiredConfiguration) String added in v1.40.16

func (s DesiredConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DesiredConfiguration) Validate added in v1.40.16

func (s *DesiredConfiguration) Validate() error

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

type DetachInstancesInput

type DetachInstancesInput struct {

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// The IDs of the instances. You can specify up to 20 instances.
	InstanceIds []*string `type:"list"`

	// Indicates whether the Auto Scaling group decrements the desired capacity
	// value by the number of instances detached.
	//
	// ShouldDecrementDesiredCapacity is a required field
	ShouldDecrementDesiredCapacity *bool `type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

func (DetachInstancesInput) GoString added in v0.6.5

func (s DetachInstancesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetachInstancesInput) SetAutoScalingGroupName added in v1.5.0

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

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*DetachInstancesInput) SetInstanceIds added in v1.5.0

func (s *DetachInstancesInput) SetInstanceIds(v []*string) *DetachInstancesInput

SetInstanceIds sets the InstanceIds field's value.

func (*DetachInstancesInput) SetShouldDecrementDesiredCapacity added in v1.5.0

func (s *DetachInstancesInput) SetShouldDecrementDesiredCapacity(v bool) *DetachInstancesInput

SetShouldDecrementDesiredCapacity sets the ShouldDecrementDesiredCapacity field's value.

func (DetachInstancesInput) String added in v0.6.5

func (s DetachInstancesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetachInstancesInput) Validate added in v1.1.21

func (s *DetachInstancesInput) Validate() error

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

type DetachInstancesOutput

type DetachInstancesOutput struct {

	// The activities related to detaching the instances from the Auto Scaling group.
	Activities []*Activity `type:"list"`
	// contains filtered or unexported fields
}

func (DetachInstancesOutput) GoString added in v0.6.5

func (s DetachInstancesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetachInstancesOutput) SetActivities added in v1.5.0

func (s *DetachInstancesOutput) SetActivities(v []*Activity) *DetachInstancesOutput

SetActivities sets the Activities field's value.

func (DetachInstancesOutput) String added in v0.6.5

func (s DetachInstancesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DetachLoadBalancerTargetGroupsInput added in v1.4.1

type DetachLoadBalancerTargetGroupsInput struct {

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// The Amazon Resource Names (ARN) of the target groups. You can specify up
	// to 10 target groups.
	//
	// TargetGroupARNs is a required field
	TargetGroupARNs []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DetachLoadBalancerTargetGroupsInput) GoString added in v1.4.1

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetachLoadBalancerTargetGroupsInput) SetAutoScalingGroupName added in v1.5.0

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*DetachLoadBalancerTargetGroupsInput) SetTargetGroupARNs added in v1.5.0

SetTargetGroupARNs sets the TargetGroupARNs field's value.

func (DetachLoadBalancerTargetGroupsInput) String added in v1.4.1

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetachLoadBalancerTargetGroupsInput) Validate added in v1.4.1

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

type DetachLoadBalancerTargetGroupsOutput added in v1.4.1

type DetachLoadBalancerTargetGroupsOutput struct {
	// contains filtered or unexported fields
}

func (DetachLoadBalancerTargetGroupsOutput) GoString added in v1.4.1

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DetachLoadBalancerTargetGroupsOutput) String added in v1.4.1

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DetachLoadBalancersInput added in v0.6.2

type DetachLoadBalancersInput struct {

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// The names of the load balancers. You can specify up to 10 load balancers.
	//
	// LoadBalancerNames is a required field
	LoadBalancerNames []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DetachLoadBalancersInput) GoString added in v0.6.5

func (s DetachLoadBalancersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetachLoadBalancersInput) SetAutoScalingGroupName added in v1.5.0

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

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*DetachLoadBalancersInput) SetLoadBalancerNames added in v1.5.0

func (s *DetachLoadBalancersInput) SetLoadBalancerNames(v []*string) *DetachLoadBalancersInput

SetLoadBalancerNames sets the LoadBalancerNames field's value.

func (DetachLoadBalancersInput) String added in v0.6.5

func (s DetachLoadBalancersInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetachLoadBalancersInput) Validate added in v1.1.21

func (s *DetachLoadBalancersInput) Validate() error

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

type DetachLoadBalancersOutput added in v0.6.2

type DetachLoadBalancersOutput struct {
	// contains filtered or unexported fields
}

func (DetachLoadBalancersOutput) GoString added in v0.6.5

func (s DetachLoadBalancersOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DetachLoadBalancersOutput) String added in v0.6.5

func (s DetachLoadBalancersOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DetachTrafficSourcesInput added in v1.44.156

type DetachTrafficSourcesInput struct {

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// The unique identifiers of one or more traffic sources. You can specify up
	// to 10 traffic sources.
	//
	// TrafficSources is a required field
	TrafficSources []*TrafficSourceIdentifier `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DetachTrafficSourcesInput) GoString added in v1.44.156

func (s DetachTrafficSourcesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetachTrafficSourcesInput) SetAutoScalingGroupName added in v1.44.156

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

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*DetachTrafficSourcesInput) SetTrafficSources added in v1.44.156

SetTrafficSources sets the TrafficSources field's value.

func (DetachTrafficSourcesInput) String added in v1.44.156

func (s DetachTrafficSourcesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetachTrafficSourcesInput) Validate added in v1.44.156

func (s *DetachTrafficSourcesInput) Validate() error

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

type DetachTrafficSourcesOutput added in v1.44.156

type DetachTrafficSourcesOutput struct {
	// contains filtered or unexported fields
}

func (DetachTrafficSourcesOutput) GoString added in v1.44.156

func (s DetachTrafficSourcesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DetachTrafficSourcesOutput) String added in v1.44.156

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisableMetricsCollectionInput

type DisableMetricsCollectionInput struct {

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// Identifies the metrics to disable.
	//
	// You can specify one or more of the following metrics:
	//
	//    * GroupMinSize
	//
	//    * GroupMaxSize
	//
	//    * GroupDesiredCapacity
	//
	//    * GroupInServiceInstances
	//
	//    * GroupPendingInstances
	//
	//    * GroupStandbyInstances
	//
	//    * GroupTerminatingInstances
	//
	//    * GroupTotalInstances
	//
	//    * GroupInServiceCapacity
	//
	//    * GroupPendingCapacity
	//
	//    * GroupStandbyCapacity
	//
	//    * GroupTerminatingCapacity
	//
	//    * GroupTotalCapacity
	//
	//    * WarmPoolDesiredCapacity
	//
	//    * WarmPoolWarmedCapacity
	//
	//    * WarmPoolPendingCapacity
	//
	//    * WarmPoolTerminatingCapacity
	//
	//    * WarmPoolTotalCapacity
	//
	//    * GroupAndWarmPoolDesiredCapacity
	//
	//    * GroupAndWarmPoolTotalCapacity
	//
	// If you omit this property, all metrics are disabled.
	//
	// For more information, see Auto Scaling group metrics (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-cloudwatch-monitoring.html#as-group-metrics)
	// in the Amazon EC2 Auto Scaling User Guide.
	Metrics []*string `type:"list"`
	// contains filtered or unexported fields
}

func (DisableMetricsCollectionInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisableMetricsCollectionInput) SetAutoScalingGroupName added in v1.5.0

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*DisableMetricsCollectionInput) SetMetrics added in v1.5.0

SetMetrics sets the Metrics field's value.

func (DisableMetricsCollectionInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisableMetricsCollectionInput) Validate added in v1.1.21

func (s *DisableMetricsCollectionInput) Validate() error

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

type DisableMetricsCollectionOutput

type DisableMetricsCollectionOutput struct {
	// contains filtered or unexported fields
}

func (DisableMetricsCollectionOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DisableMetricsCollectionOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Ebs added in v0.9.5

type Ebs struct {

	// Indicates whether the volume is deleted on instance termination. For Amazon
	// EC2 Auto Scaling, the default value is true.
	DeleteOnTermination *bool `type:"boolean"`

	// Specifies whether the volume should be encrypted. Encrypted EBS volumes can
	// only be attached to instances that support Amazon EBS encryption. For more
	// information, see Supported instance types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances).
	// If your AMI uses encrypted volumes, you can also only launch it on supported
	// instance types.
	//
	// If you are creating a volume from a snapshot, you cannot create an unencrypted
	// volume from an encrypted snapshot. Also, you cannot specify a KMS key ID
	// when using a launch configuration.
	//
	// If you enable encryption by default, the EBS volumes that you create are
	// always encrypted, either using the Amazon Web Services managed KMS key or
	// a customer-managed KMS key, regardless of whether the snapshot was encrypted.
	//
	// For more information, see Use Amazon Web Services KMS keys to encrypt Amazon
	// EBS volumes (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-data-protection.html#encryption)
	// in the Amazon EC2 Auto Scaling User Guide.
	Encrypted *bool `type:"boolean"`

	// The number of input/output (I/O) operations per second (IOPS) to provision
	// for the volume. For gp3 and io1 volumes, this represents the number of IOPS
	// that are provisioned for the volume. For gp2 volumes, this represents the
	// baseline performance of the volume and the rate at which the volume accumulates
	// I/O credits for bursting.
	//
	// The following are the supported values for each volume type:
	//
	//    * gp3: 3,000-16,000 IOPS
	//
	//    * io1: 100-64,000 IOPS
	//
	// For io1 volumes, we guarantee 64,000 IOPS only for Instances built on the
	// Nitro System (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances).
	// Other instance families guarantee performance up to 32,000 IOPS.
	//
	// Iops is supported when the volume type is gp3 or io1 and required only when
	// the volume type is io1. (Not used with standard, gp2, st1, or sc1 volumes.)
	Iops *int64 `min:"100" type:"integer"`

	// The snapshot ID of the volume to use.
	//
	// You must specify either a VolumeSize or a SnapshotId.
	SnapshotId *string `min:"1" type:"string"`

	// The throughput (MiBps) to provision for a gp3 volume.
	Throughput *int64 `min:"125" type:"integer"`

	// The volume size, in GiBs. The following are the supported volumes sizes for
	// each volume type:
	//
	//    * gp2 and gp3: 1-16,384
	//
	//    * io1: 4-16,384
	//
	//    * st1 and sc1: 125-16,384
	//
	//    * standard: 1-1,024
	//
	// You must specify either a SnapshotId or a VolumeSize. If you specify both
	// SnapshotId and VolumeSize, the volume size must be equal or greater than
	// the size of the snapshot.
	VolumeSize *int64 `min:"1" type:"integer"`

	// The volume type. For more information, see Amazon EBS volume types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html)
	// in the Amazon EC2 User Guide for Linux Instances.
	//
	// Valid values: standard | io1 | gp2 | st1 | sc1 | gp3
	VolumeType *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes information used to set up an Amazon EBS volume specified in a block device mapping.

func (Ebs) GoString added in v0.9.5

func (s Ebs) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Ebs) SetDeleteOnTermination added in v1.5.0

func (s *Ebs) SetDeleteOnTermination(v bool) *Ebs

SetDeleteOnTermination sets the DeleteOnTermination field's value.

func (*Ebs) SetEncrypted added in v1.5.0

func (s *Ebs) SetEncrypted(v bool) *Ebs

SetEncrypted sets the Encrypted field's value.

func (*Ebs) SetIops added in v1.5.0

func (s *Ebs) SetIops(v int64) *Ebs

SetIops sets the Iops field's value.

func (*Ebs) SetSnapshotId added in v1.5.0

func (s *Ebs) SetSnapshotId(v string) *Ebs

SetSnapshotId sets the SnapshotId field's value.

func (*Ebs) SetThroughput added in v1.38.53

func (s *Ebs) SetThroughput(v int64) *Ebs

SetThroughput sets the Throughput field's value.

func (*Ebs) SetVolumeSize added in v1.5.0

func (s *Ebs) SetVolumeSize(v int64) *Ebs

SetVolumeSize sets the VolumeSize field's value.

func (*Ebs) SetVolumeType added in v1.5.0

func (s *Ebs) SetVolumeType(v string) *Ebs

SetVolumeType sets the VolumeType field's value.

func (Ebs) String added in v0.9.5

func (s Ebs) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Ebs) Validate added in v1.1.21

func (s *Ebs) Validate() error

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

type EnableMetricsCollectionInput

type EnableMetricsCollectionInput struct {

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch.
	// The only valid value is 1Minute.
	//
	// Granularity is a required field
	Granularity *string `min:"1" type:"string" required:"true"`

	// Identifies the metrics to enable.
	//
	// You can specify one or more of the following metrics:
	//
	//    * GroupMinSize
	//
	//    * GroupMaxSize
	//
	//    * GroupDesiredCapacity
	//
	//    * GroupInServiceInstances
	//
	//    * GroupPendingInstances
	//
	//    * GroupStandbyInstances
	//
	//    * GroupTerminatingInstances
	//
	//    * GroupTotalInstances
	//
	//    * GroupInServiceCapacity
	//
	//    * GroupPendingCapacity
	//
	//    * GroupStandbyCapacity
	//
	//    * GroupTerminatingCapacity
	//
	//    * GroupTotalCapacity
	//
	//    * WarmPoolDesiredCapacity
	//
	//    * WarmPoolWarmedCapacity
	//
	//    * WarmPoolPendingCapacity
	//
	//    * WarmPoolTerminatingCapacity
	//
	//    * WarmPoolTotalCapacity
	//
	//    * GroupAndWarmPoolDesiredCapacity
	//
	//    * GroupAndWarmPoolTotalCapacity
	//
	// If you specify Granularity and don't specify any metrics, all metrics are
	// enabled.
	//
	// For more information, see Auto Scaling group metrics (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-cloudwatch-monitoring.html#as-group-metrics)
	// in the Amazon EC2 Auto Scaling User Guide.
	Metrics []*string `type:"list"`
	// contains filtered or unexported fields
}

func (EnableMetricsCollectionInput) GoString added in v0.6.5

func (s EnableMetricsCollectionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EnableMetricsCollectionInput) SetAutoScalingGroupName added in v1.5.0

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

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*EnableMetricsCollectionInput) SetGranularity added in v1.5.0

SetGranularity sets the Granularity field's value.

func (*EnableMetricsCollectionInput) SetMetrics added in v1.5.0

SetMetrics sets the Metrics field's value.

func (EnableMetricsCollectionInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EnableMetricsCollectionInput) Validate added in v1.1.21

func (s *EnableMetricsCollectionInput) Validate() error

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

type EnableMetricsCollectionOutput

type EnableMetricsCollectionOutput struct {
	// contains filtered or unexported fields
}

func (EnableMetricsCollectionOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (EnableMetricsCollectionOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EnabledMetric

type EnabledMetric struct {

	// The granularity of the metric. The only valid value is 1Minute.
	Granularity *string `min:"1" type:"string"`

	// One of the following metrics:
	//
	//    * GroupMinSize
	//
	//    * GroupMaxSize
	//
	//    * GroupDesiredCapacity
	//
	//    * GroupInServiceInstances
	//
	//    * GroupPendingInstances
	//
	//    * GroupStandbyInstances
	//
	//    * GroupTerminatingInstances
	//
	//    * GroupTotalInstances
	//
	//    * GroupInServiceCapacity
	//
	//    * GroupPendingCapacity
	//
	//    * GroupStandbyCapacity
	//
	//    * GroupTerminatingCapacity
	//
	//    * GroupTotalCapacity
	//
	//    * WarmPoolDesiredCapacity
	//
	//    * WarmPoolWarmedCapacity
	//
	//    * WarmPoolPendingCapacity
	//
	//    * WarmPoolTerminatingCapacity
	//
	//    * WarmPoolTotalCapacity
	//
	//    * GroupAndWarmPoolDesiredCapacity
	//
	//    * GroupAndWarmPoolTotalCapacity
	//
	// For more information, see Auto Scaling group metrics (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-cloudwatch-monitoring.html#as-group-metrics)
	// in the Amazon EC2 Auto Scaling User Guide.
	Metric *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes an enabled Auto Scaling group metric.

func (EnabledMetric) GoString added in v0.6.5

func (s EnabledMetric) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EnabledMetric) SetGranularity added in v1.5.0

func (s *EnabledMetric) SetGranularity(v string) *EnabledMetric

SetGranularity sets the Granularity field's value.

func (*EnabledMetric) SetMetric added in v1.5.0

func (s *EnabledMetric) SetMetric(v string) *EnabledMetric

SetMetric sets the Metric field's value.

func (EnabledMetric) String added in v0.6.5

func (s EnabledMetric) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EnterStandbyInput

type EnterStandbyInput struct {

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// The IDs of the instances. You can specify up to 20 instances.
	InstanceIds []*string `type:"list"`

	// Indicates whether to decrement the desired capacity of the Auto Scaling group
	// by the number of instances moved to Standby mode.
	//
	// ShouldDecrementDesiredCapacity is a required field
	ShouldDecrementDesiredCapacity *bool `type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

func (EnterStandbyInput) GoString added in v0.6.5

func (s EnterStandbyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EnterStandbyInput) SetAutoScalingGroupName added in v1.5.0

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

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*EnterStandbyInput) SetInstanceIds added in v1.5.0

func (s *EnterStandbyInput) SetInstanceIds(v []*string) *EnterStandbyInput

SetInstanceIds sets the InstanceIds field's value.

func (*EnterStandbyInput) SetShouldDecrementDesiredCapacity added in v1.5.0

func (s *EnterStandbyInput) SetShouldDecrementDesiredCapacity(v bool) *EnterStandbyInput

SetShouldDecrementDesiredCapacity sets the ShouldDecrementDesiredCapacity field's value.

func (EnterStandbyInput) String added in v0.6.5

func (s EnterStandbyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EnterStandbyInput) Validate added in v1.1.21

func (s *EnterStandbyInput) Validate() error

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

type EnterStandbyOutput

type EnterStandbyOutput struct {

	// The activities related to moving instances into Standby mode.
	Activities []*Activity `type:"list"`
	// contains filtered or unexported fields
}

func (EnterStandbyOutput) GoString added in v0.6.5

func (s EnterStandbyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EnterStandbyOutput) SetActivities added in v1.5.0

func (s *EnterStandbyOutput) SetActivities(v []*Activity) *EnterStandbyOutput

SetActivities sets the Activities field's value.

func (EnterStandbyOutput) String added in v0.6.5

func (s EnterStandbyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExecutePolicyInput

type ExecutePolicyInput struct {

	// The name of the Auto Scaling group.
	AutoScalingGroupName *string `min:"1" type:"string"`

	// The breach threshold for the alarm.
	//
	// Required if the policy type is StepScaling and not supported otherwise.
	BreachThreshold *float64 `type:"double"`

	// Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to
	// complete before executing the policy.
	//
	// Valid only if the policy type is SimpleScaling. For more information, see
	// Scaling cooldowns for Amazon EC2 Auto Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html)
	// in the Amazon EC2 Auto Scaling User Guide.
	HonorCooldown *bool `type:"boolean"`

	// The metric value to compare to BreachThreshold. This enables you to execute
	// a policy of type StepScaling and determine which step adjustment to use.
	// For example, if the breach threshold is 50 and you want to use a step adjustment
	// with a lower bound of 0 and an upper bound of 10, you can set the metric
	// value to 59.
	//
	// If you specify a metric value that doesn't correspond to a step adjustment
	// for the policy, the call returns an error.
	//
	// Required if the policy type is StepScaling and not supported otherwise.
	MetricValue *float64 `type:"double"`

	// The name or ARN of the policy.
	//
	// PolicyName is a required field
	PolicyName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ExecutePolicyInput) GoString added in v0.6.5

func (s ExecutePolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExecutePolicyInput) SetAutoScalingGroupName added in v1.5.0

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

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*ExecutePolicyInput) SetBreachThreshold added in v1.5.0

func (s *ExecutePolicyInput) SetBreachThreshold(v float64) *ExecutePolicyInput

SetBreachThreshold sets the BreachThreshold field's value.

func (*ExecutePolicyInput) SetHonorCooldown added in v1.5.0

func (s *ExecutePolicyInput) SetHonorCooldown(v bool) *ExecutePolicyInput

SetHonorCooldown sets the HonorCooldown field's value.

func (*ExecutePolicyInput) SetMetricValue added in v1.5.0

func (s *ExecutePolicyInput) SetMetricValue(v float64) *ExecutePolicyInput

SetMetricValue sets the MetricValue field's value.

func (*ExecutePolicyInput) SetPolicyName added in v1.5.0

func (s *ExecutePolicyInput) SetPolicyName(v string) *ExecutePolicyInput

SetPolicyName sets the PolicyName field's value.

func (ExecutePolicyInput) String added in v0.6.5

func (s ExecutePolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExecutePolicyInput) Validate added in v1.1.21

func (s *ExecutePolicyInput) Validate() error

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

type ExecutePolicyOutput

type ExecutePolicyOutput struct {
	// contains filtered or unexported fields
}

func (ExecutePolicyOutput) GoString added in v0.6.5

func (s ExecutePolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (ExecutePolicyOutput) String added in v0.6.5

func (s ExecutePolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExitStandbyInput

type ExitStandbyInput struct {

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// The IDs of the instances. You can specify up to 20 instances.
	InstanceIds []*string `type:"list"`
	// contains filtered or unexported fields
}

func (ExitStandbyInput) GoString added in v0.6.5

func (s ExitStandbyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExitStandbyInput) SetAutoScalingGroupName added in v1.5.0

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

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*ExitStandbyInput) SetInstanceIds added in v1.5.0

func (s *ExitStandbyInput) SetInstanceIds(v []*string) *ExitStandbyInput

SetInstanceIds sets the InstanceIds field's value.

func (ExitStandbyInput) String added in v0.6.5

func (s ExitStandbyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExitStandbyInput) Validate added in v1.1.21

func (s *ExitStandbyInput) Validate() error

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

type ExitStandbyOutput

type ExitStandbyOutput struct {

	// The activities related to moving instances out of Standby mode.
	Activities []*Activity `type:"list"`
	// contains filtered or unexported fields
}

func (ExitStandbyOutput) GoString added in v0.6.5

func (s ExitStandbyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExitStandbyOutput) SetActivities added in v1.5.0

func (s *ExitStandbyOutput) SetActivities(v []*Activity) *ExitStandbyOutput

SetActivities sets the Activities field's value.

func (ExitStandbyOutput) String added in v0.6.5

func (s ExitStandbyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FailedScheduledUpdateGroupActionRequest added in v1.15.12

type FailedScheduledUpdateGroupActionRequest struct {

	// The error code.
	ErrorCode *string `min:"1" type:"string"`

	// The error message accompanying the error code.
	ErrorMessage *string `type:"string"`

	// The name of the scheduled action.
	//
	// ScheduledActionName is a required field
	ScheduledActionName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes a scheduled action that could not be created, updated, or deleted.

func (FailedScheduledUpdateGroupActionRequest) GoString added in v1.15.12

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FailedScheduledUpdateGroupActionRequest) SetErrorCode added in v1.15.12

SetErrorCode sets the ErrorCode field's value.

func (*FailedScheduledUpdateGroupActionRequest) SetErrorMessage added in v1.15.12

SetErrorMessage sets the ErrorMessage field's value.

func (*FailedScheduledUpdateGroupActionRequest) SetScheduledActionName added in v1.15.12

SetScheduledActionName sets the ScheduledActionName field's value.

func (FailedScheduledUpdateGroupActionRequest) String added in v1.15.12

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Filter

type Filter struct {

	// The name of the filter.
	//
	// The valid values for Name depend on which API operation you're using with
	// the filter (DescribeAutoScalingGroups or DescribeTags).
	//
	// DescribeAutoScalingGroups
	//
	// Valid values for Name include the following:
	//
	//    * tag-key - Accepts tag keys. The results only include information about
	//    the Auto Scaling groups associated with these tag keys.
	//
	//    * tag-value - Accepts tag values. The results only include information
	//    about the Auto Scaling groups associated with these tag values.
	//
	//    * tag:<key> - Accepts the key/value combination of the tag. Use the tag
	//    key in the filter name and the tag value as the filter value. The results
	//    only include information about the Auto Scaling groups associated with
	//    the specified key/value combination.
	//
	// DescribeTags
	//
	// Valid values for Name include the following:
	//
	//    * auto-scaling-group - Accepts the names of Auto Scaling groups. The results
	//    only include information about the tags associated with these Auto Scaling
	//    groups.
	//
	//    * key - Accepts tag keys. The results only include information about the
	//    tags associated with these tag keys.
	//
	//    * value - Accepts tag values. The results only include information about
	//    the tags associated with these tag values.
	//
	//    * propagate-at-launch - Accepts a Boolean value, which specifies whether
	//    tags propagate to instances at launch. The results only include information
	//    about the tags associated with the specified Boolean value.
	Name *string `type:"string"`

	// One or more filter values. Filter values are case-sensitive.
	//
	// If you specify multiple values for a filter, the values are automatically
	// logically joined with an OR, and the request returns all results that match
	// any of the specified values. For example, specify "tag:environment" for the
	// filter name and "production,development" for the filter values to find Auto
	// Scaling groups with the tag "environment=production" or "environment=development".
	Values []*string `type:"list"`
	// contains filtered or unexported fields
}

Describes a filter that is used to return a more specific list of results from a describe operation.

If you specify multiple filters, the filters are automatically logically joined with an AND, and the request returns only the results that match all of the specified filters.

For more information, see Tag Auto Scaling groups and instances (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html) in the Amazon EC2 Auto Scaling User Guide.

func (Filter) GoString added in v0.6.5

func (s Filter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Filter) SetName added in v1.5.0

func (s *Filter) SetName(v string) *Filter

SetName sets the Name field's value.

func (*Filter) SetValues added in v1.5.0

func (s *Filter) SetValues(v []*string) *Filter

SetValues sets the Values field's value.

func (Filter) String added in v0.6.5

func (s Filter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetPredictiveScalingForecastInput added in v1.38.43

type GetPredictiveScalingForecastInput struct {

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// The exclusive end time of the time range for the forecast data to get. The
	// maximum time duration between the start and end time is 30 days.
	//
	// Although this parameter can accept a date and time that is more than two
	// days in the future, the availability of forecast data has limits. Amazon
	// EC2 Auto Scaling only issues forecasts for periods of two days in advance.
	//
	// EndTime is a required field
	EndTime *time.Time `type:"timestamp" required:"true"`

	// The name of the policy.
	//
	// PolicyName is a required field
	PolicyName *string `min:"1" type:"string" required:"true"`

	// The inclusive start time of the time range for the forecast data to get.
	// At most, the date and time can be one year before the current date and time.
	//
	// StartTime is a required field
	StartTime *time.Time `type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

func (GetPredictiveScalingForecastInput) GoString added in v1.38.43

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetPredictiveScalingForecastInput) SetAutoScalingGroupName added in v1.38.43

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*GetPredictiveScalingForecastInput) SetEndTime added in v1.38.43

SetEndTime sets the EndTime field's value.

func (*GetPredictiveScalingForecastInput) SetPolicyName added in v1.38.43

SetPolicyName sets the PolicyName field's value.

func (*GetPredictiveScalingForecastInput) SetStartTime added in v1.38.43

SetStartTime sets the StartTime field's value.

func (GetPredictiveScalingForecastInput) String added in v1.38.43

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetPredictiveScalingForecastInput) Validate added in v1.38.43

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

type GetPredictiveScalingForecastOutput added in v1.38.43

type GetPredictiveScalingForecastOutput struct {

	// The capacity forecast.
	//
	// CapacityForecast is a required field
	CapacityForecast *CapacityForecast `type:"structure" required:"true"`

	// The load forecast.
	//
	// LoadForecast is a required field
	LoadForecast []*LoadForecast `type:"list" required:"true"`

	// The time the forecast was made.
	//
	// UpdateTime is a required field
	UpdateTime *time.Time `type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

func (GetPredictiveScalingForecastOutput) GoString added in v1.38.43

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetPredictiveScalingForecastOutput) SetCapacityForecast added in v1.38.43

SetCapacityForecast sets the CapacityForecast field's value.

func (*GetPredictiveScalingForecastOutput) SetLoadForecast added in v1.38.43

SetLoadForecast sets the LoadForecast field's value.

func (*GetPredictiveScalingForecastOutput) SetUpdateTime added in v1.38.43

SetUpdateTime sets the UpdateTime field's value.

func (GetPredictiveScalingForecastOutput) String added in v1.38.43

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Group

type Group struct {

	// The Amazon Resource Name (ARN) of the Auto Scaling group.
	AutoScalingGroupARN *string `min:"1" type:"string"`

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// One or more Availability Zones for the group.
	//
	// AvailabilityZones is a required field
	AvailabilityZones []*string `type:"list" required:"true"`

	// Indicates whether Capacity Rebalancing is enabled.
	CapacityRebalance *bool `type:"boolean"`

	// Reserved.
	Context *string `type:"string"`

	// The date and time the group was created.
	//
	// CreatedTime is a required field
	CreatedTime *time.Time `type:"timestamp" required:"true"`

	// The duration of the default cooldown period, in seconds.
	//
	// DefaultCooldown is a required field
	DefaultCooldown *int64 `type:"integer" required:"true"`

	// The duration of the default instance warmup, in seconds.
	DefaultInstanceWarmup *int64 `type:"integer"`

	// The desired size of the group.
	//
	// DesiredCapacity is a required field
	DesiredCapacity *int64 `type:"integer" required:"true"`

	// The unit of measurement for the value specified for desired capacity. Amazon
	// EC2 Auto Scaling supports DesiredCapacityType for attribute-based instance
	// type selection only.
	DesiredCapacityType *string `min:"1" type:"string"`

	// The metrics enabled for the group.
	EnabledMetrics []*EnabledMetric `type:"list"`

	// The duration of the health check grace period, in seconds.
	HealthCheckGracePeriod *int64 `type:"integer"`

	// A comma-separated value string of one or more health check types.
	//
	// HealthCheckType is a required field
	HealthCheckType *string `min:"1" type:"string" required:"true"`

	// The EC2 instances associated with the group.
	Instances []*Instance `type:"list"`

	// The name of the associated launch configuration.
	LaunchConfigurationName *string `min:"1" type:"string"`

	// The launch template for the group.
	LaunchTemplate *LaunchTemplateSpecification `type:"structure"`

	// One or more load balancers associated with the group.
	LoadBalancerNames []*string `type:"list"`

	// The maximum amount of time, in seconds, that an instance can be in service.
	//
	// Valid Range: Minimum value of 0.
	MaxInstanceLifetime *int64 `type:"integer"`

	// The maximum size of the group.
	//
	// MaxSize is a required field
	MaxSize *int64 `type:"integer" required:"true"`

	// The minimum size of the group.
	//
	// MinSize is a required field
	MinSize *int64 `type:"integer" required:"true"`

	// The mixed instances policy for the group.
	MixedInstancesPolicy *MixedInstancesPolicy `type:"structure"`

	// Indicates whether newly launched instances are protected from termination
	// by Amazon EC2 Auto Scaling when scaling in.
	NewInstancesProtectedFromScaleIn *bool `type:"boolean"`

	// The name of the placement group into which to launch your instances, if any.
	PlacementGroup *string `min:"1" type:"string"`

	// The predicted capacity of the group when it has a predictive scaling policy.
	PredictedCapacity *int64 `type:"integer"`

	// 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.
	ServiceLinkedRoleARN *string `min:"1" type:"string"`

	// The current state of the group when the DeleteAutoScalingGroup operation
	// is in progress.
	Status *string `min:"1" type:"string"`

	// The suspended processes associated with the group.
	SuspendedProcesses []*SuspendedProcess `type:"list"`

	// The tags for the group.
	Tags []*TagDescription `type:"list"`

	// The Amazon Resource Names (ARN) of the target groups for your load balancer.
	TargetGroupARNs []*string `type:"list"`

	// The termination policies for the group.
	TerminationPolicies []*string `type:"list"`

	// The traffic sources associated with this Auto Scaling group.
	TrafficSources []*TrafficSourceIdentifier `type:"list"`

	// One or more subnet IDs, if applicable, separated by commas.
	VPCZoneIdentifier *string `min:"1" type:"string"`

	// The warm pool for the group.
	WarmPoolConfiguration *WarmPoolConfiguration `type:"structure"`

	// The current size of the warm pool.
	WarmPoolSize *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Describes an Auto Scaling group.

func (Group) GoString added in v0.6.5

func (s Group) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Group) SetAutoScalingGroupARN added in v1.5.0

func (s *Group) SetAutoScalingGroupARN(v string) *Group

SetAutoScalingGroupARN sets the AutoScalingGroupARN field's value.

func (*Group) SetAutoScalingGroupName added in v1.5.0

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

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*Group) SetAvailabilityZones added in v1.5.0

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

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*Group) SetCapacityRebalance added in v1.35.21

func (s *Group) SetCapacityRebalance(v bool) *Group

SetCapacityRebalance sets the CapacityRebalance field's value.

func (*Group) SetContext added in v1.38.70

func (s *Group) SetContext(v string) *Group

SetContext sets the Context field's value.

func (*Group) SetCreatedTime added in v1.5.0

func (s *Group) SetCreatedTime(v time.Time) *Group

SetCreatedTime sets the CreatedTime field's value.

func (*Group) SetDefaultCooldown added in v1.5.0

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

SetDefaultCooldown sets the DefaultCooldown field's value.

func (*Group) SetDefaultInstanceWarmup added in v1.43.42

func (s *Group) SetDefaultInstanceWarmup(v int64) *Group

SetDefaultInstanceWarmup sets the DefaultInstanceWarmup field's value.

func (*Group) SetDesiredCapacity added in v1.5.0

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

SetDesiredCapacity sets the DesiredCapacity field's value.

func (*Group) SetDesiredCapacityType added in v1.41.12

func (s *Group) SetDesiredCapacityType(v string) *Group

SetDesiredCapacityType sets the DesiredCapacityType field's value.

func (*Group) SetEnabledMetrics added in v1.5.0

func (s *Group) SetEnabledMetrics(v []*EnabledMetric) *Group

SetEnabledMetrics sets the EnabledMetrics field's value.

func (*Group) SetHealthCheckGracePeriod added in v1.5.0

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

SetHealthCheckGracePeriod sets the HealthCheckGracePeriod field's value.

func (*Group) SetHealthCheckType added in v1.5.0

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

SetHealthCheckType sets the HealthCheckType field's value.

func (*Group) SetInstances added in v1.5.0

func (s *Group) SetInstances(v []*Instance) *Group

SetInstances sets the Instances field's value.

func (*Group) SetLaunchConfigurationName added in v1.5.0

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

SetLaunchConfigurationName sets the LaunchConfigurationName field's value.

func (*Group) SetLaunchTemplate added in v1.12.37

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

SetLaunchTemplate sets the LaunchTemplate field's value.

func (*Group) SetLoadBalancerNames added in v1.5.0

func (s *Group) SetLoadBalancerNames(v []*string) *Group

SetLoadBalancerNames sets the LoadBalancerNames field's value.

func (*Group) SetMaxInstanceLifetime added in v1.25.38

func (s *Group) SetMaxInstanceLifetime(v int64) *Group

SetMaxInstanceLifetime sets the MaxInstanceLifetime field's value.

func (*Group) SetMaxSize added in v1.5.0

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

SetMaxSize sets the MaxSize field's value.

func (*Group) SetMinSize added in v1.5.0

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

SetMinSize sets the MinSize field's value.

func (*Group) SetMixedInstancesPolicy added in v1.15.76

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

SetMixedInstancesPolicy sets the MixedInstancesPolicy field's value.

func (*Group) SetNewInstancesProtectedFromScaleIn added in v1.5.0

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

SetNewInstancesProtectedFromScaleIn sets the NewInstancesProtectedFromScaleIn field's value.

func (*Group) SetPlacementGroup added in v1.5.0

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

SetPlacementGroup sets the PlacementGroup field's value.

func (*Group) SetPredictedCapacity added in v1.38.43

func (s *Group) SetPredictedCapacity(v int64) *Group

SetPredictedCapacity sets the PredictedCapacity field's value.

func (*Group) SetServiceLinkedRoleARN added in v1.13.1

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

SetServiceLinkedRoleARN sets the ServiceLinkedRoleARN field's value.

func (*Group) SetStatus added in v1.5.0

func (s *Group) SetStatus(v string) *Group

SetStatus sets the Status field's value.

func (*Group) SetSuspendedProcesses added in v1.5.0

func (s *Group) SetSuspendedProcesses(v []*SuspendedProcess) *Group

SetSuspendedProcesses sets the SuspendedProcesses field's value.

func (*Group) SetTags added in v1.5.0

func (s *Group) SetTags(v []*TagDescription) *Group

SetTags sets the Tags field's value.

func (*Group) SetTargetGroupARNs added in v1.5.0

func (s *Group) SetTargetGroupARNs(v []*string) *Group

SetTargetGroupARNs sets the TargetGroupARNs field's value.

func (*Group) SetTerminationPolicies added in v1.5.0

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

SetTerminationPolicies sets the TerminationPolicies field's value.

func (*Group) SetTrafficSources added in v1.44.156

func (s *Group) SetTrafficSources(v []*TrafficSourceIdentifier) *Group

SetTrafficSources sets the TrafficSources field's value.

func (*Group) SetVPCZoneIdentifier added in v1.5.0

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

SetVPCZoneIdentifier sets the VPCZoneIdentifier field's value.

func (*Group) SetWarmPoolConfiguration added in v1.38.16

func (s *Group) SetWarmPoolConfiguration(v *WarmPoolConfiguration) *Group

SetWarmPoolConfiguration sets the WarmPoolConfiguration field's value.

func (*Group) SetWarmPoolSize added in v1.38.16

func (s *Group) SetWarmPoolSize(v int64) *Group

SetWarmPoolSize sets the WarmPoolSize field's value.

func (Group) String added in v0.6.5

func (s Group) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Instance

type Instance struct {

	// The Availability Zone in which the instance is running.
	//
	// AvailabilityZone is a required field
	AvailabilityZone *string `min:"1" type:"string" required:"true"`

	// The last reported health status of the instance. Healthy means that the instance
	// is healthy and should remain in service. Unhealthy means that the instance
	// is unhealthy and that Amazon EC2 Auto Scaling should terminate and replace
	// it.
	//
	// HealthStatus is a required field
	HealthStatus *string `min:"1" type:"string" required:"true"`

	// The ID of the instance.
	//
	// InstanceId is a required field
	InstanceId *string `min:"1" type:"string" required:"true"`

	// The instance type of the EC2 instance.
	InstanceType *string `min:"1" type:"string"`

	// The launch configuration associated with the instance.
	LaunchConfigurationName *string `min:"1" type:"string"`

	// The launch template for the instance.
	LaunchTemplate *LaunchTemplateSpecification `type:"structure"`

	// A description of the current lifecycle state. The Quarantined state is not
	// used. For information about lifecycle states, see Instance lifecycle (https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroupLifecycle.html)
	// in the Amazon EC2 Auto Scaling User Guide.
	//
	// LifecycleState is a required field
	LifecycleState *string `type:"string" required:"true" enum:"LifecycleState"`

	// Indicates whether the instance is protected from termination by Amazon EC2
	// Auto Scaling when scaling in.
	//
	// ProtectedFromScaleIn is a required field
	ProtectedFromScaleIn *bool `type:"boolean" required:"true"`

	// The number of capacity units contributed by the instance based on its instance
	// type.
	//
	// Valid Range: Minimum value of 1. Maximum value of 999.
	WeightedCapacity *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes an EC2 instance.

func (Instance) GoString added in v0.6.5

func (s Instance) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Instance) SetAvailabilityZone added in v1.5.0

func (s *Instance) SetAvailabilityZone(v string) *Instance

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*Instance) SetHealthStatus added in v1.5.0

func (s *Instance) SetHealthStatus(v string) *Instance

SetHealthStatus sets the HealthStatus field's value.

func (*Instance) SetInstanceId added in v1.5.0

func (s *Instance) SetInstanceId(v string) *Instance

SetInstanceId sets the InstanceId field's value.

func (*Instance) SetInstanceType added in v1.25.38

func (s *Instance) SetInstanceType(v string) *Instance

SetInstanceType sets the InstanceType field's value.

func (*Instance) SetLaunchConfigurationName added in v1.5.0

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

SetLaunchConfigurationName sets the LaunchConfigurationName field's value.

func (*Instance) SetLaunchTemplate added in v1.12.37

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

SetLaunchTemplate sets the LaunchTemplate field's value.

func (*Instance) SetLifecycleState added in v1.5.0

func (s *Instance) SetLifecycleState(v string) *Instance

SetLifecycleState sets the LifecycleState field's value.

func (*Instance) SetProtectedFromScaleIn added in v1.5.0

func (s *Instance) SetProtectedFromScaleIn(v bool) *Instance

SetProtectedFromScaleIn sets the ProtectedFromScaleIn field's value.

func (*Instance) SetWeightedCapacity added in v1.25.38

func (s *Instance) SetWeightedCapacity(v string) *Instance

SetWeightedCapacity sets the WeightedCapacity field's value.

func (Instance) String added in v0.6.5

func (s Instance) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InstanceDetails

type InstanceDetails struct {

	// The name of the Auto Scaling group for the instance.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// The Availability Zone for the instance.
	//
	// AvailabilityZone is a required field
	AvailabilityZone *string `min:"1" type:"string" required:"true"`

	// The last reported health status of this instance. Healthy means that the
	// instance is healthy and should remain in service. Unhealthy means that the
	// instance is unhealthy and Amazon EC2 Auto Scaling should terminate and replace
	// it.
	//
	// HealthStatus is a required field
	HealthStatus *string `min:"1" type:"string" required:"true"`

	// The ID of the instance.
	//
	// InstanceId is a required field
	InstanceId *string `min:"1" type:"string" required:"true"`

	// The instance type of the EC2 instance.
	InstanceType *string `min:"1" type:"string"`

	// The launch configuration used to launch the instance. This value is not available
	// if you attached the instance to the Auto Scaling group.
	LaunchConfigurationName *string `min:"1" type:"string"`

	// The launch template for the instance.
	LaunchTemplate *LaunchTemplateSpecification `type:"structure"`

	// The lifecycle state for the instance. The Quarantined state is not used.
	// For information about lifecycle states, see Instance lifecycle (https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroupLifecycle.html)
	// in the Amazon EC2 Auto Scaling User Guide.
	//
	// Valid values: Pending | Pending:Wait | Pending:Proceed | Quarantined | InService
	// | Terminating | Terminating:Wait | Terminating:Proceed | Terminated | Detaching
	// | Detached | EnteringStandby | Standby | Warmed:Pending | Warmed:Pending:Wait
	// | Warmed:Pending:Proceed | Warmed:Terminating | Warmed:Terminating:Wait |
	// Warmed:Terminating:Proceed | Warmed:Terminated | Warmed:Stopped | Warmed:Running
	//
	// LifecycleState is a required field
	LifecycleState *string `min:"1" type:"string" required:"true"`

	// Indicates whether the instance is protected from termination by Amazon EC2
	// Auto Scaling when scaling in.
	//
	// ProtectedFromScaleIn is a required field
	ProtectedFromScaleIn *bool `type:"boolean" required:"true"`

	// The number of capacity units contributed by the instance based on its instance
	// type.
	//
	// Valid Range: Minimum value of 1. Maximum value of 999.
	WeightedCapacity *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes an EC2 instance associated with an Auto Scaling group.

func (InstanceDetails) GoString added in v0.6.5

func (s InstanceDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InstanceDetails) SetAutoScalingGroupName added in v1.5.0

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

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*InstanceDetails) SetAvailabilityZone added in v1.5.0

func (s *InstanceDetails) SetAvailabilityZone(v string) *InstanceDetails

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*InstanceDetails) SetHealthStatus added in v1.5.0

func (s *InstanceDetails) SetHealthStatus(v string) *InstanceDetails

SetHealthStatus sets the HealthStatus field's value.

func (*InstanceDetails) SetInstanceId added in v1.5.0

func (s *InstanceDetails) SetInstanceId(v string) *InstanceDetails

SetInstanceId sets the InstanceId field's value.

func (*InstanceDetails) SetInstanceType added in v1.25.38

func (s *InstanceDetails) SetInstanceType(v string) *InstanceDetails

SetInstanceType sets the InstanceType field's value.

func (*InstanceDetails) SetLaunchConfigurationName added in v1.5.0

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

SetLaunchConfigurationName sets the LaunchConfigurationName field's value.

func (*InstanceDetails) SetLaunchTemplate added in v1.12.37

SetLaunchTemplate sets the LaunchTemplate field's value.

func (*InstanceDetails) SetLifecycleState added in v1.5.0

func (s *InstanceDetails) SetLifecycleState(v string) *InstanceDetails

SetLifecycleState sets the LifecycleState field's value.

func (*InstanceDetails) SetProtectedFromScaleIn added in v1.5.0

func (s *InstanceDetails) SetProtectedFromScaleIn(v bool) *InstanceDetails

SetProtectedFromScaleIn sets the ProtectedFromScaleIn field's value.

func (*InstanceDetails) SetWeightedCapacity added in v1.25.38

func (s *InstanceDetails) SetWeightedCapacity(v string) *InstanceDetails

SetWeightedCapacity sets the WeightedCapacity field's value.

func (InstanceDetails) String added in v0.6.5

func (s InstanceDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InstanceMetadataOptions added in v1.33.14

type InstanceMetadataOptions struct {

	// This parameter enables or disables the HTTP metadata endpoint on your instances.
	// If the parameter is not specified, the default state is enabled.
	//
	// If you specify a value of disabled, you will not be able to access your instance
	// metadata.
	HttpEndpoint *string `type:"string" enum:"InstanceMetadataEndpointState"`

	// The desired HTTP PUT response hop limit for instance metadata requests. The
	// larger the number, the further instance metadata requests can travel.
	//
	// Default: 1
	HttpPutResponseHopLimit *int64 `min:"1" type:"integer"`

	// The state of token usage for your instance metadata requests. If the parameter
	// is not specified in the request, the default state is optional.
	//
	// If the state is optional, you can choose to retrieve instance metadata with
	// or without a signed token header on your request. If you retrieve the IAM
	// role credentials without a token, the version 1.0 role credentials are returned.
	// If you retrieve the IAM role credentials using a valid signed token, the
	// version 2.0 role credentials are returned.
	//
	// If the state is required, you must send a signed token header with any instance
	// metadata retrieval requests. In this state, retrieving the IAM role credentials
	// always returns the version 2.0 credentials; the version 1.0 credentials are
	// not available.
	HttpTokens *string `type:"string" enum:"InstanceMetadataHttpTokensState"`
	// contains filtered or unexported fields
}

The metadata options for the instances. For more information, see Configuring the Instance Metadata Options (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-config.html#launch-configurations-imds) in the Amazon EC2 Auto Scaling User Guide.

func (InstanceMetadataOptions) GoString added in v1.33.14

func (s InstanceMetadataOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InstanceMetadataOptions) SetHttpEndpoint added in v1.33.14

SetHttpEndpoint sets the HttpEndpoint field's value.

func (*InstanceMetadataOptions) SetHttpPutResponseHopLimit added in v1.33.14

func (s *InstanceMetadataOptions) SetHttpPutResponseHopLimit(v int64) *InstanceMetadataOptions

SetHttpPutResponseHopLimit sets the HttpPutResponseHopLimit field's value.

func (*InstanceMetadataOptions) SetHttpTokens added in v1.33.14

SetHttpTokens sets the HttpTokens field's value.

func (InstanceMetadataOptions) String added in v1.33.14

func (s InstanceMetadataOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InstanceMetadataOptions) Validate added in v1.33.14

func (s *InstanceMetadataOptions) Validate() error

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

type InstanceMonitoring

type InstanceMonitoring struct {

	// If true, detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
	Enabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Describes whether detailed monitoring is enabled for the Auto Scaling instances.

func (InstanceMonitoring) GoString added in v0.6.5

func (s InstanceMonitoring) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InstanceMonitoring) SetEnabled added in v1.5.0

func (s *InstanceMonitoring) SetEnabled(v bool) *InstanceMonitoring

SetEnabled sets the Enabled field's value.

func (InstanceMonitoring) String added in v0.6.5

func (s InstanceMonitoring) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InstanceRefresh added in v1.32.3

type InstanceRefresh struct {

	// The name of the Auto Scaling group.
	AutoScalingGroupName *string `min:"1" type:"string"`

	// Describes the desired configuration for the instance refresh.
	DesiredConfiguration *DesiredConfiguration `type:"structure"`

	// The date and time at which the instance refresh ended.
	EndTime *time.Time `type:"timestamp"`

	// The instance refresh ID.
	InstanceRefreshId *string `min:"1" type:"string"`

	// The number of instances remaining to update before the instance refresh is
	// complete.
	//
	// If you roll back the instance refresh, InstancesToUpdate shows you the number
	// of instances that were not yet updated by the instance refresh. Therefore,
	// these instances don't need to be replaced as part of the rollback.
	InstancesToUpdate *int64 `type:"integer"`

	// The percentage of the instance refresh that is complete. For each instance
	// replacement, Amazon EC2 Auto Scaling tracks the instance's health status
	// and warm-up time. When the instance's health status changes to healthy and
	// the specified warm-up time passes, the instance is considered updated and
	// is added to the percentage complete.
	//
	// PercentageComplete does not include instances that are replaced during a
	// rollback. This value gradually goes back down to zero during a rollback.
	PercentageComplete *int64 `type:"integer"`

	// The preferences for an instance refresh.
	Preferences *RefreshPreferences `type:"structure"`

	// Additional progress details for an Auto Scaling group that has a warm pool.
	ProgressDetails *InstanceRefreshProgressDetails `type:"structure"`

	// The rollback details.
	RollbackDetails *RollbackDetails `type:"structure"`

	// The date and time at which the instance refresh began.
	StartTime *time.Time `type:"timestamp"`

	// The current status for the instance refresh operation:
	//
	//    * Pending - The request was created, but the instance refresh has not
	//    started.
	//
	//    * InProgress - An instance refresh is in progress.
	//
	//    * Successful - An instance refresh completed successfully.
	//
	//    * Failed - An instance refresh failed to complete. You can troubleshoot
	//    using the status reason and the scaling activities.
	//
	//    * Cancelling - An ongoing instance refresh is being cancelled.
	//
	//    * Cancelled - The instance refresh is cancelled.
	//
	//    * RollbackInProgress - An instance refresh is being rolled back.
	//
	//    * RollbackFailed - The rollback failed to complete. You can troubleshoot
	//    using the status reason and the scaling activities.
	//
	//    * RollbackSuccessful - The rollback completed successfully.
	Status *string `type:"string" enum:"InstanceRefreshStatus"`

	// The explanation for the specific status assigned to this operation.
	StatusReason *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes an instance refresh for an Auto Scaling group.

func (InstanceRefresh) GoString added in v1.32.3

func (s InstanceRefresh) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InstanceRefresh) SetAutoScalingGroupName added in v1.32.3

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

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*InstanceRefresh) SetDesiredConfiguration added in v1.40.16

func (s *InstanceRefresh) SetDesiredConfiguration(v *DesiredConfiguration) *InstanceRefresh

SetDesiredConfiguration sets the DesiredConfiguration field's value.

func (*InstanceRefresh) SetEndTime added in v1.32.3

func (s *InstanceRefresh) SetEndTime(v time.Time) *InstanceRefresh

SetEndTime sets the EndTime field's value.

func (*InstanceRefresh) SetInstanceRefreshId added in v1.32.3

func (s *InstanceRefresh) SetInstanceRefreshId(v string) *InstanceRefresh

SetInstanceRefreshId sets the InstanceRefreshId field's value.

func (*InstanceRefresh) SetInstancesToUpdate added in v1.32.3

func (s *InstanceRefresh) SetInstancesToUpdate(v int64) *InstanceRefresh

SetInstancesToUpdate sets the InstancesToUpdate field's value.

func (*InstanceRefresh) SetPercentageComplete added in v1.32.3

func (s *InstanceRefresh) SetPercentageComplete(v int64) *InstanceRefresh

SetPercentageComplete sets the PercentageComplete field's value.

func (*InstanceRefresh) SetPreferences added in v1.40.16

func (s *InstanceRefresh) SetPreferences(v *RefreshPreferences) *InstanceRefresh

SetPreferences sets the Preferences field's value.

func (*InstanceRefresh) SetProgressDetails added in v1.38.16

SetProgressDetails sets the ProgressDetails field's value.

func (*InstanceRefresh) SetRollbackDetails added in v1.44.199

func (s *InstanceRefresh) SetRollbackDetails(v *RollbackDetails) *InstanceRefresh

SetRollbackDetails sets the RollbackDetails field's value.

func (*InstanceRefresh) SetStartTime added in v1.32.3

func (s *InstanceRefresh) SetStartTime(v time.Time) *InstanceRefresh

SetStartTime sets the StartTime field's value.

func (*InstanceRefresh) SetStatus added in v1.32.3

func (s *InstanceRefresh) SetStatus(v string) *InstanceRefresh

SetStatus sets the Status field's value.

func (*InstanceRefresh) SetStatusReason added in v1.32.3

func (s *InstanceRefresh) SetStatusReason(v string) *InstanceRefresh

SetStatusReason sets the StatusReason field's value.

func (InstanceRefresh) String added in v1.32.3

func (s InstanceRefresh) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InstanceRefreshLivePoolProgress added in v1.38.16

type InstanceRefreshLivePoolProgress struct {

	// The number of instances remaining to update.
	InstancesToUpdate *int64 `type:"integer"`

	// The percentage of instances in the Auto Scaling group that have been replaced.
	// For each instance replacement, Amazon EC2 Auto Scaling tracks the instance's
	// health status and warm-up time. When the instance's health status changes
	// to healthy and the specified warm-up time passes, the instance is considered
	// updated and is added to the percentage complete.
	PercentageComplete *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Reports progress on replacing instances that are in the Auto Scaling group.

func (InstanceRefreshLivePoolProgress) GoString added in v1.38.16

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InstanceRefreshLivePoolProgress) SetInstancesToUpdate added in v1.38.16

SetInstancesToUpdate sets the InstancesToUpdate field's value.

func (*InstanceRefreshLivePoolProgress) SetPercentageComplete added in v1.38.16

SetPercentageComplete sets the PercentageComplete field's value.

func (InstanceRefreshLivePoolProgress) String added in v1.38.16

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InstanceRefreshProgressDetails added in v1.38.16

type InstanceRefreshProgressDetails struct {

	// Reports progress on replacing instances that are in the Auto Scaling group.
	LivePoolProgress *InstanceRefreshLivePoolProgress `type:"structure"`

	// Reports progress on replacing instances that are in the warm pool.
	WarmPoolProgress *InstanceRefreshWarmPoolProgress `type:"structure"`
	// contains filtered or unexported fields
}

Reports progress on replacing instances in an Auto Scaling group that has a warm pool. This includes separate details for instances in the warm pool and instances in the Auto Scaling group (the live pool).

func (InstanceRefreshProgressDetails) GoString added in v1.38.16

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InstanceRefreshProgressDetails) SetLivePoolProgress added in v1.38.16

SetLivePoolProgress sets the LivePoolProgress field's value.

func (*InstanceRefreshProgressDetails) SetWarmPoolProgress added in v1.38.16

SetWarmPoolProgress sets the WarmPoolProgress field's value.

func (InstanceRefreshProgressDetails) String added in v1.38.16

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InstanceRefreshWarmPoolProgress added in v1.38.16

type InstanceRefreshWarmPoolProgress struct {

	// The number of instances remaining to update.
	InstancesToUpdate *int64 `type:"integer"`

	// The percentage of instances in the warm pool that have been replaced. For
	// each instance replacement, Amazon EC2 Auto Scaling tracks the instance's
	// health status and warm-up time. When the instance's health status changes
	// to healthy and the specified warm-up time passes, the instance is considered
	// updated and is added to the percentage complete.
	PercentageComplete *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Reports progress on replacing instances that are in the warm pool.

func (InstanceRefreshWarmPoolProgress) GoString added in v1.38.16

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InstanceRefreshWarmPoolProgress) SetInstancesToUpdate added in v1.38.16

SetInstancesToUpdate sets the InstancesToUpdate field's value.

func (*InstanceRefreshWarmPoolProgress) SetPercentageComplete added in v1.38.16

SetPercentageComplete sets the PercentageComplete field's value.

func (InstanceRefreshWarmPoolProgress) String added in v1.38.16

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InstanceRequirements added in v1.41.12

type InstanceRequirements struct {

	// The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web
	// Services Inferentia chips) for an instance type.
	//
	// To exclude accelerator-enabled instance types, set Max to 0.
	//
	// Default: No minimum or maximum limits
	AcceleratorCount *AcceleratorCountRequest `type:"structure"`

	// Indicates whether instance types must have accelerators by specific manufacturers.
	//
	//    * For instance types with NVIDIA devices, specify nvidia.
	//
	//    * For instance types with AMD devices, specify amd.
	//
	//    * For instance types with Amazon Web Services devices, specify amazon-web-services.
	//
	//    * For instance types with Xilinx devices, specify xilinx.
	//
	// Default: Any manufacturer
	AcceleratorManufacturers []*string `type:"list" enum:"AcceleratorManufacturer"`

	// Lists the accelerators that must be on an instance type.
	//
	//    * For instance types with NVIDIA A100 GPUs, specify a100.
	//
	//    * For instance types with NVIDIA V100 GPUs, specify v100.
	//
	//    * For instance types with NVIDIA K80 GPUs, specify k80.
	//
	//    * For instance types with NVIDIA T4 GPUs, specify t4.
	//
	//    * For instance types with NVIDIA M60 GPUs, specify m60.
	//
	//    * For instance types with AMD Radeon Pro V520 GPUs, specify radeon-pro-v520.
	//
	//    * For instance types with Xilinx VU9P FPGAs, specify vu9p.
	//
	// Default: Any accelerator
	AcceleratorNames []*string `type:"list" enum:"AcceleratorName"`

	// The minimum and maximum total memory size for the accelerators on an instance
	// type, in MiB.
	//
	// Default: No minimum or maximum limits
	AcceleratorTotalMemoryMiB *AcceleratorTotalMemoryMiBRequest `type:"structure"`

	// Lists the accelerator types that must be on an instance type.
	//
	//    * For instance types with GPU accelerators, specify gpu.
	//
	//    * For instance types with FPGA accelerators, specify fpga.
	//
	//    * For instance types with inference accelerators, specify inference.
	//
	// Default: Any accelerator type
	AcceleratorTypes []*string `type:"list" enum:"AcceleratorType"`

	// The instance types to apply your specified attributes against. All other
	// instance types are ignored, even if they match your specified attributes.
	//
	// You can use strings with one or more wild cards, represented by an asterisk
	// (*), to allow an instance type, size, or generation. The following are examples:
	// m5.8xlarge, c5*.*, m5a.*, r*, *3*.
	//
	// For example, if you specify c5*, Amazon EC2 Auto Scaling will allow the entire
	// C5 instance family, which includes all C5a and C5n instance types. If you
	// specify m5a.*, Amazon EC2 Auto Scaling will allow all the M5a instance types,
	// but not the M5n instance types.
	//
	// If you specify AllowedInstanceTypes, you can't specify ExcludedInstanceTypes.
	//
	// Default: All instance types
	AllowedInstanceTypes []*string `type:"list"`

	// Indicates whether bare metal instance types are included, excluded, or required.
	//
	// Default: excluded
	BareMetal *string `type:"string" enum:"BareMetal"`

	// The minimum and maximum baseline bandwidth performance for an instance type,
	// in Mbps. For more information, see Amazon EBS–optimized instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html)
	// in the Amazon EC2 User Guide for Linux Instances.
	//
	// Default: No minimum or maximum limits
	BaselineEbsBandwidthMbps *BaselineEbsBandwidthMbpsRequest `type:"structure"`

	// Indicates whether burstable performance instance types are included, excluded,
	// or required. For more information, see Burstable performance instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html)
	// in the Amazon EC2 User Guide for Linux Instances.
	//
	// Default: excluded
	BurstablePerformance *string `type:"string" enum:"BurstablePerformance"`

	// Lists which specific CPU manufacturers to include.
	//
	//    * For instance types with Intel CPUs, specify intel.
	//
	//    * For instance types with AMD CPUs, specify amd.
	//
	//    * For instance types with Amazon Web Services CPUs, specify amazon-web-services.
	//
	// Don't confuse the CPU hardware manufacturer with the CPU hardware architecture.
	// Instances will be launched with a compatible CPU architecture based on the
	// Amazon Machine Image (AMI) that you specify in your launch template.
	//
	// Default: Any manufacturer
	CpuManufacturers []*string `type:"list" enum:"CpuManufacturer"`

	// The instance types to exclude. You can use strings with one or more wild
	// cards, represented by an asterisk (*), to exclude an instance family, type,
	// size, or generation. The following are examples: m5.8xlarge, c5*.*, m5a.*,
	// r*, *3*.
	//
	// For example, if you specify c5*, you are excluding the entire C5 instance
	// family, which includes all C5a and C5n instance types. If you specify m5a.*,
	// Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not
	// the M5n instance types.
	//
	// If you specify ExcludedInstanceTypes, you can't specify AllowedInstanceTypes.
	//
	// Default: No excluded instance types
	ExcludedInstanceTypes []*string `type:"list"`

	// Indicates whether current or previous generation instance types are included.
	//
	//    * For current generation instance types, specify current. The current
	//    generation includes EC2 instance types currently recommended for use.
	//    This typically includes the latest two to three generations in each instance
	//    family. For more information, see Instance types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html)
	//    in the Amazon EC2 User Guide for Linux Instances.
	//
	//    * For previous generation instance types, specify previous.
	//
	// Default: Any current or previous generation
	InstanceGenerations []*string `type:"list" enum:"InstanceGeneration"`

	// Indicates whether instance types with instance store volumes are included,
	// excluded, or required. For more information, see Amazon EC2 instance store
	// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html)
	// in the Amazon EC2 User Guide for Linux Instances.
	//
	// Default: included
	LocalStorage *string `type:"string" enum:"LocalStorage"`

	// Indicates the type of local storage that is required.
	//
	//    * For instance types with hard disk drive (HDD) storage, specify hdd.
	//
	//    * For instance types with solid state drive (SSD) storage, specify ssd.
	//
	// Default: Any local storage type
	LocalStorageTypes []*string `type:"list" enum:"LocalStorageType"`

	// The minimum and maximum amount of memory per vCPU for an instance type, in
	// GiB.
	//
	// Default: No minimum or maximum limits
	MemoryGiBPerVCpu *MemoryGiBPerVCpuRequest `type:"structure"`

	// The minimum and maximum instance memory size for an instance type, in MiB.
	//
	// MemoryMiB is a required field
	MemoryMiB *MemoryMiBRequest `type:"structure" required:"true"`

	// The minimum and maximum amount of network bandwidth, in gigabits per second
	// (Gbps).
	//
	// Default: No minimum or maximum limits
	NetworkBandwidthGbps *NetworkBandwidthGbpsRequest `type:"structure"`

	// The minimum and maximum number of network interfaces for an instance type.
	//
	// Default: No minimum or maximum limits
	NetworkInterfaceCount *NetworkInterfaceCountRequest `type:"structure"`

	// The price protection threshold for On-Demand Instances. This is the maximum
	// you’ll pay for an On-Demand Instance, expressed as a percentage higher
	// than the least expensive current generation M, C, or R instance type with
	// your specified attributes. When Amazon EC2 Auto Scaling selects instance
	// types with your attributes, we will exclude instance types whose price is
	// higher than your threshold. The parameter accepts an integer, which Amazon
	// EC2 Auto Scaling interprets as a percentage. To turn off price protection,
	// specify a high value, such as 999999.
	//
	// If you set DesiredCapacityType to vcpu or memory-mib, the price protection
	// threshold is applied based on the per vCPU or per memory price instead of
	// the per instance price.
	//
	// Default: 20
	OnDemandMaxPricePercentageOverLowestPrice *int64 `type:"integer"`

	// Indicates whether instance types must provide On-Demand Instance hibernation
	// support.
	//
	// Default: false
	RequireHibernateSupport *bool `type:"boolean"`

	// The price protection threshold for Spot Instances. This is the maximum you’ll
	// pay for a Spot Instance, expressed as a percentage higher than the least
	// expensive current generation M, C, or R instance type with your specified
	// attributes. When Amazon EC2 Auto Scaling selects instance types with your
	// attributes, we will exclude instance types whose price is higher than your
	// threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling
	// interprets as a percentage. To turn off price protection, specify a high
	// value, such as 999999.
	//
	// If you set DesiredCapacityType to vcpu or memory-mib, the price protection
	// threshold is applied based on the per vCPU or per memory price instead of
	// the per instance price.
	//
	// Default: 100
	SpotMaxPricePercentageOverLowestPrice *int64 `type:"integer"`

	// The minimum and maximum total local storage size for an instance type, in
	// GB.
	//
	// Default: No minimum or maximum limits
	TotalLocalStorageGB *TotalLocalStorageGBRequest `type:"structure"`

	// The minimum and maximum number of vCPUs for an instance type.
	//
	// VCpuCount is a required field
	VCpuCount *VCpuCountRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The attributes for the instance types for a mixed instances policy. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance types.

When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.

To limit the list of instance types from which Amazon EC2 Auto Scaling can identify matching instance types, you can use one of the following parameters, but not both in the same request:

  • AllowedInstanceTypes - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.

  • ExcludedInstanceTypes - The instance types to exclude from the list, even if they match your specified attributes.

You must specify VCpuCount and MemoryMiB. All other attributes are optional. Any unspecified optional attribute is set to its default.

For more information, see Creating an Auto Scaling group using attribute-based instance type selection (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html) in the Amazon EC2 Auto Scaling User Guide. For help determining which instance types match your attributes before you apply them to your Auto Scaling group, see Preview instance types with specified attributes (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-get-instance-types-from-instance-requirements) in the Amazon EC2 User Guide for Linux Instances.

func (InstanceRequirements) GoString added in v1.41.12

func (s InstanceRequirements) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InstanceRequirements) SetAcceleratorCount added in v1.41.12

SetAcceleratorCount sets the AcceleratorCount field's value.

func (*InstanceRequirements) SetAcceleratorManufacturers added in v1.41.12

func (s *InstanceRequirements) SetAcceleratorManufacturers(v []*string) *InstanceRequirements

SetAcceleratorManufacturers sets the AcceleratorManufacturers field's value.

func (*InstanceRequirements) SetAcceleratorNames added in v1.41.12

func (s *InstanceRequirements) SetAcceleratorNames(v []*string) *InstanceRequirements

SetAcceleratorNames sets the AcceleratorNames field's value.

func (*InstanceRequirements) SetAcceleratorTotalMemoryMiB added in v1.41.12

func (s *InstanceRequirements) SetAcceleratorTotalMemoryMiB(v *AcceleratorTotalMemoryMiBRequest) *InstanceRequirements

SetAcceleratorTotalMemoryMiB sets the AcceleratorTotalMemoryMiB field's value.

func (*InstanceRequirements) SetAcceleratorTypes added in v1.41.12

func (s *InstanceRequirements) SetAcceleratorTypes(v []*string) *InstanceRequirements

SetAcceleratorTypes sets the AcceleratorTypes field's value.

func (*InstanceRequirements) SetAllowedInstanceTypes added in v1.44.132

func (s *InstanceRequirements) SetAllowedInstanceTypes(v []*string) *InstanceRequirements

SetAllowedInstanceTypes sets the AllowedInstanceTypes field's value.

func (*InstanceRequirements) SetBareMetal added in v1.41.12

func (s *InstanceRequirements) SetBareMetal(v string) *InstanceRequirements

SetBareMetal sets the BareMetal field's value.

func (*InstanceRequirements) SetBaselineEbsBandwidthMbps added in v1.41.12

SetBaselineEbsBandwidthMbps sets the BaselineEbsBandwidthMbps field's value.

func (*InstanceRequirements) SetBurstablePerformance added in v1.41.12

func (s *InstanceRequirements) SetBurstablePerformance(v string) *InstanceRequirements

SetBurstablePerformance sets the BurstablePerformance field's value.

func (*InstanceRequirements) SetCpuManufacturers added in v1.41.12

func (s *InstanceRequirements) SetCpuManufacturers(v []*string) *InstanceRequirements

SetCpuManufacturers sets the CpuManufacturers field's value.

func (*InstanceRequirements) SetExcludedInstanceTypes added in v1.41.12

func (s *InstanceRequirements) SetExcludedInstanceTypes(v []*string) *InstanceRequirements

SetExcludedInstanceTypes sets the ExcludedInstanceTypes field's value.

func (*InstanceRequirements) SetInstanceGenerations added in v1.41.12

func (s *InstanceRequirements) SetInstanceGenerations(v []*string) *InstanceRequirements

SetInstanceGenerations sets the InstanceGenerations field's value.

func (*InstanceRequirements) SetLocalStorage added in v1.41.12

func (s *InstanceRequirements) SetLocalStorage(v string) *InstanceRequirements

SetLocalStorage sets the LocalStorage field's value.

func (*InstanceRequirements) SetLocalStorageTypes added in v1.41.12

func (s *InstanceRequirements) SetLocalStorageTypes(v []*string) *InstanceRequirements

SetLocalStorageTypes sets the LocalStorageTypes field's value.

func (*InstanceRequirements) SetMemoryGiBPerVCpu added in v1.41.12

SetMemoryGiBPerVCpu sets the MemoryGiBPerVCpu field's value.

func (*InstanceRequirements) SetMemoryMiB added in v1.41.12

SetMemoryMiB sets the MemoryMiB field's value.

func (*InstanceRequirements) SetNetworkBandwidthGbps added in v1.44.132

SetNetworkBandwidthGbps sets the NetworkBandwidthGbps field's value.

func (*InstanceRequirements) SetNetworkInterfaceCount added in v1.41.12

SetNetworkInterfaceCount sets the NetworkInterfaceCount field's value.

func (*InstanceRequirements) SetOnDemandMaxPricePercentageOverLowestPrice added in v1.41.12

func (s *InstanceRequirements) SetOnDemandMaxPricePercentageOverLowestPrice(v int64) *InstanceRequirements

SetOnDemandMaxPricePercentageOverLowestPrice sets the OnDemandMaxPricePercentageOverLowestPrice field's value.

func (*InstanceRequirements) SetRequireHibernateSupport added in v1.41.12

func (s *InstanceRequirements) SetRequireHibernateSupport(v bool) *InstanceRequirements

SetRequireHibernateSupport sets the RequireHibernateSupport field's value.

func (*InstanceRequirements) SetSpotMaxPricePercentageOverLowestPrice added in v1.41.12

func (s *InstanceRequirements) SetSpotMaxPricePercentageOverLowestPrice(v int64) *InstanceRequirements

SetSpotMaxPricePercentageOverLowestPrice sets the SpotMaxPricePercentageOverLowestPrice field's value.

func (*InstanceRequirements) SetTotalLocalStorageGB added in v1.41.12

SetTotalLocalStorageGB sets the TotalLocalStorageGB field's value.

func (*InstanceRequirements) SetVCpuCount added in v1.41.12

SetVCpuCount sets the VCpuCount field's value.

func (InstanceRequirements) String added in v1.41.12

func (s InstanceRequirements) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InstanceRequirements) Validate added in v1.41.12

func (s *InstanceRequirements) Validate() error

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

type InstanceReusePolicy added in v1.43.6

type InstanceReusePolicy struct {

	// Specifies whether instances in the Auto Scaling group can be returned to
	// the warm pool on scale in.
	ReuseOnScaleIn *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Describes an instance reuse policy for a warm pool.

For more information, see Warm pools for Amazon EC2 Auto Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html) in the Amazon EC2 Auto Scaling User Guide.

func (InstanceReusePolicy) GoString added in v1.43.6

func (s InstanceReusePolicy) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InstanceReusePolicy) SetReuseOnScaleIn added in v1.43.6

func (s *InstanceReusePolicy) SetReuseOnScaleIn(v bool) *InstanceReusePolicy

SetReuseOnScaleIn sets the ReuseOnScaleIn field's value.

func (InstanceReusePolicy) String added in v1.43.6

func (s InstanceReusePolicy) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InstancesDistribution added in v1.15.76

type InstancesDistribution struct {

	// The allocation strategy to apply to your On-Demand Instances when they are
	// launched. Possible instance types are determined by the launch template overrides
	// that you specify.
	//
	// The following lists the valid values:
	//
	// lowest-price
	//
	// Uses price to determine which instance types are the highest priority, launching
	// the lowest priced instance types within an Availability Zone first. This
	// is the default value for Auto Scaling groups that specify InstanceRequirements.
	//
	// prioritized
	//
	// You set the order of instance types for the launch template overrides from
	// highest to lowest priority (from first to last in the list). Amazon EC2 Auto
	// Scaling launches your highest priority instance types first. If all your
	// On-Demand capacity cannot be fulfilled using your highest priority instance
	// type, then Amazon EC2 Auto Scaling launches the remaining capacity using
	// the second priority instance type, and so on. This is the default value for
	// Auto Scaling groups that don't specify InstanceRequirements and cannot be
	// used for groups that do.
	OnDemandAllocationStrategy *string `type:"string"`

	// The minimum amount of the Auto Scaling group's capacity that must be fulfilled
	// by On-Demand Instances. This base portion is launched first as your group
	// scales.
	//
	// This number has the same unit of measurement as the group's desired capacity.
	// If you change the default unit of measurement (number of instances) by specifying
	// weighted capacity values in your launch template overrides list, or by changing
	// the default desired capacity type setting of the group, you must specify
	// this number using the same unit of measurement.
	//
	// Default: 0
	OnDemandBaseCapacity *int64 `type:"integer"`

	// Controls the percentages of On-Demand Instances and Spot Instances for your
	// additional capacity beyond OnDemandBaseCapacity. Expressed as a number (for
	// example, 20 specifies 20% On-Demand Instances, 80% Spot Instances). If set
	// to 100, only On-Demand Instances are used.
	//
	// Default: 100
	OnDemandPercentageAboveBaseCapacity *int64 `type:"integer"`

	// The allocation strategy to apply to your Spot Instances when they are launched.
	// Possible instance types are determined by the launch template overrides that
	// you specify.
	//
	// The following lists the valid values:
	//
	// capacity-optimized
	//
	// Requests Spot Instances using pools that are optimally chosen based on the
	// available Spot capacity. This strategy has the lowest risk of interruption.
	// To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized.
	//
	// capacity-optimized-prioritized
	//
	// You set the order of instance types for the launch template overrides from
	// highest to lowest priority (from first to last in the list). Amazon EC2 Auto
	// Scaling honors the instance type priorities on a best effort basis but optimizes
	// for capacity first. Note that if the On-Demand allocation strategy is set
	// to prioritized, the same priority is applied when fulfilling On-Demand capacity.
	// This is not a valid value for Auto Scaling groups that specify InstanceRequirements.
	//
	// lowest-price
	//
	// Requests Spot Instances using the lowest priced pools within an Availability
	// Zone, across the number of Spot pools that you specify for the SpotInstancePools
	// property. To ensure that your desired capacity is met, you might receive
	// Spot Instances from several pools. This is the default value, but it might
	// lead to high interruption rates because this strategy only considers instance
	// price and not available capacity.
	//
	// price-capacity-optimized (recommended)
	//
	// The price and capacity optimized allocation strategy looks at both price
	// and capacity to select the Spot Instance pools that are the least likely
	// to be interrupted and have the lowest possible price.
	SpotAllocationStrategy *string `type:"string"`

	// The number of Spot Instance pools across which to allocate your Spot Instances.
	// The Spot pools are determined from the different instance types in the overrides.
	// Valid only when the SpotAllocationStrategy is lowest-price. Value must be
	// in the range of 1–20.
	//
	// Default: 2
	SpotInstancePools *int64 `type:"integer"`

	// The maximum price per unit hour that you are willing to pay for a Spot Instance.
	// If your maximum price is lower than the Spot price for the instance types
	// that you selected, your Spot Instances are not launched. We do not recommend
	// specifying a maximum price because it can lead to increased interruptions.
	// When Spot Instances launch, you pay the current Spot price. To remove a maximum
	// price that you previously set, include the property but specify an empty
	// string ("") for the value.
	//
	// If you specify a maximum price, your instances will be interrupted more frequently
	// than if you do not specify one.
	//
	// Valid Range: Minimum value of 0.001
	SpotMaxPrice *string `type:"string"`
	// contains filtered or unexported fields
}

Use this structure to specify the distribution of On-Demand Instances and Spot Instances and the allocation strategies used to fulfill On-Demand and Spot capacities for a mixed instances policy.

func (InstancesDistribution) GoString added in v1.15.76

func (s InstancesDistribution) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InstancesDistribution) SetOnDemandAllocationStrategy added in v1.15.76

func (s *InstancesDistribution) SetOnDemandAllocationStrategy(v string) *InstancesDistribution

SetOnDemandAllocationStrategy sets the OnDemandAllocationStrategy field's value.

func (*InstancesDistribution) SetOnDemandBaseCapacity added in v1.15.76

func (s *InstancesDistribution) SetOnDemandBaseCapacity(v int64) *InstancesDistribution

SetOnDemandBaseCapacity sets the OnDemandBaseCapacity field's value.

func (*InstancesDistribution) SetOnDemandPercentageAboveBaseCapacity added in v1.15.76

func (s *InstancesDistribution) SetOnDemandPercentageAboveBaseCapacity(v int64) *InstancesDistribution

SetOnDemandPercentageAboveBaseCapacity sets the OnDemandPercentageAboveBaseCapacity field's value.

func (*InstancesDistribution) SetSpotAllocationStrategy added in v1.15.76

func (s *InstancesDistribution) SetSpotAllocationStrategy(v string) *InstancesDistribution

SetSpotAllocationStrategy sets the SpotAllocationStrategy field's value.

func (*InstancesDistribution) SetSpotInstancePools added in v1.15.76

func (s *InstancesDistribution) SetSpotInstancePools(v int64) *InstancesDistribution

SetSpotInstancePools sets the SpotInstancePools field's value.

func (*InstancesDistribution) SetSpotMaxPrice added in v1.15.76

func (s *InstancesDistribution) SetSpotMaxPrice(v string) *InstancesDistribution

SetSpotMaxPrice sets the SpotMaxPrice field's value.

func (InstancesDistribution) String added in v1.15.76

func (s InstancesDistribution) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LaunchConfiguration

type LaunchConfiguration struct {

	// Specifies whether to assign a public IPv4 address to the group's instances.
	// If the instance is launched into a default subnet, the default is to assign
	// a public IPv4 address, unless you disabled the option to assign a public
	// IPv4 address on the subnet. If the instance is launched into a nondefault
	// subnet, the default is not to assign a public IPv4 address, unless you enabled
	// the option to assign a public IPv4 address on the subnet. 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.
	AssociatePublicIpAddress *bool `type:"boolean"`

	// The block device mapping entries that define the block devices to attach
	// to the instances at launch. By default, the block devices specified in the
	// block device mapping for the AMI are used. For more information, see Block
	// Device Mapping (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html)
	// in the Amazon EC2 User Guide for Linux Instances.
	BlockDeviceMappings []*BlockDeviceMapping `type:"list"`

	// Available for backward compatibility.
	ClassicLinkVPCId *string `min:"1" type:"string"`

	// Available for backward compatibility.
	ClassicLinkVPCSecurityGroups []*string `type:"list"`

	// The creation date and time for the launch configuration.
	//
	// CreatedTime is a required field
	CreatedTime *time.Time `type:"timestamp" required:"true"`

	// Specifies whether the launch configuration is optimized for EBS I/O (true)
	// or not (false). For more information, see Amazon EBS-Optimized Instances
	// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html) in
	// the Amazon EC2 User Guide for Linux Instances.
	EbsOptimized *bool `type:"boolean"`

	// The name or the Amazon Resource Name (ARN) of the instance profile associated
	// with the IAM role for the instance. The instance profile contains the IAM
	// role. For more information, see IAM role for applications that run on Amazon
	// EC2 instances (https://docs.aws.amazon.com/autoscaling/ec2/userguide/us-iam-role.html)
	// in the Amazon EC2 Auto Scaling User Guide.
	IamInstanceProfile *string `min:"1" type:"string"`

	// The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances.
	// For more information, see Find a Linux AMI (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html)
	// in the Amazon EC2 User Guide for Linux Instances.
	//
	// ImageId is a required field
	ImageId *string `min:"1" type:"string" required:"true"`

	// Controls whether instances in this group are launched with detailed (true)
	// or basic (false) monitoring.
	//
	// For more information, see Configure Monitoring for Auto Scaling Instances
	// (https://docs.aws.amazon.com/autoscaling/latest/userguide/enable-as-instance-metrics.html)
	// in the Amazon EC2 Auto Scaling User Guide.
	InstanceMonitoring *InstanceMonitoring `type:"structure"`

	// The instance type for the instances. For information about available instance
	// types, see Available instance types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes)
	// in the Amazon EC2 User Guide for Linux Instances.
	//
	// InstanceType is a required field
	InstanceType *string `min:"1" type:"string" required:"true"`

	// The ID of the kernel associated with the AMI.
	KernelId *string `min:"1" type:"string"`

	// The name of the key pair.
	//
	// For more information, see Amazon EC2 Key Pairs (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html)
	// in the Amazon EC2 User Guide for Linux Instances.
	KeyName *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the launch configuration.
	LaunchConfigurationARN *string `min:"1" type:"string"`

	// The name of the launch configuration.
	//
	// LaunchConfigurationName is a required field
	LaunchConfigurationName *string `min:"1" type:"string" required:"true"`

	// The metadata options for the instances. For more information, see Configuring
	// the Instance Metadata Options (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-config.html#launch-configurations-imds)
	// in the Amazon EC2 Auto Scaling User Guide.
	MetadataOptions *InstanceMetadataOptions `type:"structure"`

	// The tenancy of the instance, either default or dedicated. An instance with
	// dedicated tenancy runs on isolated, single-tenant hardware and can only be
	// launched into a VPC.
	//
	// For more information, see Configuring instance tenancy with Amazon EC2 Auto
	// Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/auto-scaling-dedicated-instances.html)
	// in the Amazon EC2 Auto Scaling User Guide.
	PlacementTenancy *string `min:"1" type:"string"`

	// The ID of the RAM disk associated with the AMI.
	RamdiskId *string `min:"1" type:"string"`

	// A list that contains the security groups to assign to the instances in the
	// Auto Scaling group. For more information, see Security Groups for Your VPC
	// (https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html)
	// in the Amazon Virtual Private Cloud User Guide.
	SecurityGroups []*string `type:"list"`

	// The maximum hourly price 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 price. For more information, see Requesting Spot Instances
	// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-launch-spot-instances.html)
	// in the Amazon EC2 Auto Scaling User Guide.
	SpotPrice *string `min:"1" type:"string"`

	// The user data to make available to the launched EC2 instances. For more information,
	// see Instance metadata and user data (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html)
	// (Linux) and Instance metadata and user data (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-instance-metadata.html)
	// (Windows). If you are using a command line tool, base64-encoding is performed
	// for you, and you can load the text from a file. Otherwise, you must provide
	// base64-encoded text. User data is limited to 16 KB.
	UserData *string `type:"string"`
	// contains filtered or unexported fields
}

Describes a launch configuration.

func (LaunchConfiguration) GoString added in v0.6.5

func (s LaunchConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LaunchConfiguration) SetAssociatePublicIpAddress added in v1.5.0

func (s *LaunchConfiguration) SetAssociatePublicIpAddress(v bool) *LaunchConfiguration

SetAssociatePublicIpAddress sets the AssociatePublicIpAddress field's value.

func (*LaunchConfiguration) SetBlockDeviceMappings added in v1.5.0

func (s *LaunchConfiguration) SetBlockDeviceMappings(v []*BlockDeviceMapping) *LaunchConfiguration

SetBlockDeviceMappings sets the BlockDeviceMappings field's value.

func (*LaunchConfiguration) SetClassicLinkVPCId added in v1.5.0

func (s *LaunchConfiguration) SetClassicLinkVPCId(v string) *LaunchConfiguration

SetClassicLinkVPCId sets the ClassicLinkVPCId field's value.

func (*LaunchConfiguration) SetClassicLinkVPCSecurityGroups added in v1.5.0

func (s *LaunchConfiguration) SetClassicLinkVPCSecurityGroups(v []*string) *LaunchConfiguration

SetClassicLinkVPCSecurityGroups sets the ClassicLinkVPCSecurityGroups field's value.

func (*LaunchConfiguration) SetCreatedTime added in v1.5.0

func (s *LaunchConfiguration) SetCreatedTime(v time.Time) *LaunchConfiguration

SetCreatedTime sets the CreatedTime field's value.

func (*LaunchConfiguration) SetEbsOptimized added in v1.5.0

func (s *LaunchConfiguration) SetEbsOptimized(v bool) *LaunchConfiguration

SetEbsOptimized sets the EbsOptimized field's value.

func (*LaunchConfiguration) SetIamInstanceProfile added in v1.5.0

func (s *LaunchConfiguration) SetIamInstanceProfile(v string) *LaunchConfiguration

SetIamInstanceProfile sets the IamInstanceProfile field's value.

func (*LaunchConfiguration) SetImageId added in v1.5.0

SetImageId sets the ImageId field's value.

func (*LaunchConfiguration) SetInstanceMonitoring added in v1.5.0

func (s *LaunchConfiguration) SetInstanceMonitoring(v *InstanceMonitoring) *LaunchConfiguration

SetInstanceMonitoring sets the InstanceMonitoring field's value.

func (*LaunchConfiguration) SetInstanceType added in v1.5.0

func (s *LaunchConfiguration) SetInstanceType(v string) *LaunchConfiguration

SetInstanceType sets the InstanceType field's value.

func (*LaunchConfiguration) SetKernelId added in v1.5.0

func (s *LaunchConfiguration) SetKernelId(v string) *LaunchConfiguration

SetKernelId sets the KernelId field's value.

func (*LaunchConfiguration) SetKeyName added in v1.5.0

SetKeyName sets the KeyName field's value.

func (*LaunchConfiguration) SetLaunchConfigurationARN added in v1.5.0

func (s *LaunchConfiguration) SetLaunchConfigurationARN(v string) *LaunchConfiguration

SetLaunchConfigurationARN sets the LaunchConfigurationARN field's value.

func (*LaunchConfiguration) SetLaunchConfigurationName added in v1.5.0

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

SetLaunchConfigurationName sets the LaunchConfigurationName field's value.

func (*LaunchConfiguration) SetMetadataOptions added in v1.33.14

SetMetadataOptions sets the MetadataOptions field's value.

func (*LaunchConfiguration) SetPlacementTenancy added in v1.5.0

func (s *LaunchConfiguration) SetPlacementTenancy(v string) *LaunchConfiguration

SetPlacementTenancy sets the PlacementTenancy field's value.

func (*LaunchConfiguration) SetRamdiskId added in v1.5.0

func (s *LaunchConfiguration) SetRamdiskId(v string) *LaunchConfiguration

SetRamdiskId sets the RamdiskId field's value.

func (*LaunchConfiguration) SetSecurityGroups added in v1.5.0

func (s *LaunchConfiguration) SetSecurityGroups(v []*string) *LaunchConfiguration

SetSecurityGroups sets the SecurityGroups field's value.

func (*LaunchConfiguration) SetSpotPrice added in v1.5.0

func (s *LaunchConfiguration) SetSpotPrice(v string) *LaunchConfiguration

SetSpotPrice sets the SpotPrice field's value.

func (*LaunchConfiguration) SetUserData added in v1.5.0

func (s *LaunchConfiguration) SetUserData(v string) *LaunchConfiguration

SetUserData sets the UserData field's value.

func (LaunchConfiguration) String added in v0.6.5

func (s LaunchConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LaunchTemplate added in v1.15.76

type LaunchTemplate struct {

	// The launch template.
	LaunchTemplateSpecification *LaunchTemplateSpecification `type:"structure"`

	// Any properties that you specify override the same properties in the launch
	// template.
	Overrides []*LaunchTemplateOverrides `type:"list"`
	// contains filtered or unexported fields
}

Use this structure to specify the launch templates and instance types (overrides) for a mixed instances policy.

func (LaunchTemplate) GoString added in v1.15.76

func (s LaunchTemplate) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LaunchTemplate) SetLaunchTemplateSpecification added in v1.15.76

func (s *LaunchTemplate) SetLaunchTemplateSpecification(v *LaunchTemplateSpecification) *LaunchTemplate

SetLaunchTemplateSpecification sets the LaunchTemplateSpecification field's value.

func (*LaunchTemplate) SetOverrides added in v1.15.76

func (s *LaunchTemplate) SetOverrides(v []*LaunchTemplateOverrides) *LaunchTemplate

SetOverrides sets the Overrides field's value.

func (LaunchTemplate) String added in v1.15.76

func (s LaunchTemplate) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LaunchTemplate) Validate added in v1.15.76

func (s *LaunchTemplate) Validate() error

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

type LaunchTemplateOverrides added in v1.15.76

type LaunchTemplateOverrides struct {

	// The instance requirements. Amazon EC2 Auto Scaling uses your specified requirements
	// to identify instance types. Then, it uses your On-Demand and Spot allocation
	// strategies to launch instances from these instance types.
	//
	// You can specify up to four separate sets of instance requirements per Auto
	// Scaling group. This is useful for provisioning instances from different Amazon
	// Machine Images (AMIs) in the same Auto Scaling group. To do this, create
	// the AMIs and create a new launch template for each AMI. Then, create a compatible
	// set of instance requirements for each launch template.
	//
	// If you specify InstanceRequirements, you can't specify InstanceType.
	InstanceRequirements *InstanceRequirements `type:"structure"`

	// The instance type, such as m3.xlarge. You must specify an instance type that
	// is supported in your requested Region and Availability Zones. For more information,
	// see Instance types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html)
	// in the Amazon Elastic Compute Cloud User Guide.
	//
	// You can specify up to 40 instance types per Auto Scaling group.
	InstanceType *string `min:"1" type:"string"`

	// Provides a launch template for the specified instance type or set of instance
	// requirements. For example, some instance types might require a launch template
	// with a different AMI. If not provided, Amazon EC2 Auto Scaling uses the launch
	// template that's specified in the LaunchTemplate definition. For more information,
	// see Specifying a different launch template for an instance type (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-launch-template-overrides.html)
	// in the Amazon EC2 Auto Scaling User Guide.
	//
	// You can specify up to 20 launch templates per Auto Scaling group. The launch
	// templates specified in the overrides and in the LaunchTemplate definition
	// count towards this limit.
	LaunchTemplateSpecification *LaunchTemplateSpecification `type:"structure"`

	// If you provide a list of instance types to use, you can specify the number
	// of capacity units provided by each instance type in terms of virtual CPUs,
	// memory, storage, throughput, or other relative performance characteristic.
	// When a Spot or On-Demand Instance is launched, the capacity units count toward
	// the desired capacity. Amazon EC2 Auto Scaling launches instances until the
	// desired capacity is totally fulfilled, even if this results in an overage.
	// For example, if there are two units remaining to fulfill capacity, and Amazon
	// EC2 Auto Scaling can only launch an instance with a WeightedCapacity of five
	// units, the instance is launched, and the desired capacity is exceeded by
	// three units. For more information, see Configuring instance weighting for
	// Amazon EC2 Auto Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-instance-weighting.html)
	// in the Amazon EC2 Auto Scaling User Guide. Value must be in the range of
	// 1–999.
	//
	// If you specify a value for WeightedCapacity for one instance type, you must
	// specify a value for WeightedCapacity for all of them.
	//
	// Every Auto Scaling group has three size parameters (DesiredCapacity, MaxSize,
	// and MinSize). Usually, you set these sizes based on a specific number of
	// instances. However, if you configure a mixed instances policy that defines
	// weights for the instance types, you must specify these sizes with the same
	// units that you use for weighting instances.
	WeightedCapacity *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Use this structure to let Amazon EC2 Auto Scaling do the following when the Auto Scaling group has a mixed instances policy:

  • Override the instance type that is specified in the launch template.

  • Use multiple instance types.

Specify the instance types that you want, or define your instance requirements instead and let Amazon EC2 Auto Scaling provision the available instance types that meet your requirements. This can provide Amazon EC2 Auto Scaling with a larger selection of instance types to choose from when fulfilling Spot and On-Demand capacities. You can view which instance types are matched before you apply the instance requirements to your Auto Scaling group.

After you define your instance requirements, you don't have to keep updating these settings to get new EC2 instance types automatically. Amazon EC2 Auto Scaling uses the instance requirements of the Auto Scaling group to determine whether a new EC2 instance type can be used.

func (LaunchTemplateOverrides) GoString added in v1.15.76

func (s LaunchTemplateOverrides) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LaunchTemplateOverrides) SetInstanceRequirements added in v1.41.12

SetInstanceRequirements sets the InstanceRequirements field's value.

func (*LaunchTemplateOverrides) SetInstanceType added in v1.15.76

SetInstanceType sets the InstanceType field's value.

func (*LaunchTemplateOverrides) SetLaunchTemplateSpecification added in v1.35.32

func (s *LaunchTemplateOverrides) SetLaunchTemplateSpecification(v *LaunchTemplateSpecification) *LaunchTemplateOverrides

SetLaunchTemplateSpecification sets the LaunchTemplateSpecification field's value.

func (*LaunchTemplateOverrides) SetWeightedCapacity added in v1.25.38

func (s *LaunchTemplateOverrides) SetWeightedCapacity(v string) *LaunchTemplateOverrides

SetWeightedCapacity sets the WeightedCapacity field's value.

func (LaunchTemplateOverrides) String added in v1.15.76

func (s LaunchTemplateOverrides) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LaunchTemplateOverrides) Validate added in v1.15.76

func (s *LaunchTemplateOverrides) Validate() error

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

type LaunchTemplateSpecification added in v1.12.37

type LaunchTemplateSpecification struct {

	// The ID of the launch template. To get the template ID, use the Amazon EC2
	// DescribeLaunchTemplates (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplates.html)
	// API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate
	// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html)
	// API.
	//
	// Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.
	LaunchTemplateId *string `min:"1" type:"string"`

	// The name of the launch template. To get the template name, use the Amazon
	// EC2 DescribeLaunchTemplates (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplates.html)
	// API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate
	// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html)
	// API.
	//
	// Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.
	LaunchTemplateName *string `min:"3" type:"string"`

	// The version number, $Latest, or $Default. To get the version number, use
	// the Amazon EC2 DescribeLaunchTemplateVersions (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplateVersions.html)
	// API operation. New launch template versions can be created using the Amazon
	// EC2 CreateLaunchTemplateVersion (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplateVersion.html)
	// API. If the value is $Latest, Amazon EC2 Auto Scaling selects the latest
	// version of the launch template when launching instances. If the value is
	// $Default, Amazon EC2 Auto Scaling selects the default version of the launch
	// template when launching instances. The default value is $Default.
	Version *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes the launch template and the version of the launch template that Amazon EC2 Auto Scaling uses to launch Amazon EC2 instances. For more information about launch templates, see Launch templates (https://docs.aws.amazon.com/autoscaling/ec2/userguide/LaunchTemplates.html) in the Amazon EC2 Auto Scaling User Guide.

func (LaunchTemplateSpecification) GoString added in v1.12.37

func (s LaunchTemplateSpecification) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LaunchTemplateSpecification) SetLaunchTemplateId added in v1.12.37

SetLaunchTemplateId sets the LaunchTemplateId field's value.

func (*LaunchTemplateSpecification) SetLaunchTemplateName added in v1.12.37

func (s *LaunchTemplateSpecification) SetLaunchTemplateName(v string) *LaunchTemplateSpecification

SetLaunchTemplateName sets the LaunchTemplateName field's value.

func (*LaunchTemplateSpecification) SetVersion added in v1.12.37

SetVersion sets the Version field's value.

func (LaunchTemplateSpecification) String added in v1.12.37

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LaunchTemplateSpecification) Validate added in v1.12.37

func (s *LaunchTemplateSpecification) Validate() error

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

type LifecycleHook

type LifecycleHook struct {

	// The name of the Auto Scaling group for the lifecycle hook.
	AutoScalingGroupName *string `min:"1" type:"string"`

	// The action the Auto Scaling group takes when the lifecycle hook timeout elapses
	// or if an unexpected failure occurs.
	//
	// Valid values: CONTINUE | ABANDON
	DefaultResult *string `type:"string"`

	// The maximum time, in seconds, that an instance can remain in a wait state.
	// The maximum is 172800 seconds (48 hours) or 100 times HeartbeatTimeout, whichever
	// is smaller.
	GlobalTimeout *int64 `type:"integer"`

	// The maximum time, in seconds, that can elapse before the lifecycle hook times
	// out. If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the
	// action that you specified in the DefaultResult property.
	HeartbeatTimeout *int64 `type:"integer"`

	// The name of the lifecycle hook.
	LifecycleHookName *string `min:"1" type:"string"`

	// The lifecycle transition.
	//
	// Valid values: autoscaling:EC2_INSTANCE_LAUNCHING | autoscaling:EC2_INSTANCE_TERMINATING
	LifecycleTransition *string `type:"string"`

	// Additional information that is included any time Amazon EC2 Auto Scaling
	// sends a message to the notification target.
	NotificationMetadata *string `min:"1" type:"string"`

	// The ARN of the target that Amazon EC2 Auto Scaling sends notifications to
	// when an instance is in a wait state for the lifecycle hook.
	NotificationTargetARN *string `type:"string"`

	// The ARN of the IAM role that allows the Auto Scaling group to publish to
	// the specified notification target (an Amazon SNS topic or an Amazon SQS queue).
	RoleARN *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes a lifecycle hook. A lifecycle hook lets you create solutions that are aware of events in the Auto Scaling instance lifecycle, and then perform a custom action on instances when the corresponding lifecycle event occurs.

func (LifecycleHook) GoString added in v0.6.5

func (s LifecycleHook) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LifecycleHook) SetAutoScalingGroupName added in v1.5.0

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

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*LifecycleHook) SetDefaultResult added in v1.5.0

func (s *LifecycleHook) SetDefaultResult(v string) *LifecycleHook

SetDefaultResult sets the DefaultResult field's value.

func (*LifecycleHook) SetGlobalTimeout added in v1.5.0

func (s *LifecycleHook) SetGlobalTimeout(v int64) *LifecycleHook

SetGlobalTimeout sets the GlobalTimeout field's value.

func (*LifecycleHook) SetHeartbeatTimeout added in v1.5.0

func (s *LifecycleHook) SetHeartbeatTimeout(v int64) *LifecycleHook

SetHeartbeatTimeout sets the HeartbeatTimeout field's value.

func (*LifecycleHook) SetLifecycleHookName added in v1.5.0

func (s *LifecycleHook) SetLifecycleHookName(v string) *LifecycleHook

SetLifecycleHookName sets the LifecycleHookName field's value.

func (*LifecycleHook) SetLifecycleTransition added in v1.5.0

func (s *LifecycleHook) SetLifecycleTransition(v string) *LifecycleHook

SetLifecycleTransition sets the LifecycleTransition field's value.

func (*LifecycleHook) SetNotificationMetadata added in v1.5.0

func (s *LifecycleHook) SetNotificationMetadata(v string) *LifecycleHook

SetNotificationMetadata sets the NotificationMetadata field's value.

func (*LifecycleHook) SetNotificationTargetARN added in v1.5.0

func (s *LifecycleHook) SetNotificationTargetARN(v string) *LifecycleHook

SetNotificationTargetARN sets the NotificationTargetARN field's value.

func (*LifecycleHook) SetRoleARN added in v1.5.0

func (s *LifecycleHook) SetRoleARN(v string) *LifecycleHook

SetRoleARN sets the RoleARN field's value.

func (LifecycleHook) String added in v0.6.5

func (s LifecycleHook) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LifecycleHookSpecification added in v1.10.44

type LifecycleHookSpecification struct {

	// The action the Auto Scaling group takes when the lifecycle hook timeout elapses
	// or if an unexpected failure occurs. The default value is ABANDON.
	//
	// Valid values: CONTINUE | ABANDON
	DefaultResult *string `type:"string"`

	// The maximum time, in seconds, that can elapse before the lifecycle hook times
	// out. The range is from 30 to 7200 seconds. The default value is 3600 seconds
	// (1 hour).
	HeartbeatTimeout *int64 `type:"integer"`

	// The name of the lifecycle hook.
	//
	// LifecycleHookName is a required field
	LifecycleHookName *string `min:"1" type:"string" required:"true"`

	// The lifecycle transition. For Auto Scaling groups, there are two major lifecycle
	// transitions.
	//
	//    * To create a lifecycle hook for scale-out events, specify autoscaling:EC2_INSTANCE_LAUNCHING.
	//
	//    * To create a lifecycle hook for scale-in events, specify autoscaling:EC2_INSTANCE_TERMINATING.
	//
	// LifecycleTransition is a required field
	LifecycleTransition *string `type:"string" required:"true"`

	// Additional information that you want to include any time Amazon EC2 Auto
	// Scaling sends a message to the notification target.
	NotificationMetadata *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the notification target that Amazon EC2
	// Auto Scaling sends notifications to when an instance is in a wait state for
	// the lifecycle hook. You can specify an Amazon SNS topic or an Amazon SQS
	// queue.
	NotificationTargetARN *string `type:"string"`

	// The ARN of the IAM role that allows the Auto Scaling group to publish to
	// the specified notification target. For information about creating this role,
	// see Configure a notification target for a lifecycle hook (https://docs.aws.amazon.com/autoscaling/ec2/userguide/prepare-for-lifecycle-notifications.html#lifecycle-hook-notification-target)
	// in the Amazon EC2 Auto Scaling User Guide.
	//
	// Valid only if the notification target is an Amazon SNS topic or an Amazon
	// SQS queue.
	RoleARN *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes information used to specify a lifecycle hook for an Auto Scaling group.

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

func (LifecycleHookSpecification) GoString added in v1.10.44

func (s LifecycleHookSpecification) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LifecycleHookSpecification) SetDefaultResult added in v1.10.44

SetDefaultResult sets the DefaultResult field's value.

func (*LifecycleHookSpecification) SetHeartbeatTimeout added in v1.10.44

func (s *LifecycleHookSpecification) SetHeartbeatTimeout(v int64) *LifecycleHookSpecification

SetHeartbeatTimeout sets the HeartbeatTimeout field's value.

func (*LifecycleHookSpecification) SetLifecycleHookName added in v1.10.44

func (s *LifecycleHookSpecification) SetLifecycleHookName(v string) *LifecycleHookSpecification

SetLifecycleHookName sets the LifecycleHookName field's value.

func (*LifecycleHookSpecification) SetLifecycleTransition added in v1.10.44

func (s *LifecycleHookSpecification) SetLifecycleTransition(v string) *LifecycleHookSpecification

SetLifecycleTransition sets the LifecycleTransition field's value.

func (*LifecycleHookSpecification) SetNotificationMetadata added in v1.10.44

func (s *LifecycleHookSpecification) SetNotificationMetadata(v string) *LifecycleHookSpecification

SetNotificationMetadata sets the NotificationMetadata field's value.

func (*LifecycleHookSpecification) SetNotificationTargetARN added in v1.10.44

func (s *LifecycleHookSpecification) SetNotificationTargetARN(v string) *LifecycleHookSpecification

SetNotificationTargetARN sets the NotificationTargetARN field's value.

func (*LifecycleHookSpecification) SetRoleARN added in v1.10.44

SetRoleARN sets the RoleARN field's value.

func (LifecycleHookSpecification) String added in v1.10.44

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LifecycleHookSpecification) Validate added in v1.10.44

func (s *LifecycleHookSpecification) Validate() error

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

type LoadBalancerState added in v0.6.2

type LoadBalancerState struct {

	// The name of the load balancer.
	LoadBalancerName *string `min:"1" type:"string"`

	// One of the following load balancer states:
	//
	//    * Adding - The Auto Scaling instances are being registered with the load
	//    balancer.
	//
	//    * Added - All Auto Scaling instances are registered with the load balancer.
	//
	//    * InService - At least one Auto Scaling instance passed an ELB health
	//    check.
	//
	//    * Removing - The Auto Scaling instances are being deregistered from the
	//    load balancer. If connection draining is enabled, Elastic Load Balancing
	//    waits for in-flight requests to complete before deregistering the instances.
	//
	//    * Removed - All Auto Scaling instances are deregistered from the load
	//    balancer.
	State *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes the state of a Classic Load Balancer.

func (LoadBalancerState) GoString added in v0.6.5

func (s LoadBalancerState) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LoadBalancerState) SetLoadBalancerName added in v1.5.0

func (s *LoadBalancerState) SetLoadBalancerName(v string) *LoadBalancerState

SetLoadBalancerName sets the LoadBalancerName field's value.

func (*LoadBalancerState) SetState added in v1.5.0

func (s *LoadBalancerState) SetState(v string) *LoadBalancerState

SetState sets the State field's value.

func (LoadBalancerState) String added in v0.6.5

func (s LoadBalancerState) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LoadBalancerTargetGroupState added in v1.4.1

type LoadBalancerTargetGroupState struct {

	// The Amazon Resource Name (ARN) of the target group.
	LoadBalancerTargetGroupARN *string `min:"1" type:"string"`

	// The state of the target group.
	//
	//    * Adding - The Auto Scaling instances are being registered with the target
	//    group.
	//
	//    * Added - All Auto Scaling instances are registered with the target group.
	//
	//    * InService - At least one Auto Scaling instance passed an ELB health
	//    check.
	//
	//    * Removing - The Auto Scaling instances are being deregistered from the
	//    target group. If connection draining is enabled, Elastic Load Balancing
	//    waits for in-flight requests to complete before deregistering the instances.
	//
	//    * Removed - All Auto Scaling instances are deregistered from the target
	//    group.
	State *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes the state of a target group.

func (LoadBalancerTargetGroupState) GoString added in v1.4.1

func (s LoadBalancerTargetGroupState) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LoadBalancerTargetGroupState) SetLoadBalancerTargetGroupARN added in v1.5.0

func (s *LoadBalancerTargetGroupState) SetLoadBalancerTargetGroupARN(v string) *LoadBalancerTargetGroupState

SetLoadBalancerTargetGroupARN sets the LoadBalancerTargetGroupARN field's value.

func (*LoadBalancerTargetGroupState) SetState added in v1.5.0

SetState sets the State field's value.

func (LoadBalancerTargetGroupState) String added in v1.4.1

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LoadForecast added in v1.38.43

type LoadForecast struct {

	// The metric specification for the load forecast.
	//
	// MetricSpecification is a required field
	MetricSpecification *PredictiveScalingMetricSpecification `type:"structure" required:"true"`

	// The timestamps for the data points, in UTC format.
	//
	// Timestamps is a required field
	Timestamps []*time.Time `type:"list" required:"true"`

	// The values of the data points.
	//
	// Values is a required field
	Values []*float64 `type:"list" required:"true"`
	// contains filtered or unexported fields
}

A GetPredictiveScalingForecast call returns the load forecast for a predictive scaling policy. This structure includes the data points for that load forecast, along with the timestamps of those data points and the metric specification.

func (LoadForecast) GoString added in v1.38.43

func (s LoadForecast) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LoadForecast) SetMetricSpecification added in v1.38.43

func (s *LoadForecast) SetMetricSpecification(v *PredictiveScalingMetricSpecification) *LoadForecast

SetMetricSpecification sets the MetricSpecification field's value.

func (*LoadForecast) SetTimestamps added in v1.38.43

func (s *LoadForecast) SetTimestamps(v []*time.Time) *LoadForecast

SetTimestamps sets the Timestamps field's value.

func (*LoadForecast) SetValues added in v1.38.43

func (s *LoadForecast) SetValues(v []*float64) *LoadForecast

SetValues sets the Values field's value.

func (LoadForecast) String added in v1.38.43

func (s LoadForecast) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MemoryGiBPerVCpuRequest added in v1.41.12

type MemoryGiBPerVCpuRequest struct {

	// The memory maximum in GiB.
	Max *float64 `type:"double"`

	// The memory minimum in GiB.
	Min *float64 `type:"double"`
	// contains filtered or unexported fields
}

Specifies the minimum and maximum for the MemoryGiBPerVCpu object when you specify InstanceRequirements for an Auto Scaling group.

func (MemoryGiBPerVCpuRequest) GoString added in v1.41.12

func (s MemoryGiBPerVCpuRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MemoryGiBPerVCpuRequest) SetMax added in v1.41.12

SetMax sets the Max field's value.

func (*MemoryGiBPerVCpuRequest) SetMin added in v1.41.12

SetMin sets the Min field's value.

func (MemoryGiBPerVCpuRequest) String added in v1.41.12

func (s MemoryGiBPerVCpuRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MemoryMiBRequest added in v1.41.12

type MemoryMiBRequest struct {

	// The memory maximum in MiB.
	Max *int64 `type:"integer"`

	// The memory minimum in MiB.
	//
	// Min is a required field
	Min *int64 `type:"integer" required:"true"`
	// contains filtered or unexported fields
}

Specifies the minimum and maximum for the MemoryMiB object when you specify InstanceRequirements for an Auto Scaling group.

func (MemoryMiBRequest) GoString added in v1.41.12

func (s MemoryMiBRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MemoryMiBRequest) SetMax added in v1.41.12

func (s *MemoryMiBRequest) SetMax(v int64) *MemoryMiBRequest

SetMax sets the Max field's value.

func (*MemoryMiBRequest) SetMin added in v1.41.12

func (s *MemoryMiBRequest) SetMin(v int64) *MemoryMiBRequest

SetMin sets the Min field's value.

func (MemoryMiBRequest) String added in v1.41.12

func (s MemoryMiBRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MemoryMiBRequest) Validate added in v1.41.12

func (s *MemoryMiBRequest) Validate() error

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

type Metric added in v1.42.12

type Metric struct {

	// The dimensions for the metric. For the list of available dimensions, see
	// the Amazon Web Services documentation available from the table in Amazon
	// Web Services services that publish CloudWatch metrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)
	// in the Amazon CloudWatch User Guide.
	//
	// Conditional: If you published your metric with dimensions, you must specify
	// the same dimensions in your scaling policy.
	Dimensions []*MetricDimension `type:"list"`

	// The name of the metric.
	//
	// MetricName is a required field
	MetricName *string `type:"string" required:"true"`

	// The namespace of the metric. For more information, see the table in Amazon
	// Web Services services that publish CloudWatch metrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)
	// in the Amazon CloudWatch User Guide.
	//
	// Namespace is a required field
	Namespace *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents a specific metric.

func (Metric) GoString added in v1.42.12

func (s Metric) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Metric) SetDimensions added in v1.42.12

func (s *Metric) SetDimensions(v []*MetricDimension) *Metric

SetDimensions sets the Dimensions field's value.

func (*Metric) SetMetricName added in v1.42.12

func (s *Metric) SetMetricName(v string) *Metric

SetMetricName sets the MetricName field's value.

func (*Metric) SetNamespace added in v1.42.12

func (s *Metric) SetNamespace(v string) *Metric

SetNamespace sets the Namespace field's value.

func (Metric) String added in v1.42.12

func (s Metric) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Metric) Validate added in v1.42.12

func (s *Metric) Validate() error

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

type MetricCollectionType

type MetricCollectionType struct {

	// One of the following metrics:
	//
	//    * GroupMinSize
	//
	//    * GroupMaxSize
	//
	//    * GroupDesiredCapacity
	//
	//    * GroupInServiceInstances
	//
	//    * GroupPendingInstances
	//
	//    * GroupStandbyInstances
	//
	//    * GroupTerminatingInstances
	//
	//    * GroupTotalInstances
	//
	//    * GroupInServiceCapacity
	//
	//    * GroupPendingCapacity
	//
	//    * GroupStandbyCapacity
	//
	//    * GroupTerminatingCapacity
	//
	//    * GroupTotalCapacity
	//
	//    * WarmPoolDesiredCapacity
	//
	//    * WarmPoolWarmedCapacity
	//
	//    * WarmPoolPendingCapacity
	//
	//    * WarmPoolTerminatingCapacity
	//
	//    * WarmPoolTotalCapacity
	//
	//    * GroupAndWarmPoolDesiredCapacity
	//
	//    * GroupAndWarmPoolTotalCapacity
	Metric *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes a metric.

func (MetricCollectionType) GoString added in v0.6.5

func (s MetricCollectionType) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetricCollectionType) SetMetric added in v1.5.0

SetMetric sets the Metric field's value.

func (MetricCollectionType) String added in v0.6.5

func (s MetricCollectionType) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MetricDataQuery added in v1.42.12

type MetricDataQuery struct {

	// The math expression to perform on the returned data, if this object is performing
	// a math expression. This expression can use the Id of the other metrics to
	// refer to those metrics, and can also use the Id of other expressions to use
	// the result of those expressions.
	//
	// Conditional: Within each MetricDataQuery object, you must specify either
	// Expression or MetricStat, but not both.
	Expression *string `min:"1" type:"string"`

	// A short name that identifies the object's results in the response. This name
	// must be unique among all MetricDataQuery objects specified for a single scaling
	// policy. If you are performing math expressions on this set of data, this
	// name represents that data and can serve as a variable in the mathematical
	// expression. The valid characters are letters, numbers, and underscores. The
	// first character must be a lowercase letter.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`

	// A human-readable label for this metric or expression. This is especially
	// useful if this is a math expression, so that you know what the value represents.
	Label *string `type:"string"`

	// Information about the metric data to return.
	//
	// Conditional: Within each MetricDataQuery object, you must specify either
	// Expression or MetricStat, but not both.
	MetricStat *MetricStat `type:"structure"`

	// Indicates whether to return the timestamps and raw data values of this metric.
	//
	// If you use any math expressions, specify true for this value for only the
	// final math expression that the metric specification is based on. You must
	// specify false for ReturnData for all the other metrics and expressions used
	// in the metric specification.
	//
	// If you are only retrieving metrics and not performing any math expressions,
	// do not specify anything for ReturnData. This sets it to its default (true).
	ReturnData *bool `type:"boolean"`
	// contains filtered or unexported fields
}

The metric data to return. Also defines whether this call is returning data for one metric only, or whether it is performing a math expression on the values of returned metric statistics to create a new time series. A time series is a series of data points, each of which is associated with a timestamp.

For more information and examples, see Advanced predictive scaling policy configurations using custom metrics (https://docs.aws.amazon.com/autoscaling/ec2/userguide/predictive-scaling-customized-metric-specification.html) in the Amazon EC2 Auto Scaling User Guide.

func (MetricDataQuery) GoString added in v1.42.12

func (s MetricDataQuery) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetricDataQuery) SetExpression added in v1.42.12

func (s *MetricDataQuery) SetExpression(v string) *MetricDataQuery

SetExpression sets the Expression field's value.

func (*MetricDataQuery) SetId added in v1.42.12

func (s *MetricDataQuery) SetId(v string) *MetricDataQuery

SetId sets the Id field's value.

func (*MetricDataQuery) SetLabel added in v1.42.12

func (s *MetricDataQuery) SetLabel(v string) *MetricDataQuery

SetLabel sets the Label field's value.

func (*MetricDataQuery) SetMetricStat added in v1.42.12

func (s *MetricDataQuery) SetMetricStat(v *MetricStat) *MetricDataQuery

SetMetricStat sets the MetricStat field's value.

func (*MetricDataQuery) SetReturnData added in v1.42.12

func (s *MetricDataQuery) SetReturnData(v bool) *MetricDataQuery

SetReturnData sets the ReturnData field's value.

func (MetricDataQuery) String added in v1.42.12

func (s MetricDataQuery) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetricDataQuery) Validate added in v1.42.12

func (s *MetricDataQuery) Validate() error

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

type MetricDimension added in v1.10.9

type MetricDimension struct {

	// The name of the dimension.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// The value of the dimension.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes the dimension of a metric.

func (MetricDimension) GoString added in v1.10.9

func (s MetricDimension) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetricDimension) SetName added in v1.10.9

func (s *MetricDimension) SetName(v string) *MetricDimension

SetName sets the Name field's value.

func (*MetricDimension) SetValue added in v1.10.9

func (s *MetricDimension) SetValue(v string) *MetricDimension

SetValue sets the Value field's value.

func (MetricDimension) String added in v1.10.9

func (s MetricDimension) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetricDimension) Validate added in v1.10.9

func (s *MetricDimension) Validate() error

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

type MetricGranularityType

type MetricGranularityType struct {

	// The granularity. The only valid value is 1Minute.
	Granularity *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes a granularity of a metric.

func (MetricGranularityType) GoString added in v0.6.5

func (s MetricGranularityType) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetricGranularityType) SetGranularity added in v1.5.0

func (s *MetricGranularityType) SetGranularity(v string) *MetricGranularityType

SetGranularity sets the Granularity field's value.

func (MetricGranularityType) String added in v0.6.5

func (s MetricGranularityType) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MetricStat added in v1.42.12

type MetricStat struct {

	// The CloudWatch metric to return, including the metric name, namespace, and
	// dimensions. To get the exact metric name, namespace, and dimensions, inspect
	// the Metric (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html)
	// object that is returned by a call to ListMetrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html).
	//
	// Metric is a required field
	Metric *Metric `type:"structure" required:"true"`

	// The statistic to return. It can include any CloudWatch statistic or extended
	// statistic. For a list of valid values, see the table in Statistics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic)
	// in the Amazon CloudWatch User Guide.
	//
	// The most commonly used metrics for predictive scaling are Average and Sum.
	//
	// Stat is a required field
	Stat *string `min:"1" type:"string" required:"true"`

	// The unit to use for the returned data points. For a complete list of the
	// units that CloudWatch supports, see the MetricDatum (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html)
	// data type in the Amazon CloudWatch API Reference.
	Unit *string `type:"string"`
	// contains filtered or unexported fields
}

This structure defines the CloudWatch metric to return, along with the statistic, period, and unit.

For more information about the CloudWatch terminology below, see Amazon CloudWatch concepts (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html) in the Amazon CloudWatch User Guide.

func (MetricStat) GoString added in v1.42.12

func (s MetricStat) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetricStat) SetMetric added in v1.42.12

func (s *MetricStat) SetMetric(v *Metric) *MetricStat

SetMetric sets the Metric field's value.

func (*MetricStat) SetStat added in v1.42.12

func (s *MetricStat) SetStat(v string) *MetricStat

SetStat sets the Stat field's value.

func (*MetricStat) SetUnit added in v1.42.12

func (s *MetricStat) SetUnit(v string) *MetricStat

SetUnit sets the Unit field's value.

func (MetricStat) String added in v1.42.12

func (s MetricStat) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetricStat) Validate added in v1.42.12

func (s *MetricStat) Validate() error

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

type MixedInstancesPolicy added in v1.15.76

type MixedInstancesPolicy struct {

	// The instances distribution.
	InstancesDistribution *InstancesDistribution `type:"structure"`

	// One or more launch templates and the instance types (overrides) that are
	// used to launch EC2 instances to fulfill On-Demand and Spot capacities.
	LaunchTemplate *LaunchTemplate `type:"structure"`
	// contains filtered or unexported fields
}

Use this structure to launch multiple instance types and On-Demand Instances and Spot Instances within a single Auto Scaling group.

A mixed instances policy contains information that Amazon EC2 Auto Scaling can use to launch instances and help optimize your costs. For more information, see Auto Scaling groups with multiple instance types and purchase options (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the Amazon EC2 Auto Scaling User Guide.

func (MixedInstancesPolicy) GoString added in v1.15.76

func (s MixedInstancesPolicy) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MixedInstancesPolicy) SetInstancesDistribution added in v1.15.76

func (s *MixedInstancesPolicy) SetInstancesDistribution(v *InstancesDistribution) *MixedInstancesPolicy

SetInstancesDistribution sets the InstancesDistribution field's value.

func (*MixedInstancesPolicy) SetLaunchTemplate added in v1.15.76

func (s *MixedInstancesPolicy) SetLaunchTemplate(v *LaunchTemplate) *MixedInstancesPolicy

SetLaunchTemplate sets the LaunchTemplate field's value.

func (MixedInstancesPolicy) String added in v1.15.76

func (s MixedInstancesPolicy) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MixedInstancesPolicy) Validate added in v1.15.76

func (s *MixedInstancesPolicy) Validate() error

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

type NetworkBandwidthGbpsRequest added in v1.44.132

type NetworkBandwidthGbpsRequest struct {

	// The maximum amount of network bandwidth, in gigabits per second (Gbps).
	Max *float64 `type:"double"`

	// The minimum amount of network bandwidth, in gigabits per second (Gbps).
	Min *float64 `type:"double"`
	// contains filtered or unexported fields
}

Specifies the minimum and maximum for the NetworkBandwidthGbps object when you specify InstanceRequirements for an Auto Scaling group.

Setting the minimum bandwidth does not guarantee that your instance will achieve the minimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum bandwidth, but the actual bandwidth of your instance might go below the specified minimum at times. For more information, see Available instance bandwidth (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth) in the Amazon EC2 User Guide for Linux Instances.

func (NetworkBandwidthGbpsRequest) GoString added in v1.44.132

func (s NetworkBandwidthGbpsRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NetworkBandwidthGbpsRequest) SetMax added in v1.44.132

SetMax sets the Max field's value.

func (*NetworkBandwidthGbpsRequest) SetMin added in v1.44.132

SetMin sets the Min field's value.

func (NetworkBandwidthGbpsRequest) String added in v1.44.132

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NetworkInterfaceCountRequest added in v1.41.12

type NetworkInterfaceCountRequest struct {

	// The maximum number of network interfaces.
	Max *int64 `type:"integer"`

	// The minimum number of network interfaces.
	Min *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Specifies the minimum and maximum for the NetworkInterfaceCount object when you specify InstanceRequirements for an Auto Scaling group.

func (NetworkInterfaceCountRequest) GoString added in v1.41.12

func (s NetworkInterfaceCountRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NetworkInterfaceCountRequest) SetMax added in v1.41.12

SetMax sets the Max field's value.

func (*NetworkInterfaceCountRequest) SetMin added in v1.41.12

SetMin sets the Min field's value.

func (NetworkInterfaceCountRequest) String added in v1.41.12

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NotificationConfiguration

type NotificationConfiguration struct {

	// The name of the Auto Scaling group.
	AutoScalingGroupName *string `min:"1" type:"string"`

	// One of the following event notification types:
	//
	//    * autoscaling:EC2_INSTANCE_LAUNCH
	//
	//    * autoscaling:EC2_INSTANCE_LAUNCH_ERROR
	//
	//    * autoscaling:EC2_INSTANCE_TERMINATE
	//
	//    * autoscaling:EC2_INSTANCE_TERMINATE_ERROR
	//
	//    * autoscaling:TEST_NOTIFICATION
	NotificationType *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the Amazon SNS topic.
	TopicARN *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes a notification.

func (NotificationConfiguration) GoString added in v0.6.5

func (s NotificationConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NotificationConfiguration) SetAutoScalingGroupName added in v1.5.0

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

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*NotificationConfiguration) SetNotificationType added in v1.5.0

func (s *NotificationConfiguration) SetNotificationType(v string) *NotificationConfiguration

SetNotificationType sets the NotificationType field's value.

func (*NotificationConfiguration) SetTopicARN added in v1.5.0

SetTopicARN sets the TopicARN field's value.

func (NotificationConfiguration) String added in v0.6.5

func (s NotificationConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PredefinedMetricSpecification added in v1.10.9

type PredefinedMetricSpecification struct {

	// The metric type. The following predefined metrics are available:
	//
	//    * ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling
	//    group.
	//
	//    * ASGAverageNetworkIn - Average number of bytes received on all network
	//    interfaces by the Auto Scaling group.
	//
	//    * ASGAverageNetworkOut - Average number of bytes sent out on all network
	//    interfaces by the Auto Scaling group.
	//
	//    * ALBRequestCountPerTarget - Average Application Load Balancer request
	//    count per target for your Auto Scaling group.
	//
	// PredefinedMetricType is a required field
	PredefinedMetricType *string `type:"string" required:"true" enum:"MetricType"`

	// A label that uniquely identifies a specific Application Load Balancer target
	// group from which to determine the average request count served by your Auto
	// Scaling group. You can't specify a resource label unless the target group
	// is attached to the Auto Scaling group.
	//
	// You create the resource label by appending the final portion of the load
	// balancer ARN and the final portion of the target group ARN into a single
	// value, separated by a forward slash (/). The format of the resource label
	// is:
	//
	// app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
	//
	// Where:
	//
	//    * app/<load-balancer-name>/<load-balancer-id> is the final portion of
	//    the load balancer ARN
	//
	//    * targetgroup/<target-group-name>/<target-group-id> is the final portion
	//    of the target group ARN.
	//
	// To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers
	// (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html)
	// API operation. To find the ARN for the target group, use the DescribeTargetGroups
	// (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html)
	// API operation.
	ResourceLabel *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents a predefined metric for a target tracking scaling policy to use with Amazon EC2 Auto Scaling.

func (PredefinedMetricSpecification) GoString added in v1.10.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PredefinedMetricSpecification) SetPredefinedMetricType added in v1.10.9

SetPredefinedMetricType sets the PredefinedMetricType field's value.

func (*PredefinedMetricSpecification) SetResourceLabel added in v1.10.9

SetResourceLabel sets the ResourceLabel field's value.

func (PredefinedMetricSpecification) String added in v1.10.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PredefinedMetricSpecification) Validate added in v1.10.9

func (s *PredefinedMetricSpecification) Validate() error

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

type PredictiveScalingConfiguration added in v1.38.43

type PredictiveScalingConfiguration struct {

	// Defines the behavior that should be applied if the forecast capacity approaches
	// or exceeds the maximum capacity of the Auto Scaling group. Defaults to HonorMaxCapacity
	// if not specified.
	//
	// The following are possible values:
	//
	//    * HonorMaxCapacity - Amazon EC2 Auto Scaling cannot scale out capacity
	//    higher than the maximum capacity. The maximum capacity is enforced as
	//    a hard limit.
	//
	//    * IncreaseMaxCapacity - Amazon EC2 Auto Scaling can scale out capacity
	//    higher than the maximum capacity when the forecast capacity is close to
	//    or exceeds the maximum capacity. The upper limit is determined by the
	//    forecasted capacity and the value for MaxCapacityBuffer.
	MaxCapacityBreachBehavior *string `type:"string" enum:"PredictiveScalingMaxCapacityBreachBehavior"`

	// The size of the capacity buffer to use when the forecast capacity is close
	// to or exceeds the maximum capacity. The value is specified as a percentage
	// relative to the forecast capacity. For example, if the buffer is 10, this
	// means a 10 percent buffer, such that if the forecast capacity is 50, and
	// the maximum capacity is 40, then the effective maximum capacity is 55.
	//
	// If set to 0, Amazon EC2 Auto Scaling may scale capacity higher than the maximum
	// capacity to equal but not exceed forecast capacity.
	//
	// Required if the MaxCapacityBreachBehavior property is set to IncreaseMaxCapacity,
	// and cannot be used otherwise.
	MaxCapacityBuffer *int64 `type:"integer"`

	// This structure includes the metrics and target utilization to use for predictive
	// scaling.
	//
	// This is an array, but we currently only support a single metric specification.
	// That is, you can specify a target value and a single metric pair, or a target
	// value and one scaling metric and one load metric.
	//
	// MetricSpecifications is a required field
	MetricSpecifications []*PredictiveScalingMetricSpecification `type:"list" required:"true"`

	// The predictive scaling mode. Defaults to ForecastOnly if not specified.
	Mode *string `type:"string" enum:"PredictiveScalingMode"`

	// The amount of time, in seconds, by which the instance launch time can be
	// advanced. For example, the forecast says to add capacity at 10:00 AM, and
	// you choose to pre-launch instances by 5 minutes. In that case, the instances
	// will be launched at 9:55 AM. The intention is to give resources time to be
	// provisioned. It can take a few minutes to launch an EC2 instance. The actual
	// amount of time required depends on several factors, such as the size of the
	// instance and whether there are startup scripts to complete.
	//
	// The value must be less than the forecast interval duration of 3600 seconds
	// (60 minutes). Defaults to 300 seconds if not specified.
	SchedulingBufferTime *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Represents a predictive scaling policy configuration to use with Amazon EC2 Auto Scaling.

func (PredictiveScalingConfiguration) GoString added in v1.38.43

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PredictiveScalingConfiguration) SetMaxCapacityBreachBehavior added in v1.38.43

func (s *PredictiveScalingConfiguration) SetMaxCapacityBreachBehavior(v string) *PredictiveScalingConfiguration

SetMaxCapacityBreachBehavior sets the MaxCapacityBreachBehavior field's value.

func (*PredictiveScalingConfiguration) SetMaxCapacityBuffer added in v1.38.43

SetMaxCapacityBuffer sets the MaxCapacityBuffer field's value.

func (*PredictiveScalingConfiguration) SetMetricSpecifications added in v1.38.43

SetMetricSpecifications sets the MetricSpecifications field's value.

func (*PredictiveScalingConfiguration) SetMode added in v1.38.43

SetMode sets the Mode field's value.

func (*PredictiveScalingConfiguration) SetSchedulingBufferTime added in v1.38.43

SetSchedulingBufferTime sets the SchedulingBufferTime field's value.

func (PredictiveScalingConfiguration) String added in v1.38.43

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PredictiveScalingConfiguration) Validate added in v1.38.43

func (s *PredictiveScalingConfiguration) Validate() error

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

type PredictiveScalingCustomizedCapacityMetric added in v1.42.12

type PredictiveScalingCustomizedCapacityMetric struct {

	// One or more metric data queries to provide the data points for a capacity
	// metric. Use multiple metric data queries only if you are performing a math
	// expression on returned data.
	//
	// MetricDataQueries is a required field
	MetricDataQueries []*MetricDataQuery `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Describes a customized capacity metric for a predictive scaling policy.

func (PredictiveScalingCustomizedCapacityMetric) GoString added in v1.42.12

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PredictiveScalingCustomizedCapacityMetric) SetMetricDataQueries added in v1.42.12

SetMetricDataQueries sets the MetricDataQueries field's value.

func (PredictiveScalingCustomizedCapacityMetric) String added in v1.42.12

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PredictiveScalingCustomizedCapacityMetric) Validate added in v1.42.12

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

type PredictiveScalingCustomizedLoadMetric added in v1.42.12

type PredictiveScalingCustomizedLoadMetric struct {

	// One or more metric data queries to provide the data points for a load metric.
	// Use multiple metric data queries only if you are performing a math expression
	// on returned data.
	//
	// MetricDataQueries is a required field
	MetricDataQueries []*MetricDataQuery `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Describes a custom load metric for a predictive scaling policy.

func (PredictiveScalingCustomizedLoadMetric) GoString added in v1.42.12

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PredictiveScalingCustomizedLoadMetric) SetMetricDataQueries added in v1.42.12

SetMetricDataQueries sets the MetricDataQueries field's value.

func (PredictiveScalingCustomizedLoadMetric) String added in v1.42.12

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PredictiveScalingCustomizedLoadMetric) Validate added in v1.42.12

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

type PredictiveScalingCustomizedScalingMetric added in v1.42.12

type PredictiveScalingCustomizedScalingMetric struct {

	// One or more metric data queries to provide the data points for a scaling
	// metric. Use multiple metric data queries only if you are performing a math
	// expression on returned data.
	//
	// MetricDataQueries is a required field
	MetricDataQueries []*MetricDataQuery `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Describes a custom scaling metric for a predictive scaling policy.

func (PredictiveScalingCustomizedScalingMetric) GoString added in v1.42.12

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PredictiveScalingCustomizedScalingMetric) SetMetricDataQueries added in v1.42.12

SetMetricDataQueries sets the MetricDataQueries field's value.

func (PredictiveScalingCustomizedScalingMetric) String added in v1.42.12

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PredictiveScalingCustomizedScalingMetric) Validate added in v1.42.12

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

type PredictiveScalingMetricSpecification added in v1.38.43

type PredictiveScalingMetricSpecification struct {

	// The customized capacity metric specification.
	CustomizedCapacityMetricSpecification *PredictiveScalingCustomizedCapacityMetric `type:"structure"`

	// The customized load metric specification.
	CustomizedLoadMetricSpecification *PredictiveScalingCustomizedLoadMetric `type:"structure"`

	// The customized scaling metric specification.
	CustomizedScalingMetricSpecification *PredictiveScalingCustomizedScalingMetric `type:"structure"`

	// The predefined load metric specification.
	PredefinedLoadMetricSpecification *PredictiveScalingPredefinedLoadMetric `type:"structure"`

	// The predefined metric pair specification from which Amazon EC2 Auto Scaling
	// determines the appropriate scaling metric and load metric to use.
	PredefinedMetricPairSpecification *PredictiveScalingPredefinedMetricPair `type:"structure"`

	// The predefined scaling metric specification.
	PredefinedScalingMetricSpecification *PredictiveScalingPredefinedScalingMetric `type:"structure"`

	// Specifies the target utilization.
	//
	// Some metrics are based on a count instead of a percentage, such as the request
	// count for an Application Load Balancer or the number of messages in an SQS
	// queue. If the scaling policy specifies one of these metrics, specify the
	// target utilization as the optimal average request or message count per instance
	// during any one-minute interval.
	//
	// TargetValue is a required field
	TargetValue *float64 `type:"double" required:"true"`
	// contains filtered or unexported fields
}

This structure specifies the metrics and target utilization settings for a predictive scaling policy.

You must specify either a metric pair, or a load metric and a scaling metric individually. Specifying a metric pair instead of individual metrics provides a simpler way to configure metrics for a scaling policy. You choose the metric pair, and the policy automatically knows the correct sum and average statistics to use for the load metric and the scaling metric.

Example

  • You create a predictive scaling policy and specify ALBRequestCount as the value for the metric pair and 1000.0 as the target value. For this type of metric, you must provide the metric dimension for the corresponding target group, so you also provide a resource label for the Application Load Balancer target group that is attached to your Auto Scaling group.

  • The number of requests the target group receives per minute provides the load metric, and the request count averaged between the members of the target group provides the scaling metric. In CloudWatch, this refers to the RequestCount and RequestCountPerTarget metrics, respectively.

  • For optimal use of predictive scaling, you adhere to the best practice of using a dynamic scaling policy to automatically scale between the minimum capacity and maximum capacity in response to real-time changes in resource utilization.

  • Amazon EC2 Auto Scaling consumes data points for the load metric over the last 14 days and creates an hourly load forecast for predictive scaling. (A minimum of 24 hours of data is required.)

  • After creating the load forecast, Amazon EC2 Auto Scaling determines when to reduce or increase the capacity of your Auto Scaling group in each hour of the forecast period so that the average number of requests received by each instance is as close to 1000 requests per minute as possible at all times.

For information about using custom metrics with predictive scaling, see Advanced predictive scaling policy configurations using custom metrics (https://docs.aws.amazon.com/autoscaling/ec2/userguide/predictive-scaling-customized-metric-specification.html) in the Amazon EC2 Auto Scaling User Guide.

func (PredictiveScalingMetricSpecification) GoString added in v1.38.43

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PredictiveScalingMetricSpecification) SetCustomizedCapacityMetricSpecification added in v1.42.12

SetCustomizedCapacityMetricSpecification sets the CustomizedCapacityMetricSpecification field's value.

func (*PredictiveScalingMetricSpecification) SetCustomizedLoadMetricSpecification added in v1.42.12

SetCustomizedLoadMetricSpecification sets the CustomizedLoadMetricSpecification field's value.

func (*PredictiveScalingMetricSpecification) SetCustomizedScalingMetricSpecification added in v1.42.12

SetCustomizedScalingMetricSpecification sets the CustomizedScalingMetricSpecification field's value.

func (*PredictiveScalingMetricSpecification) SetPredefinedLoadMetricSpecification added in v1.38.43

SetPredefinedLoadMetricSpecification sets the PredefinedLoadMetricSpecification field's value.

func (*PredictiveScalingMetricSpecification) SetPredefinedMetricPairSpecification added in v1.38.43

SetPredefinedMetricPairSpecification sets the PredefinedMetricPairSpecification field's value.

func (*PredictiveScalingMetricSpecification) SetPredefinedScalingMetricSpecification added in v1.38.43

SetPredefinedScalingMetricSpecification sets the PredefinedScalingMetricSpecification field's value.

func (*PredictiveScalingMetricSpecification) SetTargetValue added in v1.38.43

SetTargetValue sets the TargetValue field's value.

func (PredictiveScalingMetricSpecification) String added in v1.38.43

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PredictiveScalingMetricSpecification) Validate added in v1.38.43

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

type PredictiveScalingPredefinedLoadMetric added in v1.38.43

type PredictiveScalingPredefinedLoadMetric struct {

	// The metric type.
	//
	// PredefinedMetricType is a required field
	PredefinedMetricType *string `type:"string" required:"true" enum:"PredefinedLoadMetricType"`

	// A label that uniquely identifies a specific Application Load Balancer target
	// group from which to determine the request count served by your Auto Scaling
	// group. You can't specify a resource label unless the target group is attached
	// to the Auto Scaling group.
	//
	// You create the resource label by appending the final portion of the load
	// balancer ARN and the final portion of the target group ARN into a single
	// value, separated by a forward slash (/). The format of the resource label
	// is:
	//
	// app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
	//
	// Where:
	//
	//    * app/<load-balancer-name>/<load-balancer-id> is the final portion of
	//    the load balancer ARN
	//
	//    * targetgroup/<target-group-name>/<target-group-id> is the final portion
	//    of the target group ARN.
	//
	// To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers
	// (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html)
	// API operation. To find the ARN for the target group, use the DescribeTargetGroups
	// (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html)
	// API operation.
	ResourceLabel *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes a load metric for a predictive scaling policy.

When returned in the output of DescribePolicies, it indicates that a predictive scaling policy uses individually specified load and scaling metrics instead of a metric pair.

func (PredictiveScalingPredefinedLoadMetric) GoString added in v1.38.43

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PredictiveScalingPredefinedLoadMetric) SetPredefinedMetricType added in v1.38.43

SetPredefinedMetricType sets the PredefinedMetricType field's value.

func (*PredictiveScalingPredefinedLoadMetric) SetResourceLabel added in v1.38.43

SetResourceLabel sets the ResourceLabel field's value.

func (PredictiveScalingPredefinedLoadMetric) String added in v1.38.43

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PredictiveScalingPredefinedLoadMetric) Validate added in v1.38.43

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

type PredictiveScalingPredefinedMetricPair added in v1.38.43

type PredictiveScalingPredefinedMetricPair struct {

	// Indicates which metrics to use. There are two different types of metrics
	// for each metric type: one is a load metric and one is a scaling metric. For
	// example, if the metric type is ASGCPUUtilization, the Auto Scaling group's
	// total CPU metric is used as the load metric, and the average CPU metric is
	// used for the scaling metric.
	//
	// PredefinedMetricType is a required field
	PredefinedMetricType *string `type:"string" required:"true" enum:"PredefinedMetricPairType"`

	// A label that uniquely identifies a specific Application Load Balancer target
	// group from which to determine the total and average request count served
	// by your Auto Scaling group. You can't specify a resource label unless the
	// target group is attached to the Auto Scaling group.
	//
	// You create the resource label by appending the final portion of the load
	// balancer ARN and the final portion of the target group ARN into a single
	// value, separated by a forward slash (/). The format of the resource label
	// is:
	//
	// app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
	//
	// Where:
	//
	//    * app/<load-balancer-name>/<load-balancer-id> is the final portion of
	//    the load balancer ARN
	//
	//    * targetgroup/<target-group-name>/<target-group-id> is the final portion
	//    of the target group ARN.
	//
	// To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers
	// (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html)
	// API operation. To find the ARN for the target group, use the DescribeTargetGroups
	// (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html)
	// API operation.
	ResourceLabel *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents a metric pair for a predictive scaling policy.

func (PredictiveScalingPredefinedMetricPair) GoString added in v1.38.43

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PredictiveScalingPredefinedMetricPair) SetPredefinedMetricType added in v1.38.43

SetPredefinedMetricType sets the PredefinedMetricType field's value.

func (*PredictiveScalingPredefinedMetricPair) SetResourceLabel added in v1.38.43

SetResourceLabel sets the ResourceLabel field's value.

func (PredictiveScalingPredefinedMetricPair) String added in v1.38.43

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PredictiveScalingPredefinedMetricPair) Validate added in v1.38.43

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

type PredictiveScalingPredefinedScalingMetric added in v1.38.43

type PredictiveScalingPredefinedScalingMetric struct {

	// The metric type.
	//
	// PredefinedMetricType is a required field
	PredefinedMetricType *string `type:"string" required:"true" enum:"PredefinedScalingMetricType"`

	// A label that uniquely identifies a specific Application Load Balancer target
	// group from which to determine the average request count served by your Auto
	// Scaling group. You can't specify a resource label unless the target group
	// is attached to the Auto Scaling group.
	//
	// You create the resource label by appending the final portion of the load
	// balancer ARN and the final portion of the target group ARN into a single
	// value, separated by a forward slash (/). The format of the resource label
	// is:
	//
	// app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
	//
	// Where:
	//
	//    * app/<load-balancer-name>/<load-balancer-id> is the final portion of
	//    the load balancer ARN
	//
	//    * targetgroup/<target-group-name>/<target-group-id> is the final portion
	//    of the target group ARN.
	//
	// To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers
	// (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html)
	// API operation. To find the ARN for the target group, use the DescribeTargetGroups
	// (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html)
	// API operation.
	ResourceLabel *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes a scaling metric for a predictive scaling policy.

When returned in the output of DescribePolicies, it indicates that a predictive scaling policy uses individually specified load and scaling metrics instead of a metric pair.

func (PredictiveScalingPredefinedScalingMetric) GoString added in v1.38.43

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PredictiveScalingPredefinedScalingMetric) SetPredefinedMetricType added in v1.38.43

SetPredefinedMetricType sets the PredefinedMetricType field's value.

func (*PredictiveScalingPredefinedScalingMetric) SetResourceLabel added in v1.38.43

SetResourceLabel sets the ResourceLabel field's value.

func (PredictiveScalingPredefinedScalingMetric) String added in v1.38.43

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PredictiveScalingPredefinedScalingMetric) Validate added in v1.38.43

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

type ProcessType

type ProcessType struct {

	// One of the following processes:
	//
	//    * Launch
	//
	//    * Terminate
	//
	//    * AddToLoadBalancer
	//
	//    * AlarmNotification
	//
	//    * AZRebalance
	//
	//    * HealthCheck
	//
	//    * InstanceRefresh
	//
	//    * ReplaceUnhealthy
	//
	//    * ScheduledActions
	//
	// ProcessName is a required field
	ProcessName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes a process type.

For more information, see Scaling processes (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html#process-types) in the Amazon EC2 Auto Scaling User Guide.

func (ProcessType) GoString added in v0.6.5

func (s ProcessType) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ProcessType) SetProcessName added in v1.5.0

func (s *ProcessType) SetProcessName(v string) *ProcessType

SetProcessName sets the ProcessName field's value.

func (ProcessType) String added in v0.6.5

func (s ProcessType) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutLifecycleHookInput

type PutLifecycleHookInput struct {

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// The action the Auto Scaling group takes when the lifecycle hook timeout elapses
	// or if an unexpected failure occurs. The default value is ABANDON.
	//
	// Valid values: CONTINUE | ABANDON
	DefaultResult *string `type:"string"`

	// The maximum time, in seconds, that can elapse before the lifecycle hook times
	// out. The range is from 30 to 7200 seconds. The default value is 3600 seconds
	// (1 hour).
	HeartbeatTimeout *int64 `type:"integer"`

	// The name of the lifecycle hook.
	//
	// LifecycleHookName is a required field
	LifecycleHookName *string `min:"1" type:"string" required:"true"`

	// The lifecycle transition. For Auto Scaling groups, there are two major lifecycle
	// transitions.
	//
	//    * To create a lifecycle hook for scale-out events, specify autoscaling:EC2_INSTANCE_LAUNCHING.
	//
	//    * To create a lifecycle hook for scale-in events, specify autoscaling:EC2_INSTANCE_TERMINATING.
	//
	// Required for new lifecycle hooks, but optional when updating existing hooks.
	LifecycleTransition *string `type:"string"`

	// Additional information that you want to include any time Amazon EC2 Auto
	// Scaling sends a message to the notification target.
	NotificationMetadata *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the notification target that Amazon EC2
	// Auto Scaling uses to notify you when an instance is in a wait state for the
	// lifecycle hook. You can specify either an Amazon SNS topic or an Amazon SQS
	// queue.
	//
	// If you specify an empty string, this overrides the current ARN.
	//
	// This operation uses the JSON format when sending notifications to an Amazon
	// SQS queue, and an email key-value pair format when sending notifications
	// to an Amazon SNS topic.
	//
	// When you specify a notification target, Amazon EC2 Auto Scaling sends it
	// a test message. Test messages contain the following additional key-value
	// pair: "Event": "autoscaling:TEST_NOTIFICATION".
	NotificationTargetARN *string `type:"string"`

	// The ARN of the IAM role that allows the Auto Scaling group to publish to
	// the specified notification target.
	//
	// Valid only if the notification target is an Amazon SNS topic or an Amazon
	// SQS queue. Required for new lifecycle hooks, but optional when updating existing
	// hooks.
	RoleARN *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (PutLifecycleHookInput) GoString added in v0.6.5

func (s PutLifecycleHookInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutLifecycleHookInput) SetAutoScalingGroupName added in v1.5.0

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

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*PutLifecycleHookInput) SetDefaultResult added in v1.5.0

func (s *PutLifecycleHookInput) SetDefaultResult(v string) *PutLifecycleHookInput

SetDefaultResult sets the DefaultResult field's value.

func (*PutLifecycleHookInput) SetHeartbeatTimeout added in v1.5.0

func (s *PutLifecycleHookInput) SetHeartbeatTimeout(v int64) *PutLifecycleHookInput

SetHeartbeatTimeout sets the HeartbeatTimeout field's value.

func (*PutLifecycleHookInput) SetLifecycleHookName added in v1.5.0

func (s *PutLifecycleHookInput) SetLifecycleHookName(v string) *PutLifecycleHookInput

SetLifecycleHookName sets the LifecycleHookName field's value.

func (*PutLifecycleHookInput) SetLifecycleTransition added in v1.5.0

func (s *PutLifecycleHookInput) SetLifecycleTransition(v string) *PutLifecycleHookInput

SetLifecycleTransition sets the LifecycleTransition field's value.

func (*PutLifecycleHookInput) SetNotificationMetadata added in v1.5.0

func (s *PutLifecycleHookInput) SetNotificationMetadata(v string) *PutLifecycleHookInput

SetNotificationMetadata sets the NotificationMetadata field's value.

func (*PutLifecycleHookInput) SetNotificationTargetARN added in v1.5.0

func (s *PutLifecycleHookInput) SetNotificationTargetARN(v string) *PutLifecycleHookInput

SetNotificationTargetARN sets the NotificationTargetARN field's value.

func (*PutLifecycleHookInput) SetRoleARN added in v1.5.0

SetRoleARN sets the RoleARN field's value.

func (PutLifecycleHookInput) String added in v0.6.5

func (s PutLifecycleHookInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutLifecycleHookInput) Validate added in v1.1.21

func (s *PutLifecycleHookInput) Validate() error

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

type PutLifecycleHookOutput

type PutLifecycleHookOutput struct {
	// contains filtered or unexported fields
}

func (PutLifecycleHookOutput) GoString added in v0.6.5

func (s PutLifecycleHookOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (PutLifecycleHookOutput) String added in v0.6.5

func (s PutLifecycleHookOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutNotificationConfigurationInput

type PutNotificationConfigurationInput struct {

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// The type of event that causes the notification to be sent. To query the notification
	// types supported by Amazon EC2 Auto Scaling, call the DescribeAutoScalingNotificationTypes
	// API.
	//
	// NotificationTypes is a required field
	NotificationTypes []*string `type:"list" required:"true"`

	// The Amazon Resource Name (ARN) of the Amazon SNS topic.
	//
	// TopicARN is a required field
	TopicARN *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutNotificationConfigurationInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutNotificationConfigurationInput) SetAutoScalingGroupName added in v1.5.0

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*PutNotificationConfigurationInput) SetNotificationTypes added in v1.5.0

SetNotificationTypes sets the NotificationTypes field's value.

func (*PutNotificationConfigurationInput) SetTopicARN added in v1.5.0

SetTopicARN sets the TopicARN field's value.

func (PutNotificationConfigurationInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutNotificationConfigurationInput) Validate added in v1.1.21

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

type PutNotificationConfigurationOutput

type PutNotificationConfigurationOutput struct {
	// contains filtered or unexported fields
}

func (PutNotificationConfigurationOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (PutNotificationConfigurationOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutScalingPolicyInput

type PutScalingPolicyInput struct {

	// Specifies how the scaling adjustment is interpreted (for example, an absolute
	// number or a percentage). The valid values are ChangeInCapacity, ExactCapacity,
	// and PercentChangeInCapacity.
	//
	// Required if the policy type is StepScaling or SimpleScaling. For more information,
	// see Scaling adjustment types (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment)
	// in the Amazon EC2 Auto Scaling User Guide.
	AdjustmentType *string `min:"1" type:"string"`

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// A cooldown period, in seconds, that applies to a specific simple scaling
	// policy. When a cooldown period is specified here, it overrides the default
	// cooldown.
	//
	// Valid only if the policy type is SimpleScaling. For more information, see
	// Scaling cooldowns for Amazon EC2 Auto Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html)
	// in the Amazon EC2 Auto Scaling User Guide.
	//
	// Default: None
	Cooldown *int64 `type:"integer"`

	// Indicates whether the scaling policy is enabled or disabled. The default
	// is enabled. For more information, see Disabling a scaling policy for an Auto
	// Scaling group (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-enable-disable-scaling-policy.html)
	// in the Amazon EC2 Auto Scaling User Guide.
	Enabled *bool `type:"boolean"`

	// Not needed if the default instance warmup is defined for the group.
	//
	// The estimated time, in seconds, until a newly launched instance can contribute
	// to the CloudWatch metrics. This warm-up period applies to instances launched
	// due to a specific target tracking or step scaling policy. When a warm-up
	// period is specified here, it overrides the default instance warmup.
	//
	// Valid only if the policy type is TargetTrackingScaling or StepScaling.
	//
	// The default is to use the value for the default instance warmup defined for
	// the group. If default instance warmup is null, then EstimatedInstanceWarmup
	// falls back to the value of default cooldown.
	EstimatedInstanceWarmup *int64 `type:"integer"`

	// The aggregation type for the CloudWatch metrics. The valid values are Minimum,
	// Maximum, and Average. If the aggregation type is null, the value is treated
	// as Average.
	//
	// Valid only if the policy type is StepScaling.
	MetricAggregationType *string `min:"1" type:"string"`

	// The minimum value to scale by when the adjustment type is PercentChangeInCapacity.
	// For example, suppose that you create a step scaling policy to scale out an
	// Auto Scaling group by 25 percent and you specify a MinAdjustmentMagnitude
	// of 2. If the group has 4 instances and the scaling policy is performed, 25
	// percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude
	// of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances.
	//
	// Valid only if the policy type is StepScaling or SimpleScaling. For more information,
	// see Scaling adjustment types (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment)
	// in the Amazon EC2 Auto Scaling User Guide.
	//
	// Some Auto Scaling groups use instance weights. In this case, set the MinAdjustmentMagnitude
	// to a value that is at least as large as your largest instance weight.
	MinAdjustmentMagnitude *int64 `type:"integer"`

	// Available for backward compatibility. Use MinAdjustmentMagnitude instead.
	MinAdjustmentStep *int64 `deprecated:"true" type:"integer"`

	// The name of the policy.
	//
	// PolicyName is a required field
	PolicyName *string `min:"1" type:"string" required:"true"`

	// One of the following policy types:
	//
	//    * TargetTrackingScaling
	//
	//    * StepScaling
	//
	//    * SimpleScaling (default)
	//
	//    * PredictiveScaling
	PolicyType *string `min:"1" type:"string"`

	// A predictive scaling policy. Provides support for predefined and custom metrics.
	//
	// Predefined metrics include CPU utilization, network in/out, and the Application
	// Load Balancer request count.
	//
	// For more information, see PredictiveScalingConfiguration (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_PredictiveScalingConfiguration.html)
	// in the Amazon EC2 Auto Scaling API Reference.
	//
	// Required if the policy type is PredictiveScaling.
	PredictiveScalingConfiguration *PredictiveScalingConfiguration `type:"structure"`

	// The amount by which to scale, based on the specified adjustment type. A positive
	// value adds to the current capacity while a negative number removes from the
	// current capacity. For exact capacity, you must specify a non-negative value.
	//
	// Required if the policy type is SimpleScaling. (Not used with any other policy
	// type.)
	ScalingAdjustment *int64 `type:"integer"`

	// A set of adjustments that enable you to scale based on the size of the alarm
	// breach.
	//
	// Required if the policy type is StepScaling. (Not used with any other policy
	// type.)
	StepAdjustments []*StepAdjustment `type:"list"`

	// A target tracking scaling policy. Provides support for predefined or custom
	// metrics.
	//
	// The following predefined metrics are available:
	//
	//    * ASGAverageCPUUtilization
	//
	//    * ASGAverageNetworkIn
	//
	//    * ASGAverageNetworkOut
	//
	//    * ALBRequestCountPerTarget
	//
	// If you specify ALBRequestCountPerTarget for the metric, you must specify
	// the ResourceLabel property with the PredefinedMetricSpecification.
	//
	// For more information, see TargetTrackingConfiguration (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_TargetTrackingConfiguration.html)
	// in the Amazon EC2 Auto Scaling API Reference.
	//
	// Required if the policy type is TargetTrackingScaling.
	TargetTrackingConfiguration *TargetTrackingConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

func (PutScalingPolicyInput) GoString added in v0.6.5

func (s PutScalingPolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutScalingPolicyInput) SetAdjustmentType added in v1.5.0

func (s *PutScalingPolicyInput) SetAdjustmentType(v string) *PutScalingPolicyInput

SetAdjustmentType sets the AdjustmentType field's value.

func (*PutScalingPolicyInput) SetAutoScalingGroupName added in v1.5.0

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

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*PutScalingPolicyInput) SetCooldown added in v1.5.0

SetCooldown sets the Cooldown field's value.

func (*PutScalingPolicyInput) SetEnabled added in v1.29.5

SetEnabled sets the Enabled field's value.

func (*PutScalingPolicyInput) SetEstimatedInstanceWarmup added in v1.5.0

func (s *PutScalingPolicyInput) SetEstimatedInstanceWarmup(v int64) *PutScalingPolicyInput

SetEstimatedInstanceWarmup sets the EstimatedInstanceWarmup field's value.

func (*PutScalingPolicyInput) SetMetricAggregationType added in v1.5.0

func (s *PutScalingPolicyInput) SetMetricAggregationType(v string) *PutScalingPolicyInput

SetMetricAggregationType sets the MetricAggregationType field's value.

func (*PutScalingPolicyInput) SetMinAdjustmentMagnitude added in v1.5.0

func (s *PutScalingPolicyInput) SetMinAdjustmentMagnitude(v int64) *PutScalingPolicyInput

SetMinAdjustmentMagnitude sets the MinAdjustmentMagnitude field's value.

func (*PutScalingPolicyInput) SetMinAdjustmentStep added in v1.5.0

func (s *PutScalingPolicyInput) SetMinAdjustmentStep(v int64) *PutScalingPolicyInput

SetMinAdjustmentStep sets the MinAdjustmentStep field's value.

func (*PutScalingPolicyInput) SetPolicyName added in v1.5.0

func (s *PutScalingPolicyInput) SetPolicyName(v string) *PutScalingPolicyInput

SetPolicyName sets the PolicyName field's value.

func (*PutScalingPolicyInput) SetPolicyType added in v1.5.0

func (s *PutScalingPolicyInput) SetPolicyType(v string) *PutScalingPolicyInput

SetPolicyType sets the PolicyType field's value.

func (*PutScalingPolicyInput) SetPredictiveScalingConfiguration added in v1.38.43

func (s *PutScalingPolicyInput) SetPredictiveScalingConfiguration(v *PredictiveScalingConfiguration) *PutScalingPolicyInput

SetPredictiveScalingConfiguration sets the PredictiveScalingConfiguration field's value.

func (*PutScalingPolicyInput) SetScalingAdjustment added in v1.5.0

func (s *PutScalingPolicyInput) SetScalingAdjustment(v int64) *PutScalingPolicyInput

SetScalingAdjustment sets the ScalingAdjustment field's value.

func (*PutScalingPolicyInput) SetStepAdjustments added in v1.5.0

func (s *PutScalingPolicyInput) SetStepAdjustments(v []*StepAdjustment) *PutScalingPolicyInput

SetStepAdjustments sets the StepAdjustments field's value.

func (*PutScalingPolicyInput) SetTargetTrackingConfiguration added in v1.10.9

func (s *PutScalingPolicyInput) SetTargetTrackingConfiguration(v *TargetTrackingConfiguration) *PutScalingPolicyInput

SetTargetTrackingConfiguration sets the TargetTrackingConfiguration field's value.

func (PutScalingPolicyInput) String added in v0.6.5

func (s PutScalingPolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutScalingPolicyInput) Validate added in v1.1.21

func (s *PutScalingPolicyInput) Validate() error

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

type PutScalingPolicyOutput

type PutScalingPolicyOutput struct {

	// The CloudWatch alarms created for the target tracking scaling policy.
	Alarms []*Alarm `type:"list"`

	// The Amazon Resource Name (ARN) of the policy.
	PolicyARN *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains the output of PutScalingPolicy.

func (PutScalingPolicyOutput) GoString added in v0.6.5

func (s PutScalingPolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutScalingPolicyOutput) SetAlarms added in v1.10.9

SetAlarms sets the Alarms field's value.

func (*PutScalingPolicyOutput) SetPolicyARN added in v1.5.0

SetPolicyARN sets the PolicyARN field's value.

func (PutScalingPolicyOutput) String added in v0.6.5

func (s PutScalingPolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutScheduledUpdateGroupActionInput

type PutScheduledUpdateGroupActionInput struct {

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// The desired capacity is the initial capacity of the Auto Scaling group after
	// the scheduled action runs and the capacity it attempts to maintain. It can
	// scale beyond this capacity if you add more scaling conditions.
	//
	// You must specify at least one of the following properties: MaxSize, MinSize,
	// or DesiredCapacity.
	DesiredCapacity *int64 `type:"integer"`

	// The date and time for the recurring schedule to end, in UTC. For example,
	// "2021-06-01T00:00:00Z".
	EndTime *time.Time `type:"timestamp"`

	// The maximum size of the Auto Scaling group.
	MaxSize *int64 `type:"integer"`

	// The minimum size of the Auto Scaling group.
	MinSize *int64 `type:"integer"`

	// The recurring schedule for this action. This format consists of five fields
	// separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year]
	// [Day_of_Week]. The value must be in quotes (for example, "30 0 1 1,6,12 *").
	// For more information about this format, see Crontab (http://crontab.org).
	//
	// When StartTime and EndTime are specified with Recurrence, they form the boundaries
	// of when the recurring action starts and stops.
	//
	// Cron expressions use Universal Coordinated Time (UTC) by default.
	Recurrence *string `min:"1" type:"string"`

	// The name of this scaling action.
	//
	// ScheduledActionName is a required field
	ScheduledActionName *string `min:"1" type:"string" required:"true"`

	// The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ format
	// in UTC/GMT only and in quotes (for example, "2021-06-01T00:00:00Z").
	//
	// If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs
	// the action at this time, and then performs the action based on the specified
	// recurrence.
	StartTime *time.Time `type:"timestamp"`

	// This property is no longer used.
	Time *time.Time `type:"timestamp"`

	// Specifies the time zone for a cron expression. If a time zone is not provided,
	// UTC is used by default.
	//
	// Valid values are the canonical names of the IANA time zones, derived from
	// the IANA Time Zone Database (such as Etc/GMT+9 or Pacific/Tahiti). For more
	// information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
	// (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
	TimeZone *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (PutScheduledUpdateGroupActionInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutScheduledUpdateGroupActionInput) SetAutoScalingGroupName added in v1.5.0

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*PutScheduledUpdateGroupActionInput) SetDesiredCapacity added in v1.5.0

SetDesiredCapacity sets the DesiredCapacity field's value.

func (*PutScheduledUpdateGroupActionInput) SetEndTime added in v1.5.0

SetEndTime sets the EndTime field's value.

func (*PutScheduledUpdateGroupActionInput) SetMaxSize added in v1.5.0

SetMaxSize sets the MaxSize field's value.

func (*PutScheduledUpdateGroupActionInput) SetMinSize added in v1.5.0

SetMinSize sets the MinSize field's value.

func (*PutScheduledUpdateGroupActionInput) SetRecurrence added in v1.5.0

SetRecurrence sets the Recurrence field's value.

func (*PutScheduledUpdateGroupActionInput) SetScheduledActionName added in v1.5.0

SetScheduledActionName sets the ScheduledActionName field's value.

func (*PutScheduledUpdateGroupActionInput) SetStartTime added in v1.5.0

SetStartTime sets the StartTime field's value.

func (*PutScheduledUpdateGroupActionInput) SetTime added in v1.5.0

SetTime sets the Time field's value.

func (*PutScheduledUpdateGroupActionInput) SetTimeZone added in v1.37.27

SetTimeZone sets the TimeZone field's value.

func (PutScheduledUpdateGroupActionInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutScheduledUpdateGroupActionInput) Validate added in v1.1.21

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

type PutScheduledUpdateGroupActionOutput

type PutScheduledUpdateGroupActionOutput struct {
	// contains filtered or unexported fields
}

func (PutScheduledUpdateGroupActionOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (PutScheduledUpdateGroupActionOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutWarmPoolInput added in v1.38.16

type PutWarmPoolInput struct {

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// Indicates whether instances in the Auto Scaling group can be returned to
	// the warm pool on scale in. The default is to terminate instances in the Auto
	// Scaling group when the group scales in.
	InstanceReusePolicy *InstanceReusePolicy `type:"structure"`

	// Specifies the maximum number of instances that are allowed to be in the warm
	// pool or in any state except Terminated for the Auto Scaling group. This is
	// an optional property. Specify it only if you do not want the warm pool size
	// to be determined by the difference between the group's maximum capacity and
	// its desired capacity.
	//
	// If a value for MaxGroupPreparedCapacity is not specified, Amazon EC2 Auto
	// Scaling launches and maintains the difference between the group's maximum
	// capacity and its desired capacity. If you specify a value for MaxGroupPreparedCapacity,
	// Amazon EC2 Auto Scaling uses the difference between the MaxGroupPreparedCapacity
	// and the desired capacity instead.
	//
	// The size of the warm pool is dynamic. Only when MaxGroupPreparedCapacity
	// and MinSize are set to the same value does the warm pool have an absolute
	// size.
	//
	// If the desired capacity of the Auto Scaling group is higher than the MaxGroupPreparedCapacity,
	// the capacity of the warm pool is 0, unless you specify a value for MinSize.
	// To remove a value that you previously set, include the property but specify
	// -1 for the value.
	MaxGroupPreparedCapacity *int64 `type:"integer"`

	// Specifies the minimum number of instances to maintain in the warm pool. This
	// helps you to ensure that there is always a certain number of warmed instances
	// available to handle traffic spikes. Defaults to 0 if not specified.
	MinSize *int64 `type:"integer"`

	// Sets the instance state to transition to after the lifecycle actions are
	// complete. Default is Stopped.
	PoolState *string `type:"string" enum:"WarmPoolState"`
	// contains filtered or unexported fields
}

func (PutWarmPoolInput) GoString added in v1.38.16

func (s PutWarmPoolInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutWarmPoolInput) SetAutoScalingGroupName added in v1.38.16

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

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*PutWarmPoolInput) SetInstanceReusePolicy added in v1.43.6

func (s *PutWarmPoolInput) SetInstanceReusePolicy(v *InstanceReusePolicy) *PutWarmPoolInput

SetInstanceReusePolicy sets the InstanceReusePolicy field's value.

func (*PutWarmPoolInput) SetMaxGroupPreparedCapacity added in v1.38.16

func (s *PutWarmPoolInput) SetMaxGroupPreparedCapacity(v int64) *PutWarmPoolInput

SetMaxGroupPreparedCapacity sets the MaxGroupPreparedCapacity field's value.

func (*PutWarmPoolInput) SetMinSize added in v1.38.16

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

SetMinSize sets the MinSize field's value.

func (*PutWarmPoolInput) SetPoolState added in v1.38.16

func (s *PutWarmPoolInput) SetPoolState(v string) *PutWarmPoolInput

SetPoolState sets the PoolState field's value.

func (PutWarmPoolInput) String added in v1.38.16

func (s PutWarmPoolInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutWarmPoolInput) Validate added in v1.38.16

func (s *PutWarmPoolInput) Validate() error

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

type PutWarmPoolOutput added in v1.38.16

type PutWarmPoolOutput struct {
	// contains filtered or unexported fields
}

func (PutWarmPoolOutput) GoString added in v1.38.16

func (s PutWarmPoolOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (PutWarmPoolOutput) String added in v1.38.16

func (s PutWarmPoolOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RecordLifecycleActionHeartbeatInput

type RecordLifecycleActionHeartbeatInput struct {

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// The ID of the instance.
	InstanceId *string `min:"1" type:"string"`

	// A token that uniquely identifies a specific lifecycle action associated with
	// an instance. Amazon EC2 Auto Scaling sends this token to the notification
	// target that you specified when you created the lifecycle hook.
	LifecycleActionToken *string `min:"36" type:"string"`

	// The name of the lifecycle hook.
	//
	// LifecycleHookName is a required field
	LifecycleHookName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RecordLifecycleActionHeartbeatInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RecordLifecycleActionHeartbeatInput) SetAutoScalingGroupName added in v1.5.0

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*RecordLifecycleActionHeartbeatInput) SetInstanceId added in v1.5.0

SetInstanceId sets the InstanceId field's value.

func (*RecordLifecycleActionHeartbeatInput) SetLifecycleActionToken added in v1.5.0

SetLifecycleActionToken sets the LifecycleActionToken field's value.

func (*RecordLifecycleActionHeartbeatInput) SetLifecycleHookName added in v1.5.0

SetLifecycleHookName sets the LifecycleHookName field's value.

func (RecordLifecycleActionHeartbeatInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RecordLifecycleActionHeartbeatInput) Validate added in v1.1.21

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

type RecordLifecycleActionHeartbeatOutput

type RecordLifecycleActionHeartbeatOutput struct {
	// contains filtered or unexported fields
}

func (RecordLifecycleActionHeartbeatOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (RecordLifecycleActionHeartbeatOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RefreshPreferences added in v1.32.3

type RefreshPreferences struct {

	// (Optional) Indicates whether to roll back the Auto Scaling group to its previous
	// configuration if the instance refresh fails. The default is false.
	//
	// A rollback is not supported in the following situations:
	//
	//    * There is no desired configuration specified for the instance refresh.
	//
	//    * The Auto Scaling group has a launch template that uses an Amazon Web
	//    Services Systems Manager parameter instead of an AMI ID for the ImageId
	//    property.
	//
	//    * The Auto Scaling group uses the launch template's $Latest or $Default
	//    version.
	AutoRollback *bool `type:"boolean"`

	// (Optional) The amount of time, in seconds, to wait after a checkpoint before
	// continuing. This property is optional, but if you specify a value for it,
	// you must also specify a value for CheckpointPercentages. If you specify a
	// value for CheckpointPercentages and not for CheckpointDelay, the CheckpointDelay
	// defaults to 3600 (1 hour).
	CheckpointDelay *int64 `type:"integer"`

	// (Optional) Threshold values for each checkpoint in ascending order. Each
	// number must be unique. To replace all instances in the Auto Scaling group,
	// the last number in the array must be 100.
	//
	// For usage examples, see Adding checkpoints to an instance refresh (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-adding-checkpoints-instance-refresh.html)
	// in the Amazon EC2 Auto Scaling User Guide.
	CheckpointPercentages []*int64 `type:"list"`

	// A time period, in seconds, during which an instance refresh waits before
	// moving on to replacing the next instance after a new instance enters the
	// InService state.
	//
	// This property is not required for normal usage. Instead, use the DefaultInstanceWarmup
	// property of the Auto Scaling group. The InstanceWarmup and DefaultInstanceWarmup
	// properties work the same way. Only specify this property if you must override
	// the DefaultInstanceWarmup property.
	//
	// If you do not specify this property, the instance warmup by default is the
	// value of the DefaultInstanceWarmup property, if defined (which is recommended
	// in all cases), or the HealthCheckGracePeriod property otherwise.
	InstanceWarmup *int64 `type:"integer"`

	// The amount of capacity in the Auto Scaling group that must pass your group's
	// health checks to allow the operation to continue. The value is expressed
	// as a percentage of the desired capacity of the Auto Scaling group (rounded
	// up to the nearest integer). The default is 90.
	//
	// Setting the minimum healthy percentage to 100 percent limits the rate of
	// replacement to one instance at a time. In contrast, setting it to 0 percent
	// has the effect of replacing all instances at the same time.
	MinHealthyPercentage *int64 `type:"integer"`

	// Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances
	// protected from scale in are found.
	//
	// The following lists the valid values:
	//
	// Refresh
	//
	// Amazon EC2 Auto Scaling replaces instances that are protected from scale
	// in.
	//
	// Ignore
	//
	// Amazon EC2 Auto Scaling ignores instances that are protected from scale in
	// and continues to replace instances that are not protected.
	//
	// Wait (default)
	//
	// Amazon EC2 Auto Scaling waits one hour for you to remove scale-in protection.
	// Otherwise, the instance refresh will fail.
	ScaleInProtectedInstances *string `type:"string" enum:"ScaleInProtectedInstances"`

	// (Optional) Indicates whether skip matching is enabled. If enabled (true),
	// then Amazon EC2 Auto Scaling skips replacing instances that match the desired
	// configuration. If no desired configuration is specified, then it skips replacing
	// instances that have the same launch template and instance types that the
	// Auto Scaling group was using before the start of the instance refresh. The
	// default is false.
	//
	// For more information, see Use an instance refresh with skip matching (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh-skip-matching.html)
	// in the Amazon EC2 Auto Scaling User Guide.
	SkipMatching *bool `type:"boolean"`

	// Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances
	// in Standby state are found.
	//
	// The following lists the valid values:
	//
	// Terminate
	//
	// Amazon EC2 Auto Scaling terminates instances that are in Standby.
	//
	// Ignore
	//
	// Amazon EC2 Auto Scaling ignores instances that are in Standby and continues
	// to replace instances that are in the InService state.
	//
	// Wait (default)
	//
	// Amazon EC2 Auto Scaling waits one hour for you to return the instances to
	// service. Otherwise, the instance refresh will fail.
	StandbyInstances *string `type:"string" enum:"StandbyInstances"`
	// contains filtered or unexported fields
}

Describes the preferences for an instance refresh.

func (RefreshPreferences) GoString added in v1.32.3

func (s RefreshPreferences) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RefreshPreferences) SetAutoRollback added in v1.44.199

func (s *RefreshPreferences) SetAutoRollback(v bool) *RefreshPreferences

SetAutoRollback sets the AutoRollback field's value.

func (*RefreshPreferences) SetCheckpointDelay added in v1.38.0

func (s *RefreshPreferences) SetCheckpointDelay(v int64) *RefreshPreferences

SetCheckpointDelay sets the CheckpointDelay field's value.

func (*RefreshPreferences) SetCheckpointPercentages added in v1.38.0

func (s *RefreshPreferences) SetCheckpointPercentages(v []*int64) *RefreshPreferences

SetCheckpointPercentages sets the CheckpointPercentages field's value.

func (*RefreshPreferences) SetInstanceWarmup added in v1.32.3

func (s *RefreshPreferences) SetInstanceWarmup(v int64) *RefreshPreferences

SetInstanceWarmup sets the InstanceWarmup field's value.

func (*RefreshPreferences) SetMinHealthyPercentage added in v1.32.3

func (s *RefreshPreferences) SetMinHealthyPercentage(v int64) *RefreshPreferences

SetMinHealthyPercentage sets the MinHealthyPercentage field's value.

func (*RefreshPreferences) SetScaleInProtectedInstances added in v1.44.199

func (s *RefreshPreferences) SetScaleInProtectedInstances(v string) *RefreshPreferences

SetScaleInProtectedInstances sets the ScaleInProtectedInstances field's value.

func (*RefreshPreferences) SetSkipMatching added in v1.40.16

func (s *RefreshPreferences) SetSkipMatching(v bool) *RefreshPreferences

SetSkipMatching sets the SkipMatching field's value.

func (*RefreshPreferences) SetStandbyInstances added in v1.44.199

func (s *RefreshPreferences) SetStandbyInstances(v string) *RefreshPreferences

SetStandbyInstances sets the StandbyInstances field's value.

func (RefreshPreferences) String added in v1.32.3

func (s RefreshPreferences) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResumeProcessesOutput

type ResumeProcessesOutput struct {
	// contains filtered or unexported fields
}

func (ResumeProcessesOutput) GoString added in v0.6.5

func (s ResumeProcessesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (ResumeProcessesOutput) String added in v0.6.5

func (s ResumeProcessesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RollbackDetails added in v1.44.199

type RollbackDetails struct {

	// Indicates the value of InstancesToUpdate at the time the rollback started.
	InstancesToUpdateOnRollback *int64 `type:"integer"`

	// Indicates the value of PercentageComplete at the time the rollback started.
	PercentageCompleteOnRollback *int64 `type:"integer"`

	// Reports progress on replacing instances in an Auto Scaling group that has
	// a warm pool. This includes separate details for instances in the warm pool
	// and instances in the Auto Scaling group (the live pool).
	ProgressDetailsOnRollback *InstanceRefreshProgressDetails `type:"structure"`

	// The reason for this instance refresh rollback (for example, whether a manual
	// or automatic rollback was initiated).
	RollbackReason *string `min:"1" type:"string"`

	// The date and time at which the rollback began.
	RollbackStartTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Details about an instance refresh rollback.

func (RollbackDetails) GoString added in v1.44.199

func (s RollbackDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RollbackDetails) SetInstancesToUpdateOnRollback added in v1.44.199

func (s *RollbackDetails) SetInstancesToUpdateOnRollback(v int64) *RollbackDetails

SetInstancesToUpdateOnRollback sets the InstancesToUpdateOnRollback field's value.

func (*RollbackDetails) SetPercentageCompleteOnRollback added in v1.44.199

func (s *RollbackDetails) SetPercentageCompleteOnRollback(v int64) *RollbackDetails

SetPercentageCompleteOnRollback sets the PercentageCompleteOnRollback field's value.

func (*RollbackDetails) SetProgressDetailsOnRollback added in v1.44.199

func (s *RollbackDetails) SetProgressDetailsOnRollback(v *InstanceRefreshProgressDetails) *RollbackDetails

SetProgressDetailsOnRollback sets the ProgressDetailsOnRollback field's value.

func (*RollbackDetails) SetRollbackReason added in v1.44.199

func (s *RollbackDetails) SetRollbackReason(v string) *RollbackDetails

SetRollbackReason sets the RollbackReason field's value.

func (*RollbackDetails) SetRollbackStartTime added in v1.44.199

func (s *RollbackDetails) SetRollbackStartTime(v time.Time) *RollbackDetails

SetRollbackStartTime sets the RollbackStartTime field's value.

func (RollbackDetails) String added in v1.44.199

func (s RollbackDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RollbackInstanceRefreshInput added in v1.44.199

type RollbackInstanceRefreshInput struct {

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RollbackInstanceRefreshInput) GoString added in v1.44.199

func (s RollbackInstanceRefreshInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RollbackInstanceRefreshInput) SetAutoScalingGroupName added in v1.44.199

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

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (RollbackInstanceRefreshInput) String added in v1.44.199

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RollbackInstanceRefreshInput) Validate added in v1.44.199

func (s *RollbackInstanceRefreshInput) Validate() error

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

type RollbackInstanceRefreshOutput added in v1.44.199

type RollbackInstanceRefreshOutput struct {

	// The instance refresh ID associated with the request. This is the unique ID
	// assigned to the instance refresh when it was started.
	InstanceRefreshId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (RollbackInstanceRefreshOutput) GoString added in v1.44.199

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RollbackInstanceRefreshOutput) SetInstanceRefreshId added in v1.44.199

SetInstanceRefreshId sets the InstanceRefreshId field's value.

func (RollbackInstanceRefreshOutput) String added in v1.44.199

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ScalingPolicy

type ScalingPolicy struct {

	// Specifies how the scaling adjustment is interpreted (for example, an absolute
	// number or a percentage). The valid values are ChangeInCapacity, ExactCapacity,
	// and PercentChangeInCapacity.
	AdjustmentType *string `min:"1" type:"string"`

	// The CloudWatch alarms related to the policy.
	Alarms []*Alarm `type:"list"`

	// The name of the Auto Scaling group.
	AutoScalingGroupName *string `min:"1" type:"string"`

	// The duration of the policy's cooldown period, in seconds.
	Cooldown *int64 `type:"integer"`

	// Indicates whether the policy is enabled (true) or disabled (false).
	Enabled *bool `type:"boolean"`

	// The estimated time, in seconds, until a newly launched instance can contribute
	// to the CloudWatch metrics.
	EstimatedInstanceWarmup *int64 `type:"integer"`

	// The aggregation type for the CloudWatch metrics. The valid values are Minimum,
	// Maximum, and Average.
	MetricAggregationType *string `min:"1" type:"string"`

	// The minimum value to scale by when the adjustment type is PercentChangeInCapacity.
	MinAdjustmentMagnitude *int64 `type:"integer"`

	// Available for backward compatibility. Use MinAdjustmentMagnitude instead.
	MinAdjustmentStep *int64 `deprecated:"true" type:"integer"`

	// The Amazon Resource Name (ARN) of the policy.
	PolicyARN *string `min:"1" type:"string"`

	// The name of the scaling policy.
	PolicyName *string `min:"1" type:"string"`

	// One of the following policy types:
	//
	//    * TargetTrackingScaling
	//
	//    * StepScaling
	//
	//    * SimpleScaling (default)
	//
	//    * PredictiveScaling
	//
	// For more information, see Target tracking scaling policies (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-target-tracking.html)
	// and Step and simple scaling policies (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html)
	// in the Amazon EC2 Auto Scaling User Guide.
	PolicyType *string `min:"1" type:"string"`

	// A predictive scaling policy.
	PredictiveScalingConfiguration *PredictiveScalingConfiguration `type:"structure"`

	// The amount by which to scale, based on the specified adjustment type. A positive
	// value adds to the current capacity while a negative number removes from the
	// current capacity.
	ScalingAdjustment *int64 `type:"integer"`

	// A set of adjustments that enable you to scale based on the size of the alarm
	// breach.
	StepAdjustments []*StepAdjustment `type:"list"`

	// A target tracking scaling policy.
	TargetTrackingConfiguration *TargetTrackingConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

Describes a scaling policy.

func (ScalingPolicy) GoString added in v0.6.5

func (s ScalingPolicy) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ScalingPolicy) SetAdjustmentType added in v1.5.0

func (s *ScalingPolicy) SetAdjustmentType(v string) *ScalingPolicy

SetAdjustmentType sets the AdjustmentType field's value.

func (*ScalingPolicy) SetAlarms added in v1.5.0

func (s *ScalingPolicy) SetAlarms(v []*Alarm) *ScalingPolicy

SetAlarms sets the Alarms field's value.

func (*ScalingPolicy) SetAutoScalingGroupName added in v1.5.0

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

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*ScalingPolicy) SetCooldown added in v1.5.0

func (s *ScalingPolicy) SetCooldown(v int64) *ScalingPolicy

SetCooldown sets the Cooldown field's value.

func (*ScalingPolicy) SetEnabled added in v1.29.5

func (s *ScalingPolicy) SetEnabled(v bool) *ScalingPolicy

SetEnabled sets the Enabled field's value.

func (*ScalingPolicy) SetEstimatedInstanceWarmup added in v1.5.0

func (s *ScalingPolicy) SetEstimatedInstanceWarmup(v int64) *ScalingPolicy

SetEstimatedInstanceWarmup sets the EstimatedInstanceWarmup field's value.

func (*ScalingPolicy) SetMetricAggregationType added in v1.5.0

func (s *ScalingPolicy) SetMetricAggregationType(v string) *ScalingPolicy

SetMetricAggregationType sets the MetricAggregationType field's value.

func (*ScalingPolicy) SetMinAdjustmentMagnitude added in v1.5.0

func (s *ScalingPolicy) SetMinAdjustmentMagnitude(v int64) *ScalingPolicy

SetMinAdjustmentMagnitude sets the MinAdjustmentMagnitude field's value.

func (*ScalingPolicy) SetMinAdjustmentStep added in v1.5.0

func (s *ScalingPolicy) SetMinAdjustmentStep(v int64) *ScalingPolicy

SetMinAdjustmentStep sets the MinAdjustmentStep field's value.

func (*ScalingPolicy) SetPolicyARN added in v1.5.0

func (s *ScalingPolicy) SetPolicyARN(v string) *ScalingPolicy

SetPolicyARN sets the PolicyARN field's value.

func (*ScalingPolicy) SetPolicyName added in v1.5.0

func (s *ScalingPolicy) SetPolicyName(v string) *ScalingPolicy

SetPolicyName sets the PolicyName field's value.

func (*ScalingPolicy) SetPolicyType added in v1.5.0

func (s *ScalingPolicy) SetPolicyType(v string) *ScalingPolicy

SetPolicyType sets the PolicyType field's value.

func (*ScalingPolicy) SetPredictiveScalingConfiguration added in v1.38.43

func (s *ScalingPolicy) SetPredictiveScalingConfiguration(v *PredictiveScalingConfiguration) *ScalingPolicy

SetPredictiveScalingConfiguration sets the PredictiveScalingConfiguration field's value.

func (*ScalingPolicy) SetScalingAdjustment added in v1.5.0

func (s *ScalingPolicy) SetScalingAdjustment(v int64) *ScalingPolicy

SetScalingAdjustment sets the ScalingAdjustment field's value.

func (*ScalingPolicy) SetStepAdjustments added in v1.5.0

func (s *ScalingPolicy) SetStepAdjustments(v []*StepAdjustment) *ScalingPolicy

SetStepAdjustments sets the StepAdjustments field's value.

func (*ScalingPolicy) SetTargetTrackingConfiguration added in v1.10.9

func (s *ScalingPolicy) SetTargetTrackingConfiguration(v *TargetTrackingConfiguration) *ScalingPolicy

SetTargetTrackingConfiguration sets the TargetTrackingConfiguration field's value.

func (ScalingPolicy) String added in v0.6.5

func (s ScalingPolicy) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ScalingProcessQuery

type ScalingProcessQuery struct {

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// One or more of the following processes:
	//
	//    * Launch
	//
	//    * Terminate
	//
	//    * AddToLoadBalancer
	//
	//    * AlarmNotification
	//
	//    * AZRebalance
	//
	//    * HealthCheck
	//
	//    * InstanceRefresh
	//
	//    * ReplaceUnhealthy
	//
	//    * ScheduledActions
	//
	// If you omit this property, all processes are specified.
	ScalingProcesses []*string `type:"list"`
	// contains filtered or unexported fields
}

func (ScalingProcessQuery) GoString added in v0.6.5

func (s ScalingProcessQuery) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ScalingProcessQuery) SetAutoScalingGroupName added in v1.5.0

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

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*ScalingProcessQuery) SetScalingProcesses added in v1.5.0

func (s *ScalingProcessQuery) SetScalingProcesses(v []*string) *ScalingProcessQuery

SetScalingProcesses sets the ScalingProcesses field's value.

func (ScalingProcessQuery) String added in v0.6.5

func (s ScalingProcessQuery) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ScalingProcessQuery) Validate added in v1.1.21

func (s *ScalingProcessQuery) Validate() error

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

type ScheduledUpdateGroupAction

type ScheduledUpdateGroupAction struct {

	// The name of the Auto Scaling group.
	AutoScalingGroupName *string `min:"1" type:"string"`

	// The desired capacity is the initial capacity of the Auto Scaling group after
	// the scheduled action runs and the capacity it attempts to maintain.
	DesiredCapacity *int64 `type:"integer"`

	// The date and time in UTC for the recurring schedule to end. For example,
	// "2019-06-01T00:00:00Z".
	EndTime *time.Time `type:"timestamp"`

	// The maximum size of the Auto Scaling group.
	MaxSize *int64 `type:"integer"`

	// The minimum size of the Auto Scaling group.
	MinSize *int64 `type:"integer"`

	// The recurring schedule for the action, in Unix cron syntax format.
	//
	// When StartTime and EndTime are specified with Recurrence, they form the boundaries
	// of when the recurring action starts and stops.
	Recurrence *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the scheduled action.
	ScheduledActionARN *string `min:"1" type:"string"`

	// The name of the scheduled action.
	ScheduledActionName *string `min:"1" type:"string"`

	// The date and time in UTC for this action to start. For example, "2019-06-01T00:00:00Z".
	StartTime *time.Time `type:"timestamp"`

	// This property is no longer used.
	Time *time.Time `type:"timestamp"`

	// The time zone for the cron expression.
	TimeZone *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes a scheduled scaling action.

func (ScheduledUpdateGroupAction) GoString added in v0.6.5

func (s ScheduledUpdateGroupAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ScheduledUpdateGroupAction) SetAutoScalingGroupName added in v1.5.0

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

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*ScheduledUpdateGroupAction) SetDesiredCapacity added in v1.5.0

SetDesiredCapacity sets the DesiredCapacity field's value.

func (*ScheduledUpdateGroupAction) SetEndTime added in v1.5.0

SetEndTime sets the EndTime field's value.

func (*ScheduledUpdateGroupAction) SetMaxSize added in v1.5.0

SetMaxSize sets the MaxSize field's value.

func (*ScheduledUpdateGroupAction) SetMinSize added in v1.5.0

SetMinSize sets the MinSize field's value.

func (*ScheduledUpdateGroupAction) SetRecurrence added in v1.5.0

SetRecurrence sets the Recurrence field's value.

func (*ScheduledUpdateGroupAction) SetScheduledActionARN added in v1.5.0

func (s *ScheduledUpdateGroupAction) SetScheduledActionARN(v string) *ScheduledUpdateGroupAction

SetScheduledActionARN sets the ScheduledActionARN field's value.

func (*ScheduledUpdateGroupAction) SetScheduledActionName added in v1.5.0

func (s *ScheduledUpdateGroupAction) SetScheduledActionName(v string) *ScheduledUpdateGroupAction

SetScheduledActionName sets the ScheduledActionName field's value.

func (*ScheduledUpdateGroupAction) SetStartTime added in v1.5.0

SetStartTime sets the StartTime field's value.

func (*ScheduledUpdateGroupAction) SetTime added in v1.5.0

SetTime sets the Time field's value.

func (*ScheduledUpdateGroupAction) SetTimeZone added in v1.37.27

SetTimeZone sets the TimeZone field's value.

func (ScheduledUpdateGroupAction) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ScheduledUpdateGroupActionRequest added in v1.15.12

type ScheduledUpdateGroupActionRequest struct {

	// The desired capacity is the initial capacity of the Auto Scaling group after
	// the scheduled action runs and the capacity it attempts to maintain.
	DesiredCapacity *int64 `type:"integer"`

	// The date and time for the recurring schedule to end, in UTC.
	EndTime *time.Time `type:"timestamp"`

	// The maximum size of the Auto Scaling group.
	MaxSize *int64 `type:"integer"`

	// The minimum size of the Auto Scaling group.
	MinSize *int64 `type:"integer"`

	// The recurring schedule for the action, in Unix cron syntax format. This format
	// consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month]
	// [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example,
	// "30 0 1 1,6,12 *"). For more information about this format, see Crontab (http://crontab.org).
	//
	// When StartTime and EndTime are specified with Recurrence, they form the boundaries
	// of when the recurring action starts and stops.
	//
	// Cron expressions use Universal Coordinated Time (UTC) by default.
	Recurrence *string `min:"1" type:"string"`

	// The name of the scaling action.
	//
	// ScheduledActionName is a required field
	ScheduledActionName *string `min:"1" type:"string" required:"true"`

	// The date and time for the action to start, in YYYY-MM-DDThh:mm:ssZ format
	// in UTC/GMT only and in quotes (for example, "2019-06-01T00:00:00Z").
	//
	// If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs
	// the action at this time, and then performs the action based on the specified
	// recurrence.
	//
	// If you try to schedule the action in the past, Amazon EC2 Auto Scaling returns
	// an error message.
	StartTime *time.Time `type:"timestamp"`

	// Specifies the time zone for a cron expression. If a time zone is not provided,
	// UTC is used by default.
	//
	// Valid values are the canonical names of the IANA time zones, derived from
	// the IANA Time Zone Database (such as Etc/GMT+9 or Pacific/Tahiti). For more
	// information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
	// (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
	TimeZone *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes information used for one or more scheduled scaling action updates in a BatchPutScheduledUpdateGroupAction operation.

func (ScheduledUpdateGroupActionRequest) GoString added in v1.15.12

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ScheduledUpdateGroupActionRequest) SetDesiredCapacity added in v1.15.12

SetDesiredCapacity sets the DesiredCapacity field's value.

func (*ScheduledUpdateGroupActionRequest) SetEndTime added in v1.15.12

SetEndTime sets the EndTime field's value.

func (*ScheduledUpdateGroupActionRequest) SetMaxSize added in v1.15.12

SetMaxSize sets the MaxSize field's value.

func (*ScheduledUpdateGroupActionRequest) SetMinSize added in v1.15.12

SetMinSize sets the MinSize field's value.

func (*ScheduledUpdateGroupActionRequest) SetRecurrence added in v1.15.12

SetRecurrence sets the Recurrence field's value.

func (*ScheduledUpdateGroupActionRequest) SetScheduledActionName added in v1.15.12

SetScheduledActionName sets the ScheduledActionName field's value.

func (*ScheduledUpdateGroupActionRequest) SetStartTime added in v1.15.12

SetStartTime sets the StartTime field's value.

func (*ScheduledUpdateGroupActionRequest) SetTimeZone added in v1.37.27

SetTimeZone sets the TimeZone field's value.

func (ScheduledUpdateGroupActionRequest) String added in v1.15.12

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ScheduledUpdateGroupActionRequest) Validate added in v1.15.12

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

type SetDesiredCapacityInput

type SetDesiredCapacityInput struct {

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// The desired capacity is the initial capacity of the Auto Scaling group after
	// this operation completes and the capacity it attempts to maintain.
	//
	// DesiredCapacity is a required field
	DesiredCapacity *int64 `type:"integer" required:"true"`

	// Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to
	// complete before initiating a scaling activity to set your Auto Scaling group
	// to its new capacity. By default, Amazon EC2 Auto Scaling does not honor the
	// cooldown period during manual scaling activities.
	HonorCooldown *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (SetDesiredCapacityInput) GoString added in v0.6.5

func (s SetDesiredCapacityInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SetDesiredCapacityInput) SetAutoScalingGroupName added in v1.5.0

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

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*SetDesiredCapacityInput) SetDesiredCapacity added in v1.5.0

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

SetDesiredCapacity sets the DesiredCapacity field's value.

func (*SetDesiredCapacityInput) SetHonorCooldown added in v1.5.0

func (s *SetDesiredCapacityInput) SetHonorCooldown(v bool) *SetDesiredCapacityInput

SetHonorCooldown sets the HonorCooldown field's value.

func (SetDesiredCapacityInput) String added in v0.6.5

func (s SetDesiredCapacityInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SetDesiredCapacityInput) Validate added in v1.1.21

func (s *SetDesiredCapacityInput) Validate() error

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

type SetDesiredCapacityOutput

type SetDesiredCapacityOutput struct {
	// contains filtered or unexported fields
}

func (SetDesiredCapacityOutput) GoString added in v0.6.5

func (s SetDesiredCapacityOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (SetDesiredCapacityOutput) String added in v0.6.5

func (s SetDesiredCapacityOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SetInstanceHealthInput

type SetInstanceHealthInput struct {

	// The health status of the instance. Set to Healthy to have the instance remain
	// in service. Set to Unhealthy to have the instance be out of service. Amazon
	// EC2 Auto Scaling terminates and replaces the unhealthy instance.
	//
	// HealthStatus is a required field
	HealthStatus *string `min:"1" type:"string" required:"true"`

	// The ID of the instance.
	//
	// InstanceId is a required field
	InstanceId *string `min:"1" type:"string" required:"true"`

	// If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod
	// specified for the group, by default, this call respects the grace period.
	// Set this to False, to have the call not respect the grace period associated
	// with the group.
	//
	// For more information about the health check grace period, see CreateAutoScalingGroup
	// (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_CreateAutoScalingGroup.html)
	// in the Amazon EC2 Auto Scaling API Reference.
	ShouldRespectGracePeriod *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (SetInstanceHealthInput) GoString added in v0.6.5

func (s SetInstanceHealthInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SetInstanceHealthInput) SetHealthStatus added in v1.5.0

func (s *SetInstanceHealthInput) SetHealthStatus(v string) *SetInstanceHealthInput

SetHealthStatus sets the HealthStatus field's value.

func (*SetInstanceHealthInput) SetInstanceId added in v1.5.0

SetInstanceId sets the InstanceId field's value.

func (*SetInstanceHealthInput) SetShouldRespectGracePeriod added in v1.5.0

func (s *SetInstanceHealthInput) SetShouldRespectGracePeriod(v bool) *SetInstanceHealthInput

SetShouldRespectGracePeriod sets the ShouldRespectGracePeriod field's value.

func (SetInstanceHealthInput) String added in v0.6.5

func (s SetInstanceHealthInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SetInstanceHealthInput) Validate added in v1.1.21

func (s *SetInstanceHealthInput) Validate() error

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

type SetInstanceHealthOutput

type SetInstanceHealthOutput struct {
	// contains filtered or unexported fields
}

func (SetInstanceHealthOutput) GoString added in v0.6.5

func (s SetInstanceHealthOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (SetInstanceHealthOutput) String added in v0.6.5

func (s SetInstanceHealthOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SetInstanceProtectionInput added in v1.0.4

type SetInstanceProtectionInput struct {

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// One or more instance IDs. You can specify up to 50 instances.
	//
	// InstanceIds is a required field
	InstanceIds []*string `type:"list" required:"true"`

	// Indicates whether the instance is protected from termination by Amazon EC2
	// Auto Scaling when scaling in.
	//
	// ProtectedFromScaleIn is a required field
	ProtectedFromScaleIn *bool `type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

func (SetInstanceProtectionInput) GoString added in v1.0.4

func (s SetInstanceProtectionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SetInstanceProtectionInput) SetAutoScalingGroupName added in v1.5.0

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

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*SetInstanceProtectionInput) SetInstanceIds added in v1.5.0

SetInstanceIds sets the InstanceIds field's value.

func (*SetInstanceProtectionInput) SetProtectedFromScaleIn added in v1.5.0

func (s *SetInstanceProtectionInput) SetProtectedFromScaleIn(v bool) *SetInstanceProtectionInput

SetProtectedFromScaleIn sets the ProtectedFromScaleIn field's value.

func (SetInstanceProtectionInput) String added in v1.0.4

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SetInstanceProtectionInput) Validate added in v1.1.21

func (s *SetInstanceProtectionInput) Validate() error

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

type SetInstanceProtectionOutput added in v1.0.4

type SetInstanceProtectionOutput struct {
	// contains filtered or unexported fields
}

func (SetInstanceProtectionOutput) GoString added in v1.0.4

func (s SetInstanceProtectionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (SetInstanceProtectionOutput) String added in v1.0.4

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartInstanceRefreshInput added in v1.32.3

type StartInstanceRefreshInput struct {

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// The desired configuration. For example, the desired configuration can specify
	// a new launch template or a new version of the current launch template.
	//
	// Once the instance refresh succeeds, Amazon EC2 Auto Scaling updates the settings
	// of the Auto Scaling group to reflect the new desired configuration.
	//
	// When you specify a new launch template or a new version of the current launch
	// template for your desired configuration, consider enabling the SkipMatching
	// property in preferences. If it's enabled, Amazon EC2 Auto Scaling skips replacing
	// instances that already use the specified launch template and instance types.
	// This can help you reduce the number of replacements that are required to
	// apply updates.
	DesiredConfiguration *DesiredConfiguration `type:"structure"`

	// Sets your preferences for the instance refresh so that it performs as expected
	// when you start it. Includes the instance warmup time, the minimum healthy
	// percentage, and the behaviors that you want Amazon EC2 Auto Scaling to use
	// if instances that are in Standby state or protected from scale in are found.
	// You can also choose to enable additional features, such as the following:
	//
	//    * Auto rollback
	//
	//    * Checkpoints
	//
	//    * Skip matching
	Preferences *RefreshPreferences `type:"structure"`

	// The strategy to use for the instance refresh. The only valid value is Rolling.
	Strategy *string `type:"string" enum:"RefreshStrategy"`
	// contains filtered or unexported fields
}

func (StartInstanceRefreshInput) GoString added in v1.32.3

func (s StartInstanceRefreshInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartInstanceRefreshInput) SetAutoScalingGroupName added in v1.32.3

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

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*StartInstanceRefreshInput) SetDesiredConfiguration added in v1.40.16

SetDesiredConfiguration sets the DesiredConfiguration field's value.

func (*StartInstanceRefreshInput) SetPreferences added in v1.32.3

SetPreferences sets the Preferences field's value.

func (*StartInstanceRefreshInput) SetStrategy added in v1.32.3

SetStrategy sets the Strategy field's value.

func (StartInstanceRefreshInput) String added in v1.32.3

func (s StartInstanceRefreshInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartInstanceRefreshInput) Validate added in v1.32.3

func (s *StartInstanceRefreshInput) Validate() error

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

type StartInstanceRefreshOutput added in v1.32.3

type StartInstanceRefreshOutput struct {

	// A unique ID for tracking the progress of the instance refresh.
	InstanceRefreshId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartInstanceRefreshOutput) GoString added in v1.32.3

func (s StartInstanceRefreshOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartInstanceRefreshOutput) SetInstanceRefreshId added in v1.32.3

func (s *StartInstanceRefreshOutput) SetInstanceRefreshId(v string) *StartInstanceRefreshOutput

SetInstanceRefreshId sets the InstanceRefreshId field's value.

func (StartInstanceRefreshOutput) String added in v1.32.3

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StepAdjustment added in v0.6.5

type StepAdjustment struct {

	// The lower bound for the difference between the alarm threshold and the CloudWatch
	// metric. If the metric value is above the breach threshold, the lower bound
	// is inclusive (the metric must be greater than or equal to the threshold plus
	// the lower bound). Otherwise, it is exclusive (the metric must be greater
	// than the threshold plus the lower bound). A null value indicates negative
	// infinity.
	MetricIntervalLowerBound *float64 `type:"double"`

	// The upper bound for the difference between the alarm threshold and the CloudWatch
	// metric. If the metric value is above the breach threshold, the upper bound
	// is exclusive (the metric must be less than the threshold plus the upper bound).
	// Otherwise, it is inclusive (the metric must be less than or equal to the
	// threshold plus the upper bound). A null value indicates positive infinity.
	//
	// The upper bound must be greater than the lower bound.
	MetricIntervalUpperBound *float64 `type:"double"`

	// The amount by which to scale, based on the specified adjustment type. A positive
	// value adds to the current capacity while a negative number removes from the
	// current capacity. For exact capacity, you must specify a non-negative value.
	//
	// ScalingAdjustment is a required field
	ScalingAdjustment *int64 `type:"integer" required:"true"`
	// contains filtered or unexported fields
}

Describes information used to create a step adjustment for a step scaling policy.

For the following examples, suppose that you have an alarm with a breach threshold of 50:

  • To trigger the adjustment when the metric is greater than or equal to 50 and less than 60, specify a lower bound of 0 and an upper bound of 10.

  • To trigger the adjustment when the metric is greater than 40 and less than or equal to 50, specify a lower bound of -10 and an upper bound of 0.

There are a few rules for the step adjustments for your step policy:

  • The ranges of your step adjustments can't overlap or have a gap.

  • At most, one step adjustment can have a null lower bound. If one step adjustment has a negative lower bound, then there must be a step adjustment with a null lower bound.

  • At most, one step adjustment can have a null upper bound. If one step adjustment has a positive upper bound, then there must be a step adjustment with a null upper bound.

  • The upper and lower bound can't be null in the same step adjustment.

For more information, see Step adjustments (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-steps) in the Amazon EC2 Auto Scaling User Guide.

func (StepAdjustment) GoString added in v0.6.5

func (s StepAdjustment) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StepAdjustment) SetMetricIntervalLowerBound added in v1.5.0

func (s *StepAdjustment) SetMetricIntervalLowerBound(v float64) *StepAdjustment

SetMetricIntervalLowerBound sets the MetricIntervalLowerBound field's value.

func (*StepAdjustment) SetMetricIntervalUpperBound added in v1.5.0

func (s *StepAdjustment) SetMetricIntervalUpperBound(v float64) *StepAdjustment

SetMetricIntervalUpperBound sets the MetricIntervalUpperBound field's value.

func (*StepAdjustment) SetScalingAdjustment added in v1.5.0

func (s *StepAdjustment) SetScalingAdjustment(v int64) *StepAdjustment

SetScalingAdjustment sets the ScalingAdjustment field's value.

func (StepAdjustment) String added in v0.6.5

func (s StepAdjustment) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StepAdjustment) Validate added in v1.1.21

func (s *StepAdjustment) Validate() error

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

type SuspendProcessesOutput

type SuspendProcessesOutput struct {
	// contains filtered or unexported fields
}

func (SuspendProcessesOutput) GoString added in v0.6.5

func (s SuspendProcessesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (SuspendProcessesOutput) String added in v0.6.5

func (s SuspendProcessesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SuspendedProcess

type SuspendedProcess struct {

	// The name of the suspended process.
	ProcessName *string `min:"1" type:"string"`

	// The reason that the process was suspended.
	SuspensionReason *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes an auto scaling process that has been suspended.

For more information, see Scaling processes (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html#process-types) in the Amazon EC2 Auto Scaling User Guide.

func (SuspendedProcess) GoString added in v0.6.5

func (s SuspendedProcess) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SuspendedProcess) SetProcessName added in v1.5.0

func (s *SuspendedProcess) SetProcessName(v string) *SuspendedProcess

SetProcessName sets the ProcessName field's value.

func (*SuspendedProcess) SetSuspensionReason added in v1.5.0

func (s *SuspendedProcess) SetSuspensionReason(v string) *SuspendedProcess

SetSuspensionReason sets the SuspensionReason field's value.

func (SuspendedProcess) String added in v0.6.5

func (s SuspendedProcess) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Tag

type Tag struct {

	// The tag key.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// Determines whether the tag is added to new instances as they are launched
	// in the group.
	PropagateAtLaunch *bool `type:"boolean"`

	// The name of the Auto Scaling group.
	ResourceId *string `type:"string"`

	// The type of resource. The only supported value is auto-scaling-group.
	ResourceType *string `type:"string"`

	// The tag value.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

Describes a tag for an Auto Scaling group.

func (Tag) GoString added in v0.6.5

func (s Tag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) SetKey added in v1.5.0

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetPropagateAtLaunch added in v1.5.0

func (s *Tag) SetPropagateAtLaunch(v bool) *Tag

SetPropagateAtLaunch sets the PropagateAtLaunch field's value.

func (*Tag) SetResourceId added in v1.5.0

func (s *Tag) SetResourceId(v string) *Tag

SetResourceId sets the ResourceId field's value.

func (*Tag) SetResourceType added in v1.5.0

func (s *Tag) SetResourceType(v string) *Tag

SetResourceType sets the ResourceType field's value.

func (*Tag) SetValue added in v1.5.0

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String added in v0.6.5

func (s Tag) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) Validate added in v1.1.21

func (s *Tag) Validate() error

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

type TagDescription

type TagDescription struct {

	// The tag key.
	Key *string `min:"1" type:"string"`

	// Determines whether the tag is added to new instances as they are launched
	// in the group.
	PropagateAtLaunch *bool `type:"boolean"`

	// The name of the group.
	ResourceId *string `type:"string"`

	// The type of resource. The only supported value is auto-scaling-group.
	ResourceType *string `type:"string"`

	// The tag value.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

Describes a tag for an Auto Scaling group.

func (TagDescription) GoString added in v0.6.5

func (s TagDescription) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagDescription) SetKey added in v1.5.0

func (s *TagDescription) SetKey(v string) *TagDescription

SetKey sets the Key field's value.

func (*TagDescription) SetPropagateAtLaunch added in v1.5.0

func (s *TagDescription) SetPropagateAtLaunch(v bool) *TagDescription

SetPropagateAtLaunch sets the PropagateAtLaunch field's value.

func (*TagDescription) SetResourceId added in v1.5.0

func (s *TagDescription) SetResourceId(v string) *TagDescription

SetResourceId sets the ResourceId field's value.

func (*TagDescription) SetResourceType added in v1.5.0

func (s *TagDescription) SetResourceType(v string) *TagDescription

SetResourceType sets the ResourceType field's value.

func (*TagDescription) SetValue added in v1.5.0

func (s *TagDescription) SetValue(v string) *TagDescription

SetValue sets the Value field's value.

func (TagDescription) String added in v0.6.5

func (s TagDescription) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TargetTrackingConfiguration added in v1.10.9

type TargetTrackingConfiguration struct {

	// A customized metric. You must specify either a predefined metric or a customized
	// metric.
	CustomizedMetricSpecification *CustomizedMetricSpecification `type:"structure"`

	// Indicates whether scaling in by the target tracking scaling policy is disabled.
	// If scaling in is disabled, the target tracking scaling policy doesn't remove
	// instances from the Auto Scaling group. Otherwise, the target tracking scaling
	// policy can remove instances from the Auto Scaling group. The default is false.
	DisableScaleIn *bool `type:"boolean"`

	// A predefined metric. You must specify either a predefined metric or a customized
	// metric.
	PredefinedMetricSpecification *PredefinedMetricSpecification `type:"structure"`

	// The target value for the metric.
	//
	// Some metrics are based on a count instead of a percentage, such as the request
	// count for an Application Load Balancer or the number of messages in an SQS
	// queue. If the scaling policy specifies one of these metrics, specify the
	// target utilization as the optimal average request or message count per instance
	// during any one-minute interval.
	//
	// TargetValue is a required field
	TargetValue *float64 `type:"double" required:"true"`
	// contains filtered or unexported fields
}

Represents a target tracking scaling policy configuration to use with Amazon EC2 Auto Scaling.

func (TargetTrackingConfiguration) GoString added in v1.10.9

func (s TargetTrackingConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TargetTrackingConfiguration) SetCustomizedMetricSpecification added in v1.10.9

SetCustomizedMetricSpecification sets the CustomizedMetricSpecification field's value.

func (*TargetTrackingConfiguration) SetDisableScaleIn added in v1.10.9

SetDisableScaleIn sets the DisableScaleIn field's value.

func (*TargetTrackingConfiguration) SetPredefinedMetricSpecification added in v1.10.9

SetPredefinedMetricSpecification sets the PredefinedMetricSpecification field's value.

func (*TargetTrackingConfiguration) SetTargetValue added in v1.10.9

SetTargetValue sets the TargetValue field's value.

func (TargetTrackingConfiguration) String added in v1.10.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TargetTrackingConfiguration) Validate added in v1.10.9

func (s *TargetTrackingConfiguration) Validate() error

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

type TargetTrackingMetricDataQuery added in v1.44.156

type TargetTrackingMetricDataQuery struct {

	// The math expression to perform on the returned data, if this object is performing
	// a math expression. This expression can use the Id of the other metrics to
	// refer to those metrics, and can also use the Id of other expressions to use
	// the result of those expressions.
	//
	// Conditional: Within each TargetTrackingMetricDataQuery object, you must specify
	// either Expression or MetricStat, but not both.
	Expression *string `min:"1" type:"string"`

	// A short name that identifies the object's results in the response. This name
	// must be unique among all TargetTrackingMetricDataQuery objects specified
	// for a single scaling policy. If you are performing math expressions on this
	// set of data, this name represents that data and can serve as a variable in
	// the mathematical expression. The valid characters are letters, numbers, and
	// underscores. The first character must be a lowercase letter.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`

	// A human-readable label for this metric or expression. This is especially
	// useful if this is a math expression, so that you know what the value represents.
	Label *string `type:"string"`

	// Information about the metric data to return.
	//
	// Conditional: Within each TargetTrackingMetricDataQuery object, you must specify
	// either Expression or MetricStat, but not both.
	MetricStat *TargetTrackingMetricStat `type:"structure"`

	// Indicates whether to return the timestamps and raw data values of this metric.
	//
	// If you use any math expressions, specify true for this value for only the
	// final math expression that the metric specification is based on. You must
	// specify false for ReturnData for all the other metrics and expressions used
	// in the metric specification.
	//
	// If you are only retrieving metrics and not performing any math expressions,
	// do not specify anything for ReturnData. This sets it to its default (true).
	ReturnData *bool `type:"boolean"`
	// contains filtered or unexported fields
}

The metric data to return. Also defines whether this call is returning data for one metric only, or whether it is performing a math expression on the values of returned metric statistics to create a new time series. A time series is a series of data points, each of which is associated with a timestamp.

func (TargetTrackingMetricDataQuery) GoString added in v1.44.156

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TargetTrackingMetricDataQuery) SetExpression added in v1.44.156

SetExpression sets the Expression field's value.

func (*TargetTrackingMetricDataQuery) SetId added in v1.44.156

SetId sets the Id field's value.

func (*TargetTrackingMetricDataQuery) SetLabel added in v1.44.156

SetLabel sets the Label field's value.

func (*TargetTrackingMetricDataQuery) SetMetricStat added in v1.44.156

SetMetricStat sets the MetricStat field's value.

func (*TargetTrackingMetricDataQuery) SetReturnData added in v1.44.156

SetReturnData sets the ReturnData field's value.

func (TargetTrackingMetricDataQuery) String added in v1.44.156

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TargetTrackingMetricDataQuery) Validate added in v1.44.156

func (s *TargetTrackingMetricDataQuery) Validate() error

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

type TargetTrackingMetricStat added in v1.44.156

type TargetTrackingMetricStat struct {

	// The metric to use.
	//
	// Metric is a required field
	Metric *Metric `type:"structure" required:"true"`

	// The statistic to return. It can include any CloudWatch statistic or extended
	// statistic. For a list of valid values, see the table in Statistics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic)
	// in the Amazon CloudWatch User Guide.
	//
	// The most commonly used metric for scaling is Average.
	//
	// Stat is a required field
	Stat *string `min:"1" type:"string" required:"true"`

	// The unit to use for the returned data points. For a complete list of the
	// units that CloudWatch supports, see the MetricDatum (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html)
	// data type in the Amazon CloudWatch API Reference.
	Unit *string `type:"string"`
	// contains filtered or unexported fields
}

This structure defines the CloudWatch metric to return, along with the statistic and unit.

For more information about the CloudWatch terminology below, see Amazon CloudWatch concepts (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html) in the Amazon CloudWatch User Guide.

func (TargetTrackingMetricStat) GoString added in v1.44.156

func (s TargetTrackingMetricStat) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TargetTrackingMetricStat) SetMetric added in v1.44.156

SetMetric sets the Metric field's value.

func (*TargetTrackingMetricStat) SetStat added in v1.44.156

SetStat sets the Stat field's value.

func (*TargetTrackingMetricStat) SetUnit added in v1.44.156

SetUnit sets the Unit field's value.

func (TargetTrackingMetricStat) String added in v1.44.156

func (s TargetTrackingMetricStat) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TargetTrackingMetricStat) Validate added in v1.44.156

func (s *TargetTrackingMetricStat) Validate() error

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

type TerminateInstanceInAutoScalingGroupInput

type TerminateInstanceInAutoScalingGroupInput struct {

	// The ID of the instance.
	//
	// InstanceId is a required field
	InstanceId *string `min:"1" type:"string" required:"true"`

	// Indicates whether terminating the instance also decrements the size of the
	// Auto Scaling group.
	//
	// ShouldDecrementDesiredCapacity is a required field
	ShouldDecrementDesiredCapacity *bool `type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

func (TerminateInstanceInAutoScalingGroupInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TerminateInstanceInAutoScalingGroupInput) SetInstanceId added in v1.5.0

SetInstanceId sets the InstanceId field's value.

func (*TerminateInstanceInAutoScalingGroupInput) SetShouldDecrementDesiredCapacity added in v1.5.0

SetShouldDecrementDesiredCapacity sets the ShouldDecrementDesiredCapacity field's value.

func (TerminateInstanceInAutoScalingGroupInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TerminateInstanceInAutoScalingGroupInput) Validate added in v1.1.21

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

type TerminateInstanceInAutoScalingGroupOutput

type TerminateInstanceInAutoScalingGroupOutput struct {

	// A scaling activity.
	Activity *Activity `type:"structure"`
	// contains filtered or unexported fields
}

func (TerminateInstanceInAutoScalingGroupOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TerminateInstanceInAutoScalingGroupOutput) SetActivity added in v1.5.0

SetActivity sets the Activity field's value.

func (TerminateInstanceInAutoScalingGroupOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TotalLocalStorageGBRequest added in v1.41.12

type TotalLocalStorageGBRequest struct {

	// The storage maximum in GB.
	Max *float64 `type:"double"`

	// The storage minimum in GB.
	Min *float64 `type:"double"`
	// contains filtered or unexported fields
}

Specifies the minimum and maximum for the TotalLocalStorageGB object when you specify InstanceRequirements for an Auto Scaling group.

func (TotalLocalStorageGBRequest) GoString added in v1.41.12

func (s TotalLocalStorageGBRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TotalLocalStorageGBRequest) SetMax added in v1.41.12

SetMax sets the Max field's value.

func (*TotalLocalStorageGBRequest) SetMin added in v1.41.12

SetMin sets the Min field's value.

func (TotalLocalStorageGBRequest) String added in v1.41.12

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TrafficSourceIdentifier added in v1.44.156

type TrafficSourceIdentifier struct {

	// Identifies the traffic source.
	//
	// For Application Load Balancers, Gateway Load Balancers, Network Load Balancers,
	// and VPC Lattice, this will be the Amazon Resource Name (ARN) for a target
	// group in this account and Region. For Classic Load Balancers, this will be
	// the name of the Classic Load Balancer in this account and Region.
	//
	// For example:
	//
	//    * Application Load Balancer ARN: arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/1234567890123456
	//
	//    * Classic Load Balancer name: my-classic-load-balancer
	//
	//    * VPC Lattice ARN: arn:aws:vpc-lattice:us-west-2:123456789012:targetgroup/tg-1234567890123456
	//
	// To get the ARN of a target group for a Application Load Balancer, Gateway
	// Load Balancer, or Network Load Balancer, or the name of a Classic Load Balancer,
	// use the Elastic Load Balancing DescribeTargetGroups (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html)
	// and DescribeLoadBalancers (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html)
	// API operations.
	//
	// To get the ARN of a target group for VPC Lattice, use the VPC Lattice GetTargetGroup
	// (https://docs.aws.amazon.com/vpc-lattice/latest/APIReference/API_GetTargetGroup.html)
	// API operation.
	//
	// Identifier is a required field
	Identifier *string `min:"1" type:"string" required:"true"`

	// Provides additional context for the value of Identifier.
	//
	// The following lists the valid values:
	//
	//    * elb if Identifier is the name of a Classic Load Balancer.
	//
	//    * elbv2 if Identifier is the ARN of an Application Load Balancer, Gateway
	//    Load Balancer, or Network Load Balancer target group.
	//
	//    * vpc-lattice if Identifier is the ARN of a VPC Lattice target group.
	//
	// Required if the identifier is the name of a Classic Load Balancer.
	Type *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Identifying information for a traffic source.

func (TrafficSourceIdentifier) GoString added in v1.44.156

func (s TrafficSourceIdentifier) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TrafficSourceIdentifier) SetIdentifier added in v1.44.156

SetIdentifier sets the Identifier field's value.

func (*TrafficSourceIdentifier) SetType added in v1.44.233

SetType sets the Type field's value.

func (TrafficSourceIdentifier) String added in v1.44.156

func (s TrafficSourceIdentifier) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TrafficSourceIdentifier) Validate added in v1.44.156

func (s *TrafficSourceIdentifier) Validate() error

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

type TrafficSourceState added in v1.44.156

type TrafficSourceState struct {

	// The unique identifier of the traffic source.
	Identifier *string `min:"1" type:"string"`

	// Describes the current state of a traffic source.
	//
	// The state values are as follows:
	//
	//    * Adding - The Auto Scaling instances are being registered with the load
	//    balancer or target group.
	//
	//    * Added - All Auto Scaling instances are registered with the load balancer
	//    or target group.
	//
	//    * InService - For an Elastic Load Balancing load balancer or target group,
	//    at least one Auto Scaling instance passed an ELB health check. For VPC
	//    Lattice, at least one Auto Scaling instance passed an VPC_LATTICE health
	//    check.
	//
	//    * Removing - The Auto Scaling instances are being deregistered from the
	//    load balancer or target group. If connection draining (deregistration
	//    delay) is enabled, Elastic Load Balancing or VPC Lattice waits for in-flight
	//    requests to complete before deregistering the instances.
	//
	//    * Removed - All Auto Scaling instances are deregistered from the load
	//    balancer or target group.
	State *string `min:"1" type:"string"`

	// This is replaced by Identifier.
	//
	// Deprecated: TrafficSource has been replaced by Identifier
	TrafficSource *string `min:"1" deprecated:"true" type:"string"`

	// Provides additional context for the value of Identifier.
	//
	// The following lists the valid values:
	//
	//    * elb if Identifier is the name of a Classic Load Balancer.
	//
	//    * elbv2 if Identifier is the ARN of an Application Load Balancer, Gateway
	//    Load Balancer, or Network Load Balancer target group.
	//
	//    * vpc-lattice if Identifier is the ARN of a VPC Lattice target group.
	//
	// Required if the identifier is the name of a Classic Load Balancer.
	Type *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes the state of a traffic source.

func (TrafficSourceState) GoString added in v1.44.156

func (s TrafficSourceState) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TrafficSourceState) SetIdentifier added in v1.44.233

func (s *TrafficSourceState) SetIdentifier(v string) *TrafficSourceState

SetIdentifier sets the Identifier field's value.

func (*TrafficSourceState) SetState added in v1.44.156

SetState sets the State field's value.

func (*TrafficSourceState) SetTrafficSource added in v1.44.156

func (s *TrafficSourceState) SetTrafficSource(v string) *TrafficSourceState

SetTrafficSource sets the TrafficSource field's value.

func (*TrafficSourceState) SetType added in v1.44.233

SetType sets the Type field's value.

func (TrafficSourceState) String added in v1.44.156

func (s TrafficSourceState) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateAutoScalingGroupInput

type UpdateAutoScalingGroupInput struct {

	// The name of the Auto Scaling group.
	//
	// AutoScalingGroupName is a required field
	AutoScalingGroupName *string `min:"1" type:"string" required:"true"`

	// One or more Availability Zones for the group.
	AvailabilityZones []*string `type:"list"`

	// Enables or disables Capacity Rebalancing. For more information, see Use Capacity
	// Rebalancing to handle Amazon EC2 Spot Interruptions (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-capacity-rebalancing.html)
	// in the Amazon EC2 Auto Scaling User Guide.
	CapacityRebalance *bool `type:"boolean"`

	// Reserved.
	Context *string `type:"string"`

	// 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 (https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html)
	// in the Amazon EC2 Auto Scaling User Guide.
	DefaultCooldown *int64 `type:"integer"`

	// 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 (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-default-instance-warmup.html)
	// 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.
	DefaultInstanceWarmup *int64 `type:"integer"`

	// 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.
	DesiredCapacity *int64 `type:"integer"`

	// 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 Creating an Auto Scaling group
	// using attribute-based instance type selection (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html)
	// 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
	DesiredCapacityType *string `min:"1" type:"string"`

	// 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 (https://docs.aws.amazon.com/autoscaling/ec2/userguide/health-check-grace-period.html)
	// in the Amazon EC2 Auto Scaling User Guide.
	HealthCheckGracePeriod *int64 `type:"integer"`

	// A comma-separated value string of one or more health check types.
	//
	// The valid values are EC2, ELB, and VPC_LATTICE. EC2 is the default health
	// check and cannot be disabled. For more information, see Health checks for
	// Auto Scaling instances (https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html)
	// in the Amazon EC2 Auto Scaling User Guide.
	//
	// Only specify EC2 if you must clear a value that was previously set.
	HealthCheckType *string `min:"1" type:"string"`

	// The name of the launch configuration. If you specify LaunchConfigurationName
	// in your update request, you can't specify LaunchTemplate or MixedInstancesPolicy.
	LaunchConfigurationName *string `min:"1" type:"string"`

	// 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.
	LaunchTemplate *LaunchTemplateSpecification `type:"structure"`

	// 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 (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html)
	// in the Amazon EC2 Auto Scaling User Guide.
	MaxInstanceLifetime *int64 `type:"integer"`

	// 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).
	MaxSize *int64 `type:"integer"`

	// The minimum size of the Auto Scaling group.
	MinSize *int64 `type:"integer"`

	// The mixed instances policy. For more information, see Auto Scaling groups
	// with multiple instance types and purchase options (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html)
	// in the Amazon EC2 Auto Scaling User Guide.
	MixedInstancesPolicy *MixedInstancesPolicy `type:"structure"`

	// 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 Using instance scale-in protection
	// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html)
	// in the Amazon EC2 Auto Scaling User Guide.
	NewInstancesProtectedFromScaleIn *bool `type:"boolean"`

	// The name of an existing placement group into which to launch your instances.
	// 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.
	//
	// 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.
	PlacementGroup *string `min:"1" type:"string"`

	// 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 (https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html)
	// in the Amazon EC2 Auto Scaling User Guide.
	ServiceLinkedRoleARN *string `min:"1" type:"string"`

	// 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 Work with Amazon EC2 Auto Scaling termination policies (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html)
	// 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
	TerminationPolicies []*string `type:"list"`

	// 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.
	VPCZoneIdentifier *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateAutoScalingGroupInput) GoString added in v0.6.5

func (s UpdateAutoScalingGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAutoScalingGroupInput) SetAutoScalingGroupName added in v1.5.0

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

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*UpdateAutoScalingGroupInput) SetAvailabilityZones added in v1.5.0

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

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*UpdateAutoScalingGroupInput) SetCapacityRebalance added in v1.35.21

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

SetCapacityRebalance sets the CapacityRebalance field's value.

func (*UpdateAutoScalingGroupInput) SetContext added in v1.38.70

SetContext sets the Context field's value.

func (*UpdateAutoScalingGroupInput) SetDefaultCooldown added in v1.5.0

SetDefaultCooldown sets the DefaultCooldown field's value.

func (*UpdateAutoScalingGroupInput) SetDefaultInstanceWarmup added in v1.43.42

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

SetDefaultInstanceWarmup sets the DefaultInstanceWarmup field's value.

func (*UpdateAutoScalingGroupInput) SetDesiredCapacity added in v1.5.0

SetDesiredCapacity sets the DesiredCapacity field's value.

func (*UpdateAutoScalingGroupInput) SetDesiredCapacityType added in v1.41.12

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

SetDesiredCapacityType sets the DesiredCapacityType field's value.

func (*UpdateAutoScalingGroupInput) SetHealthCheckGracePeriod added in v1.5.0

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

SetHealthCheckGracePeriod sets the HealthCheckGracePeriod field's value.

func (*UpdateAutoScalingGroupInput) SetHealthCheckType added in v1.5.0

SetHealthCheckType sets the HealthCheckType field's value.

func (*UpdateAutoScalingGroupInput) SetLaunchConfigurationName added in v1.5.0

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

SetLaunchConfigurationName sets the LaunchConfigurationName field's value.

func (*UpdateAutoScalingGroupInput) SetLaunchTemplate added in v1.12.37

SetLaunchTemplate sets the LaunchTemplate field's value.

func (*UpdateAutoScalingGroupInput) SetMaxInstanceLifetime added in v1.25.38

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

SetMaxInstanceLifetime sets the MaxInstanceLifetime field's value.

func (*UpdateAutoScalingGroupInput) SetMaxSize added in v1.5.0

SetMaxSize sets the MaxSize field's value.

func (*UpdateAutoScalingGroupInput) SetMinSize added in v1.5.0

SetMinSize sets the MinSize field's value.

func (*UpdateAutoScalingGroupInput) SetMixedInstancesPolicy added in v1.15.76

SetMixedInstancesPolicy sets the MixedInstancesPolicy field's value.

func (*UpdateAutoScalingGroupInput) SetNewInstancesProtectedFromScaleIn added in v1.5.0

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

SetNewInstancesProtectedFromScaleIn sets the NewInstancesProtectedFromScaleIn field's value.

func (*UpdateAutoScalingGroupInput) SetPlacementGroup added in v1.5.0

SetPlacementGroup sets the PlacementGroup field's value.

func (*UpdateAutoScalingGroupInput) SetServiceLinkedRoleARN added in v1.13.1

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

SetServiceLinkedRoleARN sets the ServiceLinkedRoleARN field's value.

func (*UpdateAutoScalingGroupInput) SetTerminationPolicies added in v1.5.0

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

SetTerminationPolicies sets the TerminationPolicies field's value.

func (*UpdateAutoScalingGroupInput) SetVPCZoneIdentifier added in v1.5.0

SetVPCZoneIdentifier sets the VPCZoneIdentifier field's value.

func (UpdateAutoScalingGroupInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAutoScalingGroupInput) Validate added in v1.1.21

func (s *UpdateAutoScalingGroupInput) Validate() error

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

type UpdateAutoScalingGroupOutput

type UpdateAutoScalingGroupOutput struct {
	// contains filtered or unexported fields
}

func (UpdateAutoScalingGroupOutput) GoString added in v0.6.5

func (s UpdateAutoScalingGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateAutoScalingGroupOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VCpuCountRequest added in v1.41.12

type VCpuCountRequest struct {

	// The maximum number of vCPUs.
	Max *int64 `type:"integer"`

	// The minimum number of vCPUs.
	//
	// Min is a required field
	Min *int64 `type:"integer" required:"true"`
	// contains filtered or unexported fields
}

Specifies the minimum and maximum for the VCpuCount object when you specify InstanceRequirements for an Auto Scaling group.

func (VCpuCountRequest) GoString added in v1.41.12

func (s VCpuCountRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VCpuCountRequest) SetMax added in v1.41.12

func (s *VCpuCountRequest) SetMax(v int64) *VCpuCountRequest

SetMax sets the Max field's value.

func (*VCpuCountRequest) SetMin added in v1.41.12

func (s *VCpuCountRequest) SetMin(v int64) *VCpuCountRequest

SetMin sets the Min field's value.

func (VCpuCountRequest) String added in v1.41.12

func (s VCpuCountRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VCpuCountRequest) Validate added in v1.41.12

func (s *VCpuCountRequest) Validate() error

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

type WarmPoolConfiguration added in v1.38.16

type WarmPoolConfiguration struct {

	// The instance reuse policy.
	InstanceReusePolicy *InstanceReusePolicy `type:"structure"`

	// The maximum number of instances that are allowed to be in the warm pool or
	// in any state except Terminated for the Auto Scaling group.
	MaxGroupPreparedCapacity *int64 `type:"integer"`

	// The minimum number of instances to maintain in the warm pool.
	MinSize *int64 `type:"integer"`

	// The instance state to transition to after the lifecycle actions are complete.
	PoolState *string `type:"string" enum:"WarmPoolState"`

	// The status of a warm pool that is marked for deletion.
	Status *string `type:"string" enum:"WarmPoolStatus"`
	// contains filtered or unexported fields
}

Describes a warm pool configuration.

func (WarmPoolConfiguration) GoString added in v1.38.16

func (s WarmPoolConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WarmPoolConfiguration) SetInstanceReusePolicy added in v1.43.6

func (s *WarmPoolConfiguration) SetInstanceReusePolicy(v *InstanceReusePolicy) *WarmPoolConfiguration

SetInstanceReusePolicy sets the InstanceReusePolicy field's value.

func (*WarmPoolConfiguration) SetMaxGroupPreparedCapacity added in v1.38.16

func (s *WarmPoolConfiguration) SetMaxGroupPreparedCapacity(v int64) *WarmPoolConfiguration

SetMaxGroupPreparedCapacity sets the MaxGroupPreparedCapacity field's value.

func (*WarmPoolConfiguration) SetMinSize added in v1.38.16

SetMinSize sets the MinSize field's value.

func (*WarmPoolConfiguration) SetPoolState added in v1.38.16

SetPoolState sets the PoolState field's value.

func (*WarmPoolConfiguration) SetStatus added in v1.38.16

SetStatus sets the Status field's value.

func (WarmPoolConfiguration) String added in v1.38.16

func (s WarmPoolConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Directories

Path Synopsis
Package autoscalingiface provides an interface to enable mocking the Auto Scaling service client for testing your code.
Package autoscalingiface provides an interface to enable mocking the Auto Scaling service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL