Classes Reference


                    
                    
                    AWSAutoScalingActivitiesType

Declaration

Objective-C

@interface AWSAutoScalingActivitiesType

Swift

class AWSAutoScalingActivitiesType


                    
                    
                    AWSAutoScalingActivity

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.

Required parameters: [ActivityId, AutoScalingGroupName, Cause, StartTime, StatusCode]

Declaration

Objective-C

@interface AWSAutoScalingActivity

Swift

class AWSAutoScalingActivity


                    
                    
                    AWSAutoScalingActivityType

Declaration

Objective-C

@interface AWSAutoScalingActivityType

Swift

class AWSAutoScalingActivityType


                    
                    
                    AWSAutoScalingAdjustmentType

Describes a policy adjustment type.

Declaration

Objective-C

@interface AWSAutoScalingAdjustmentType

Swift

class AWSAutoScalingAdjustmentType


                    
                    
                    AWSAutoScalingAlarm

Describes an alarm.

Declaration

Objective-C

@interface AWSAutoScalingAlarm

Swift

class AWSAutoScalingAlarm


                    
                    
                    AWSAutoScalingAttachInstancesQuery

Declaration

Objective-C

@interface AWSAutoScalingAttachInstancesQuery

Swift

class AWSAutoScalingAttachInstancesQuery


                    
                    
                    AWSAutoScalingAttachLoadBalancerTargetGroupsResultType

Declaration

Objective-C

@interface AWSAutoScalingAttachLoadBalancerTargetGroupsResultType

Swift

class AWSAutoScalingAttachLoadBalancerTargetGroupsResultType


                    
                    
                    AWSAutoScalingAttachLoadBalancerTargetGroupsType

Declaration

Objective-C

@interface AWSAutoScalingAttachLoadBalancerTargetGroupsType

Swift

class AWSAutoScalingAttachLoadBalancerTargetGroupsType


                    
                    
                    AWSAutoScalingAttachLoadBalancersResultType

Declaration

Objective-C

@interface AWSAutoScalingAttachLoadBalancersResultType

Swift

class AWSAutoScalingAttachLoadBalancersResultType


                    
                    
                    AWSAutoScalingAttachLoadBalancersType

Declaration

Objective-C

@interface AWSAutoScalingAttachLoadBalancersType

Swift

class AWSAutoScalingAttachLoadBalancersType


                    
                    
                    AWSAutoScalingAutoScalingGroup

Describes an Auto Scaling group.

Required parameters: [AutoScalingGroupName, MinSize, MaxSize, DesiredCapacity, DefaultCooldown, AvailabilityZones, HealthCheckType, CreatedTime]

Declaration

Objective-C

@interface AWSAutoScalingAutoScalingGroup

Swift

class AWSAutoScalingAutoScalingGroup


                    
                    
                    AWSAutoScalingAutoScalingGroupNamesType

Declaration

Objective-C

@interface AWSAutoScalingAutoScalingGroupNamesType

Swift

class AWSAutoScalingAutoScalingGroupNamesType


                    
                    
                    AWSAutoScalingAutoScalingGroupsType

Declaration

Objective-C

@interface AWSAutoScalingAutoScalingGroupsType

Swift

class AWSAutoScalingAutoScalingGroupsType


                    
                    
                    AWSAutoScalingAutoScalingInstanceDetails

Describes an EC2 instance associated with an Auto Scaling group.

Required parameters: [InstanceId, AutoScalingGroupName, AvailabilityZone, LifecycleState, HealthStatus, ProtectedFromScaleIn]

Declaration

Objective-C

@interface AWSAutoScalingAutoScalingInstanceDetails

Swift

class AWSAutoScalingAutoScalingInstanceDetails


                    
                    
                    AWSAutoScalingAutoScalingInstancesType

Declaration

Objective-C

@interface AWSAutoScalingAutoScalingInstancesType

Swift

class AWSAutoScalingAutoScalingInstancesType


                    
                    
                    AWSAutoScalingBatchDeleteScheduledActionAnswer

Declaration

Objective-C

@interface AWSAutoScalingBatchDeleteScheduledActionAnswer

Swift

class AWSAutoScalingBatchDeleteScheduledActionAnswer


                    
                    
                    AWSAutoScalingBatchDeleteScheduledActionType

Declaration

Objective-C

@interface AWSAutoScalingBatchDeleteScheduledActionType

Swift

class AWSAutoScalingBatchDeleteScheduledActionType


                    
                    
                    AWSAutoScalingBatchPutScheduledUpdateGroupActionAnswer

Declaration

Objective-C

@interface AWSAutoScalingBatchPutScheduledUpdateGroupActionAnswer

Swift

class AWSAutoScalingBatchPutScheduledUpdateGroupActionAnswer


                    
                    
                    AWSAutoScalingBatchPutScheduledUpdateGroupActionType

Declaration

Objective-C

@interface AWSAutoScalingBatchPutScheduledUpdateGroupActionType

Swift

class AWSAutoScalingBatchPutScheduledUpdateGroupActionType


                    
                    
                    AWSAutoScalingBlockDeviceMapping

Describes a block device mapping.

Required parameters: [DeviceName]

Declaration

Objective-C

@interface AWSAutoScalingBlockDeviceMapping

Swift

class AWSAutoScalingBlockDeviceMapping


                    
                    
                    AWSAutoScalingCancelInstanceRefreshAnswer

Declaration

Objective-C

@interface AWSAutoScalingCancelInstanceRefreshAnswer

Swift

class AWSAutoScalingCancelInstanceRefreshAnswer


                    
                    
                    AWSAutoScalingCancelInstanceRefreshType

Declaration

Objective-C

@interface AWSAutoScalingCancelInstanceRefreshType

Swift

class AWSAutoScalingCancelInstanceRefreshType


                    
                    
                    AWSAutoScalingCapacityForecast

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.

Required parameters: [Timestamps, Values]

Declaration

Objective-C

@interface AWSAutoScalingCapacityForecast

Swift

class AWSAutoScalingCapacityForecast


                    
                    
                    AWSAutoScalingCompleteLifecycleActionAnswer

Declaration

Objective-C

@interface AWSAutoScalingCompleteLifecycleActionAnswer

Swift

class AWSAutoScalingCompleteLifecycleActionAnswer


                    
                    
                    AWSAutoScalingCompleteLifecycleActionType

Declaration

Objective-C

@interface AWSAutoScalingCompleteLifecycleActionType

Swift

class AWSAutoScalingCompleteLifecycleActionType


                    
                    
                    AWSAutoScalingCreateAutoScalingGroupType

Declaration

Objective-C

@interface AWSAutoScalingCreateAutoScalingGroupType

Swift

class AWSAutoScalingCreateAutoScalingGroupType


                    
                    
                    AWSAutoScalingCreateLaunchConfigurationType

Declaration

Objective-C

@interface AWSAutoScalingCreateLaunchConfigurationType

Swift

class AWSAutoScalingCreateLaunchConfigurationType


                    
                    
                    AWSAutoScalingCreateOrUpdateTagsType

Declaration

Objective-C

@interface AWSAutoScalingCreateOrUpdateTagsType

Swift

class AWSAutoScalingCreateOrUpdateTagsType


                    
                    
                    AWSAutoScalingCustomizedMetricSpecification

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 parameter 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 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 CloudWatch, see Amazon CloudWatch Concepts.

Required parameters: [MetricName, Namespace, Statistic]

Declaration

Objective-C

@interface AWSAutoScalingCustomizedMetricSpecification

Swift

class AWSAutoScalingCustomizedMetricSpecification


                    
                    
                    AWSAutoScalingDeleteAutoScalingGroupType

Declaration

Objective-C

@interface AWSAutoScalingDeleteAutoScalingGroupType

Swift

class AWSAutoScalingDeleteAutoScalingGroupType


                    
                    
                    AWSAutoScalingDeleteLifecycleHookAnswer

Declaration

Objective-C

@interface AWSAutoScalingDeleteLifecycleHookAnswer

Swift

class AWSAutoScalingDeleteLifecycleHookAnswer


                    
                    
                    AWSAutoScalingDeleteLifecycleHookType

Declaration

Objective-C

@interface AWSAutoScalingDeleteLifecycleHookType

Swift

class AWSAutoScalingDeleteLifecycleHookType


                    
                    
                    AWSAutoScalingDeleteNotificationConfigurationType

Declaration

Objective-C

@interface AWSAutoScalingDeleteNotificationConfigurationType

Swift

class AWSAutoScalingDeleteNotificationConfigurationType


                    
                    
                    AWSAutoScalingDeletePolicyType

Declaration

Objective-C

@interface AWSAutoScalingDeletePolicyType

Swift

class AWSAutoScalingDeletePolicyType


                    
                    
                    AWSAutoScalingDeleteScheduledActionType

Declaration

Objective-C

@interface AWSAutoScalingDeleteScheduledActionType

Swift

class AWSAutoScalingDeleteScheduledActionType


                    
                    
                    AWSAutoScalingDeleteTagsType

Declaration

Objective-C

@interface AWSAutoScalingDeleteTagsType

Swift

class AWSAutoScalingDeleteTagsType


                    
                    
                    AWSAutoScalingDeleteWarmPoolAnswer

Declaration

Objective-C

@interface AWSAutoScalingDeleteWarmPoolAnswer

Swift

class AWSAutoScalingDeleteWarmPoolAnswer


                    
                    
                    AWSAutoScalingDeleteWarmPoolType

Declaration

Objective-C

@interface AWSAutoScalingDeleteWarmPoolType

Swift

class AWSAutoScalingDeleteWarmPoolType


                    
                    
                    AWSAutoScalingDescribeAccountLimitsAnswer

Declaration

Objective-C

@interface AWSAutoScalingDescribeAccountLimitsAnswer

Swift

class AWSAutoScalingDescribeAccountLimitsAnswer


                    
                    
                    AWSAutoScalingDescribeAdjustmentTypesAnswer

Declaration

Objective-C

@interface AWSAutoScalingDescribeAdjustmentTypesAnswer

Swift

class AWSAutoScalingDescribeAdjustmentTypesAnswer


                    
                    
                    AWSAutoScalingDescribeAutoScalingInstancesType

Declaration

Objective-C

@interface AWSAutoScalingDescribeAutoScalingInstancesType

Swift

class AWSAutoScalingDescribeAutoScalingInstancesType


                    
                    
                    AWSAutoScalingDescribeAutoScalingNotificationTypesAnswer

Declaration

Objective-C

@interface AWSAutoScalingDescribeAutoScalingNotificationTypesAnswer

Swift

class AWSAutoScalingDescribeAutoScalingNotificationTypesAnswer


                    
                    
                    AWSAutoScalingDescribeInstanceRefreshesAnswer

Declaration

Objective-C

@interface AWSAutoScalingDescribeInstanceRefreshesAnswer

Swift

class AWSAutoScalingDescribeInstanceRefreshesAnswer


                    
                    
                    AWSAutoScalingDescribeInstanceRefreshesType

Declaration

Objective-C

@interface AWSAutoScalingDescribeInstanceRefreshesType

Swift

class AWSAutoScalingDescribeInstanceRefreshesType


                    
                    
                    AWSAutoScalingDescribeLifecycleHookTypesAnswer

Declaration

Objective-C

@interface AWSAutoScalingDescribeLifecycleHookTypesAnswer

Swift

class AWSAutoScalingDescribeLifecycleHookTypesAnswer


                    
                    
                    AWSAutoScalingDescribeLifecycleHooksAnswer

Declaration

Objective-C

@interface AWSAutoScalingDescribeLifecycleHooksAnswer

Swift

class AWSAutoScalingDescribeLifecycleHooksAnswer


                    
                    
                    AWSAutoScalingDescribeLifecycleHooksType

Declaration

Objective-C

@interface AWSAutoScalingDescribeLifecycleHooksType

Swift

class AWSAutoScalingDescribeLifecycleHooksType


                    
                    
                    AWSAutoScalingDescribeLoadBalancerTargetGroupsRequest

Declaration

Objective-C

@interface AWSAutoScalingDescribeLoadBalancerTargetGroupsRequest

Swift

class AWSAutoScalingDescribeLoadBalancerTargetGroupsRequest


                    
                    
                    AWSAutoScalingDescribeLoadBalancerTargetGroupsResponse

Declaration

Objective-C

@interface AWSAutoScalingDescribeLoadBalancerTargetGroupsResponse

Swift

class AWSAutoScalingDescribeLoadBalancerTargetGroupsResponse


                    
                    
                    AWSAutoScalingDescribeLoadBalancersRequest

Declaration

Objective-C

@interface AWSAutoScalingDescribeLoadBalancersRequest

Swift

class AWSAutoScalingDescribeLoadBalancersRequest


                    
                    
                    AWSAutoScalingDescribeLoadBalancersResponse

Declaration

Objective-C

@interface AWSAutoScalingDescribeLoadBalancersResponse

Swift

class AWSAutoScalingDescribeLoadBalancersResponse


                    
                    
                    AWSAutoScalingDescribeMetricCollectionTypesAnswer

Declaration

Objective-C

@interface AWSAutoScalingDescribeMetricCollectionTypesAnswer

Swift

class AWSAutoScalingDescribeMetricCollectionTypesAnswer


                    
                    
                    AWSAutoScalingDescribeNotificationConfigurationsAnswer

Declaration

Objective-C

@interface AWSAutoScalingDescribeNotificationConfigurationsAnswer

Swift

class AWSAutoScalingDescribeNotificationConfigurationsAnswer


                    
                    
                    AWSAutoScalingDescribeNotificationConfigurationsType

Declaration

Objective-C

@interface AWSAutoScalingDescribeNotificationConfigurationsType

Swift

class AWSAutoScalingDescribeNotificationConfigurationsType


                    
                    
                    AWSAutoScalingDescribePoliciesType

Declaration

Objective-C

@interface AWSAutoScalingDescribePoliciesType

Swift

class AWSAutoScalingDescribePoliciesType


                    
                    
                    AWSAutoScalingDescribeScalingActivitiesType

Declaration

Objective-C

@interface AWSAutoScalingDescribeScalingActivitiesType

Swift

class AWSAutoScalingDescribeScalingActivitiesType


                    
                    
                    AWSAutoScalingDescribeScheduledActionsType

Declaration

Objective-C

@interface AWSAutoScalingDescribeScheduledActionsType

Swift

class AWSAutoScalingDescribeScheduledActionsType


                    
                    
                    AWSAutoScalingDescribeTagsType

Declaration

Objective-C

@interface AWSAutoScalingDescribeTagsType

Swift

class AWSAutoScalingDescribeTagsType


                    
                    
                    AWSAutoScalingDescribeTerminationPolicyTypesAnswer

Declaration

Objective-C

@interface AWSAutoScalingDescribeTerminationPolicyTypesAnswer

Swift

class AWSAutoScalingDescribeTerminationPolicyTypesAnswer


                    
                    
                    AWSAutoScalingDescribeWarmPoolAnswer

Declaration

Objective-C

@interface AWSAutoScalingDescribeWarmPoolAnswer

Swift

class AWSAutoScalingDescribeWarmPoolAnswer


                    
                    
                    AWSAutoScalingDescribeWarmPoolType

Declaration

Objective-C

@interface AWSAutoScalingDescribeWarmPoolType

Swift

class AWSAutoScalingDescribeWarmPoolType


                    
                    
                    AWSAutoScalingDetachInstancesAnswer

Declaration

Objective-C

@interface AWSAutoScalingDetachInstancesAnswer

Swift

class AWSAutoScalingDetachInstancesAnswer


                    
                    
                    AWSAutoScalingDetachInstancesQuery

Declaration

Objective-C

@interface AWSAutoScalingDetachInstancesQuery

Swift

class AWSAutoScalingDetachInstancesQuery


                    
                    
                    AWSAutoScalingDetachLoadBalancerTargetGroupsResultType

Declaration

Objective-C

@interface AWSAutoScalingDetachLoadBalancerTargetGroupsResultType

Swift

class AWSAutoScalingDetachLoadBalancerTargetGroupsResultType


                    
                    
                    AWSAutoScalingDetachLoadBalancerTargetGroupsType

Declaration

Objective-C

@interface AWSAutoScalingDetachLoadBalancerTargetGroupsType

Swift

class AWSAutoScalingDetachLoadBalancerTargetGroupsType


                    
                    
                    AWSAutoScalingDetachLoadBalancersResultType

Declaration

Objective-C

@interface AWSAutoScalingDetachLoadBalancersResultType

Swift

class AWSAutoScalingDetachLoadBalancersResultType


                    
                    
                    AWSAutoScalingDetachLoadBalancersType

Declaration

Objective-C

@interface AWSAutoScalingDetachLoadBalancersType

Swift

class AWSAutoScalingDetachLoadBalancersType


                    
                    
                    AWSAutoScalingDisableMetricsCollectionQuery

Declaration

Objective-C

@interface AWSAutoScalingDisableMetricsCollectionQuery

Swift

class AWSAutoScalingDisableMetricsCollectionQuery


                    
                    
                    AWSAutoScalingEbs

Describes information used to set up an Amazon EBS volume specified in a block device mapping.

Declaration

Objective-C

@interface AWSAutoScalingEbs

Swift

class AWSAutoScalingEbs


                    
                    
                    AWSAutoScalingEnableMetricsCollectionQuery

Declaration

Objective-C

@interface AWSAutoScalingEnableMetricsCollectionQuery

Swift

class AWSAutoScalingEnableMetricsCollectionQuery


                    
                    
                    AWSAutoScalingEnabledMetric

Describes an enabled metric.

Declaration

Objective-C

@interface AWSAutoScalingEnabledMetric

Swift

class AWSAutoScalingEnabledMetric


                    
                    
                    AWSAutoScalingEnterStandbyAnswer

Declaration

Objective-C

@interface AWSAutoScalingEnterStandbyAnswer

Swift

class AWSAutoScalingEnterStandbyAnswer


                    
                    
                    AWSAutoScalingEnterStandbyQuery

Declaration

Objective-C

@interface AWSAutoScalingEnterStandbyQuery

Swift

class AWSAutoScalingEnterStandbyQuery


                    
                    
                    AWSAutoScalingExecutePolicyType

Declaration

Objective-C

@interface AWSAutoScalingExecutePolicyType

Swift

class AWSAutoScalingExecutePolicyType


                    
                    
                    AWSAutoScalingExitStandbyAnswer

Declaration

Objective-C

@interface AWSAutoScalingExitStandbyAnswer

Swift

class AWSAutoScalingExitStandbyAnswer


                    
                    
                    AWSAutoScalingExitStandbyQuery

Declaration

Objective-C

@interface AWSAutoScalingExitStandbyQuery

Swift

class AWSAutoScalingExitStandbyQuery


                    
                    
                    AWSAutoScalingFailedScheduledUpdateGroupActionRequest

Describes a scheduled action that could not be created, updated, or deleted.

Required parameters: [ScheduledActionName]

Declaration

Objective-C

@interface AWSAutoScalingFailedScheduledUpdateGroupActionRequest

Swift

class AWSAutoScalingFailedScheduledUpdateGroupActionRequest


                    
                    
                    AWSAutoScalingFilter

Describes a filter that is used to return a more specific list of results when describing tags.

For more information, see Tagging Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.

Declaration

Objective-C

@interface AWSAutoScalingFilter

Swift

class AWSAutoScalingFilter


                    
                    
                    AWSAutoScalingGetPredictiveScalingForecastAnswer

Declaration

Objective-C

@interface AWSAutoScalingGetPredictiveScalingForecastAnswer

Swift

class AWSAutoScalingGetPredictiveScalingForecastAnswer


                    
                    
                    AWSAutoScalingGetPredictiveScalingForecastType

Declaration

Objective-C

@interface AWSAutoScalingGetPredictiveScalingForecastType

Swift

class AWSAutoScalingGetPredictiveScalingForecastType


                    
                    
                    AWSAutoScalingInstance

Describes an EC2 instance.

Required parameters: [InstanceId, AvailabilityZone, LifecycleState, HealthStatus, ProtectedFromScaleIn]

Declaration

Objective-C

@interface AWSAutoScalingInstance

Swift

class AWSAutoScalingInstance


                    
                    
                    AWSAutoScalingInstanceMetadataOptions

The metadata options for the instances. For more information, see Configuring the Instance Metadata Options in the Amazon EC2 Auto Scaling User Guide.

Declaration

Objective-C

@interface AWSAutoScalingInstanceMetadataOptions

Swift

class AWSAutoScalingInstanceMetadataOptions


                    
                    
                    AWSAutoScalingInstanceMonitoring

Describes whether detailed monitoring is enabled for the Auto Scaling instances.

Declaration

Objective-C

@interface AWSAutoScalingInstanceMonitoring

Swift

class AWSAutoScalingInstanceMonitoring


                    
                    
                    AWSAutoScalingInstanceRefresh

Describes an instance refresh for an Auto Scaling group.

Declaration

Objective-C

@interface AWSAutoScalingInstanceRefresh

Swift

class AWSAutoScalingInstanceRefresh


                    
                    
                    AWSAutoScalingInstanceRefreshLivePoolProgress

Reports the progress of an instance refresh on instances that are in the Auto Scaling group.

Declaration

Objective-C

@interface AWSAutoScalingInstanceRefreshLivePoolProgress

Swift

class AWSAutoScalingInstanceRefreshLivePoolProgress


                    
                    
                    AWSAutoScalingInstanceRefreshProgressDetails

Reports the progress of an instance refresh on 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).

Declaration

Objective-C

@interface AWSAutoScalingInstanceRefreshProgressDetails

Swift

class AWSAutoScalingInstanceRefreshProgressDetails


                    
                    
                    AWSAutoScalingInstanceRefreshWarmPoolProgress

Reports the progress of an instance refresh on instances that are in the warm pool.

Declaration

Objective-C

@interface AWSAutoScalingInstanceRefreshWarmPoolProgress

Swift

class AWSAutoScalingInstanceRefreshWarmPoolProgress


                    
                    
                    AWSAutoScalingInstancesDistribution

Describes an instances distribution for an Auto Scaling group with a MixedInstancesPolicy.

The instances distribution specifies the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances, and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities.

When you update SpotAllocationStrategy, SpotInstancePools, or SpotMaxPrice, this update action does not deploy any changes across the running Amazon EC2 instances in the group. Your existing Spot Instances continue to run as long as the maximum price for those instances is higher than the current Spot price. When scale out occurs, Amazon EC2 Auto Scaling launches instances based on the new settings. When scale in occurs, Amazon EC2 Auto Scaling terminates instances according to the group’s termination policies.

Declaration

Objective-C

@interface AWSAutoScalingInstancesDistribution

Swift

class AWSAutoScalingInstancesDistribution


                    
                    
                    AWSAutoScalingLaunchConfiguration

Describes a launch configuration.

Required parameters: [LaunchConfigurationName, ImageId, InstanceType, CreatedTime]

Declaration

Objective-C

@interface AWSAutoScalingLaunchConfiguration

Swift

class AWSAutoScalingLaunchConfiguration


                    
                    
                    AWSAutoScalingLaunchConfigurationNameType

Declaration

Objective-C

@interface AWSAutoScalingLaunchConfigurationNameType

Swift

class AWSAutoScalingLaunchConfigurationNameType


                    
                    
                    AWSAutoScalingLaunchConfigurationNamesType

Declaration

Objective-C

@interface AWSAutoScalingLaunchConfigurationNamesType

Swift

class AWSAutoScalingLaunchConfigurationNamesType


                    
                    
                    AWSAutoScalingLaunchConfigurationsType

Declaration

Objective-C

@interface AWSAutoScalingLaunchConfigurationsType

Swift

class AWSAutoScalingLaunchConfigurationsType


                    
                    
                    AWSAutoScalingLaunchTemplate

Describes a launch template and overrides.

You specify these properties as part of a mixed instances policy.

When you update the launch template or overrides, existing Amazon EC2 instances continue to run. When scale out occurs, Amazon EC2 Auto Scaling launches instances to match the new settings. When scale in occurs, Amazon EC2 Auto Scaling terminates instances according to the group’s termination policies.

Declaration

Objective-C

@interface AWSAutoScalingLaunchTemplate

Swift

class AWSAutoScalingLaunchTemplate


                    
                    
                    AWSAutoScalingLaunchTemplateOverrides

Describes an override for a launch template. The maximum number of instance types that can be associated with an Auto Scaling group is 40. The maximum number of distinct launch templates you can define for an Auto Scaling group is 20. For more information about configuring overrides, see Configuring overrides in the Amazon EC2 Auto Scaling User Guide.

Declaration

Objective-C

@interface AWSAutoScalingLaunchTemplateOverrides

Swift

class AWSAutoScalingLaunchTemplateOverrides


                    
                    
                    AWSAutoScalingLaunchTemplateSpecification

Describes the Amazon EC2 launch template and the launch template version that can be used by an Auto Scaling group to configure Amazon EC2 instances.

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

Declaration

Objective-C

@interface AWSAutoScalingLaunchTemplateSpecification

Swift

class AWSAutoScalingLaunchTemplateSpecification


                    
                    
                    AWSAutoScalingLifecycleHook

Describes a lifecycle hook, which tells Amazon EC2 Auto Scaling that you want to perform an action whenever it launches instances or terminates instances.

Declaration

Objective-C

@interface AWSAutoScalingLifecycleHook

Swift

class AWSAutoScalingLifecycleHook


                    
                    
                    AWSAutoScalingLifecycleHookSpecification

Describes information used to specify a lifecycle hook for an Auto Scaling group.

A lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on an instance when the instance launches (before it is put into service) or as the instance terminates (before it is fully terminated).

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

(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.
(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 pending state.
If you finish before the timeout period ends, complete the lifecycle action.

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

Required parameters: [LifecycleHookName, LifecycleTransition]

Declaration

Objective-C

@interface AWSAutoScalingLifecycleHookSpecification

Swift

class AWSAutoScalingLifecycleHookSpecification


                    
                    
                    AWSAutoScalingLoadBalancerState

Describes the state of a Classic Load Balancer.

If you specify a load balancer when creating the Auto Scaling group, the state of the load balancer is InService.

If you attach a load balancer to an existing Auto Scaling group, the initial state is Adding. The state transitions to Added after all instances in the group are registered with the load balancer. If Elastic Load Balancing health checks are enabled for the load balancer, the state transitions to InService after at least one instance in the group passes the health check. If EC2 health checks are enabled instead, the load balancer remains in the Added state.

Declaration

Objective-C

@interface AWSAutoScalingLoadBalancerState

Swift

class AWSAutoScalingLoadBalancerState


                    
                    
                    AWSAutoScalingLoadBalancerTargetGroupState

Describes the state of a target group.

If you attach a target group to an existing Auto Scaling group, the initial state 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, the state transitions to InService after at least one Auto Scaling instance passes the health check. If EC2 health checks are enabled instead, the target group remains in the Added state.

Declaration

Objective-C

@interface AWSAutoScalingLoadBalancerTargetGroupState

Swift

class AWSAutoScalingLoadBalancerTargetGroupState


                    
                    
                    AWSAutoScalingLoadForecast

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.

Required parameters: [Timestamps, Values, MetricSpecification]

Declaration

Objective-C

@interface AWSAutoScalingLoadForecast

Swift

class AWSAutoScalingLoadForecast


                    
                    
                    AWSAutoScalingMetricCollectionType

Describes a metric.

Declaration

Objective-C

@interface AWSAutoScalingMetricCollectionType

Swift

class AWSAutoScalingMetricCollectionType


                    
                    
                    AWSAutoScalingMetricDimension

Describes the dimension of a metric.

Required parameters: [Name, Value]

Declaration

Objective-C

@interface AWSAutoScalingMetricDimension

Swift

class AWSAutoScalingMetricDimension


                    
                    
                    AWSAutoScalingMetricGranularityType

Describes a granularity of a metric.

Declaration

Objective-C

@interface AWSAutoScalingMetricGranularityType

Swift

class AWSAutoScalingMetricGranularityType


                    
                    
                    AWSAutoScalingMixedInstancesPolicy

Describes a mixed instances policy for an Auto Scaling group. With mixed instances, your Auto Scaling group can provision a combination of On-Demand Instances and Spot Instances across multiple instance types. For more information, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide.

You can create a mixed instances policy for a new Auto Scaling group, or you can create it for an existing group by updating the group to specify MixedInstancesPolicy as the top-level property instead of a launch configuration or launch template.

Declaration

Objective-C

@interface AWSAutoScalingMixedInstancesPolicy

Swift

class AWSAutoScalingMixedInstancesPolicy


                    
                    
                    AWSAutoScalingNotificationConfiguration

Describes a notification.

Declaration

Objective-C

@interface AWSAutoScalingNotificationConfiguration

Swift

class AWSAutoScalingNotificationConfiguration


                    
                    
                    AWSAutoScalingPoliciesType

Declaration

Objective-C

@interface AWSAutoScalingPoliciesType

Swift

class AWSAutoScalingPoliciesType


                    
                    
                    AWSAutoScalingPolicyARNType

Contains the output of PutScalingPolicy.

Declaration

Objective-C

@interface AWSAutoScalingPolicyARNType

Swift

class AWSAutoScalingPolicyARNType


                    
                    
                    AWSAutoScalingPredefinedMetricSpecification

Represents a predefined metric for a target tracking scaling policy to use with Amazon EC2 Auto Scaling.

Required parameters: [PredefinedMetricType]

Declaration

Objective-C

@interface AWSAutoScalingPredefinedMetricSpecification

Swift

class AWSAutoScalingPredefinedMetricSpecification


                    
                    
                    AWSAutoScalingPredictiveScalingConfiguration

Represents a predictive scaling policy configuration to use with Amazon EC2 Auto Scaling.

Required parameters: [MetricSpecifications]

Declaration

Objective-C

@interface AWSAutoScalingPredictiveScalingConfiguration

Swift

class AWSAutoScalingPredictiveScalingConfiguration


                    
                    
                    AWSAutoScalingPredictiveScalingMetricSpecification

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.

Required parameters: [TargetValue]

Declaration

Objective-C

@interface AWSAutoScalingPredictiveScalingMetricSpecification

Swift

class AWSAutoScalingPredictiveScalingMetricSpecification


                    
                    
                    AWSAutoScalingPredictiveScalingPredefinedLoadMetric

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.

Required parameters: [PredefinedMetricType]

Declaration

Objective-C

@interface AWSAutoScalingPredictiveScalingPredefinedLoadMetric

Swift

class AWSAutoScalingPredictiveScalingPredefinedLoadMetric


                    
                    
                    AWSAutoScalingPredictiveScalingPredefinedMetricPair

Represents a metric pair for a predictive scaling policy.

Required parameters: [PredefinedMetricType]

Declaration

Objective-C

@interface AWSAutoScalingPredictiveScalingPredefinedMetricPair

Swift

class AWSAutoScalingPredictiveScalingPredefinedMetricPair


                    
                    
                    AWSAutoScalingPredictiveScalingPredefinedScalingMetric

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.

Required parameters: [PredefinedMetricType]

Declaration

Objective-C

@interface AWSAutoScalingPredictiveScalingPredefinedScalingMetric

Swift

class AWSAutoScalingPredictiveScalingPredefinedScalingMetric


                    
                    
                    AWSAutoScalingProcessType

Describes a process type.

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

Required parameters: [ProcessName]

Declaration

Objective-C

@interface AWSAutoScalingProcessType

Swift

class AWSAutoScalingProcessType


                    
                    
                    AWSAutoScalingProcessesType

Declaration

Objective-C

@interface AWSAutoScalingProcessesType

Swift

class AWSAutoScalingProcessesType


                    
                    
                    AWSAutoScalingPutLifecycleHookAnswer

Declaration

Objective-C

@interface AWSAutoScalingPutLifecycleHookAnswer

Swift

class AWSAutoScalingPutLifecycleHookAnswer


                    
                    
                    AWSAutoScalingPutLifecycleHookType

Declaration

Objective-C

@interface AWSAutoScalingPutLifecycleHookType

Swift

class AWSAutoScalingPutLifecycleHookType


                    
                    
                    AWSAutoScalingPutNotificationConfigurationType

Declaration

Objective-C

@interface AWSAutoScalingPutNotificationConfigurationType

Swift

class AWSAutoScalingPutNotificationConfigurationType


                    
                    
                    AWSAutoScalingPutScalingPolicyType

Declaration

Objective-C

@interface AWSAutoScalingPutScalingPolicyType

Swift

class AWSAutoScalingPutScalingPolicyType


                    
                    
                    AWSAutoScalingPutScheduledUpdateGroupActionType

Declaration

Objective-C

@interface AWSAutoScalingPutScheduledUpdateGroupActionType

Swift

class AWSAutoScalingPutScheduledUpdateGroupActionType


                    
                    
                    AWSAutoScalingPutWarmPoolAnswer

Declaration

Objective-C

@interface AWSAutoScalingPutWarmPoolAnswer

Swift

class AWSAutoScalingPutWarmPoolAnswer


                    
                    
                    AWSAutoScalingPutWarmPoolType

Declaration

Objective-C

@interface AWSAutoScalingPutWarmPoolType

Swift

class AWSAutoScalingPutWarmPoolType


                    
                    
                    AWSAutoScalingRecordLifecycleActionHeartbeatAnswer

Declaration

Objective-C

@interface AWSAutoScalingRecordLifecycleActionHeartbeatAnswer

Swift

class AWSAutoScalingRecordLifecycleActionHeartbeatAnswer


                    
                    
                    AWSAutoScalingRecordLifecycleActionHeartbeatType

Declaration

Objective-C

@interface AWSAutoScalingRecordLifecycleActionHeartbeatType

Swift

class AWSAutoScalingRecordLifecycleActionHeartbeatType


                    
                    
                    AWSAutoScalingRefreshPreferences

Describes information used to start an instance refresh.

All properties are optional. However, if you specify a value for CheckpointDelay, you must also provide a value for CheckpointPercentages.

Declaration

Objective-C

@interface AWSAutoScalingRefreshPreferences

Swift

class AWSAutoScalingRefreshPreferences


                    
                    
                    AWSAutoScalingScalingPolicy

Describes a scaling policy.

Declaration

Objective-C

@interface AWSAutoScalingScalingPolicy

Swift

class AWSAutoScalingScalingPolicy


                    
                    
                    AWSAutoScalingScalingProcessQuery

Declaration

Objective-C

@interface AWSAutoScalingScalingProcessQuery

Swift

class AWSAutoScalingScalingProcessQuery


                    
                    
                    AWSAutoScalingScheduledActionsType

Declaration

Objective-C

@interface AWSAutoScalingScheduledActionsType

Swift

class AWSAutoScalingScheduledActionsType


                    
                    
                    AWSAutoScalingScheduledUpdateGroupAction

Describes a scheduled scaling action.

Declaration

Objective-C

@interface AWSAutoScalingScheduledUpdateGroupAction

Swift

class AWSAutoScalingScheduledUpdateGroupAction


                    
                    
                    AWSAutoScalingScheduledUpdateGroupActionRequest

Describes information used for one or more scheduled scaling action updates in a BatchPutScheduledUpdateGroupAction operation.

Required parameters: [ScheduledActionName]

Declaration

Objective-C

@interface AWSAutoScalingScheduledUpdateGroupActionRequest

Swift

class AWSAutoScalingScheduledUpdateGroupActionRequest


                    
                    
                    AWSAutoScalingSetDesiredCapacityType

Declaration

Objective-C

@interface AWSAutoScalingSetDesiredCapacityType

Swift

class AWSAutoScalingSetDesiredCapacityType


                    
                    
                    AWSAutoScalingSetInstanceHealthQuery

Declaration

Objective-C

@interface AWSAutoScalingSetInstanceHealthQuery

Swift

class AWSAutoScalingSetInstanceHealthQuery


                    
                    
                    AWSAutoScalingSetInstanceProtectionAnswer

Declaration

Objective-C

@interface AWSAutoScalingSetInstanceProtectionAnswer

Swift

class AWSAutoScalingSetInstanceProtectionAnswer


                    
                    
                    AWSAutoScalingSetInstanceProtectionQuery

Declaration

Objective-C

@interface AWSAutoScalingSetInstanceProtectionQuery

Swift

class AWSAutoScalingSetInstanceProtectionQuery


                    
                    
                    AWSAutoScalingStartInstanceRefreshAnswer

Declaration

Objective-C

@interface AWSAutoScalingStartInstanceRefreshAnswer

Swift

class AWSAutoScalingStartInstanceRefreshAnswer


                    
                    
                    AWSAutoScalingStartInstanceRefreshType

Declaration

Objective-C

@interface AWSAutoScalingStartInstanceRefreshType

Swift

class AWSAutoScalingStartInstanceRefreshType


                    
                    
                    AWSAutoScalingStepAdjustment

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

Required parameters: [ScalingAdjustment]

Declaration

Objective-C

@interface AWSAutoScalingStepAdjustment

Swift

class AWSAutoScalingStepAdjustment


                    
                    
                    AWSAutoScalingSuspendedProcess

Describes an auto scaling process that has been suspended.

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

Declaration

Objective-C

@interface AWSAutoScalingSuspendedProcess

Swift

class AWSAutoScalingSuspendedProcess


                    
                    
                    AWSAutoScalingTag

Describes a tag for an Auto Scaling group.

Required parameters: [Key]

Declaration

Objective-C

@interface AWSAutoScalingTag

Swift

class AWSAutoScalingTag


                    
                    
                    AWSAutoScalingTagDescription

Describes a tag for an Auto Scaling group.

Declaration

Objective-C

@interface AWSAutoScalingTagDescription

Swift

class AWSAutoScalingTagDescription


                    
                    
                    AWSAutoScalingTagsType

Declaration

Objective-C

@interface AWSAutoScalingTagsType

Swift

class AWSAutoScalingTagsType


                    
                    
                    AWSAutoScalingTargetTrackingConfiguration

Represents a target tracking scaling policy configuration to use with Amazon EC2 Auto Scaling.

Required parameters: [TargetValue]

Declaration

Objective-C

@interface AWSAutoScalingTargetTrackingConfiguration

Swift

class AWSAutoScalingTargetTrackingConfiguration


                    
                    
                    AWSAutoScalingTerminateInstanceInAutoScalingGroupType

Declaration

Objective-C

@interface AWSAutoScalingTerminateInstanceInAutoScalingGroupType

Swift

class AWSAutoScalingTerminateInstanceInAutoScalingGroupType


                    
                    
                    AWSAutoScalingUpdateAutoScalingGroupType

Declaration

Objective-C

@interface AWSAutoScalingUpdateAutoScalingGroupType

Swift

class AWSAutoScalingUpdateAutoScalingGroupType


                    
                    
                    AWSAutoScalingWarmPoolConfiguration

Describes a warm pool configuration.

Declaration

Objective-C

@interface AWSAutoScalingWarmPoolConfiguration

Swift

class AWSAutoScalingWarmPoolConfiguration


                    
                    
                    AWSAutoScalingResources

Undocumented

Declaration

Objective-C

@interface AWSAutoScalingResources : NSObject

+ (instancetype)sharedInstance;

- (NSDictionary *)JSONObject;

@end

Swift

class AWSAutoScalingResources : NSObject


                    
                    
                    AWSAutoScaling

Amazon EC2 Auto Scaling

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

For more information about Amazon EC2 Auto Scaling, see the Amazon EC2 Auto Scaling User Guide. For information about granting IAM users required permissions for calls to Amazon EC2 Auto Scaling, see Granting IAM users required permissions for Amazon EC2 Auto Scaling resources in the Amazon EC2 Auto Scaling API Reference.

Declaration

Objective-C

@interface AWSAutoScaling

Swift

class AWSAutoScaling