{ "smithy": "2.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.autoscaling#AcceleratorCountRequest": { "type": "structure", "members": { "Min": { "target": "com.amazonaws.autoscaling#NullablePositiveInteger", "traits": { "smithy.api#documentation": "
The minimum value.
" } }, "Max": { "target": "com.amazonaws.autoscaling#NullablePositiveInteger", "traits": { "smithy.api#documentation": "The maximum value.
" } } }, "traits": { "smithy.api#documentation": "Specifies the minimum and maximum for the AcceleratorCount object when\n you specify InstanceRequirements for an Auto Scaling group.
The memory minimum in MiB.
" } }, "Max": { "target": "com.amazonaws.autoscaling#NullablePositiveInteger", "traits": { "smithy.api#documentation": "The memory maximum in MiB.
" } } }, "traits": { "smithy.api#documentation": "Specifies the minimum and maximum for the AcceleratorTotalMemoryMiB\n object when you specify InstanceRequirements for an Auto Scaling group.
\n The name of the account setting. Each account setting has a unique name that identifies the specific feature it controls.\n
" } }, "Value": { "target": "com.amazonaws.autoscaling#AsciiStringMaxLen255", "traits": { "smithy.api#documentation": "\n The current value of the account setting.\n
" } }, "EnforcementType": { "target": "com.amazonaws.autoscaling#AsciiStringMaxLen255", "traits": { "smithy.api#documentation": "\n The type of enforcement for the account setting. Valid values include: hard (the setting has a hard enforcement date after which the setting will be enforced and cannot be modified), flexible (the setting has a flexible enforcement where you can always modify the setting value), and none (the setting has no enforcement and can always be modified).\n
\n The date when the account setting will be enforced. After this date, for settings with hard enforcement type, you can no longer modify the setting value. This parameter is only returned for settings with hard or flexible enforcement types.\n
" } }, "DefaultValue": { "target": "com.amazonaws.autoscaling#AsciiStringMaxLen255", "traits": { "smithy.api#documentation": "\n The default value of the account setting before the enforcement date. Valid values are enabled and disabled. This parameter is only returned for settings with hard or flexible enforcement types.\n
" } }, "EnforcedValue": { "target": "com.amazonaws.autoscaling#AsciiStringMaxLen255", "traits": { "smithy.api#documentation": "\n The value that will be enforced after the enforcement date. Valid values are enabled and disabled. This parameter is only returned for settings with hard or flexible enforcement types.\n
" } } }, "traits": { "smithy.api#documentation": "\n Describes an account setting for Amazon EC2 Auto Scaling. Account settings control how certain features behave for your account. Some settings can be enforced after a specified date, meaning that after the enforcement date, you can no longer modify the setting.\n
" } }, "com.amazonaws.autoscaling#AccountSettings": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#AccountSetting" } }, "com.amazonaws.autoscaling#ActiveInstanceRefreshNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" } }, "traits": { "aws.protocols#awsQueryError": { "code": "ActiveInstanceRefreshNotFound", "httpResponseCode": 400 }, "smithy.api#documentation": "The request failed because an active instance refresh or rollback for the specified\n Auto Scaling group was not found.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.autoscaling#Activities": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#Activity" } }, "com.amazonaws.autoscaling#ActivitiesType": { "type": "structure", "members": { "Activities": { "target": "com.amazonaws.autoscaling#Activities", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The scaling activities. Activities are sorted by start time. Activities still in\n progress are described first.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { "smithy.api#documentation": "A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.
The ID of the activity.
", "smithy.api#required": {} } }, "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { "smithy.api#documentation": "A friendly, more verbose description of the activity.
" } }, "Cause": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The reason the activity began.
", "smithy.api#required": {} } }, "StartTime": { "target": "com.amazonaws.autoscaling#TimestampType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The start time of the activity.
", "smithy.api#required": {} } }, "EndTime": { "target": "com.amazonaws.autoscaling#TimestampType", "traits": { "smithy.api#documentation": "The end time of the activity.
" } }, "StatusCode": { "target": "com.amazonaws.autoscaling#ScalingActivityStatusCode", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The current status of the activity.
", "smithy.api#required": {} } }, "StatusMessage": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "A friendly, more verbose description of the activity status.
" } }, "Progress": { "target": "com.amazonaws.autoscaling#Progress", "traits": { "smithy.api#documentation": "A value between 0 and 100 that indicates the progress of the activity.
" } }, "Details": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { "smithy.api#documentation": "The details about the activity.
" } }, "AutoScalingGroupState": { "target": "com.amazonaws.autoscaling#AutoScalingGroupState", "traits": { "smithy.api#documentation": "The state of the Auto Scaling group, which is either InService or\n Deleted.
The Amazon Resource Name (ARN) of the Auto Scaling group.
" } } }, "traits": { "smithy.api#documentation": "Describes scaling activity, which is a long-running process that represents a change\n to your Auto Scaling group, such as changing its size or replacing an instance.
" } }, "com.amazonaws.autoscaling#ActivityIds": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#XmlString" } }, "com.amazonaws.autoscaling#ActivityType": { "type": "structure", "members": { "Activity": { "target": "com.amazonaws.autoscaling#Activity", "traits": { "smithy.api#documentation": "A scaling activity.
" } }, "Activities": { "target": "com.amazonaws.autoscaling#Activities", "traits": { "smithy.api#documentation": "The scaling activities related to terminating the instances from the Auto Scaling group.
" } } } }, "com.amazonaws.autoscaling#AdjustmentType": { "type": "structure", "members": { "AdjustmentType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The policy adjustment type. The valid values are ChangeInCapacity,\n ExactCapacity, and PercentChangeInCapacity.
Describes a policy adjustment type.
" } }, "com.amazonaws.autoscaling#AdjustmentTypes": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#AdjustmentType" } }, "com.amazonaws.autoscaling#Alarm": { "type": "structure", "members": { "AlarmName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The name of the alarm.
" } }, "AlarmARN": { "target": "com.amazonaws.autoscaling#ResourceName", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the alarm.
" } } }, "traits": { "smithy.api#documentation": "Describes an alarm.
" } }, "com.amazonaws.autoscaling#AlarmList": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" } }, "com.amazonaws.autoscaling#AlarmSpecification": { "type": "structure", "members": { "Alarms": { "target": "com.amazonaws.autoscaling#AlarmList", "traits": { "smithy.api#documentation": "The names of one or more CloudWatch alarms to monitor for the instance refresh. You can\n specify up to 10 alarms.
" } } }, "traits": { "smithy.api#documentation": "Specifies the CloudWatch alarm specification to use in an instance refresh.
" } }, "com.amazonaws.autoscaling#Alarms": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#Alarm" } }, "com.amazonaws.autoscaling#AllowedInstanceType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 30 }, "smithy.api#pattern": "^[a-zA-Z0-9\\.\\*\\-]+$" } }, "com.amazonaws.autoscaling#AllowedInstanceTypes": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#AllowedInstanceType" }, "traits": { "smithy.api#length": { "min": 0, "max": 400 } } }, "com.amazonaws.autoscaling#AlreadyExistsFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "AlreadyExists", "httpResponseCode": 400 }, "smithy.api#documentation": "You already have an Auto Scaling group or launch configuration with this name.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.autoscaling#AnyPrintableAsciiStringMaxLen4000": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 4000 }, "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u007e]+$" } }, "com.amazonaws.autoscaling#AsciiStringMaxLen255": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^[A-Za-z0-9\\-_\\/]+$" } }, "com.amazonaws.autoscaling#AssociatePublicIpAddress": { "type": "boolean" }, "com.amazonaws.autoscaling#AttachInstances": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#AttachInstancesQuery" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" }, { "target": "com.amazonaws.autoscaling#ServiceLinkedRoleFailure" } ], "traits": { "smithy.api#documentation": "Attaches one or more EC2 instances to the specified Auto Scaling group.
\nWhen you attach instances, Amazon EC2 Auto Scaling increases the desired capacity of the group by the\n number of instances being attached. If the number of instances being attached plus the\n desired capacity of the group exceeds the maximum size of the group, the operation\n fails.
\nIf there is a Classic Load Balancer attached to your Auto Scaling group, the instances are\n also registered with the load balancer. If there are target groups attached to your Auto Scaling\n group, the instances are also registered with the target groups.
\nFor more information, see Detach\n or attach instances in the Amazon EC2 Auto Scaling User Guide.
", "smithy.api#examples": [ { "title": "To attach an instance to an Auto Scaling group", "documentation": "This example attaches the specified instance to the specified Auto Scaling group.", "input": { "InstanceIds": [ "i-93633f9b" ], "AutoScalingGroupName": "my-auto-scaling-group" } } ] } }, "com.amazonaws.autoscaling#AttachInstancesQuery": { "type": "structure", "members": { "InstanceIds": { "target": "com.amazonaws.autoscaling#InstanceIds", "traits": { "smithy.api#documentation": "The IDs of the instances. You can specify up to 20 instances.
" } }, "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } } } }, "com.amazonaws.autoscaling#AttachLoadBalancerTargetGroups": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#AttachLoadBalancerTargetGroupsType" }, "output": { "target": "com.amazonaws.autoscaling#AttachLoadBalancerTargetGroupsResultType" }, "errors": [ { "target": "com.amazonaws.autoscaling#InstanceRefreshInProgressFault" }, { "target": "com.amazonaws.autoscaling#ResourceContentionFault" }, { "target": "com.amazonaws.autoscaling#ServiceLinkedRoleFailure" } ], "traits": { "smithy.api#documentation": "This API operation is superseded by AttachTrafficSources, which\n can attach multiple traffic sources types. We recommend using\n AttachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support AttachLoadBalancerTargetGroups. You can\n use both the original AttachLoadBalancerTargetGroups API operation and\n AttachTrafficSources on the same Auto Scaling group.
Attaches one or more target groups to the specified Auto Scaling group.
\nThis operation is used with the following load balancer types:
\nApplication Load Balancer - Operates at the application layer (layer 7) and supports HTTP and\n HTTPS.
\nNetwork Load Balancer - Operates at the transport layer (layer 4) and supports TCP, TLS, and\n UDP.
\nGateway Load Balancer - Operates at the network layer (layer 3).
\nTo describe the target groups for an Auto Scaling group, call the DescribeLoadBalancerTargetGroups\n API. To detach the target group from\n the Auto Scaling group, call the DetachLoadBalancerTargetGroups API.
\nThis operation is additive and does not detach existing target groups or Classic Load\n Balancers from the Auto Scaling group.
\nFor more information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
", "smithy.api#examples": [ { "title": "To attach a target group to an Auto Scaling group", "documentation": "This example attaches the specified target group to the specified Auto Scaling group.", "input": { "AutoScalingGroupName": "my-auto-scaling-group", "TargetGroupARNs": [ "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" ] } } ] } }, "com.amazonaws.autoscaling#AttachLoadBalancerTargetGroupsResultType": { "type": "structure", "members": {} }, "com.amazonaws.autoscaling#AttachLoadBalancerTargetGroupsType": { "type": "structure", "members": { "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } }, "TargetGroupARNs": { "target": "com.amazonaws.autoscaling#TargetGroupARNs", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the target groups. You can specify up to 10 target\n groups. To get the ARN of a target group, use the Elastic Load Balancing DescribeTargetGroups API operation.
", "smithy.api#required": {} } } } }, "com.amazonaws.autoscaling#AttachLoadBalancers": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#AttachLoadBalancersType" }, "output": { "target": "com.amazonaws.autoscaling#AttachLoadBalancersResultType" }, "errors": [ { "target": "com.amazonaws.autoscaling#InstanceRefreshInProgressFault" }, { "target": "com.amazonaws.autoscaling#ResourceContentionFault" }, { "target": "com.amazonaws.autoscaling#ServiceLinkedRoleFailure" } ], "traits": { "smithy.api#documentation": "This API operation is superseded by AttachTrafficSources, which\n can attach multiple traffic sources types. We recommend using\n AttachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support AttachLoadBalancers. You can use both\n the original AttachLoadBalancers API operation and\n 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\n running instances with these Classic Load Balancers.
\nTo describe the load balancers for an Auto Scaling group, call the DescribeLoadBalancers API.\n To detach a load balancer from the Auto Scaling group, call the DetachLoadBalancers\n API.
\nThis operation is additive and does not detach existing Classic Load Balancers or\n target groups from the Auto Scaling group.
\nFor more information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
", "smithy.api#examples": [ { "title": "To attach a load balancer to an Auto Scaling group", "documentation": "This example attaches the specified load balancer to the specified Auto Scaling group.", "input": { "AutoScalingGroupName": "my-auto-scaling-group", "LoadBalancerNames": [ "my-load-balancer" ] } } ] } }, "com.amazonaws.autoscaling#AttachLoadBalancersResultType": { "type": "structure", "members": {} }, "com.amazonaws.autoscaling#AttachLoadBalancersType": { "type": "structure", "members": { "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } }, "LoadBalancerNames": { "target": "com.amazonaws.autoscaling#LoadBalancerNames", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The names of the load balancers. You can specify up to 10 load balancers.
", "smithy.api#required": {} } } } }, "com.amazonaws.autoscaling#AttachTrafficSources": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#AttachTrafficSourcesType" }, "output": { "target": "com.amazonaws.autoscaling#AttachTrafficSourcesResultType" }, "errors": [ { "target": "com.amazonaws.autoscaling#InstanceRefreshInProgressFault" }, { "target": "com.amazonaws.autoscaling#ResourceContentionFault" }, { "target": "com.amazonaws.autoscaling#ServiceLinkedRoleFailure" } ], "traits": { "smithy.api#documentation": "Attaches one or more traffic sources to the specified Auto Scaling group.
\nYou can use any of the following as traffic sources for an Auto Scaling group:
\nApplication Load Balancer
\nClassic Load Balancer
\nGateway Load Balancer
\nNetwork Load Balancer
\nVPC Lattice
\nThis operation is additive and does not detach existing traffic sources from the Auto Scaling\n group.
\nAfter the operation completes, use the DescribeTrafficSources API to\n return details about the state of the attachments between traffic sources and your Auto Scaling\n group. To detach a traffic source from the Auto Scaling group, call the \n DetachTrafficSources API.
", "smithy.api#examples": [ { "title": "To attach a target group to an Auto Scaling group", "documentation": "This example attaches the specified target group to the specified Auto Scaling group.", "input": { "AutoScalingGroupName": "my-auto-scaling-group", "TrafficSources": [ { "Identifier": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" } ] }, "output": {} } ] } }, "com.amazonaws.autoscaling#AttachTrafficSourcesResultType": { "type": "structure", "members": {} }, "com.amazonaws.autoscaling#AttachTrafficSourcesType": { "type": "structure", "members": { "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } }, "TrafficSources": { "target": "com.amazonaws.autoscaling#TrafficSources", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The unique identifiers of one or more traffic sources. You can specify up to 10\n traffic sources.
", "smithy.api#required": {} } }, "SkipZonalShiftValidation": { "target": "com.amazonaws.autoscaling#SkipZonalShiftValidation", "traits": { "smithy.api#documentation": "\n If you enable zonal shift with cross-zone disabled load balancers, capacity could become imbalanced across Availability Zones. To skip the validation, specify true. For more information, see\n Auto Scaling group zonal shift in the Amazon EC2 Auto Scaling User Guide.\n
The name of the Auto Scaling group.
", "smithy.api#required": {} } }, "AutoScalingGroupARN": { "target": "com.amazonaws.autoscaling#ResourceName", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Auto Scaling group.
" } }, "LaunchConfigurationName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The name of the associated launch configuration for the Auto Scaling group.
" } }, "LaunchTemplate": { "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", "traits": { "smithy.api#documentation": "The launch template for the Auto Scaling group.
" } }, "MixedInstancesPolicy": { "target": "com.amazonaws.autoscaling#MixedInstancesPolicy", "traits": { "smithy.api#documentation": "The mixed instances policy for the group.
" } }, "MinSize": { "target": "com.amazonaws.autoscaling#AutoScalingGroupMinSize", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The minimum size of the Auto Scaling group.
", "smithy.api#required": {} } }, "MaxSize": { "target": "com.amazonaws.autoscaling#AutoScalingGroupMaxSize", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The maximum size of the Auto Scaling group.
", "smithy.api#required": {} } }, "DesiredCapacity": { "target": "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The desired size of the Auto Scaling group.
", "smithy.api#required": {} } }, "PredictedCapacity": { "target": "com.amazonaws.autoscaling#AutoScalingGroupPredictedCapacity", "traits": { "smithy.api#documentation": "The predicted capacity of the group when it has a predictive scaling policy.
" } }, "DefaultCooldown": { "target": "com.amazonaws.autoscaling#Cooldown", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The duration of the default cooldown period, in seconds, for the Auto Scaling group.
", "smithy.api#required": {} } }, "AvailabilityZones": { "target": "com.amazonaws.autoscaling#AvailabilityZones", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "One or more Availability Zones for the Auto Scaling group.
", "smithy.api#required": {} } }, "AvailabilityZoneIds": { "target": "com.amazonaws.autoscaling#AvailabilityZoneIds", "traits": { "smithy.api#documentation": "\n The Availability Zone IDs where the Auto Scaling group can launch instances.\n
" } }, "LoadBalancerNames": { "target": "com.amazonaws.autoscaling#LoadBalancerNames", "traits": { "smithy.api#documentation": "One or more load balancers associated with the group.
" } }, "TargetGroupARNs": { "target": "com.amazonaws.autoscaling#TargetGroupARNs", "traits": { "smithy.api#documentation": "The Amazon Resource Names (ARN) of the target groups for your load balancer.
" } }, "HealthCheckType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "One or more comma-separated health check types for the Auto Scaling group.
", "smithy.api#required": {} } }, "HealthCheckGracePeriod": { "target": "com.amazonaws.autoscaling#HealthCheckGracePeriod", "traits": { "smithy.api#documentation": "The duration of the health check grace period, in seconds, for the Auto Scaling group.
" } }, "Instances": { "target": "com.amazonaws.autoscaling#Instances", "traits": { "smithy.api#documentation": "The EC2 instances associated with the Auto Scaling group.
" } }, "CreatedTime": { "target": "com.amazonaws.autoscaling#TimestampType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The date and time the Auto Scaling group was created.
", "smithy.api#required": {} } }, "SuspendedProcesses": { "target": "com.amazonaws.autoscaling#SuspendedProcesses", "traits": { "smithy.api#documentation": "The suspended processes associated with the Auto Scaling group.
" } }, "PlacementGroup": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The name of the placement group into which to launch EC2 instances for the Auto Scaling group.
" } }, "VPCZoneIdentifier": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen5000", "traits": { "smithy.api#documentation": "One or more comma-separated subnet IDs for the Auto Scaling group.
" } }, "EnabledMetrics": { "target": "com.amazonaws.autoscaling#EnabledMetrics", "traits": { "smithy.api#documentation": "The metrics enabled for the Auto Scaling group.
" } }, "Status": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The current state of the Auto Scaling group when the\n DeleteAutoScalingGroup\n operation is in progress.
" } }, "Tags": { "target": "com.amazonaws.autoscaling#TagDescriptionList", "traits": { "smithy.api#documentation": "The tags for the Auto Scaling group.
" } }, "TerminationPolicies": { "target": "com.amazonaws.autoscaling#TerminationPolicies", "traits": { "smithy.api#documentation": "The termination policies for the Auto Scaling group.
" } }, "NewInstancesProtectedFromScaleIn": { "target": "com.amazonaws.autoscaling#InstanceProtected", "traits": { "smithy.api#documentation": "Indicates whether newly launched EC2 instances are protected from termination when scaling in for the Auto Scaling group.
\n\n For more information about preventing instances from terminating on scale in, see\n Use instance scale-in protection\n in the Amazon EC2 Auto Scaling User Guide.\n
" } }, "ServiceLinkedRoleARN": { "target": "com.amazonaws.autoscaling#ResourceName", "traits": { "smithy.api#documentation": "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.
" } }, "MaxInstanceLifetime": { "target": "com.amazonaws.autoscaling#MaxInstanceLifetime", "traits": { "smithy.api#documentation": "The maximum amount of time, in seconds, that an EC2 instance can be in service for the Auto Scaling group.
" } }, "CapacityRebalance": { "target": "com.amazonaws.autoscaling#CapacityRebalanceEnabled", "traits": { "smithy.api#documentation": "Indicates whether Capacity Rebalancing is enabled.
" } }, "WarmPoolConfiguration": { "target": "com.amazonaws.autoscaling#WarmPoolConfiguration", "traits": { "smithy.api#documentation": "The warm pool for the group.
" } }, "WarmPoolSize": { "target": "com.amazonaws.autoscaling#WarmPoolSize", "traits": { "smithy.api#documentation": "The current size of the warm pool.
" } }, "Context": { "target": "com.amazonaws.autoscaling#Context", "traits": { "smithy.api#documentation": "Reserved.
" } }, "DesiredCapacityType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling\n supports DesiredCapacityType for attribute-based instance type selection\n only.
The duration of the default EC2 instance warmup time, in seconds, for the Auto Scaling group.
" } }, "TrafficSources": { "target": "com.amazonaws.autoscaling#TrafficSources", "traits": { "smithy.api#documentation": "The traffic sources associated with this Auto Scaling group.
" } }, "InstanceMaintenancePolicy": { "target": "com.amazonaws.autoscaling#InstanceMaintenancePolicy", "traits": { "smithy.api#documentation": "An instance maintenance policy.
" } }, "DeletionProtection": { "target": "com.amazonaws.autoscaling#DeletionProtection", "traits": { "smithy.api#documentation": "The deletion protection setting for the Auto Scaling group.
" } }, "AvailabilityZoneDistribution": { "target": "com.amazonaws.autoscaling#AvailabilityZoneDistribution", "traits": { "smithy.api#documentation": "The EC2 instance capacity distribution across Availability Zones for the Auto Scaling group.
" } }, "AvailabilityZoneImpairmentPolicy": { "target": "com.amazonaws.autoscaling#AvailabilityZoneImpairmentPolicy", "traits": { "smithy.api#documentation": "The Availability Zone impairment policy for the Auto Scaling group.
" } }, "CapacityReservationSpecification": { "target": "com.amazonaws.autoscaling#CapacityReservationSpecification", "traits": { "smithy.api#documentation": "The capacity reservation specification for the Auto Scaling group.
" } }, "InstanceLifecyclePolicy": { "target": "com.amazonaws.autoscaling#InstanceLifecyclePolicy", "traits": { "smithy.api#documentation": "The instance lifecycle policy for the Auto Scaling group.
" } }, "Operator": { "target": "com.amazonaws.autoscaling#Operator", "traits": { "smithy.api#documentation": "The entity that manages the Auto Scaling group, if applicable. When set, only the designated\n operator can make changes to the group configuration.
" } } }, "traits": { "smithy.api#documentation": "Describes an Auto Scaling group.
" } }, "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity": { "type": "integer" }, "com.amazonaws.autoscaling#AutoScalingGroupMaxSize": { "type": "integer" }, "com.amazonaws.autoscaling#AutoScalingGroupMinSize": { "type": "integer" }, "com.amazonaws.autoscaling#AutoScalingGroupNames": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" } }, "com.amazonaws.autoscaling#AutoScalingGroupNamesType": { "type": "structure", "members": { "AutoScalingGroupNames": { "target": "com.amazonaws.autoscaling#AutoScalingGroupNames", "traits": { "smithy.api#documentation": "The names of the Auto Scaling groups. By default, you can only specify up to 50 names. You can\n optionally increase this limit using the MaxRecords property.
If you omit this property, all Auto Scaling groups are described.
" } }, "IncludeInstances": { "target": "com.amazonaws.autoscaling#IncludeInstances", "traits": { "smithy.api#documentation": "\n Specifies whether to include information about Amazon EC2 instances in the response. When set to true (default), the response includes instance details.\n
\n Specifies whether to include managed Auto Scaling groups in the response. When set to true (default), the response includes managed Auto Scaling groups.\n
The token for the next set of items to return. (You received this token from a\n previous call.)
" } }, "MaxRecords": { "target": "com.amazonaws.autoscaling#MaxRecords", "traits": { "smithy.api#documentation": "The maximum number of items to return with this call. The default value is\n 50 and the maximum value is 100.
A response can contain fewer items than the value specified by MaxRecords, even when more items are available. To retrieve the additional items, use the NextToken value in a subsequent call rather than relying on the number of items in the response.
One or more filters to limit the results based on specific tags.\n
" } } } }, "com.amazonaws.autoscaling#AutoScalingGroupPredictedCapacity": { "type": "integer" }, "com.amazonaws.autoscaling#AutoScalingGroupState": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 32 } } }, "com.amazonaws.autoscaling#AutoScalingGroups": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#AutoScalingGroup" } }, "com.amazonaws.autoscaling#AutoScalingGroupsType": { "type": "structure", "members": { "AutoScalingGroups": { "target": "com.amazonaws.autoscaling#AutoScalingGroups", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The groups.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { "smithy.api#documentation": "A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.
The ID of the instance.
", "smithy.api#required": {} } }, "InstanceType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The instance type of the EC2 instance.
" } }, "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Auto Scaling group for the instance.
", "smithy.api#required": {} } }, "AvailabilityZone": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Availability Zone for the instance.
", "smithy.api#required": {} } }, "AvailabilityZoneId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "\n The Availability Zone ID where the instance is located.\n
" } }, "LifecycleState": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The lifecycle state for the instance. The Quarantined state is not used.\n For more information, see Amazon EC2 Auto Scaling instance\n lifecycle in the Amazon EC2 Auto Scaling User Guide.
Valid values: Pending | Pending:Wait |\n Pending:Proceed | Quarantined | InService |\n Terminating | Terminating:Wait |\n Terminating:Proceed | Terminating:Retained | Terminated | Detaching |\n Detached | EnteringStandby | Standby |\n ReplacingRootVolume | ReplacingRootVolume:Wait | ReplacingRootVolume:Proceed | RootVolumeReplaced |\n Warmed:Pending | Warmed:Pending:Wait |\n Warmed:Pending:Proceed | Warmed:Pending:Retained | Warmed:Terminating |\n Warmed:Terminating:Wait | Warmed:Terminating:Proceed | Warmed:Terminating:Retained |\n Warmed:Terminated | Warmed:Stopped |\n Warmed:Running | Warmed:Hibernated\n
The last reported health status of this instance. Healthy means that the\n instance is healthy and should remain in service. Unhealthy means that the\n instance is unhealthy and Amazon EC2 Auto Scaling should terminate and replace it.
The launch configuration used to launch the instance. This value is not available if\n you attached the instance to the Auto Scaling group.
" } }, "LaunchTemplate": { "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", "traits": { "smithy.api#documentation": "The launch template for the instance.
" } }, "ImageId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "\n The ID of the Amazon Machine Image (AMI) associated with the instance. This field shows the \n current AMI ID of the instance's root volume. It may differ from the original AMI used when \n the instance was first launched.\n
\n\n This field appears for:\n
\nInstances with root volume replacements through Instance Refresh
\nInstances launched with AMI overrides
\nThis field won't appear for:
\nExisting instances launched from Launch Templates without overrides
\nExisting instances that didn\u2019t have their root volume replaced through Instance Refresh
\nIndicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling\n in.
", "smithy.api#required": {} } }, "WeightedCapacity": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", "traits": { "smithy.api#documentation": "The number of capacity units contributed by the instance based on its instance\n type.
\nValid Range: Minimum value of 1. Maximum value of 999.
" } } }, "traits": { "smithy.api#documentation": "Describes an EC2 instance associated with an Auto Scaling group.
" } }, "com.amazonaws.autoscaling#AutoScalingInstances": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#AutoScalingInstanceDetails" } }, "com.amazonaws.autoscaling#AutoScalingInstancesType": { "type": "structure", "members": { "AutoScalingInstances": { "target": "com.amazonaws.autoscaling#AutoScalingInstances", "traits": { "smithy.api#documentation": "The instances.
" } }, "NextToken": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { "smithy.api#documentation": "A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.
The DescribeAutoScalingGroups API operation might be throttled when retrieving details for an Auto Scaling group that contains many instances. By default, this operation returns details for all instances in the group. \n To help prevent throttling, you can set the IncludeInstances parameter to false to exclude instance details from the response.
Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances\n based on user-defined scaling policies, scheduled actions, and health checks.
\nFor more information, see the Amazon EC2 Auto Scaling User Guide and the Amazon EC2 Auto Scaling API Reference.
", "smithy.api#title": "Auto Scaling", "smithy.api#xmlNamespace": { "uri": "http://autoscaling.amazonaws.com/doc/2011-01-01/" }, "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://autoscaling-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://autoscaling.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://autoscaling-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://autoscaling.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://autoscaling.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 14, "nodes": "/////wAAAAH/////AAAAAAAAAA0AAAADAAAAAQAAAAQF9eEMAAAAAgAAAAUF9eEMAAAAAwAAAAgAAAAGAAAABAAAAAcF9eELAAAABQX14QkF9eEKAAAABAAAAAsAAAAJAAAABgAAAAoF9eEIAAAABwX14QYF9eEHAAAABQAAAAwF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAAOAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://autoscaling-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] } ], "endpoint": { "url": "https://autoscaling.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://autoscaling-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://autoscaling.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://autoscaling.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://autoscaling.af-south-1.amazonaws.com" } }, "params": { "Region": "af-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://autoscaling.ap-east-1.amazonaws.com" } }, "params": { "Region": "ap-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://autoscaling.ap-northeast-1.amazonaws.com" } }, "params": { "Region": "ap-northeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://autoscaling.ap-northeast-2.amazonaws.com" } }, "params": { "Region": "ap-northeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://autoscaling.ap-northeast-3.amazonaws.com" } }, "params": { "Region": "ap-northeast-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://autoscaling.ap-south-1.amazonaws.com" } }, "params": { "Region": "ap-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://autoscaling.ap-southeast-1.amazonaws.com" } }, "params": { "Region": "ap-southeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://autoscaling.ap-southeast-2.amazonaws.com" } }, "params": { "Region": "ap-southeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://autoscaling.ap-southeast-3.amazonaws.com" } }, "params": { "Region": "ap-southeast-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://autoscaling.ca-central-1.amazonaws.com" } }, "params": { "Region": "ca-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://autoscaling.eu-central-1.amazonaws.com" } }, "params": { "Region": "eu-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://autoscaling.eu-north-1.amazonaws.com" } }, "params": { "Region": "eu-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://autoscaling.eu-south-1.amazonaws.com" } }, "params": { "Region": "eu-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://autoscaling.eu-west-1.amazonaws.com" } }, "params": { "Region": "eu-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://autoscaling.eu-west-2.amazonaws.com" } }, "params": { "Region": "eu-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://autoscaling.eu-west-3.amazonaws.com" } }, "params": { "Region": "eu-west-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://autoscaling.me-south-1.amazonaws.com" } }, "params": { "Region": "me-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://autoscaling.sa-east-1.amazonaws.com" } }, "params": { "Region": "sa-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://autoscaling.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://autoscaling.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://autoscaling.us-west-1.amazonaws.com" } }, "params": { "Region": "us-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://autoscaling.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://autoscaling-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://autoscaling-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://autoscaling.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://autoscaling.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://autoscaling.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://autoscaling-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://autoscaling-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://autoscaling.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://autoscaling.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://autoscaling.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://autoscaling-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://autoscaling.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://autoscaling.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://autoscaling.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://autoscaling.us-iso-west-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://autoscaling-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://autoscaling.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://autoscaling-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.autoscaling#AvailabilityZoneDistribution": { "type": "structure", "members": { "CapacityDistributionStrategy": { "target": "com.amazonaws.autoscaling#CapacityDistributionStrategy", "traits": { "smithy.api#documentation": "\n If launches fail in an Availability Zone, the following strategies are available. The default is balanced-best-effort.
\n balanced-only - If launches fail in an Availability Zone, Auto Scaling will continue to attempt to launch in the unhealthy zone to preserve a balanced distribution.
\n balanced-best-effort - If launches fail in an Availability Zone, Auto Scaling will attempt to launch in another healthy Availability Zone instead.
\n reservations-then-balanced - Auto Scaling will first attempt to launch into your Capacity Reservations, and then balance any remaining capacity across healthy Availability Zones.
\n Describes an Availability Zone distribution.\n
" } }, "com.amazonaws.autoscaling#AvailabilityZoneIds": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" } }, "com.amazonaws.autoscaling#AvailabilityZoneIdsLimit1": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" }, "traits": { "smithy.api#length": { "min": 0, "max": 1 } } }, "com.amazonaws.autoscaling#AvailabilityZoneImpairmentPolicy": { "type": "structure", "members": { "ZonalShiftEnabled": { "target": "com.amazonaws.autoscaling#ZonalShiftEnabled", "traits": { "smithy.api#documentation": "\n If true, enable zonal shift for your Auto Scaling group.\n
\n Specifies the health check behavior for the impaired Availability Zone in an active zonal shift. If you select Replace unhealthy, instances that appear unhealthy will be replaced in all Availability Zones. \n If you select Ignore unhealthy, instances will not be replaced in the Availability Zone with the active zonal shift. For more information, see Auto Scaling group zonal shift \n in the Amazon EC2 Auto Scaling User Guide.\n \n
\n Describes an Availability Zone impairment policy.\n
" } }, "com.amazonaws.autoscaling#AvailabilityZones": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" } }, "com.amazonaws.autoscaling#AvailabilityZonesLimit1": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" }, "traits": { "smithy.api#length": { "min": 0, "max": 1 } } }, "com.amazonaws.autoscaling#BakeTime": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 172800 } } }, "com.amazonaws.autoscaling#BareMetal": { "type": "enum", "members": { "INCLUDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "included" } }, "EXCLUDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "excluded" } }, "REQUIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "required" } } } }, "com.amazonaws.autoscaling#BaselineEbsBandwidthMbpsRequest": { "type": "structure", "members": { "Min": { "target": "com.amazonaws.autoscaling#NullablePositiveInteger", "traits": { "smithy.api#documentation": "The minimum value in Mbps.
" } }, "Max": { "target": "com.amazonaws.autoscaling#NullablePositiveInteger", "traits": { "smithy.api#documentation": "The maximum value in Mbps.
" } } }, "traits": { "smithy.api#documentation": "Specifies the minimum and maximum for the BaselineEbsBandwidthMbps object\n when you specify InstanceRequirements for an Auto Scaling group.
\n The CPU performance to consider, using an instance family as the baseline reference.\n
" } } }, "traits": { "smithy.api#documentation": "\n The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Auto Scaling uses\n this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application.\n
\nCurrently, this parameter only supports CPU performance as a baseline performance factor. For example, specifying c6i uses the CPU performance of the c6i\n family as the baseline reference.
Deletes one or more scheduled actions for the specified Auto Scaling group.
" } }, "com.amazonaws.autoscaling#BatchDeleteScheduledActionAnswer": { "type": "structure", "members": { "FailedScheduledActions": { "target": "com.amazonaws.autoscaling#FailedScheduledUpdateGroupActionRequests", "traits": { "smithy.api#documentation": "The names of the scheduled actions that could not be deleted, including an error\n message.
" } } } }, "com.amazonaws.autoscaling#BatchDeleteScheduledActionType": { "type": "structure", "members": { "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } }, "ScheduledActionNames": { "target": "com.amazonaws.autoscaling#ScheduledActionNames", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The names of the scheduled actions to delete. The maximum number allowed is 50.\n
", "smithy.api#required": {} } } } }, "com.amazonaws.autoscaling#BatchPutScheduledUpdateGroupAction": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#BatchPutScheduledUpdateGroupActionType" }, "output": { "target": "com.amazonaws.autoscaling#BatchPutScheduledUpdateGroupActionAnswer" }, "errors": [ { "target": "com.amazonaws.autoscaling#AlreadyExistsFault" }, { "target": "com.amazonaws.autoscaling#LimitExceededFault" }, { "target": "com.amazonaws.autoscaling#ResourceContentionFault" } ], "traits": { "smithy.api#documentation": "Creates or updates one or more scheduled scaling actions for an Auto Scaling group.
" } }, "com.amazonaws.autoscaling#BatchPutScheduledUpdateGroupActionAnswer": { "type": "structure", "members": { "FailedScheduledUpdateGroupActions": { "target": "com.amazonaws.autoscaling#FailedScheduledUpdateGroupActionRequests", "traits": { "smithy.api#documentation": "The names of the scheduled actions that could not be created or updated, including an\n error message.
" } } } }, "com.amazonaws.autoscaling#BatchPutScheduledUpdateGroupActionType": { "type": "structure", "members": { "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } }, "ScheduledUpdateGroupActions": { "target": "com.amazonaws.autoscaling#ScheduledUpdateGroupActionRequests", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "One or more scheduled actions. The maximum number allowed is 50.
", "smithy.api#required": {} } } } }, "com.amazonaws.autoscaling#BlockDeviceEbsDeleteOnTermination": { "type": "boolean" }, "com.amazonaws.autoscaling#BlockDeviceEbsEncrypted": { "type": "boolean" }, "com.amazonaws.autoscaling#BlockDeviceEbsIops": { "type": "integer", "traits": { "smithy.api#range": { "min": 100, "max": 20000 } } }, "com.amazonaws.autoscaling#BlockDeviceEbsThroughput": { "type": "integer", "traits": { "smithy.api#range": { "min": 125, "max": 1000 } } }, "com.amazonaws.autoscaling#BlockDeviceEbsVolumeSize": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 16384 } } }, "com.amazonaws.autoscaling#BlockDeviceEbsVolumeType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.autoscaling#BlockDeviceMapping": { "type": "structure", "members": { "VirtualName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The name of the instance store volume (virtual device) to attach to an instance at\n launch. The name must be in the form ephemeralX where\n X is a number starting from zero (0), for example,\n ephemeral0.
The device name assigned to the volume (for example, /dev/sdh or\n xvdh). For more information, see Device naming on Linux\n instances in the Amazon EC2 User Guide.
To define a block device mapping, set the device name and exactly one of the\n following properties: Ebs, NoDevice, or\n VirtualName.
Information to attach an EBS volume to an instance at launch.
" } }, "NoDevice": { "target": "com.amazonaws.autoscaling#NoDevice", "traits": { "smithy.api#documentation": "Setting this value to true prevents a volume that is included in the\n block device mapping of the AMI from being mapped to the specified device name at\n launch.
If NoDevice is true for the root device, instances might\n fail the EC2 health check. In that case, Amazon EC2 Auto Scaling launches replacement instances.
Describes a block device mapping.
" } }, "com.amazonaws.autoscaling#BlockDeviceMappings": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#BlockDeviceMapping" } }, "com.amazonaws.autoscaling#BooleanType": { "type": "boolean" }, "com.amazonaws.autoscaling#BurstablePerformance": { "type": "enum", "members": { "INCLUDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "included" } }, "EXCLUDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "excluded" } }, "REQUIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "required" } } } }, "com.amazonaws.autoscaling#CancelInstanceRefresh": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#CancelInstanceRefreshType" }, "output": { "target": "com.amazonaws.autoscaling#CancelInstanceRefreshAnswer" }, "errors": [ { "target": "com.amazonaws.autoscaling#ActiveInstanceRefreshNotFoundFault" }, { "target": "com.amazonaws.autoscaling#LimitExceededFault" }, { "target": "com.amazonaws.autoscaling#ResourceContentionFault" } ], "traits": { "smithy.api#documentation": "Cancels an instance refresh or rollback that is in progress. If an instance refresh or\n rollback is not in progress, an ActiveInstanceRefreshNotFound error\n occurs.
This operation is part of the instance refresh\n feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group\n after you make configuration changes.
\nWhen you cancel an instance refresh, this does not roll back any changes that it made.\n Use the RollbackInstanceRefresh API to roll back instead.
", "smithy.api#examples": [ { "title": "To cancel an instance refresh", "documentation": "This example cancels an instance refresh operation in progress.", "input": { "AutoScalingGroupName": "my-auto-scaling-group" }, "output": { "InstanceRefreshId": "08b91cf7-8fa6-48af-b6a6-d227f40f1b9b" } } ] } }, "com.amazonaws.autoscaling#CancelInstanceRefreshAnswer": { "type": "structure", "members": { "InstanceRefreshId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The instance refresh ID associated with the request. This is the unique ID assigned to\n the instance refresh when it was started.
" } } } }, "com.amazonaws.autoscaling#CancelInstanceRefreshType": { "type": "structure", "members": { "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } }, "WaitForTransitioningInstances": { "target": "com.amazonaws.autoscaling#BooleanType", "traits": { "smithy.api#documentation": "When cancelling an instance refresh, this indicates whether to wait for in-flight launches \n and terminations to complete. The default is true.
\nWhen set to false, Amazon EC2 Auto Scaling cancels the instance refresh \n without waiting for any pending launches or terminations to complete.
" } } } }, "com.amazonaws.autoscaling#CapacityDistributionStrategy": { "type": "enum", "members": { "BALANCED_ONLY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "balanced-only" } }, "BALANCED_BEST_EFFORT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "balanced-best-effort" } }, "RESERVATIONS_THEN_BALANCED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "reservations-then-balanced" } } } }, "com.amazonaws.autoscaling#CapacityForecast": { "type": "structure", "members": { "Timestamps": { "target": "com.amazonaws.autoscaling#PredictiveScalingForecastTimestamps", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The timestamps for the data points, in UTC format.
", "smithy.api#required": {} } }, "Values": { "target": "com.amazonaws.autoscaling#PredictiveScalingForecastValues", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The values of the data points.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A GetPredictiveScalingForecast call returns the capacity forecast for a\n predictive scaling policy. This structure includes the data points for that capacity\n forecast, along with the timestamps of those data points.
\n The capacity reservation preference. The following options are available:\n
\n\n capacity-reservations-only - Auto Scaling will only launch instances into a Capacity Reservation or Capacity Reservation resource group. If capacity isn't available, instances will fail to launch.
\n capacity-reservations-first - Auto Scaling will try to launch instances into a Capacity Reservation or Capacity Reservation resource group first. If capacity isn't available, instances will run in On-Demand capacity.
\n none - Auto Scaling will not launch instances into a Capacity Reservation. Instances will run in On-Demand capacity.
\n default - Auto Scaling uses the Capacity Reservation preference from your launch template or an open Capacity Reservation.
\n Describes a target Capacity Reservation or Capacity Reservation resource group.\n
" } } }, "traits": { "smithy.api#documentation": "\n Describes the Capacity Reservation preference and targeting options. If you specify open or none for CapacityReservationPreference, do not specify a CapacityReservationTarget.\n
\n The Capacity Reservation IDs to launch instances into.\n
" } }, "CapacityReservationResourceGroupArns": { "target": "com.amazonaws.autoscaling#CapacityReservationResourceGroupArns", "traits": { "smithy.api#documentation": "\n The resource group ARNs of the Capacity Reservation to launch instances into.\n
" } } }, "traits": { "smithy.api#documentation": "\n The target for the Capacity Reservation. Specify Capacity Reservations IDs or Capacity Reservation resource group ARNs. \n
" } }, "com.amazonaws.autoscaling#CheckpointDelay": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 172800 } } }, "com.amazonaws.autoscaling#CheckpointPercentages": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#NonZeroIntPercent" } }, "com.amazonaws.autoscaling#ClassicLinkVPCSecurityGroups": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" } }, "com.amazonaws.autoscaling#ClientToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[A-Za-z0-9\\-_\\/]+$" } }, "com.amazonaws.autoscaling#CompleteLifecycleAction": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#CompleteLifecycleActionType" }, "output": { "target": "com.amazonaws.autoscaling#CompleteLifecycleActionAnswer" }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" } ], "traits": { "smithy.api#documentation": "Completes the lifecycle action for the specified token or instance with the specified\n result.
\nThis step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:
\n(Optional) Create a launch template or launch configuration with a user data\n script that runs while an instance is in a wait state due to a lifecycle\n hook.
\n(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke\n your Lambda function when an instance is put into a wait state due to a\n lifecycle hook.
\n(Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish\n lifecycle notifications to the target.
\nCreate the lifecycle hook. Specify whether the hook is used when the instances\n launch or terminate.
\nIf you need more time, record the lifecycle action heartbeat to keep the\n instance in a wait state.
\n\n If you finish before the timeout period ends, send a\n callback by using the CompleteLifecycleAction API\n call.\n
\nFor more information, see Complete a lifecycle\n action in the Amazon EC2 Auto Scaling User Guide.
", "smithy.api#examples": [ { "title": "To complete the lifecycle action", "documentation": "This example notifies Auto Scaling that the specified lifecycle action is complete so that it can finish launching or terminating the instance.", "input": { "LifecycleHookName": "my-lifecycle-hook", "AutoScalingGroupName": "my-auto-scaling-group", "LifecycleActionToken": "bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635", "LifecycleActionResult": "CONTINUE" } } ] } }, "com.amazonaws.autoscaling#CompleteLifecycleActionAnswer": { "type": "structure", "members": {} }, "com.amazonaws.autoscaling#CompleteLifecycleActionType": { "type": "structure", "members": { "LifecycleHookName": { "target": "com.amazonaws.autoscaling#AsciiStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the lifecycle hook.
", "smithy.api#required": {} } }, "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#ResourceName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } }, "LifecycleActionToken": { "target": "com.amazonaws.autoscaling#LifecycleActionToken", "traits": { "smithy.api#documentation": "A universally unique identifier (UUID) that identifies a specific lifecycle action\n associated with an instance. Amazon EC2 Auto Scaling sends this token to the notification target you\n specified when you created the lifecycle hook.
" } }, "LifecycleActionResult": { "target": "com.amazonaws.autoscaling#LifecycleActionResult", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The action for the group to take. You can specify either CONTINUE or\n ABANDON.
The ID of the instance.
" } } } }, "com.amazonaws.autoscaling#Context": { "type": "string" }, "com.amazonaws.autoscaling#Cooldown": { "type": "integer" }, "com.amazonaws.autoscaling#CpuManufacturer": { "type": "enum", "members": { "INTEL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "intel" } }, "AMD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "amd" } }, "AMAZON_WEB_SERVICES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "amazon-web-services" } }, "APPLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "apple" } } } }, "com.amazonaws.autoscaling#CpuManufacturers": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#CpuManufacturer" } }, "com.amazonaws.autoscaling#CpuPerformanceFactorRequest": { "type": "structure", "members": { "References": { "target": "com.amazonaws.autoscaling#PerformanceFactorReferenceSetRequest", "traits": { "smithy.api#documentation": "\n Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the\n referenced instance family, regardless of CPU manufacturer or architecture differences.\n
\nCurrently only one instance family can be specified in the list.
\n\n The CPU performance to consider, using an instance family as the baseline reference.\n
" } }, "com.amazonaws.autoscaling#CreateAutoScalingGroup": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#CreateAutoScalingGroupType" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.autoscaling#AlreadyExistsFault" }, { "target": "com.amazonaws.autoscaling#LimitExceededFault" }, { "target": "com.amazonaws.autoscaling#ResourceContentionFault" }, { "target": "com.amazonaws.autoscaling#ServiceLinkedRoleFailure" } ], "traits": { "smithy.api#documentation": "\n We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.\n
\nCreates an Auto Scaling group with the specified name and attributes.
\nIf you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit,\n call the DescribeAccountLimits API. For information about updating\n this limit, see Quotas for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
\nIf you're new to Amazon EC2 Auto Scaling, see the introductory tutorials in Get started\n with Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
\nEvery Auto Scaling group has three size properties (DesiredCapacity,\n MaxSize, and MinSize). Usually, you set these sizes based\n on a specific number of instances. However, if you configure a mixed instances policy\n that defines weights for the instance types, you must specify these sizes with the same\n units that you use for weighting instances.
The name of the Auto Scaling group. This name must be unique per Region per account.
\nThe name can contain any ASCII character 33 to 126 including most punctuation\n characters, digits, and upper and lowercased letters.
\nYou cannot use a colon (:) in the name.
\nThe name of the launch configuration to use to launch instances.
\nConditional: You must specify either a launch template (LaunchTemplate or\n MixedInstancesPolicy) or a launch configuration\n (LaunchConfigurationName or InstanceId).
Information used to specify the launch template and version to use to launch\n instances.
\nConditional: You must specify either a launch template (LaunchTemplate or\n MixedInstancesPolicy) or a launch configuration\n (LaunchConfigurationName or InstanceId).
The launch template that is specified must be configured for use with an Auto Scaling\n group. For more information, see Create a launch\n template for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
\nThe mixed instances policy. For more information, see Auto Scaling\n groups with multiple instance types and purchase options in the\n Amazon EC2 Auto Scaling User Guide. To learn how to prioritize multiple capacity\n types, see Use Distribution\n Segments to target multiple capacity types in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "InstanceId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", "traits": { "smithy.api#documentation": "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\n new launch configuration. To get the instance ID, use the Amazon EC2 DescribeInstances API operation. For more information, see Create an Auto Scaling group using parameters from an existing instance in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "MinSize": { "target": "com.amazonaws.autoscaling#AutoScalingGroupMinSize", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The minimum size of the group.
", "smithy.api#required": {} } }, "MaxSize": { "target": "com.amazonaws.autoscaling#AutoScalingGroupMaxSize", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The maximum size of the group.
\nWith a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to\n go above MaxSize to meet your capacity requirements. In this event,\n Amazon EC2 Auto Scaling will never go above MaxSize by more than your largest instance\n weight (weights that define how many units each instance contributes to the desired\n capacity of the group).
The desired capacity is the initial capacity of the Auto Scaling group at the time of its\n creation and the capacity it attempts to maintain. It can scale beyond this capacity if\n you configure auto scaling. This number must be greater than or equal to the minimum\n size of the group and less than or equal to the maximum size of the group. If you do not\n specify a desired capacity, the default is the minimum size of the group.
" } }, "DefaultCooldown": { "target": "com.amazonaws.autoscaling#Cooldown", "traits": { "smithy.api#documentation": "\n Only needed if you use simple scaling policies.\n
\nThe amount of time, in seconds, between one scaling activity ending and another one\n starting due to simple scaling policies. For more information, see Scaling\n cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
\nDefault: 300 seconds
A list of Availability Zones where instances in the Auto Scaling group can be created. Used\n for launching into the default VPC subnet in each Availability Zone when not using the\n VPCZoneIdentifier property, or for attaching a network interface when\n an existing network interface ID is specified in a launch template.
\n A list of Availability Zone IDs where the Auto Scaling group can launch instances. You cannot specify both AvailabilityZones and AvailabilityZoneIds in the same request.\n
" } }, "LoadBalancerNames": { "target": "com.amazonaws.autoscaling#LoadBalancerNames", "traits": { "smithy.api#documentation": "A list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers, Network Load Balancers, and Gateway Load Balancers,\n specify the TargetGroupARNs property instead.
The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling\n group. Instances are registered as targets with the target groups. The target groups\n receive incoming traffic and route requests to one or more registered targets. For more\n information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "HealthCheckType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", "traits": { "smithy.api#documentation": "A comma-separated value string of one or more health check types.
\nThe valid values are EC2, EBS, ELB, and\n VPC_LATTICE. EC2 is the default health check and cannot be\n disabled. For more information, see Health checks\n for instances in an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
Only specify EC2 if you must clear a value that was previously\n set.
The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service and marking it unhealthy due to a failed\n health check. This is useful if your instances do not immediately pass their health\n checks after they enter the InService state. For more information, see\n Set the health check\n grace period for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
Default: 0 seconds
The name of the placement group into which to launch your instances. For more\n information, see Placement groups in the\n Amazon EC2 User Guide.
\nA cluster placement group is a logical grouping of instances\n within a single Availability Zone. You cannot specify multiple Availability Zones\n and a cluster placement group.
\nA comma-separated list of subnet IDs for a virtual private cloud (VPC) where instances\n in the Auto Scaling group can be created. If you specify VPCZoneIdentifier with\n AvailabilityZones, the subnets that you specify must reside in those\n Availability Zones.
A policy or a list of policies that are used to select the instance to terminate.\n These policies are executed in the order that you list them. For more information, see\n Configure\n termination policies for Amazon EC2 Auto Scaling in the\n Amazon EC2 Auto Scaling User Guide.
\nValid values: Default | AllocationStrategy |\n ClosestToNextInstanceHour | NewestInstance |\n OldestInstance | OldestLaunchConfiguration |\n OldestLaunchTemplate |\n arn:aws:lambda:region:account-id:function:my-function:my-alias\n
Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling\n when scaling in. For more information about preventing instances from terminating on\n scale in, see Use\n instance scale-in protection in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "CapacityRebalance": { "target": "com.amazonaws.autoscaling#CapacityRebalanceEnabled", "traits": { "smithy.api#documentation": "Indicates whether Capacity Rebalancing is enabled. Otherwise, Capacity Rebalancing is\n disabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot\n Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of\n interruption. After launching a new instance, it then terminates an old instance. For\n more information, see Use Capacity\n Rebalancing to handle Amazon EC2 Spot Interruptions in the in the Amazon EC2 Auto Scaling User Guide.
" } }, "LifecycleHookSpecificationList": { "target": "com.amazonaws.autoscaling#LifecycleHookSpecifications", "traits": { "smithy.api#documentation": "One or more lifecycle hooks to add to the Auto Scaling group before instances are\n launched.
" } }, "DeletionProtection": { "target": "com.amazonaws.autoscaling#DeletionProtection", "traits": { "smithy.api#documentation": "\n The deletion protection setting for the Auto Scaling group. This setting helps safeguard your Auto Scaling group and its\n instances by controlling whether the DeleteAutoScalingGroup operation is allowed. When deletion\n protection is enabled, users cannot delete the Auto Scaling group according to the specified protection level until\n the setting is changed back to a less restrictive level.\n
\n The valid values are none, prevent-force-deletion, and prevent-all-deletion.\n
\n Default: none\n
\n For more information, see\n \n Configure deletion protection for your Amazon EC2 Auto Scaling resources\n in the Amazon EC2 Auto Scaling User Guide.\n
" } }, "Tags": { "target": "com.amazonaws.autoscaling#Tags", "traits": { "smithy.api#documentation": "One or more tags. You can tag your Auto Scaling group and propagate the tags to the Amazon EC2\n instances it launches. Tags are not propagated to Amazon EBS volumes. To add tags to Amazon EBS\n volumes, specify the tags in a launch template but use caution. If the launch template\n specifies an instance tag with a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling\n overrides the value of that instance tag with the value specified by the Auto Scaling group. For\n more information, see Tag Auto Scaling groups and\n instances in the Amazon EC2 Auto Scaling User Guide.
" } }, "ServiceLinkedRoleARN": { "target": "com.amazonaws.autoscaling#ResourceName", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to\n call other Amazon Web Services service on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role\n named AWSServiceRoleForAutoScaling, which it creates if it does not exist.\n For more information, see Service-linked\n roles in the Amazon EC2 Auto Scaling User Guide.
The maximum amount of time, in seconds, that an instance can be in service. The\n default is null. If specified, the value must be either 0 or a number equal to or\n greater than 86,400 seconds (1 day). For more information, see Replace Auto Scaling instances based on maximum instance lifetime in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "Context": { "target": "com.amazonaws.autoscaling#Context", "traits": { "smithy.api#documentation": "Reserved.
" } }, "DesiredCapacityType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling\n supports DesiredCapacityType for attribute-based instance type selection\n only. For more information, see Create a mixed instances group using attribute-based instance type\n selection in the Amazon EC2 Auto Scaling User Guide.
By default, Amazon EC2 Auto Scaling specifies units, which translates into number of\n instances.
Valid values: units | vcpu | memory-mib\n
The amount of time, in seconds, until a new instance is considered to have finished\n initializing and resource consumption to become stable after it enters the\n InService state.
During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an\n instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the\n warm-up period before aggregating the metrics for new instances with existing instances\n in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage\n data. For more information, see Set\n the default instance warmup for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
\nTo manage various warm-up settings at the group level, we recommend that you set\n the default instance warmup, even if it is set to 0 seconds. To\n remove a value that you previously set, include the property but specify\n -1 for the value. However, we strongly recommend keeping the\n default instance warmup enabled by specifying a value of 0 or other\n nominal value.
Default: None
" } }, "TrafficSources": { "target": "com.amazonaws.autoscaling#TrafficSources", "traits": { "smithy.api#documentation": "The list of traffic sources to attach to this Auto Scaling group. You can use any of the\n following as traffic sources for an Auto Scaling group: Classic Load Balancer, Application Load Balancer, Gateway Load Balancer, Network Load Balancer, and\n VPC Lattice.
" } }, "InstanceMaintenancePolicy": { "target": "com.amazonaws.autoscaling#InstanceMaintenancePolicy", "traits": { "smithy.api#documentation": "An instance maintenance policy. For more information, see Set instance maintenance policy in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "AvailabilityZoneDistribution": { "target": "com.amazonaws.autoscaling#AvailabilityZoneDistribution", "traits": { "smithy.api#documentation": "The instance capacity distribution across Availability Zones.
" } }, "AvailabilityZoneImpairmentPolicy": { "target": "com.amazonaws.autoscaling#AvailabilityZoneImpairmentPolicy", "traits": { "smithy.api#documentation": "\n The policy for Availability Zone impairment.\n
" } }, "SkipZonalShiftValidation": { "target": "com.amazonaws.autoscaling#SkipZonalShiftValidation", "traits": { "smithy.api#documentation": "\n If you enable zonal shift with cross-zone disabled load balancers, capacity could become imbalanced across Availability Zones. To skip the validation, specify true. For more information, see\n Auto Scaling group zonal shift in the Amazon EC2 Auto Scaling User Guide.\n
\n The capacity reservation specification for the Auto Scaling group. \n
" } }, "InstanceLifecyclePolicy": { "target": "com.amazonaws.autoscaling#InstanceLifecyclePolicy", "traits": { "smithy.api#documentation": "\n The instance lifecycle policy for the Auto Scaling group. This policy controls instance behavior when an instance\n transitions through its lifecycle states. Configure retention triggers to specify when instances should\n move to a Retained state instead of automatic termination.\n
For more information, see\n \n Control instance retention with instance lifecycle policies\n in the Amazon EC2 Auto Scaling User Guide.\n
\nInstances in a Retained state will continue to incur standard EC2 charges until terminated.
\nThe entity that manages the Auto Scaling group. If you specify this parameter, Amazon EC2 Auto Scaling\n passes the operator identity to EC2 for instance launches and only allows the\n designated operator to make changes to the Auto Scaling group. All mutating API calls from\n non-operator callers are rejected with an AccessDenied exception.
Creates a launch configuration.
\nIf you exceed your maximum limit of launch configurations, the call fails. To query\n this limit, call the DescribeAccountLimits API. \n For information about updating this limit, see Quotas for \n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
\nFor more information, see Launch\n configurations in the Amazon EC2 Auto Scaling User Guide.
\nAmazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a\n launch template or a launch configuration. We strongly recommend that you do not use\n launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2.\n For information about using launch templates, see Launch templates in the Amazon EC2 Auto Scaling User Guide.
\nThe name of the launch configuration. This name must be unique per Region per\n account.
", "smithy.api#required": {} } }, "ImageId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The ID of the Amazon Machine Image (AMI) that was assigned during registration. For\n more information, see Find a Linux AMI in the\n Amazon EC2 User Guide.
\nIf you specify InstanceId, an ImageId is not\n required.
The name of the key pair. For more information, see Amazon EC2 key pairs and Amazon EC2\n instances in the Amazon EC2 User Guide.
" } }, "SecurityGroups": { "target": "com.amazonaws.autoscaling#SecurityGroups", "traits": { "smithy.api#documentation": "A list that contains the security group IDs to assign to the instances in the Auto Scaling\n group. For more information, see Control traffic to your Amazon Web Services\n resources using security groups in the Amazon Virtual Private\n Cloud User Guide.
" } }, "ClassicLinkVPCId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "Available for backward compatibility.
" } }, "ClassicLinkVPCSecurityGroups": { "target": "com.amazonaws.autoscaling#ClassicLinkVPCSecurityGroups", "traits": { "smithy.api#documentation": "Available for backward compatibility.
" } }, "UserData": { "target": "com.amazonaws.autoscaling#XmlStringUserData", "traits": { "smithy.api#documentation": "The user data to make available to the launched EC2 instances. For more information,\n see Instance metadata and user data (Linux) and Instance metadata and\n user data (Windows). If you are using a command line tool, base64-encoding\n is performed for you, and you can load the text from a file. Otherwise, you must provide\n base64-encoded text. User data is limited to 16 KB.
" } }, "InstanceId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", "traits": { "smithy.api#documentation": "The ID of the instance to use to create the launch configuration. The new launch\n configuration derives attributes from the instance, except for the block device\n mapping.
\nTo create a launch configuration with a block device mapping or override any other\n instance attributes, specify them as part of the same request.
\nFor more information, see Create a launch\n configuration in the Amazon EC2 Auto Scaling User Guide.
" } }, "InstanceType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "Specifies the instance type of the EC2 instance. For information about available\n instance types, see Available\n instance types in the Amazon EC2 User Guide.
\nIf you specify InstanceId, an InstanceType is not\n required.
The ID of the kernel associated with the AMI.
\nWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User provided\n kernels in the Amazon EC2 User Guide.
\nThe ID of the RAM disk to select.
\nWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User provided\n kernels in the Amazon EC2 User Guide.
\nThe block device mapping entries that define the block devices to attach to the\n instances at launch. By default, the block devices specified in the block device mapping\n for the AMI are used. For more information, see Block device\n mappings in the Amazon EC2 User Guide.
" } }, "InstanceMonitoring": { "target": "com.amazonaws.autoscaling#InstanceMonitoring", "traits": { "smithy.api#documentation": "Controls whether instances in this group are launched with detailed\n (true) or basic (false) monitoring.
The default value is true (enabled).
When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and\n your account is charged a fee. When you disable detailed monitoring, CloudWatch generates\n metrics every 5 minutes. For more information, see Configure\n monitoring for Auto Scaling instances in the\n Amazon EC2 Auto Scaling User Guide.
\nThe maximum hourly price to be paid for any Spot Instance launched to fulfill the\n request. Spot Instances are launched when the price you specify exceeds the current Spot\n price. For more information, see Request Spot\n Instances for fault-tolerant and flexible applications in the\n Amazon EC2 Auto Scaling User Guide.
\nValid Range: Minimum value of 0.001
\nWhen you change your maximum price by creating a new launch configuration, running\n instances will continue to run as long as the maximum price for those running\n instances is higher than the current Spot price.
\nThe name or the Amazon Resource Name (ARN) of the instance profile associated with the\n IAM role for the instance. The instance profile contains the IAM role. For more\n information, see IAM role for applications that run\n on Amazon EC2 instances in the Amazon EC2 Auto Scaling User Guide.
" } }, "EbsOptimized": { "target": "com.amazonaws.autoscaling#EbsOptimized", "traits": { "smithy.api#documentation": "Specifies whether the launch configuration is optimized for EBS I/O\n (true) or not (false). The optimization provides dedicated\n throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O\n performance. This optimization is not available with all instance types. Additional fees\n are incurred when you enable EBS optimization for an instance type that is not\n EBS-optimized by default. For more information, see Amazon EBS-optimized instances\n in the Amazon EC2 User Guide.
The default value is false.
Specifies whether to assign a public IPv4 address to the group's instances. If the\n instance is launched into a default subnet, the default is to assign a public IPv4\n address, unless you disabled the option to assign a public IPv4 address on the subnet.\n If the instance is launched into a nondefault subnet, the default is not to assign a\n public IPv4 address, unless you enabled the option to assign a public IPv4 address on\n the subnet.
\nIf you specify true, each instance in the Auto Scaling group receives a unique\n public IPv4 address. For more information, see Provide network connectivity for\n your Auto Scaling instances using Amazon VPC in the\n Amazon EC2 Auto Scaling User Guide.
If you specify this property, you must specify at least one subnet for\n VPCZoneIdentifier when you create your group.
The tenancy of the instance, either default or dedicated. An\n instance with dedicated tenancy runs on isolated, single-tenant hardware\n and can only be launched into a VPC. To launch dedicated instances into a shared tenancy\n VPC (a VPC with the instance placement tenancy attribute set to default),\n you must set the value of this property to dedicated.
If you specify PlacementTenancy, you must specify at least one subnet for\n VPCZoneIdentifier when you create your group.
Valid values: default | dedicated\n
The metadata options for the instances. For more information, see Configure the instance metadata options in the\n Amazon EC2 Auto Scaling User Guide.
" } } } }, "com.amazonaws.autoscaling#CreateOrUpdateTags": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#CreateOrUpdateTagsType" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.autoscaling#AlreadyExistsFault" }, { "target": "com.amazonaws.autoscaling#LimitExceededFault" }, { "target": "com.amazonaws.autoscaling#ResourceContentionFault" }, { "target": "com.amazonaws.autoscaling#ResourceInUseFault" } ], "traits": { "smithy.api#documentation": "Creates or updates tags for the specified Auto Scaling group.
\nWhen you specify a tag with a key that already exists, the operation overwrites the\n previous tag definition, and you do not get an error message.
\nFor more information, see Tag Auto Scaling groups and\n instances in the Amazon EC2 Auto Scaling User Guide.
", "smithy.api#examples": [ { "title": "To create or update tags for an Auto Scaling group", "documentation": "This example adds two tags to the specified Auto Scaling group.", "input": { "Tags": [ { "ResourceId": "my-auto-scaling-group", "ResourceType": "auto-scaling-group", "Key": "Role", "Value": "WebServer", "PropagateAtLaunch": true }, { "ResourceId": "my-auto-scaling-group", "ResourceType": "auto-scaling-group", "Key": "Dept", "Value": "Research", "PropagateAtLaunch": true } ] } } ] } }, "com.amazonaws.autoscaling#CreateOrUpdateTagsType": { "type": "structure", "members": { "Tags": { "target": "com.amazonaws.autoscaling#Tags", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "One or more tags.
", "smithy.api#required": {} } } } }, "com.amazonaws.autoscaling#CustomizedMetricSpecification": { "type": "structure", "members": { "MetricName": { "target": "com.amazonaws.autoscaling#MetricName", "traits": { "smithy.api#documentation": "The name of the metric. To get the exact metric name, namespace, and dimensions,\n inspect the Metric object\n that is returned by a call to ListMetrics.
" } }, "Namespace": { "target": "com.amazonaws.autoscaling#MetricNamespace", "traits": { "smithy.api#documentation": "The namespace of the metric.
" } }, "Dimensions": { "target": "com.amazonaws.autoscaling#MetricDimensions", "traits": { "smithy.api#documentation": "The dimensions of the metric.
\nConditional: If you published your metric with dimensions, you must specify the same\n dimensions in your scaling policy.
" } }, "Statistic": { "target": "com.amazonaws.autoscaling#MetricStatistic", "traits": { "smithy.api#documentation": "The statistic of the metric.
" } }, "Unit": { "target": "com.amazonaws.autoscaling#MetricUnit", "traits": { "smithy.api#documentation": "The unit of the metric. For a complete list of the units that CloudWatch supports, see the\n MetricDatum\n data type in the Amazon CloudWatch API Reference.
" } }, "Period": { "target": "com.amazonaws.autoscaling#MetricGranularityInSeconds", "traits": { "smithy.api#documentation": "\n The period of the metric in seconds. The default value is 60. Accepted values are 10, 30, and 60. For high resolution metric, set the value to less than 60. For more information, see\n Create a target tracking policy using high-resolution metrics for faster response.\n
" } }, "Metrics": { "target": "com.amazonaws.autoscaling#TargetTrackingMetricDataQueries", "traits": { "smithy.api#documentation": "The metrics to include in the target tracking scaling policy, as a metric data query.\n This can include both raw metric and metric math expressions.
" } } }, "traits": { "smithy.api#documentation": "Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use\n with Amazon EC2 Auto Scaling.
\nTo create your customized metric specification:
\nAdd values for each required property from CloudWatch. You can use an existing\n metric, or a new metric that you create. To use your own metric, you must first\n publish the metric to CloudWatch. For more information, see Publish\n custom metrics in the Amazon CloudWatch User\n Guide.
\nChoose a metric that changes proportionally with capacity. The value of the\n metric should increase or decrease in inverse proportion to the number of\n capacity units. That is, the value of the metric should decrease when capacity\n increases.
\nFor more information about the CloudWatch terminology below, see Amazon CloudWatch\n concepts.
\nEach individual service provides information about the metrics, namespace, and\n dimensions they use. For more information, see Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User\n Guide.
\nDeletes the specified Auto Scaling group.
\nIf the group has instances or scaling activities in progress, you must specify the\n option to force the deletion in order for it to succeed. The force delete operation will\n also terminate the EC2 instances. If the group has a warm pool, the force delete option\n also deletes the warm pool.
\nTo remove instances from the Auto Scaling group before deleting it, call the \n DetachInstances API with the list of instances and the option to\n decrement the desired capacity. This ensures that Amazon EC2 Auto Scaling does not launch replacement\n instances.
\nTo terminate all instances before deleting the Auto Scaling group, call the \n UpdateAutoScalingGroup API and set the minimum size and desired capacity\n of the Auto Scaling group to\n zero.
\nIf the group has scaling policies, deleting the group deletes the policies, the\n underlying alarm actions, and any alarm that no longer has an associated action.
\nFor more information, see Delete your Auto Scaling\n infrastructure in the Amazon EC2 Auto Scaling User Guide.
", "smithy.api#examples": [ { "title": "To delete an Auto Scaling group", "documentation": "This example deletes the specified Auto Scaling group.", "input": { "AutoScalingGroupName": "my-auto-scaling-group" } }, { "title": "To delete an Auto Scaling group and all its instances", "documentation": "This example deletes the specified Auto Scaling group and all its instances.", "input": { "AutoScalingGroupName": "my-auto-scaling-group", "ForceDelete": true } } ] } }, "com.amazonaws.autoscaling#DeleteAutoScalingGroupType": { "type": "structure", "members": { "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } }, "ForceDelete": { "target": "com.amazonaws.autoscaling#ForceDelete", "traits": { "smithy.api#documentation": "Specifies that the group is to be deleted along with all instances associated with the\n group, without waiting for all instances to be terminated. This action also deletes any\n outstanding lifecycle actions associated with the group.
" } } } }, "com.amazonaws.autoscaling#DeleteLaunchConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#LaunchConfigurationNameType" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" }, { "target": "com.amazonaws.autoscaling#ResourceInUseFault" } ], "traits": { "smithy.api#documentation": "Deletes the specified launch configuration.
\nThe launch configuration must not be attached to an Auto Scaling group. When this call\n completes, the launch configuration is no longer available for use.
", "smithy.api#examples": [ { "title": "To delete a launch configuration", "documentation": "This example deletes the specified launch configuration.", "input": { "LaunchConfigurationName": "my-launch-config" } } ] } }, "com.amazonaws.autoscaling#DeleteLifecycleHook": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#DeleteLifecycleHookType" }, "output": { "target": "com.amazonaws.autoscaling#DeleteLifecycleHookAnswer" }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" } ], "traits": { "smithy.api#documentation": "Deletes the specified lifecycle hook.
\nIf there are any outstanding lifecycle actions, they are completed first\n (ABANDON for launching instances, CONTINUE for terminating\n instances).
The name of the lifecycle hook.
", "smithy.api#required": {} } }, "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } } } }, "com.amazonaws.autoscaling#DeleteNotificationConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#DeleteNotificationConfigurationType" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" } ], "traits": { "smithy.api#documentation": "Deletes the specified notification.
", "smithy.api#examples": [ { "title": "To delete an Auto Scaling notification", "documentation": "This example deletes the specified notification from the specified Auto Scaling group.", "input": { "AutoScalingGroupName": "my-auto-scaling-group", "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic" } } ] } }, "com.amazonaws.autoscaling#DeleteNotificationConfigurationType": { "type": "structure", "members": { "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } }, "TopicARN": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon SNS topic.
", "smithy.api#required": {} } } } }, "com.amazonaws.autoscaling#DeletePolicy": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#DeletePolicyType" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" }, { "target": "com.amazonaws.autoscaling#ServiceLinkedRoleFailure" } ], "traits": { "smithy.api#documentation": "Deletes the specified scaling policy.
\nDeleting either a step scaling policy or a simple scaling policy deletes the\n underlying alarm action, but does not delete the alarm, even if it no longer has an\n associated action.
\nFor more information, see Delete a scaling\n policy in the Amazon EC2 Auto Scaling User Guide.
", "smithy.api#examples": [ { "title": "To delete an Auto Scaling policy", "documentation": "This example deletes the specified Auto Scaling policy.", "input": { "AutoScalingGroupName": "my-auto-scaling-group", "PolicyName": "my-step-scale-out-policy" } } ] } }, "com.amazonaws.autoscaling#DeletePolicyType": { "type": "structure", "members": { "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The name of the Auto Scaling group.
" } }, "PolicyName": { "target": "com.amazonaws.autoscaling#ResourceName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the policy.
", "smithy.api#required": {} } } } }, "com.amazonaws.autoscaling#DeleteScheduledAction": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#DeleteScheduledActionType" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" } ], "traits": { "smithy.api#documentation": "Deletes the specified scheduled action.
", "smithy.api#examples": [ { "title": "To delete a scheduled action from an Auto Scaling group", "documentation": "This example deletes the specified scheduled action from the specified Auto Scaling group.", "input": { "AutoScalingGroupName": "my-auto-scaling-group", "ScheduledActionName": "my-scheduled-action" } } ] } }, "com.amazonaws.autoscaling#DeleteScheduledActionType": { "type": "structure", "members": { "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } }, "ScheduledActionName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the action to delete.
", "smithy.api#required": {} } } } }, "com.amazonaws.autoscaling#DeleteTags": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#DeleteTagsType" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" }, { "target": "com.amazonaws.autoscaling#ResourceInUseFault" } ], "traits": { "smithy.api#documentation": "Deletes the specified tags.
", "smithy.api#examples": [ { "title": "To delete a tag from an Auto Scaling group", "documentation": "This example deletes the specified tag from the specified Auto Scaling group.", "input": { "Tags": [ { "ResourceId": "my-auto-scaling-group", "ResourceType": "auto-scaling-group", "Key": "Dept", "Value": "Research" } ] } } ] } }, "com.amazonaws.autoscaling#DeleteTagsType": { "type": "structure", "members": { "Tags": { "target": "com.amazonaws.autoscaling#Tags", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "One or more tags.
", "smithy.api#required": {} } } } }, "com.amazonaws.autoscaling#DeleteWarmPool": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#DeleteWarmPoolType" }, "output": { "target": "com.amazonaws.autoscaling#DeleteWarmPoolAnswer" }, "errors": [ { "target": "com.amazonaws.autoscaling#LimitExceededFault" }, { "target": "com.amazonaws.autoscaling#ResourceContentionFault" }, { "target": "com.amazonaws.autoscaling#ResourceInUseFault" }, { "target": "com.amazonaws.autoscaling#ScalingActivityInProgressFault" } ], "traits": { "smithy.api#documentation": "Deletes the warm pool for the specified Auto Scaling group.
\nFor more information, see Warm pools for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#DeleteWarmPoolAnswer": { "type": "structure", "members": {} }, "com.amazonaws.autoscaling#DeleteWarmPoolType": { "type": "structure", "members": { "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } }, "ForceDelete": { "target": "com.amazonaws.autoscaling#ForceDelete", "traits": { "smithy.api#documentation": "Specifies that the warm pool is to be deleted along with all of its associated\n instances, without waiting for all instances to be terminated. This parameter also\n deletes any outstanding lifecycle actions associated with the warm pool\n instances.
" } } } }, "com.amazonaws.autoscaling#DeletionProtection": { "type": "enum", "members": { "None": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "none" } }, "PreventForceDeletion": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "prevent-force-deletion" } }, "PreventAllDeletion": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "prevent-all-deletion" } } } }, "com.amazonaws.autoscaling#DescribeAccountLimits": { "type": "operation", "input": { "target": "smithy.api#Unit" }, "output": { "target": "com.amazonaws.autoscaling#DescribeAccountLimitsAnswer" }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" } ], "traits": { "smithy.api#documentation": "Describes the current Amazon EC2 Auto Scaling resource quotas for your account.
\nWhen you establish an Amazon Web Services account, the account has initial quotas on the maximum\n number of Auto Scaling groups and launch configurations that you can create in a given Region.\n For more information, see Quotas for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
", "smithy.api#examples": [ { "title": "To describe your Auto Scaling account limits", "documentation": "This example describes the Amazon EC2 Auto Scaling service quotas for your account.", "output": { "MaxNumberOfAutoScalingGroups": 20, "MaxNumberOfLaunchConfigurations": 100, "NumberOfAutoScalingGroups": 3, "NumberOfLaunchConfigurations": 5 } } ] } }, "com.amazonaws.autoscaling#DescribeAccountLimitsAnswer": { "type": "structure", "members": { "MaxNumberOfAutoScalingGroups": { "target": "com.amazonaws.autoscaling#MaxNumberOfAutoScalingGroups", "traits": { "smithy.api#documentation": "The maximum number of groups allowed for your account. The default is 200 groups per\n Region.
" } }, "MaxNumberOfLaunchConfigurations": { "target": "com.amazonaws.autoscaling#MaxNumberOfLaunchConfigurations", "traits": { "smithy.api#documentation": "The maximum number of launch configurations allowed for your account. The default is\n 200 launch configurations per Region.
" } }, "NumberOfAutoScalingGroups": { "target": "com.amazonaws.autoscaling#NumberOfAutoScalingGroups", "traits": { "smithy.api#documentation": "The current number of groups for your account.
" } }, "NumberOfLaunchConfigurations": { "target": "com.amazonaws.autoscaling#NumberOfLaunchConfigurations", "traits": { "smithy.api#documentation": "The current number of launch configurations for your account.
" } } } }, "com.amazonaws.autoscaling#DescribeAccountSettings": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#DescribeAccountSettingsType" }, "output": { "target": "com.amazonaws.autoscaling#DescribeAccountSettingsAnswer" }, "errors": [ { "target": "com.amazonaws.autoscaling#InvalidNextToken" } ], "traits": { "smithy.api#documentation": "\n Describes the current Amazon EC2 Auto Scaling account settings for your account. Account settings are a framework that allows you to enable or disable features for your account. The framework also gives you visibility into features that will be enforced by a given date, providing a time window to prepare for backwards-incompatible changes.\n
" } }, "com.amazonaws.autoscaling#DescribeAccountSettingsAnswer": { "type": "structure", "members": { "Settings": { "target": "com.amazonaws.autoscaling#AccountSettings", "traits": { "smithy.api#documentation": "\n Information about the account settings.\n
" } }, "NextToken": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { "smithy.api#documentation": "\n 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.\n
\n The name of the account setting to describe. If you omit this parameter, all account settings are described.\n
" } }, "NextToken": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { "smithy.api#documentation": "\n The token for the next set of items to return. (You received this token from a previous call.)\n
" } }, "MaxRecords": { "target": "com.amazonaws.autoscaling#MaxRecords", "traits": { "smithy.api#documentation": "\n The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.\n
Describes the available adjustment types for step scaling and simple scaling\n policies.
\nThe following adjustment types are supported:
\n\n ChangeInCapacity\n
\n ExactCapacity\n
\n PercentChangeInCapacity\n
The policy adjustment types.
" } } } }, "com.amazonaws.autoscaling#DescribeAutoScalingGroups": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#AutoScalingGroupNamesType" }, "output": { "target": "com.amazonaws.autoscaling#AutoScalingGroupsType" }, "errors": [ { "target": "com.amazonaws.autoscaling#InvalidNextToken" }, { "target": "com.amazonaws.autoscaling#ResourceContentionFault" } ], "traits": { "smithy.api#documentation": "Gets information about the Auto Scaling groups in the account and Region.
\nIf you specify Auto Scaling group names, the output includes information for only the\n specified Auto Scaling groups. If you specify filters, the output includes information for only\n those Auto Scaling groups that meet the filter criteria. If you do not specify group names or\n filters, the output includes information for all Auto Scaling groups.
\nThis operation also returns information about instances in Auto Scaling groups. To retrieve\n information about the instances in a warm pool, you must call the \n DescribeWarmPool API.
", "smithy.api#examples": [ { "title": "To describe an Auto Scaling group", "documentation": "This example describes the specified Auto Scaling group.", "input": { "AutoScalingGroupNames": [ "my-auto-scaling-group" ] }, "output": { "AutoScalingGroups": [ { "AutoScalingGroupName": "my-auto-scaling-group", "AutoScalingGroupARN": "arn:aws:autoscaling:us-west-1:123456789012:autoScalingGroup:12345678-1234-1234-1234-123456789012:autoScalingGroupName/my-auto-scaling-group", "LaunchConfigurationName": "my-launch-config", "MinSize": 1, "MaxSize": 5, "DesiredCapacity": 2, "DefaultCooldown": 300, "AvailabilityZones": [ "us-west-2a", "us-west-2b", "us-west-2c" ], "AvailabilityZoneIds": [ "usw2-az1", "usw2-az2", "usw2-az3" ], "LoadBalancerNames": [], "TargetGroupARNs": [], "HealthCheckType": "EC2", "HealthCheckGracePeriod": 300, "Instances": [ { "ProtectedFromScaleIn": false, "AvailabilityZone": "us-west-2c", "AvailabilityZoneId": "usw2-az3", "LaunchConfigurationName": "my-launch-config", "InstanceId": "i-05b4f7d5be44822a6", "InstanceType": "t3.micro", "HealthStatus": "Healthy", "LifecycleState": "InService" }, { "ProtectedFromScaleIn": false, "AvailabilityZone": "us-west-2b", "AvailabilityZoneId": "usw2-az2", "LaunchConfigurationName": "my-launch-config", "InstanceId": "i-0c20ac468fa3049e8", "InstanceType": "t3.micro", "HealthStatus": "Healthy", "LifecycleState": "InService" } ], "CreatedTime": "2023-03-09T22:15:11.611Z", "SuspendedProcesses": [], "VPCZoneIdentifier": "subnet-5ea0c127,subnet-6194ea3b,subnet-c934b782", "EnabledMetrics": [], "Tags": [], "TerminationPolicies": [ "Default" ], "NewInstancesProtectedFromScaleIn": false, "ServiceLinkedRoleARN": "arn:aws:iam::123456789012:role/aws-service-role/autoscaling.amazonaws.com/AWSServiceRoleForAutoScaling", "TrafficSources": [] } ] } } ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "AutoScalingGroups", "pageSize": "MaxRecords" }, "smithy.waiters#waitable": { "GroupExists": { "acceptors": [ { "state": "success", "matcher": { "output": { "path": "length(AutoScalingGroups) > `0`", "expected": "true", "comparator": "booleanEquals" } } }, { "state": "retry", "matcher": { "output": { "path": "length(AutoScalingGroups) > `0`", "expected": "false", "comparator": "booleanEquals" } } } ], "minDelay": 5 }, "GroupInService": { "acceptors": [ { "state": "success", "matcher": { "output": { "path": "contains(AutoScalingGroups[].[length(Instances[?LifecycleState=='InService']) >= MinSize][], `false`)", "expected": "false", "comparator": "booleanEquals" } } }, { "state": "retry", "matcher": { "output": { "path": "contains(AutoScalingGroups[].[length(Instances[?LifecycleState=='InService']) >= MinSize][], `false`)", "expected": "true", "comparator": "booleanEquals" } } } ], "minDelay": 15 }, "GroupNotExists": { "acceptors": [ { "state": "success", "matcher": { "output": { "path": "length(AutoScalingGroups) > `0`", "expected": "false", "comparator": "booleanEquals" } } }, { "state": "retry", "matcher": { "output": { "path": "length(AutoScalingGroups) > `0`", "expected": "true", "comparator": "booleanEquals" } } } ], "minDelay": 15 } } } }, "com.amazonaws.autoscaling#DescribeAutoScalingInstances": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#DescribeAutoScalingInstancesType" }, "output": { "target": "com.amazonaws.autoscaling#AutoScalingInstancesType" }, "errors": [ { "target": "com.amazonaws.autoscaling#InvalidNextToken" }, { "target": "com.amazonaws.autoscaling#ResourceContentionFault" } ], "traits": { "smithy.api#documentation": "Gets information about the Auto Scaling instances in the account and Region.
", "smithy.api#examples": [ { "title": "To describe one or more Auto Scaling instances", "documentation": "This example describes the specified Auto Scaling instance.", "input": { "InstanceIds": [ "i-05b4f7d5be44822a6" ] }, "output": { "AutoScalingInstances": [ { "ProtectedFromScaleIn": false, "AvailabilityZone": "us-west-2c", "AvailabilityZoneId": "usw2-az2", "LaunchConfigurationName": "my-launch-config", "InstanceId": "i-05b4f7d5be44822a6", "InstanceType": "t3.micro", "AutoScalingGroupName": "my-auto-scaling-group", "HealthStatus": "HEALTHY", "LifecycleState": "InService" } ] } } ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "AutoScalingInstances", "pageSize": "MaxRecords" } } }, "com.amazonaws.autoscaling#DescribeAutoScalingInstancesType": { "type": "structure", "members": { "InstanceIds": { "target": "com.amazonaws.autoscaling#InstanceIds", "traits": { "smithy.api#documentation": "The IDs of the instances. If you omit this property, all Auto Scaling instances are described.\n If you specify an ID that does not exist, it is ignored with no error.
\nArray Members: Maximum number of 50 items.
" } }, "IncludeManagedResources": { "target": "com.amazonaws.autoscaling#IncludeManagedResources", "traits": { "smithy.api#documentation": "\n Specifies whether to include managed Auto Scaling instances in the response. When set to true (default), the response includes managed Auto Scaling instances.\n
The maximum number of items to return with this call. The default value is\n 50 and the maximum value is 50.
A response can contain fewer items than the value specified by MaxRecords, even when more items are available. To retrieve the additional items, use the NextToken value in a subsequent call rather than relying on the number of items in the response.
The token for the next set of items to return. (You received this token from a\n previous call.)
" } } } }, "com.amazonaws.autoscaling#DescribeAutoScalingNotificationTypes": { "type": "operation", "input": { "target": "smithy.api#Unit" }, "output": { "target": "com.amazonaws.autoscaling#DescribeAutoScalingNotificationTypesAnswer" }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" } ], "traits": { "smithy.api#documentation": "Describes the notification types that are supported by Amazon EC2 Auto Scaling.
", "smithy.api#examples": [ { "title": "To describe the Auto Scaling notification types", "documentation": "This example describes the available notification types.", "output": { "AutoScalingNotificationTypes": [ "autoscaling:EC2_INSTANCE_LAUNCH", "autoscaling:EC2_INSTANCE_LAUNCH_ERROR", "autoscaling:EC2_INSTANCE_TERMINATE", "autoscaling:EC2_INSTANCE_TERMINATE_ERROR", "autoscaling:TEST_NOTIFICATION" ] } } ] } }, "com.amazonaws.autoscaling#DescribeAutoScalingNotificationTypesAnswer": { "type": "structure", "members": { "AutoScalingNotificationTypes": { "target": "com.amazonaws.autoscaling#AutoScalingNotificationTypes", "traits": { "smithy.api#documentation": "The notification types.
" } } } }, "com.amazonaws.autoscaling#DescribeInstanceRefreshes": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#DescribeInstanceRefreshesType" }, "output": { "target": "com.amazonaws.autoscaling#DescribeInstanceRefreshesAnswer" }, "errors": [ { "target": "com.amazonaws.autoscaling#InvalidNextToken" }, { "target": "com.amazonaws.autoscaling#ResourceContentionFault" } ], "traits": { "smithy.api#documentation": "Gets information about the instance refreshes for the specified Auto Scaling group from the\n previous six weeks.
\nThis operation is part of the instance refresh\n feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group\n after you make configuration changes.
\nTo help you determine the status of an instance refresh, Amazon EC2 Auto Scaling returns information\n about the instance refreshes you previously initiated, including their status, start\n time, end time, the percentage of the instance refresh that is complete, and the number\n of instances remaining to update before the instance refresh is complete. If a rollback\n is initiated while an instance refresh is in progress, Amazon EC2 Auto Scaling also returns information\n about the rollback of the instance refresh.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxRecords" } } }, "com.amazonaws.autoscaling#DescribeInstanceRefreshesAnswer": { "type": "structure", "members": { "InstanceRefreshes": { "target": "com.amazonaws.autoscaling#InstanceRefreshes", "traits": { "smithy.api#documentation": "The instance refreshes for the specified group, sorted by creation timestamp in\n descending order.
" } }, "NextToken": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { "smithy.api#documentation": "A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.
The name of the Auto Scaling group.
", "smithy.api#required": {} } }, "InstanceRefreshIds": { "target": "com.amazonaws.autoscaling#InstanceRefreshIds", "traits": { "smithy.api#documentation": "One or more instance refresh IDs.
" } }, "NextToken": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a\n previous call.)
" } }, "MaxRecords": { "target": "com.amazonaws.autoscaling#MaxRecords", "traits": { "smithy.api#documentation": "The maximum number of items to return with this call. The default value is\n 50 and the maximum value is 100.
Gets information about the launch configurations in the account and Region.
", "smithy.api#examples": [ { "title": "To describe Auto Scaling launch configurations", "documentation": "This example describes the specified launch configuration.", "input": { "LaunchConfigurationNames": [ "my-launch-config" ] }, "output": { "LaunchConfigurations": [ { "EbsOptimized": false, "LaunchConfigurationARN": "arn:aws:autoscaling:us-west-2:123456789012:launchConfiguration:98d3b196-4cf9-4e88-8ca1-8547c24ced8b:launchConfigurationName/my-launch-config", "InstanceMonitoring": { "Enabled": true }, "ImageId": "ami-043a5034", "CreatedTime": "2014-05-07T17:39:28.599Z", "BlockDeviceMappings": [], "SecurityGroups": [ "sg-67ef0308" ], "LaunchConfigurationName": "my-launch-config", "InstanceType": "t1.micro", "AssociatePublicIpAddress": true } ] } } ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "LaunchConfigurations", "pageSize": "MaxRecords" } } }, "com.amazonaws.autoscaling#DescribeLifecycleHookTypes": { "type": "operation", "input": { "target": "smithy.api#Unit" }, "output": { "target": "com.amazonaws.autoscaling#DescribeLifecycleHookTypesAnswer" }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" } ], "traits": { "smithy.api#documentation": "Describes the available types of lifecycle hooks.
\nThe following hook types are supported:
\n\n autoscaling:EC2_INSTANCE_LAUNCHING\n
\n autoscaling:EC2_INSTANCE_TERMINATING\n
The lifecycle hook types.
" } } } }, "com.amazonaws.autoscaling#DescribeLifecycleHooks": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#DescribeLifecycleHooksType" }, "output": { "target": "com.amazonaws.autoscaling#DescribeLifecycleHooksAnswer" }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" } ], "traits": { "smithy.api#documentation": "Gets information about the lifecycle hooks for the specified Auto Scaling group.
", "smithy.api#examples": [ { "title": "To describe your lifecycle hooks", "documentation": "This example describes the lifecycle hooks for the specified Auto Scaling group.", "input": { "AutoScalingGroupName": "my-auto-scaling-group" }, "output": { "LifecycleHooks": [ { "GlobalTimeout": 172800, "HeartbeatTimeout": 3600, "RoleARN": "arn:aws:iam::123456789012:role/my-auto-scaling-role", "AutoScalingGroupName": "my-auto-scaling-group", "LifecycleHookName": "my-lifecycle-hook", "DefaultResult": "ABANDON", "NotificationTargetARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic", "LifecycleTransition": "autoscaling:EC2_INSTANCE_LAUNCHING" } ] } } ] } }, "com.amazonaws.autoscaling#DescribeLifecycleHooksAnswer": { "type": "structure", "members": { "LifecycleHooks": { "target": "com.amazonaws.autoscaling#LifecycleHooks", "traits": { "smithy.api#documentation": "The lifecycle hooks for the specified group.
" } } } }, "com.amazonaws.autoscaling#DescribeLifecycleHooksType": { "type": "structure", "members": { "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } }, "LifecycleHookNames": { "target": "com.amazonaws.autoscaling#LifecycleHookNames", "traits": { "smithy.api#documentation": "The names of one or more lifecycle hooks. If you omit this property, all lifecycle\n hooks are described.
" } } } }, "com.amazonaws.autoscaling#DescribeLoadBalancerTargetGroups": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#DescribeLoadBalancerTargetGroupsRequest" }, "output": { "target": "com.amazonaws.autoscaling#DescribeLoadBalancerTargetGroupsResponse" }, "errors": [ { "target": "com.amazonaws.autoscaling#InvalidNextToken" }, { "target": "com.amazonaws.autoscaling#ResourceContentionFault" } ], "traits": { "smithy.api#documentation": "This API operation is superseded by DescribeTrafficSources,\n which can describe multiple traffic sources types. We recommend using\n DetachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support DescribeLoadBalancerTargetGroups. You\n can use both the original DescribeLoadBalancerTargetGroups API\n operation and DescribeTrafficSources on the same Auto Scaling group.
Gets information about the Elastic Load Balancing target groups for the specified Auto Scaling group.
\nTo determine the attachment status of the target group, use the State\n element in the response. When you attach a target group to an Auto Scaling group, the initial\n State value is Adding. The state transitions to\n Added after all Auto Scaling instances are registered with the target group. If\n Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to\n InService after at least one Auto Scaling instance passes the health check.\n When the target group is in the InService state, Amazon EC2 Auto Scaling can terminate and\n replace any instances that are reported as unhealthy. If no registered instances pass\n 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\n CreateAutoScalingGroup API call. If your target group state is\n InService, but it is not working properly, check the scaling activities\n by calling DescribeScalingActivities and take any corrective actions\n necessary.
For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling:\n Health checks in the Amazon EC2 Auto Scaling User Guide. For more\n information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
\nYou can use this operation to describe target groups that were attached by using\n AttachLoadBalancerTargetGroups, but not for target groups that\n were attached by using AttachTrafficSources.
\nThe name of the Auto Scaling group.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a\n previous call.)
" } }, "MaxRecords": { "target": "com.amazonaws.autoscaling#MaxRecords", "traits": { "smithy.api#documentation": "The maximum number of items to return with this call. The default value is\n 100 and the maximum value is 100.
Information about the target groups.
" } }, "NextToken": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { "smithy.api#documentation": "A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.
This API operation is superseded by DescribeTrafficSources,\n which can describe multiple traffic sources types. We recommend using\n DescribeTrafficSources to simplify how you manage traffic sources.\n However, we continue to support DescribeLoadBalancers. You can use both\n the original DescribeLoadBalancers API operation and\n DescribeTrafficSources on the same Auto Scaling group.
Gets information about the load balancers for the specified Auto Scaling group.
\nThis operation describes only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancers, use the\n DescribeLoadBalancerTargetGroups API instead.
\nTo determine the attachment status of the load balancer, use the State\n element in the response. When you attach a load balancer to an Auto Scaling group, the initial\n State value is Adding. The state transitions to\n Added after all Auto Scaling instances are registered with the load balancer.\n If Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to\n InService after at least one Auto Scaling instance passes the health check.\n When the load balancer is in the InService state, Amazon EC2 Auto Scaling can terminate\n and replace any instances that are reported as unhealthy. If no registered instances\n pass the health checks, the load balancer doesn't enter the InService\n state.
Load balancers also have an InService state if you attach them in the\n CreateAutoScalingGroup API call. If your load balancer state is\n InService, but it is not working properly, check the scaling activities\n by calling DescribeScalingActivities and take any corrective actions\n necessary.
For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling:\n Health checks in the Amazon EC2 Auto Scaling User Guide. For more\n information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
", "smithy.api#examples": [ { "title": "To describe the load balancers for an Auto Scaling group", "documentation": "This example describes the load balancers attached to the specified Auto Scaling group.", "input": { "AutoScalingGroupName": "my-auto-scaling-group" }, "output": { "LoadBalancers": [ { "State": "Added", "LoadBalancerName": "my-load-balancer" } ] } } ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxRecords" } } }, "com.amazonaws.autoscaling#DescribeLoadBalancersRequest": { "type": "structure", "members": { "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a\n previous call.)
" } }, "MaxRecords": { "target": "com.amazonaws.autoscaling#MaxRecords", "traits": { "smithy.api#documentation": "The maximum number of items to return with this call. The default value is\n 100 and the maximum value is 100.
The load balancers.
" } }, "NextToken": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { "smithy.api#documentation": "A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.
Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.
", "smithy.api#examples": [ { "title": "To describe the Auto Scaling metric collection types", "documentation": "This example describes the available metric collection types.", "output": { "Metrics": [ { "Metric": "GroupMinSize" }, { "Metric": "GroupMaxSize" }, { "Metric": "GroupDesiredCapacity" }, { "Metric": "GroupInServiceInstances" }, { "Metric": "GroupPendingInstances" }, { "Metric": "GroupTerminatingInstances" }, { "Metric": "GroupStandbyInstances" }, { "Metric": "GroupTotalInstances" } ], "Granularities": [ { "Granularity": "1Minute" } ] } } ] } }, "com.amazonaws.autoscaling#DescribeMetricCollectionTypesAnswer": { "type": "structure", "members": { "Metrics": { "target": "com.amazonaws.autoscaling#MetricCollectionTypes", "traits": { "smithy.api#documentation": "The metrics.
" } }, "Granularities": { "target": "com.amazonaws.autoscaling#MetricGranularityTypes", "traits": { "smithy.api#documentation": "The granularities for the metrics.
" } } } }, "com.amazonaws.autoscaling#DescribeNotificationConfigurations": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#DescribeNotificationConfigurationsType" }, "output": { "target": "com.amazonaws.autoscaling#DescribeNotificationConfigurationsAnswer" }, "errors": [ { "target": "com.amazonaws.autoscaling#InvalidNextToken" }, { "target": "com.amazonaws.autoscaling#ResourceContentionFault" } ], "traits": { "smithy.api#documentation": "Gets information about the Amazon SNS notifications that are configured for one or more\n Auto Scaling groups.
", "smithy.api#examples": [ { "title": "To describe Auto Scaling notification configurations", "documentation": "This example describes the notification configurations for the specified Auto Scaling group.", "input": { "AutoScalingGroupNames": [ "my-auto-scaling-group" ] }, "output": { "NotificationConfigurations": [ { "AutoScalingGroupName": "my-auto-scaling-group", "NotificationType": "autoscaling:TEST_NOTIFICATION", "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic-2" }, { "AutoScalingGroupName": "my-auto-scaling-group", "NotificationType": "autoscaling:TEST_NOTIFICATION", "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic" } ] } } ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "NotificationConfigurations", "pageSize": "MaxRecords" } } }, "com.amazonaws.autoscaling#DescribeNotificationConfigurationsAnswer": { "type": "structure", "members": { "NotificationConfigurations": { "target": "com.amazonaws.autoscaling#NotificationConfigurations", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The notification configurations.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { "smithy.api#documentation": "A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.
The name of the Auto Scaling group.
" } }, "IncludeManagedResources": { "target": "com.amazonaws.autoscaling#IncludeManagedResources", "traits": { "smithy.api#documentation": "\n Specifies whether to include notification configurations for managed Auto Scaling groups in the response. When set to true (default), the response includes notification configurations for managed Auto Scaling groups.\n
The token for the next set of items to return. (You received this token from a\n previous call.)
" } }, "MaxRecords": { "target": "com.amazonaws.autoscaling#MaxRecords", "traits": { "smithy.api#documentation": "The maximum number of items to return with this call. The default value is\n 50 and the maximum value is 100.
A response can contain fewer items than the value specified by MaxRecords, even when more items are available. To retrieve the additional items, use the NextToken value in a subsequent call rather than relying on the number of items in the response.
Gets information about the scaling policies in the account and Region.
", "smithy.api#examples": [ { "title": "To describe scaling policies", "documentation": "This example describes the policies for the specified Auto Scaling group.", "input": { "AutoScalingGroupName": "my-auto-scaling-group" }, "output": { "ScalingPolicies": [ { "PolicyName": "ScaleIn", "AutoScalingGroupName": "my-auto-scaling-group", "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2233f3d7-6290-403b-b632-93c553560106:autoScalingGroupName/my-auto-scaling-group:policyName/ScaleIn", "AdjustmentType": "ChangeInCapacity", "Alarms": [], "ScalingAdjustment": -1 }, { "PolicyName": "ScalePercentChange", "MinAdjustmentStep": 2, "AutoScalingGroupName": "my-auto-scaling-group", "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2b435159-cf77-4e89-8c0e-d63b497baad7:autoScalingGroupName/my-auto-scaling-group:policyName/ScalePercentChange", "Cooldown": 60, "AdjustmentType": "PercentChangeInCapacity", "Alarms": [], "ScalingAdjustment": 25 } ] } } ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "ScalingPolicies", "pageSize": "MaxRecords" } } }, "com.amazonaws.autoscaling#DescribePoliciesType": { "type": "structure", "members": { "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The name of the Auto Scaling group.
" } }, "PolicyNames": { "target": "com.amazonaws.autoscaling#PolicyNames", "traits": { "smithy.api#documentation": "The names of one or more policies. If you omit this property, all policies are\n described. If a group name is provided, the results are limited to that group. If you\n specify an unknown policy name, it is ignored with no error.
\nArray Members: Maximum number of 50 items.
" } }, "PolicyTypes": { "target": "com.amazonaws.autoscaling#PolicyTypes", "traits": { "smithy.api#documentation": "One or more policy types. The valid values are SimpleScaling,\n StepScaling, TargetTrackingScaling, and\n PredictiveScaling.
\n Specifies whether to include scaling policies for managed Auto Scaling groups in the response. When set to true (default), the response includes scaling policies for managed Auto Scaling groups.\n
The token for the next set of items to return. (You received this token from a\n previous call.)
" } }, "MaxRecords": { "target": "com.amazonaws.autoscaling#MaxRecords", "traits": { "smithy.api#documentation": "The maximum number of items to be returned with each call. The default value is\n 50 and the maximum value is 100.
A response can contain fewer items than the value specified by MaxRecords, even when more items are available. To retrieve the additional items, use the NextToken value in a subsequent call rather than relying on the number of items in the response.
Gets information about the scaling activities in the account and Region.
\nWhen scaling events occur, you see a record of the scaling activity in the scaling\n activities. For more information, see Verify a scaling\n activity for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
\nIf the scaling event succeeds, the value of the StatusCode element in the\n response is Successful. If an attempt to launch instances failed, the\n StatusCode value is Failed or Cancelled and\n the StatusMessage element in the response indicates the cause of the\n failure. For help interpreting the StatusMessage, see Troubleshooting Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
\n The activity IDs of the desired scaling activities. If unknown activity IDs are requested, they are ignored\n with no error. Only activities started within the last six weeks can be returned regardless of the activity\n IDs specified. If other filters are specified with the request, only results matching all filter criteria\n can be returned.\n
\nArray Members: Maximum number of 50 IDs.
" } }, "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The name of the Auto Scaling group.
\n\n Omitting this property performs an account-wide operation, which can result in slower or timed-out requests.\n
\nIndicates whether to include scaling activity from deleted Auto Scaling groups.
" } }, "IncludeManagedResources": { "target": "com.amazonaws.autoscaling#IncludeManagedResources", "traits": { "smithy.api#documentation": "\n Specifies whether to include scaling activities for managed Auto Scaling groups in the response. When set to true (default), the response includes scaling activities for managed Auto Scaling groups.\n
The maximum number of items to return with this call. The default value is\n 100 and the maximum value is 100.
A response can contain fewer items than the value specified by MaxRecords, even when more items are available. To retrieve the additional items, use the NextToken value in a subsequent call rather than relying on the number of items in the response.
The token for the next set of items to return. (You received this token from a\n previous call.)
" } }, "Filters": { "target": "com.amazonaws.autoscaling#Filters", "traits": { "smithy.api#documentation": "\n One or more filters to limit the results based on specific criteria. The following filters are supported:\n
\n\n StartTimeLowerBound - The earliest scaling activities to return based on the activity start time.\n Scaling activities with a start time earlier than this value are not included in the results.\n Only activities started within the last six weeks can be returned regardless of the value specified.\n
\n StartTimeUpperBound - The latest scaling activities to return based on the activity start time.\n Scaling activities with a start time later than this value are not included in the results.\n Only activities started within the last six weeks can be returned regardless of the value specified.\n
\n Status - The StatusCode value of the scaling activity. This filter can only be\n used in combination with the AutoScalingGroupName parameter. For valid StatusCode\n values, see Activity\n in the Amazon EC2 Auto Scaling API Reference.\n
\n StartTimeLowerBound and StartTimeUpperBound accept ISO 8601 formatted timestamps.\n Timestamps without a timezone offset are assumed to be UTC.\n
\n 2000-01-18T08:15:00Z\n
\n 2000-01-18T16:15:00+08:00\n
Describes the scaling process types for use with the ResumeProcesses \n and SuspendProcesses APIs.
", "smithy.api#examples": [ { "title": "To describe the Auto Scaling process types", "documentation": "This example describes the Auto Scaling process types.", "output": { "Processes": [ { "ProcessName": "AZRebalance" }, { "ProcessName": "AddToLoadBalancer" }, { "ProcessName": "AlarmNotification" }, { "ProcessName": "HealthCheck" }, { "ProcessName": "Launch" }, { "ProcessName": "ReplaceUnhealthy" }, { "ProcessName": "ScheduledActions" }, { "ProcessName": "Terminate" } ] } } ], "smithy.test#smokeTests": [ { "id": "DescribeScalingProcessTypesSuccess", "params": {}, "vendorParams": { "region": "us-west-2" }, "vendorParamsShape": "aws.test#AwsVendorParams", "expect": { "success": {} } } ] } }, "com.amazonaws.autoscaling#DescribeScheduledActions": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#DescribeScheduledActionsType" }, "output": { "target": "com.amazonaws.autoscaling#ScheduledActionsType" }, "errors": [ { "target": "com.amazonaws.autoscaling#InvalidNextToken" }, { "target": "com.amazonaws.autoscaling#ResourceContentionFault" } ], "traits": { "smithy.api#documentation": "Gets information about the scheduled actions that haven't run or that have not reached\n their end time.
\nTo describe the scaling activities for scheduled actions that have already run, call\n the DescribeScalingActivities API.
", "smithy.api#examples": [ { "title": "To describe scheduled actions", "documentation": "This example describes the scheduled actions for the specified Auto Scaling group.", "input": { "AutoScalingGroupName": "my-auto-scaling-group" }, "output": { "ScheduledUpdateGroupActions": [ { "MinSize": 2, "DesiredCapacity": 4, "AutoScalingGroupName": "my-auto-scaling-group", "MaxSize": 6, "Recurrence": "30 0 1 12 0", "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8e86b655-b2e6-4410-8f29-b4f094d6871c:autoScalingGroupName/my-auto-scaling-group:scheduledActionName/my-scheduled-action", "ScheduledActionName": "my-scheduled-action", "StartTime": "2016-12-01T00:30:00Z", "Time": "2016-12-01T00:30:00Z" } ] } } ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "ScheduledUpdateGroupActions", "pageSize": "MaxRecords" } } }, "com.amazonaws.autoscaling#DescribeScheduledActionsType": { "type": "structure", "members": { "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The name of the Auto Scaling group.
" } }, "ScheduledActionNames": { "target": "com.amazonaws.autoscaling#ScheduledActionNames", "traits": { "smithy.api#documentation": "The names of one or more scheduled actions. If you omit this property, all scheduled\n actions are described. If you specify an unknown scheduled action, it is ignored with no\n error.
\nArray Members: Maximum number of 50 actions.
" } }, "StartTime": { "target": "com.amazonaws.autoscaling#TimestampType", "traits": { "smithy.api#documentation": "The earliest scheduled start time to return. If scheduled action names are provided,\n this property is ignored.
" } }, "EndTime": { "target": "com.amazonaws.autoscaling#TimestampType", "traits": { "smithy.api#documentation": "The latest scheduled start time to return. If scheduled action names are provided,\n this property is ignored.
" } }, "IncludeManagedResources": { "target": "com.amazonaws.autoscaling#IncludeManagedResources", "traits": { "smithy.api#documentation": "\n Specifies whether to include scheduled actions for managed Auto Scaling groups in the response. When set to true (default), the response includes scheduled actions for managed Auto Scaling groups.\n
The token for the next set of items to return. (You received this token from a\n previous call.)
" } }, "MaxRecords": { "target": "com.amazonaws.autoscaling#MaxRecords", "traits": { "smithy.api#documentation": "The maximum number of items to return with this call. The default value is\n 50 and the maximum value is 100.
A response can contain fewer items than the value specified by MaxRecords, even when more items are available. To retrieve the additional items, use the NextToken value in a subsequent call rather than relying on the number of items in the response.
Describes the specified tags.
\nYou can use filters to limit the results. For example, you can query for the tags for\n a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at\n least one of the specified values for it to be included in the results.
\nYou can also specify multiple filters. The result includes information for a\n particular tag only if it matches all the filters. If there's no match, no special\n message is returned.
\nFor more information, see Tag Auto Scaling groups and\n instances in the Amazon EC2 Auto Scaling User Guide.
", "smithy.api#examples": [ { "title": "To describe tags", "documentation": "This example describes the tags for the specified Auto Scaling group.", "input": { "Filters": [ { "Values": [ "my-auto-scaling-group" ], "Name": "auto-scaling-group" } ] }, "output": { "Tags": [ { "ResourceType": "auto-scaling-group", "ResourceId": "my-auto-scaling-group", "PropagateAtLaunch": true, "Value": "Research", "Key": "Dept" }, { "ResourceType": "auto-scaling-group", "ResourceId": "my-auto-scaling-group", "PropagateAtLaunch": true, "Value": "WebServer", "Key": "Role" } ] } } ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Tags", "pageSize": "MaxRecords" } } }, "com.amazonaws.autoscaling#DescribeTagsType": { "type": "structure", "members": { "Filters": { "target": "com.amazonaws.autoscaling#Filters", "traits": { "smithy.api#documentation": "One or more filters to scope the tags to return. The maximum number of filters per\n filter type (for example, auto-scaling-group) is 1000.
\n Specifies whether to include tags for managed Auto Scaling groups in the response. When set to true (default), the response includes tags for managed Auto Scaling groups.\n
The token for the next set of items to return. (You received this token from a\n previous call.)
" } }, "MaxRecords": { "target": "com.amazonaws.autoscaling#MaxRecords", "traits": { "smithy.api#documentation": "The maximum number of items to return with this call. The default value is\n 50 and the maximum value is 100.
A response can contain fewer items than the value specified by MaxRecords, even when more items are available. To retrieve the additional items, use the NextToken value in a subsequent call rather than relying on the number of items in the response.
Describes the termination policies supported by Amazon EC2 Auto Scaling.
\nFor more information, see Configure\n termination policies for Amazon EC2 Auto Scaling in the\n Amazon EC2 Auto Scaling User Guide.
", "smithy.api#examples": [ { "title": "To describe termination policy types", "documentation": "This example describes the available termination policy types.", "output": { "TerminationPolicyTypes": [ "ClosestToNextInstanceHour", "Default", "NewestInstance", "OldestInstance", "OldestLaunchConfiguration" ] } } ] } }, "com.amazonaws.autoscaling#DescribeTerminationPolicyTypesAnswer": { "type": "structure", "members": { "TerminationPolicyTypes": { "target": "com.amazonaws.autoscaling#TerminationPolicies", "traits": { "smithy.api#documentation": "The termination policies supported by Amazon EC2 Auto Scaling: OldestInstance,\n OldestLaunchConfiguration, NewestInstance,\n ClosestToNextInstanceHour, Default,\n OldestLaunchTemplate, and AllocationStrategy.
Gets information about the traffic sources for the specified Auto Scaling group.
\nYou can optionally provide a traffic source type. If you provide a traffic source\n type, then the results only include that traffic source type.
\nIf you do not provide a traffic source type, then the results include all the traffic\n sources for the specified Auto Scaling group.
", "smithy.api#examples": [ { "title": "To describe the target groups for an Auto Scaling group", "documentation": "This example describes the target groups attached to the specified Auto Scaling group.", "input": { "AutoScalingGroupName": "my-auto-scaling-group" }, "output": { "TrafficSources": [ { "Identifier": "arn:aws:vpc-lattice:us-west-2:123456789012:targetgroup/tg-0e2f2665eEXAMPLE", "State": "InService", "Type": "vpc-lattice" } ], "NextToken": "" } } ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxRecords" } } }, "com.amazonaws.autoscaling#DescribeTrafficSourcesRequest": { "type": "structure", "members": { "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } }, "TrafficSourceType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The traffic source type that you want to describe.
\nThe following lists the valid values:
\n\n elb if the traffic source is a Classic Load Balancer.
\n elbv2 if the traffic source is a Application Load Balancer, Gateway Load Balancer, or Network Load Balancer.
\n vpc-lattice if the traffic source is VPC Lattice.
The token for the next set of items to return. (You received this token from a\n previous call.)
" } }, "MaxRecords": { "target": "com.amazonaws.autoscaling#MaxRecords", "traits": { "smithy.api#documentation": "The maximum number of items to return with this call. The maximum value is\n 50.
Information about the traffic sources.
" } }, "NextToken": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { "smithy.api#documentation": "This string indicates that the response contains more items than can be returned in a\n single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.
Gets information about a warm pool and its instances.
\nFor more information, see Warm pools for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Instances", "pageSize": "MaxRecords" } } }, "com.amazonaws.autoscaling#DescribeWarmPoolAnswer": { "type": "structure", "members": { "WarmPoolConfiguration": { "target": "com.amazonaws.autoscaling#WarmPoolConfiguration", "traits": { "smithy.api#documentation": "The warm pool configuration details.
" } }, "Instances": { "target": "com.amazonaws.autoscaling#Instances", "traits": { "smithy.api#documentation": "The instances that are currently in the warm pool.
" } }, "NextToken": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { "smithy.api#documentation": "This string indicates that the response contains more items than can be returned in a\n single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.
The name of the Auto Scaling group.
", "smithy.api#required": {} } }, "MaxRecords": { "target": "com.amazonaws.autoscaling#MaxRecords", "traits": { "smithy.api#documentation": "The maximum number of instances to return with this call. The maximum value is\n 50.
The token for the next set of instances to return. (You received this token from a\n previous call.)
" } } } }, "com.amazonaws.autoscaling#DesiredConfiguration": { "type": "structure", "members": { "LaunchTemplate": { "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", "traits": { "smithy.api#documentation": "Describes the launch template and the version of the launch template that Amazon EC2 Auto Scaling\n uses to launch Amazon EC2 instances. For more information about launch templates, see Launch\n templates in the Amazon EC2 Auto Scaling User Guide.
" } }, "MixedInstancesPolicy": { "target": "com.amazonaws.autoscaling#MixedInstancesPolicy", "traits": { "smithy.api#documentation": "Use this structure to launch multiple instance types and configure how capacity is\n distributed across On-Demand, Spot, and supported Capacity Reservation types within a\n single Auto Scaling group.
\nA mixed instances policy contains information that Amazon EC2 Auto Scaling can use to launch\n instances, prioritize capacity types, and help optimize your costs. For more\n information, see Auto Scaling\n groups with multiple instance types and purchase options in the\n Amazon EC2 Auto Scaling User Guide.
" } } }, "traits": { "smithy.api#documentation": "Describes the desired configuration for an instance refresh.
\nIf you specify a desired configuration, you must specify either a\n LaunchTemplate or a MixedInstancesPolicy.
Removes one or more instances from the specified Auto Scaling group.
\nAfter the instances are detached, you can manage them independent of the Auto Scaling\n group.
\nIf you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches\n instances to replace the ones that are detached.
\nIf there is a Classic Load Balancer attached to the Auto Scaling group, the instances are\n deregistered from the load balancer. If there are target groups attached to the Auto Scaling\n group, the instances are deregistered from the target groups.
\nFor more information, see Detach\n or attach instances in the Amazon EC2 Auto Scaling User Guide.
", "smithy.api#examples": [ { "title": "To detach an instance from an Auto Scaling group", "documentation": "This example detaches the specified instance from the specified Auto Scaling group.", "input": { "InstanceIds": [ "i-93633f9b" ], "AutoScalingGroupName": "my-auto-scaling-group", "ShouldDecrementDesiredCapacity": true }, "output": { "Activities": [ { "Description": "Detaching EC2 instance: i-93633f9b", "AutoScalingGroupName": "my-auto-scaling-group", "ActivityId": "5091cb52-547a-47ce-a236-c9ccbc2cb2c9", "Details": "details", "StartTime": "2015-04-12T15:02:16.179Z", "Progress": 50, "Cause": "At 2015-04-12T15:02:16Z instance i-93633f9b was detached in response to a user request, shrinking the capacity from 2 to 1.", "StatusCode": "InProgress" } ] } } ] } }, "com.amazonaws.autoscaling#DetachInstancesAnswer": { "type": "structure", "members": { "Activities": { "target": "com.amazonaws.autoscaling#Activities", "traits": { "smithy.api#documentation": "The activities related to detaching the instances from the Auto Scaling group.
" } } } }, "com.amazonaws.autoscaling#DetachInstancesQuery": { "type": "structure", "members": { "InstanceIds": { "target": "com.amazonaws.autoscaling#InstanceIds", "traits": { "smithy.api#documentation": "The IDs of the instances. You can specify up to 20 instances.
" } }, "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } }, "ShouldDecrementDesiredCapacity": { "target": "com.amazonaws.autoscaling#ShouldDecrementDesiredCapacity", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Indicates whether the Auto Scaling group decrements the desired capacity value by the number\n of instances detached.
", "smithy.api#required": {} } } } }, "com.amazonaws.autoscaling#DetachLoadBalancerTargetGroups": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#DetachLoadBalancerTargetGroupsType" }, "output": { "target": "com.amazonaws.autoscaling#DetachLoadBalancerTargetGroupsResultType" }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" } ], "traits": { "smithy.api#documentation": "This API operation is superseded by DetachTrafficSources, which\n can detach multiple traffic sources types. We recommend using\n DetachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support DetachLoadBalancerTargetGroups. You can\n use both the original DetachLoadBalancerTargetGroups API operation and\n DetachTrafficSources on the same Auto Scaling group.
Detaches one or more target groups from the specified Auto Scaling group.
\nWhen you detach a target group, it enters the Removing state while\n deregistering the instances in the group. When all instances are deregistered, then you\n can no longer describe the target group using the \n DescribeLoadBalancerTargetGroups\n API call. The instances remain running.
You can use this operation to detach target groups that were attached by using\n AttachLoadBalancerTargetGroups, but not for target groups that\n were attached by using AttachTrafficSources.
\nThe name of the Auto Scaling group.
", "smithy.api#required": {} } }, "TargetGroupARNs": { "target": "com.amazonaws.autoscaling#TargetGroupARNs", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 target\n groups.
", "smithy.api#required": {} } } } }, "com.amazonaws.autoscaling#DetachLoadBalancers": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#DetachLoadBalancersType" }, "output": { "target": "com.amazonaws.autoscaling#DetachLoadBalancersResultType" }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" } ], "traits": { "smithy.api#documentation": "This API operation is superseded by DetachTrafficSources, which\n can detach multiple traffic sources types. We recommend using\n DetachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support DetachLoadBalancers. You can use both\n the original DetachLoadBalancers API operation and\n DetachTrafficSources on the same Auto Scaling group.
Detaches one or more Classic Load Balancers from the specified Auto Scaling group.
\nThis operation detaches only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or\n Gateway Load Balancers, use the DetachLoadBalancerTargetGroups API instead.
\nWhen you detach a load balancer, it enters the Removing state while\n deregistering the instances in the group. When all instances are deregistered, then you\n can no longer describe the load balancer using the DescribeLoadBalancers\n API call. The instances remain running.
The name of the Auto Scaling group.
", "smithy.api#required": {} } }, "LoadBalancerNames": { "target": "com.amazonaws.autoscaling#LoadBalancerNames", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The names of the load balancers. You can specify up to 10 load balancers.
", "smithy.api#required": {} } } } }, "com.amazonaws.autoscaling#DetachTrafficSources": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#DetachTrafficSourcesType" }, "output": { "target": "com.amazonaws.autoscaling#DetachTrafficSourcesResultType" }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" } ], "traits": { "smithy.api#documentation": "Detaches one or more traffic sources from the specified Auto Scaling group.
\nWhen you detach a traffic source, it enters the Removing state while\n deregistering the instances in the group. When all instances are deregistered, then you\n can no longer describe the traffic source using the \n DescribeTrafficSources\n API call. The instances continue to run.
The name of the Auto Scaling group.
", "smithy.api#required": {} } }, "TrafficSources": { "target": "com.amazonaws.autoscaling#TrafficSources", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The unique identifiers of one or more traffic sources. You can specify up to 10\n traffic sources.
", "smithy.api#required": {} } } } }, "com.amazonaws.autoscaling#DisableMetricsCollection": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#DisableMetricsCollectionQuery" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" } ], "traits": { "smithy.api#documentation": "Disables group metrics collection for the specified Auto Scaling group.
", "smithy.api#examples": [ { "title": "To disable metrics collection for an Auto Scaling group", "documentation": "This example disables collecting data for the GroupDesiredCapacity metric for the specified Auto Scaling group.", "input": { "AutoScalingGroupName": "my-auto-scaling-group", "Metrics": [ "GroupDesiredCapacity" ] } } ] } }, "com.amazonaws.autoscaling#DisableMetricsCollectionQuery": { "type": "structure", "members": { "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } }, "Metrics": { "target": "com.amazonaws.autoscaling#Metrics", "traits": { "smithy.api#documentation": "Identifies the metrics to disable.
\nYou can specify one or more of the following metrics:
\n\n GroupMinSize\n
\n GroupMaxSize\n
\n GroupDesiredCapacity\n
\n GroupInServiceInstances\n
\n GroupPendingInstances\n
\n GroupStandbyInstances\n
\n GroupTerminatingInstances\n
\n GroupTotalInstances\n
\n GroupInServiceCapacity\n
\n GroupPendingCapacity\n
\n GroupStandbyCapacity\n
\n GroupTerminatingCapacity\n
\n GroupTotalCapacity\n
\n WarmPoolDesiredCapacity\n
\n WarmPoolWarmedCapacity\n
\n WarmPoolPendingCapacity\n
\n WarmPoolTerminatingCapacity\n
\n WarmPoolTotalCapacity\n
\n GroupAndWarmPoolDesiredCapacity\n
\n GroupAndWarmPoolTotalCapacity\n
If you omit this property, all metrics are disabled.
\nFor more information, see Amazon CloudWatch metrics for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
" } } } }, "com.amazonaws.autoscaling#DisableScaleIn": { "type": "boolean" }, "com.amazonaws.autoscaling#DistributionSegment": { "type": "structure", "members": { "TargetCapacityTypes": { "target": "com.amazonaws.autoscaling#TargetCapacityTypes", "traits": { "smithy.api#documentation": "The capacity types to prioritize, in order. Amazon EC2 Auto Scaling attempts to launch instances in\n the priority order of the capacity types, and within each capacity type, in the order of\n instance types listed in your launch template Overrides.
The following lists the valid values:
\nOn-Demand Capacity Reservations.
\nCapacity Blocks.
\nInterruptible Capacity Reservations.
\nOn-Demand capacity. Include this value to allow the group to fall back to\n On-Demand capacity when the preceding capacity types are unavailable.
\nUse this structure to specify the capacity types that Amazon EC2 Auto Scaling prioritizes when it\n launches instances.
" } }, "com.amazonaws.autoscaling#DistributionSegments": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#DistributionSegment" } }, "com.amazonaws.autoscaling#Ebs": { "type": "structure", "members": { "SnapshotId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The snapshot ID of the volume to use.
\nYou must specify either a VolumeSize or a SnapshotId.
The volume size, in GiBs. The following are the supported volumes sizes for each\n volume type:
\n\n gp2 and gp3: 1-16,384
\n io1: 4-16,384
\n st1 and sc1: 125-16,384
\n standard: 1-1,024
You must specify either a SnapshotId or a VolumeSize. If you\n specify both SnapshotId and VolumeSize, the volume size must\n be equal or greater than the size of the snapshot.
The volume type. For more information, see Amazon EBS volume types in the\n Amazon EBS User Guide.
\nValid values: standard | io1 | gp2 |\n st1 | sc1 | gp3\n
Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the\n default value is true.
The number of input/output (I/O) operations per second (IOPS) to provision for the\n volume. For gp3 and io1 volumes, this represents the number of\n IOPS that are provisioned for the volume. For gp2 volumes, this represents\n the baseline performance of the volume and the rate at which the volume accumulates I/O\n credits for bursting.
The following are the supported values for each volume type:
\n\n gp3: 3,000-16,000 IOPS
\n io1: 100-64,000 IOPS
For io1 volumes, we guarantee 64,000 IOPS only for Instances built on the Amazon Web Services Nitro System. Other instance families\n guarantee performance up to 32,000 IOPS.
\n Iops is supported when the volume type is gp3 or\n io1 and required only when the volume type is io1. (Not\n used with standard, gp2, st1, or sc1\n volumes.)
Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be\n attached to instances that support Amazon EBS encryption. For more information, see Requirements for Amazon EBS encryption in the Amazon EBS User Guide. If your AMI uses encrypted volumes, you\n can also only launch it on supported instance types.
\nIf you are creating a volume from a snapshot, you cannot create an unencrypted\n volume from an encrypted snapshot. Also, you cannot specify a KMS key ID when using\n a launch configuration.
\nIf you enable encryption by default, the EBS volumes that you create are always\n encrypted, either using the Amazon Web Services managed KMS key or a customer-managed KMS key,\n regardless of whether the snapshot was encrypted.
\nFor more information, see Use Amazon Web Services KMS keys to encrypt Amazon EBS volumes in the\n Amazon EC2 Auto Scaling User Guide.
\nThe throughput (MiBps) to provision for a gp3 volume.
Describes information used to set up an Amazon EBS volume specified in a block device\n mapping.
" } }, "com.amazonaws.autoscaling#EbsOptimized": { "type": "boolean" }, "com.amazonaws.autoscaling#EnableMetricsCollection": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#EnableMetricsCollectionQuery" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" } ], "traits": { "smithy.api#documentation": "Enables group metrics collection for the specified Auto Scaling group.
\nYou can use these metrics to track changes in an Auto Scaling group and to set alarms on\n threshold values. You can view group metrics using the Amazon EC2 Auto Scaling console or the CloudWatch\n console. For more information, see Monitor\n CloudWatch metrics for your Auto Scaling groups and instances in the\n Amazon EC2 Auto Scaling User Guide.
", "smithy.api#examples": [ { "title": "To enable metrics collection for an Auto Scaling group", "documentation": "This example enables data collection for the specified Auto Scaling group.", "input": { "AutoScalingGroupName": "my-auto-scaling-group", "Granularity": "1Minute" } } ] } }, "com.amazonaws.autoscaling#EnableMetricsCollectionQuery": { "type": "structure", "members": { "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } }, "Metrics": { "target": "com.amazonaws.autoscaling#Metrics", "traits": { "smithy.api#documentation": "Identifies the metrics to enable.
\nYou can specify one or more of the following metrics:
\n\n GroupMinSize\n
\n GroupMaxSize\n
\n GroupDesiredCapacity\n
\n GroupInServiceInstances\n
\n GroupPendingInstances\n
\n GroupStandbyInstances\n
\n GroupTerminatingInstances\n
\n GroupTotalInstances\n
\n GroupInServiceCapacity\n
\n GroupPendingCapacity\n
\n GroupStandbyCapacity\n
\n GroupTerminatingCapacity\n
\n GroupTotalCapacity\n
\n WarmPoolDesiredCapacity\n
\n WarmPoolWarmedCapacity\n
\n WarmPoolPendingCapacity\n
\n WarmPoolTerminatingCapacity\n
\n WarmPoolTotalCapacity\n
\n GroupAndWarmPoolDesiredCapacity\n
\n GroupAndWarmPoolTotalCapacity\n
If you specify Granularity and don't specify any metrics, all metrics are\n enabled.
For more information, see Amazon CloudWatch metrics for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
" } }, "Granularity": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is\n 1Minute.
One of the following metrics:
\n\n GroupMinSize\n
\n GroupMaxSize\n
\n GroupDesiredCapacity\n
\n GroupInServiceInstances\n
\n GroupPendingInstances\n
\n GroupStandbyInstances\n
\n GroupTerminatingInstances\n
\n GroupTotalInstances\n
\n GroupInServiceCapacity\n
\n GroupPendingCapacity\n
\n GroupStandbyCapacity\n
\n GroupTerminatingCapacity\n
\n GroupTotalCapacity\n
\n WarmPoolDesiredCapacity\n
\n WarmPoolWarmedCapacity\n
\n WarmPoolPendingCapacity\n
\n WarmPoolTerminatingCapacity\n
\n WarmPoolTotalCapacity\n
\n GroupAndWarmPoolDesiredCapacity\n
\n GroupAndWarmPoolTotalCapacity\n
For more information, see Amazon CloudWatch metrics for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
" } }, "Granularity": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The granularity of the metric. The only valid value is 1Minute.
Describes an enabled Auto Scaling group metric.
" } }, "com.amazonaws.autoscaling#EnabledMetrics": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#EnabledMetric" } }, "com.amazonaws.autoscaling#EnterStandby": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#EnterStandbyQuery" }, "output": { "target": "com.amazonaws.autoscaling#EnterStandbyAnswer" }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" } ], "traits": { "smithy.api#documentation": "Moves the specified instances into the standby state.
\nIf you choose to decrement the desired capacity of the Auto Scaling group, the instances can\n enter standby as long as the desired capacity of the Auto Scaling group after the instances are\n placed into standby is equal to or greater than the minimum capacity of the\n group.
\nIf you choose not to decrement the desired capacity of the Auto Scaling group, the Auto Scaling group\n launches new instances to replace the instances on standby.
\nFor more information, see Temporarily removing\n instances from your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
", "smithy.api#examples": [ { "title": "To move instances into standby mode", "documentation": "This example puts the specified instance into standby mode.", "input": { "InstanceIds": [ "i-93633f9b" ], "AutoScalingGroupName": "my-auto-scaling-group", "ShouldDecrementDesiredCapacity": true }, "output": { "Activities": [ { "Description": "Moving EC2 instance to Standby: i-93633f9b", "AutoScalingGroupName": "my-auto-scaling-group", "ActivityId": "ffa056b4-6ed3-41ba-ae7c-249dfae6eba1", "Details": "details", "StartTime": "2015-04-12T15:10:23.640Z", "Progress": 50, "Cause": "At 2015-04-12T15:10:23Z instance i-93633f9b was moved to standby in response to a user request, shrinking the capacity from 2 to 1.", "StatusCode": "InProgress" } ] } } ] } }, "com.amazonaws.autoscaling#EnterStandbyAnswer": { "type": "structure", "members": { "Activities": { "target": "com.amazonaws.autoscaling#Activities", "traits": { "smithy.api#documentation": "The activities related to moving instances into Standby mode.
The IDs of the instances. You can specify up to 20 instances.
" } }, "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } }, "ShouldDecrementDesiredCapacity": { "target": "com.amazonaws.autoscaling#ShouldDecrementDesiredCapacity", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Indicates whether to decrement the desired capacity of the Auto Scaling group by the number of\n instances moved to Standby mode.
Executes the specified policy. This can be useful for testing the design of your\n scaling policy.
", "smithy.api#examples": [ { "title": "To execute a scaling policy", "documentation": "This example executes the specified policy.", "input": { "AutoScalingGroupName": "my-auto-scaling-group", "PolicyName": "my-step-scale-out-policy", "BreachThreshold": 50.0, "MetricValue": 59.0 } } ] } }, "com.amazonaws.autoscaling#ExecutePolicyType": { "type": "structure", "members": { "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The name of the Auto Scaling group.
" } }, "PolicyName": { "target": "com.amazonaws.autoscaling#ResourceName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name or ARN of the policy.
", "smithy.api#required": {} } }, "HonorCooldown": { "target": "com.amazonaws.autoscaling#HonorCooldown", "traits": { "smithy.api#documentation": "Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing\n the policy.
\nValid only if the policy type is SimpleScaling. For more information, see\n Scaling\n cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
The metric value to compare to BreachThreshold. This enables you to\n execute a policy of type StepScaling and determine which step adjustment to\n use. For example, if the breach threshold is 50 and you want to use a step adjustment\n with a lower bound of 0 and an upper bound of 10, you can set the metric value to\n 59.
If you specify a metric value that doesn't correspond to a step adjustment for the\n policy, the call returns an error.
\nRequired if the policy type is StepScaling and not supported\n otherwise.
The breach threshold for the alarm.
\nRequired if the policy type is StepScaling and not supported\n otherwise.
Moves the specified instances out of the standby state.
\nAfter you put the instances back in service, the desired capacity is\n incremented.
\nFor more information, see Temporarily removing\n instances from your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
", "smithy.api#examples": [ { "title": "To move instances out of standby mode", "documentation": "This example moves the specified instance out of standby mode.", "input": { "InstanceIds": [ "i-93633f9b" ], "AutoScalingGroupName": "my-auto-scaling-group" }, "output": { "Activities": [ { "Description": "Moving EC2 instance out of Standby: i-93633f9b", "AutoScalingGroupName": "my-auto-scaling-group", "ActivityId": "142928e1-a2dc-453a-9b24-b85ad6735928", "Details": "details", "StartTime": "2015-04-12T15:14:29.886Z", "Progress": 30, "Cause": "At 2015-04-12T15:14:29Z instance i-93633f9b was moved out of standby in response to a user request, increasing the capacity from 1 to 2.", "StatusCode": "PreInService" } ] } } ] } }, "com.amazonaws.autoscaling#ExitStandbyAnswer": { "type": "structure", "members": { "Activities": { "target": "com.amazonaws.autoscaling#Activities", "traits": { "smithy.api#documentation": "The activities related to moving instances out of Standby mode.
The IDs of the instances. You can specify up to 20 instances.
" } }, "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } } } }, "com.amazonaws.autoscaling#FailedScheduledUpdateGroupActionRequest": { "type": "structure", "members": { "ScheduledActionName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the scheduled action.
", "smithy.api#required": {} } }, "ErrorCode": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", "traits": { "smithy.api#documentation": "The error code.
" } }, "ErrorMessage": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { "smithy.api#documentation": "The error message accompanying the error code.
" } } }, "traits": { "smithy.api#documentation": "Describes a scheduled action that could not be created, updated, or deleted.
" } }, "com.amazonaws.autoscaling#FailedScheduledUpdateGroupActionRequests": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#FailedScheduledUpdateGroupActionRequest" } }, "com.amazonaws.autoscaling#Filter": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { "smithy.api#documentation": "The name of the filter.
\n\n The valid values for Name depend on which API operation you're using with the filter.\n
\n \n DescribeAutoScalingGroups\n \n
\nValid values for Name include the following:
\n tag-key - Accepts tag keys. The results only include information\n about the Auto Scaling groups associated with these tag keys.
\n tag-value - Accepts tag values. The results only include\n information about the Auto Scaling groups associated with these tag values.
\n tag: - Accepts the key/value combination of the tag.\n Use the tag key in the filter name and the tag value as the filter value. The\n results only include information about the Auto Scaling groups associated with the\n specified key/value combination.
\n \n DescribeTags\n \n
\nValid values for Name include the following:
\n auto-scaling-group - Accepts the names of Auto Scaling groups. The\n results only include information about the tags associated with these Auto Scaling\n groups.
\n key - Accepts tag keys. The results only include information\n about the tags associated with these tag keys.
\n value - Accepts tag values. The results only include information\n about the tags associated with these tag values.
\n propagate-at-launch - Accepts a Boolean value, which specifies\n whether tags propagate to instances at launch. The results only include\n information about the tags associated with the specified Boolean value.
\n \n DescribeScalingActivities\n \n
\nValid values for Name include the following:
\n StartTimeLowerBound - The earliest scaling activities to return based on the activity start time.\n Scaling activities with a start time earlier than this value are not included in the results.\n Only activities started within the last six weeks can be returned regardless of the value specified.\n
\n StartTimeUpperBound - The latest scaling activities to return based on the activity start time.\n Scaling activities with a start time later than this value are not included in the results.\n Only activities started within the last six weeks can be returned regardless of the value specified.\n
\n Status - The StatusCode value of the scaling activity. This filter can only be\n used in combination with the AutoScalingGroupName parameter. For valid StatusCode\n values, see Activity\n in the Amazon EC2 Auto Scaling API Reference.\n
\n StartTimeLowerBound and StartTimeUpperBound accept ISO 8601 formatted timestamps.\n Timestamps without a timezone offset are assumed to be UTC.\n
\n 2000-01-18T08:15:00Z\n
\n 2000-01-18T16:15:00+08:00\n
One or more filter values. Filter values are case-sensitive.
\nIf you specify multiple values for a filter, the values are automatically logically\n joined with an OR, and the request returns all results that match any of\n the specified values.
\n DescribeAutoScalingGroups example: Specify \"tag:environment\" \n for the filter name and \"production,development\" for the filter values to find Auto Scaling groups with \n the tag \"environment=production\" or \"environment=development\".\n
\n\n DescribeScalingActivities example: Specify \"Status\" for the \n filter name and \"Successful,Failed\" for the filter values to find scaling activities with a \n status of either \"Successful\" or \"Failed\".\n
" } } }, "traits": { "smithy.api#documentation": "Describes a filter that is used to return a more specific list of results from a\n describe operation.
\nIf you specify multiple filters, the filters are automatically logically joined with\n an AND, and the request returns only the results that match all of the\n specified filters.
For more information, see Tag Auto Scaling groups and\n instances in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#Filters": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#Filter" } }, "com.amazonaws.autoscaling#ForceDelete": { "type": "boolean" }, "com.amazonaws.autoscaling#GetPredictiveScalingForecast": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#GetPredictiveScalingForecastType" }, "output": { "target": "com.amazonaws.autoscaling#GetPredictiveScalingForecastAnswer" }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" } ], "traits": { "smithy.api#documentation": "Retrieves the forecast data for a predictive scaling policy.
\nLoad forecasts are predictions of the hourly load values using historical load data\n from CloudWatch and an analysis of historical trends. Capacity forecasts are represented as\n predicted values for the minimum capacity that is needed on an hourly basis, based on\n the hourly load forecast.
\nA minimum of 24 hours of data is required to create the initial forecasts. However,\n having a full 14 days of historical data results in more accurate forecasts.
\nFor more information, see Predictive\n scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#GetPredictiveScalingForecastAnswer": { "type": "structure", "members": { "LoadForecast": { "target": "com.amazonaws.autoscaling#LoadForecasts", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The load forecast.
", "smithy.api#required": {} } }, "CapacityForecast": { "target": "com.amazonaws.autoscaling#CapacityForecast", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The capacity forecast.
", "smithy.api#required": {} } }, "UpdateTime": { "target": "com.amazonaws.autoscaling#TimestampType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The time the forecast was made.
", "smithy.api#required": {} } } } }, "com.amazonaws.autoscaling#GetPredictiveScalingForecastType": { "type": "structure", "members": { "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } }, "PolicyName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the policy.
", "smithy.api#required": {} } }, "StartTime": { "target": "com.amazonaws.autoscaling#TimestampType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The inclusive start time of the time range for the forecast data to get. At most, the\n date and time can be one year before the current date and time.
", "smithy.api#required": {} } }, "EndTime": { "target": "com.amazonaws.autoscaling#TimestampType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The exclusive end time of the time range for the forecast data to get. The maximum\n time duration between the start and end time is 30 days.
\nAlthough this parameter can accept a date and time that is more than two days in the\n future, the availability of forecast data has limits. Amazon EC2 Auto Scaling only issues forecasts for\n periods of two days in advance.
", "smithy.api#required": {} } } } }, "com.amazonaws.autoscaling#GlobalTimeout": { "type": "integer" }, "com.amazonaws.autoscaling#HealthCheckGracePeriod": { "type": "integer" }, "com.amazonaws.autoscaling#HeartbeatTimeout": { "type": "integer" }, "com.amazonaws.autoscaling#HonorCooldown": { "type": "boolean" }, "com.amazonaws.autoscaling#IdempotentCallInProgressFault": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" } }, "traits": { "aws.protocols#awsQueryError": { "code": "IdempotentCallInProgress", "httpResponseCode": 500 }, "smithy.api#documentation": "\n The service is currently processing another request with the same client token. Retry\n the request with the same client token\u2014the in-flight operation will complete and return\n its result.\n
", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.autoscaling#IdempotentParameterMismatchError": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" } }, "traits": { "aws.protocols#awsQueryError": { "code": "IdempotentParameterMismatch", "httpResponseCode": 400 }, "smithy.api#documentation": "\n Indicates that the parameters in the current request do not match the parameters from a previous request with the same client token within the idempotency window.\n
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.autoscaling#ImageId": { "type": "string", "traits": { "smithy.api#length": { "min": 5, "max": 21 }, "smithy.api#pattern": "^ami-[a-z0-9]{1,17}$" } }, "com.amazonaws.autoscaling#ImpairedZoneHealthCheckBehavior": { "type": "enum", "members": { "ReplaceUnhealthy": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ReplaceUnhealthy" } }, "IgnoreUnhealthy": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IgnoreUnhealthy" } } } }, "com.amazonaws.autoscaling#IncludeDeletedGroups": { "type": "boolean" }, "com.amazonaws.autoscaling#IncludeInstances": { "type": "boolean" }, "com.amazonaws.autoscaling#IncludeManagedResources": { "type": "boolean" }, "com.amazonaws.autoscaling#Instance": { "type": "structure", "members": { "InstanceId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The ID of the instance.
", "smithy.api#required": {} } }, "InstanceType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The instance type of the EC2 instance.
" } }, "AvailabilityZone": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Availability Zone in which the instance is running.
", "smithy.api#required": {} } }, "AvailabilityZoneId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "\n The Availability Zone ID where the instance was launched.\n
" } }, "LifecycleState": { "target": "com.amazonaws.autoscaling#LifecycleState", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "A description of the current lifecycle state. The Quarantined state is\n not used. For more information, see Amazon EC2 Auto Scaling instance\n lifecycle in the Amazon EC2 Auto Scaling User Guide.
The last reported health status of the instance. Healthy means that the\n instance is healthy and should remain in service. Unhealthy means that the\n instance is unhealthy and that Amazon EC2 Auto Scaling should terminate and replace it.
The launch configuration associated with the instance.
" } }, "LaunchTemplate": { "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", "traits": { "smithy.api#documentation": "The launch template for the instance.
" } }, "ImageId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "\n The ID of the Amazon Machine Image (AMI) used for the instance's current root volume. \n This value reflects the most recent AMI applied to the instance, including updates made \n through root volume replacement operations.\n
\n\n This field appears for:\n
\nInstances with root volume replacements through Instance Refresh
\nInstances launched with AMI overrides
\nThis field won't appear for:
\nExisting instances launched from Launch Templates without overrides
\nExisting instances that didn\u2019t have their root volume replaced through Instance Refresh
\nIndicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling\n in.
", "smithy.api#required": {} } }, "WeightedCapacity": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", "traits": { "smithy.api#documentation": "The number of capacity units contributed by the instance based on its instance\n type.
\nValid Range: Minimum value of 1. Maximum value of 999.
" } } }, "traits": { "smithy.api#documentation": "Describes an EC2 instance.
" } }, "com.amazonaws.autoscaling#InstanceCollection": { "type": "structure", "members": { "InstanceType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "\n The instance type of the launched instances.\n
" } }, "MarketType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", "traits": { "smithy.api#documentation": "\n The market type for the instances (On-Demand or Spot).\n
" } }, "SubnetId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "\n The ID of the subnet where the instances were launched.\n
" } }, "AvailabilityZone": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "\n The Availability Zone where the instances were launched.\n
" } }, "AvailabilityZoneId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "\n The Availability Zone ID where the instances in this collection were launched.\n
" } }, "InstanceIds": { "target": "com.amazonaws.autoscaling#InstanceIds", "traits": { "smithy.api#documentation": "\n A list of instance IDs for the successfully launched instances.\n
" } } }, "traits": { "smithy.api#documentation": "\n Contains details about a collection of instances launched in the Auto Scaling group.\n
" } }, "com.amazonaws.autoscaling#InstanceCollections": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#InstanceCollection" } }, "com.amazonaws.autoscaling#InstanceGeneration": { "type": "enum", "members": { "CURRENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "current" } }, "PREVIOUS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "previous" } } } }, "com.amazonaws.autoscaling#InstanceGenerations": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#InstanceGeneration" } }, "com.amazonaws.autoscaling#InstanceIds": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen19" } }, "com.amazonaws.autoscaling#InstanceLifecyclePolicy": { "type": "structure", "members": { "RetentionTriggers": { "target": "com.amazonaws.autoscaling#RetentionTriggers", "traits": { "smithy.api#documentation": "\n Specifies the conditions that trigger instance retention behavior. These triggers determine when instances \n should move to a Retained state instead of automatic termination. This allows you to maintain\n control over instance management when lifecycles transition and operations fail.\n
\n The instance lifecycle policy for the Auto Scaling group. This policy controls instance behavior when an instance\n transitions through its lifecycle states. Configure retention triggers to specify when instances should\n move to a Retained state instead of automatic termination.\n
For more information, see\n \n Control instance retention with instance lifecycle policies\n in the Amazon EC2 Auto Scaling User Guide.\n
" } }, "com.amazonaws.autoscaling#InstanceMaintenancePolicy": { "type": "structure", "members": { "MinHealthyPercentage": { "target": "com.amazonaws.autoscaling#IntPercentResettable", "traits": { "smithy.api#documentation": "Specifies the lower threshold as a percentage of the desired capacity of the Auto Scaling\n group. It represents the minimum percentage of the group to keep in service, healthy,\n and ready to use to support your workload when replacing instances. Value range is 0 to\n 100. To clear a previously set value, specify a value of -1.
Specifies the upper threshold as a percentage of the desired capacity of the Auto Scaling\n group. It represents the maximum percentage of the group that can be in service and\n healthy, or pending, to support your workload when replacing instances. Value range is\n 100 to 200. To clear a previously set value, specify a value of -1.
Both MinHealthyPercentage and MaxHealthyPercentage must be\n specified, and the difference between them cannot be greater than 100. A large range\n increases the number of instances that can be replaced at the same time.
Describes an instance maintenance policy.
\nFor more information, see Set instance maintenance policy in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#InstanceMetadataEndpointState": { "type": "enum", "members": { "Disabled": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "disabled" } }, "Enabled": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "enabled" } } } }, "com.amazonaws.autoscaling#InstanceMetadataHttpPutResponseHopLimit": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 64 } } }, "com.amazonaws.autoscaling#InstanceMetadataHttpTokensState": { "type": "enum", "members": { "Optional": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "optional" } }, "Required": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "required" } } } }, "com.amazonaws.autoscaling#InstanceMetadataOptions": { "type": "structure", "members": { "HttpTokens": { "target": "com.amazonaws.autoscaling#InstanceMetadataHttpTokensState", "traits": { "smithy.api#documentation": "The state of token usage for your instance metadata requests. If the parameter is not\n specified in the request, the default state is optional.
If the state is optional, you can choose to retrieve instance metadata\n with or without a signed token header on your request. If you retrieve the IAM role\n credentials without a token, the version 1.0 role credentials are returned. If you\n retrieve the IAM role credentials using a valid signed token, the version 2.0 role\n credentials are returned.
If the state is required, you must send a signed token header with any\n instance metadata retrieval requests. In this state, retrieving the IAM role credentials\n always returns the version 2.0 credentials; the version 1.0 credentials are not\n available.
The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel.
\nDefault: 1
" } }, "HttpEndpoint": { "target": "com.amazonaws.autoscaling#InstanceMetadataEndpointState", "traits": { "smithy.api#documentation": "This parameter enables or disables the HTTP metadata endpoint on your instances. If\n the parameter is not specified, the default state is enabled.
If you specify a value of disabled, you will not be able to access\n your instance metadata.
The metadata options for the instances. For more information, see Configure the instance metadata options in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#InstanceMonitoring": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.autoscaling#MonitoringEnabled", "traits": { "smithy.api#documentation": "If true, detailed monitoring is enabled. Otherwise, basic monitoring is\n enabled.
Describes whether detailed monitoring is enabled for the Auto Scaling instances.
" } }, "com.amazonaws.autoscaling#InstanceProtected": { "type": "boolean" }, "com.amazonaws.autoscaling#InstanceRefresh": { "type": "structure", "members": { "InstanceRefreshId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The instance refresh ID.
" } }, "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The name of the Auto Scaling group.
" } }, "Status": { "target": "com.amazonaws.autoscaling#InstanceRefreshStatus", "traits": { "smithy.api#documentation": "The current status for the instance refresh operation:
\n\n Pending - The request was created, but the instance refresh has\n not started.
\n InProgress - An instance refresh is in progress.
\n Successful - An instance refresh completed successfully.
\n Failed - An instance refresh failed to complete. You can\n troubleshoot using the status reason and the scaling activities.
\n Cancelling - An ongoing instance refresh is being\n cancelled.
\n Cancelled - The instance refresh is cancelled.
\n RollbackInProgress - An instance refresh is being rolled\n back.
\n RollbackFailed - The rollback failed to complete. You can\n troubleshoot using the status reason and the scaling activities.
\n RollbackSuccessful - The rollback completed successfully.
\n Baking - Waiting the specified bake time after an instance refresh has finished updating instances.
The explanation for the specific status assigned to this operation.
" } }, "StartTime": { "target": "com.amazonaws.autoscaling#TimestampType", "traits": { "smithy.api#documentation": "The date and time at which the instance refresh began.
" } }, "EndTime": { "target": "com.amazonaws.autoscaling#TimestampType", "traits": { "smithy.api#documentation": "The date and time at which the instance refresh ended.
" } }, "PercentageComplete": { "target": "com.amazonaws.autoscaling#IntPercent", "traits": { "smithy.api#documentation": "The percentage of the instance refresh that is complete. For each instance\n replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the\n instance's health status changes to healthy and the specified warm-up time passes, the\n instance is considered updated and is added to the percentage complete.
\n\n PercentageComplete does not include instances that are replaced\n during a rollback. This value gradually goes back down to zero during a\n rollback.
The number of instances remaining to update before the instance refresh is\n complete.
\nIf you roll back the instance refresh, InstancesToUpdate shows you\n the number of instances that were not yet updated by the instance refresh.\n Therefore, these instances don't need to be replaced as part of the rollback.
Additional progress details for an Auto Scaling group that has a warm pool.
" } }, "Preferences": { "target": "com.amazonaws.autoscaling#RefreshPreferences", "traits": { "smithy.api#documentation": "The preferences for an instance refresh.
" } }, "DesiredConfiguration": { "target": "com.amazonaws.autoscaling#DesiredConfiguration", "traits": { "smithy.api#documentation": "Describes the desired configuration for the instance refresh.
" } }, "RollbackDetails": { "target": "com.amazonaws.autoscaling#RollbackDetails", "traits": { "smithy.api#documentation": "The rollback details.
" } }, "Strategy": { "target": "com.amazonaws.autoscaling#RefreshStrategy", "traits": { "smithy.api#documentation": "\n The strategy to use for the instance refresh. This determines how instances in the Auto Scaling group are \n updated. Default is Rolling.\n
\n\n Rolling \u2013 Terminates instances and launches replacements in batches
\n ReplaceRootVolume \u2013 Updates instances by replacing only the root volume without terminating the instance
Describes an instance refresh for an Auto Scaling group.
" } }, "com.amazonaws.autoscaling#InstanceRefreshIds": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" } }, "com.amazonaws.autoscaling#InstanceRefreshInProgressFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" } }, "traits": { "aws.protocols#awsQueryError": { "code": "InstanceRefreshInProgress", "httpResponseCode": 400 }, "smithy.api#documentation": "The request failed because an active instance refresh already exists for the specified\n Auto Scaling group.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.autoscaling#InstanceRefreshLivePoolProgress": { "type": "structure", "members": { "PercentageComplete": { "target": "com.amazonaws.autoscaling#IntPercent", "traits": { "smithy.api#documentation": "The percentage of instances in the Auto Scaling group that have been replaced. For each\n instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time.\n When the instance's health status changes to healthy and the specified warm-up time\n passes, the instance is considered updated and is added to the percentage\n complete.
" } }, "InstancesToUpdate": { "target": "com.amazonaws.autoscaling#InstancesToUpdate", "traits": { "smithy.api#documentation": "The number of instances remaining to update.
" } } }, "traits": { "smithy.api#documentation": "Reports progress on replacing instances that are in the Auto Scaling group.
" } }, "com.amazonaws.autoscaling#InstanceRefreshProgressDetails": { "type": "structure", "members": { "LivePoolProgress": { "target": "com.amazonaws.autoscaling#InstanceRefreshLivePoolProgress", "traits": { "smithy.api#documentation": "Reports progress on replacing instances that are in the Auto Scaling group.
" } }, "WarmPoolProgress": { "target": "com.amazonaws.autoscaling#InstanceRefreshWarmPoolProgress", "traits": { "smithy.api#documentation": "Reports progress on replacing instances that are in the warm pool.
" } } }, "traits": { "smithy.api#documentation": "Reports progress on replacing instances in an Auto Scaling group that has a warm pool. This\n includes separate details for instances in the warm pool and instances in the Auto Scaling group\n (the live pool).
" } }, "com.amazonaws.autoscaling#InstanceRefreshStatus": { "type": "enum", "members": { "Pending": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Pending" } }, "InProgress": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "InProgress" } }, "Successful": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Successful" } }, "Failed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Failed" } }, "Cancelling": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Cancelling" } }, "Cancelled": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Cancelled" } }, "RollbackInProgress": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RollbackInProgress" } }, "RollbackFailed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RollbackFailed" } }, "RollbackSuccessful": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RollbackSuccessful" } }, "Baking": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Baking" } } } }, "com.amazonaws.autoscaling#InstanceRefreshWarmPoolProgress": { "type": "structure", "members": { "PercentageComplete": { "target": "com.amazonaws.autoscaling#IntPercent", "traits": { "smithy.api#documentation": "The percentage of instances in the warm pool that have been replaced. For each\n instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time.\n When the instance's health status changes to healthy and the specified warm-up time\n passes, the instance is considered updated and is added to the percentage\n complete.
" } }, "InstancesToUpdate": { "target": "com.amazonaws.autoscaling#InstancesToUpdate", "traits": { "smithy.api#documentation": "The number of instances remaining to update.
" } } }, "traits": { "smithy.api#documentation": "Reports progress on replacing instances that are in the warm pool.
" } }, "com.amazonaws.autoscaling#InstanceRefreshes": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#InstanceRefresh" } }, "com.amazonaws.autoscaling#InstanceRequirements": { "type": "structure", "members": { "VCpuCount": { "target": "com.amazonaws.autoscaling#VCpuCountRequest", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The minimum and maximum number of vCPUs for an instance type.
", "smithy.api#required": {} } }, "MemoryMiB": { "target": "com.amazonaws.autoscaling#MemoryMiBRequest", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The minimum and maximum instance memory size for an instance type, in MiB.
", "smithy.api#required": {} } }, "CpuManufacturers": { "target": "com.amazonaws.autoscaling#CpuManufacturers", "traits": { "smithy.api#documentation": "Lists which specific CPU manufacturers to include.
\nFor instance types with Intel CPUs, specify intel.
For instance types with AMD CPUs, specify amd.
For instance types with Amazon Web Services CPUs, specify\n amazon-web-services.
For instance types with Apple CPUs, specify\n apple.
Don't confuse the CPU hardware manufacturer with the CPU hardware architecture.\n Instances will be launched with a compatible CPU architecture based on the Amazon\n Machine Image (AMI) that you specify in your launch template.
\nDefault: Any manufacturer
" } }, "MemoryGiBPerVCpu": { "target": "com.amazonaws.autoscaling#MemoryGiBPerVCpuRequest", "traits": { "smithy.api#documentation": "The minimum and maximum amount of memory per vCPU for an instance type, in GiB.
\nDefault: No minimum or maximum limits
" } }, "ExcludedInstanceTypes": { "target": "com.amazonaws.autoscaling#ExcludedInstanceTypes", "traits": { "smithy.api#documentation": "The instance types to exclude. You can use strings with one or more wild cards,\n represented by an asterisk (*), to exclude an instance family, type, size,\n or generation. The following are examples: m5.8xlarge, c5*.*,\n m5a.*, r*, *3*.
For example, if you specify c5*, you are excluding the entire C5 instance\n family, which includes all C5a and C5n instance types. If you specify\n m5a.*, Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n\n instance types.
If you specify ExcludedInstanceTypes, you can't specify\n AllowedInstanceTypes.
Default: No excluded instance types
" } }, "InstanceGenerations": { "target": "com.amazonaws.autoscaling#InstanceGenerations", "traits": { "smithy.api#documentation": "Indicates whether current or previous generation instance types are included.
\nFor current generation instance types, specify current. The\n current generation includes EC2 instance types currently recommended for use.\n This typically includes the latest two to three generations in each instance\n family. For more information, see Instance types in\n the Amazon EC2 User Guide.
For previous generation instance types, specify previous.
Default: Any current or previous generation
" } }, "SpotMaxPricePercentageOverLowestPrice": { "target": "com.amazonaws.autoscaling#NullablePositiveInteger", "traits": { "smithy.api#documentation": "[Price protection] The price protection threshold for Spot Instances, as a percentage\n higher than an identified Spot price. The identified Spot price is the price of the\n lowest priced current generation C, M, or R instance type with your specified\n attributes. If no current generation C, M, or R instance type matches your attributes,\n then the identified price is from either the lowest priced current generation instance\n types or, failing that, the lowest priced previous generation instance types that match\n your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will\n exclude instance types whose price exceeds your specified threshold.
\nThe parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.
\nIf you set DesiredCapacityType to vcpu or\n memory-mib, the price protection threshold is based on the per-vCPU or\n per-memory price instead of the per instance price.
Only one of SpotMaxPricePercentageOverLowestPrice or\n MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If\n you don't specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection\n to consistently select from a wide range of instance types. To indicate no price\n protection threshold for Spot Instances, meaning you want to consider all instance\n types that match your attributes, include one of these parameters and specify a high\n value, such as 999999.
[Price protection] The price protection threshold for Spot Instances, as a percentage\n of an identified On-Demand price. The identified On-Demand price is the price of the\n lowest priced current generation C, M, or R instance type with your specified\n attributes. If no current generation C, M, or R instance type matches your attributes,\n then the identified price is from either the lowest priced current generation instance\n types or, failing that, the lowest priced previous generation instance types that match\n your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will\n exclude instance types whose price exceeds your specified threshold.
\nThe parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.
\nIf you set DesiredCapacityType to vcpu or\n memory-mib, the price protection threshold is based on the per-vCPU or\n per-memory price instead of the per instance price.
Only one of SpotMaxPricePercentageOverLowestPrice or\n MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If\n you don't specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection\n to consistently select from a wide range of instance types. To indicate no price\n protection threshold for Spot Instances, meaning you want to consider all instance\n types that match your attributes, include one of these parameters and specify a high\n value, such as 999999.
[Price protection] The price protection threshold for On-Demand Instances, as a\n percentage higher than an identified On-Demand price. The identified On-Demand price is\n the price of the lowest priced current generation C, M, or R instance type with your\n specified attributes. If no current generation C, M, or R instance type matches your\n attributes, then the identified price is from either the lowest priced current\n generation instance types or, failing that, the lowest priced previous generation\n instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with\n your attributes, we will exclude instance types whose price exceeds your specified\n threshold.
\nThe parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.
\nTo turn off price protection, specify a high value, such as 999999.
If you set DesiredCapacityType to vcpu or\n memory-mib, the price protection threshold is applied based on the\n per-vCPU or per-memory price instead of the per instance price.
Default: 20\n
Indicates whether bare metal instance types are included, excluded, or\n required.
\nDefault: excluded\n
Indicates whether burstable performance instance types are included, excluded, or\n required. For more information, see Burstable\n performance instances in the Amazon EC2 User Guide.
\nDefault: excluded\n
Indicates whether instance types must provide On-Demand Instance hibernation\n support.
\nDefault: false\n
The minimum and maximum number of network interfaces for an instance type.
\nDefault: No minimum or maximum limits
" } }, "LocalStorage": { "target": "com.amazonaws.autoscaling#LocalStorage", "traits": { "smithy.api#documentation": "Indicates whether instance types with instance store volumes are included, excluded,\n or required. For more information, see Amazon EC2 instance store in\n the Amazon EC2 User Guide.
\nDefault: included\n
Indicates the type of local storage that is required.
\nFor instance types with hard disk drive (HDD) storage, specify\n hdd.
For instance types with solid state drive (SSD) storage, specify\n ssd.
Default: Any local storage type
" } }, "TotalLocalStorageGB": { "target": "com.amazonaws.autoscaling#TotalLocalStorageGBRequest", "traits": { "smithy.api#documentation": "The minimum and maximum total local storage size for an instance type, in GB.
\nDefault: No minimum or maximum limits
" } }, "BaselineEbsBandwidthMbps": { "target": "com.amazonaws.autoscaling#BaselineEbsBandwidthMbpsRequest", "traits": { "smithy.api#documentation": "The minimum and maximum baseline bandwidth performance for an instance type, in Mbps.\n For more information, see Amazon EBS\u2013optimized instances\n in the Amazon EC2 User Guide.
\nDefault: No minimum or maximum limits
" } }, "AcceleratorTypes": { "target": "com.amazonaws.autoscaling#AcceleratorTypes", "traits": { "smithy.api#documentation": "Lists the accelerator types that must be on an instance type.
\nFor instance types with GPU accelerators, specify gpu.
For instance types with FPGA accelerators, specify fpga.
For instance types with inference accelerators, specify\n inference.
Default: Any accelerator type
" } }, "AcceleratorCount": { "target": "com.amazonaws.autoscaling#AcceleratorCountRequest", "traits": { "smithy.api#documentation": "The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia\n chips) for an instance type.
\nTo exclude accelerator-enabled instance types, set Max to\n 0.
Default: No minimum or maximum limits
" } }, "AcceleratorManufacturers": { "target": "com.amazonaws.autoscaling#AcceleratorManufacturers", "traits": { "smithy.api#documentation": "Indicates whether instance types must have accelerators by specific\n manufacturers.
\nFor instance types with NVIDIA devices, specify nvidia.
For instance types with AMD devices, specify amd.
For instance types with Amazon Web Services devices, specify\n amazon-web-services.
For instance types with Xilinx devices, specify xilinx.
Default: Any manufacturer
" } }, "AcceleratorNames": { "target": "com.amazonaws.autoscaling#AcceleratorNames", "traits": { "smithy.api#documentation": "Lists the accelerators that must be on an instance type.
\nFor 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\n radeon-pro-v520.
For instance types with Xilinx VU9P FPGAs, specify vu9p.
Default: Any accelerator
" } }, "AcceleratorTotalMemoryMiB": { "target": "com.amazonaws.autoscaling#AcceleratorTotalMemoryMiBRequest", "traits": { "smithy.api#documentation": "The minimum and maximum total memory size for the accelerators on an instance type, in\n MiB.
\nDefault: No minimum or maximum limits
" } }, "NetworkBandwidthGbps": { "target": "com.amazonaws.autoscaling#NetworkBandwidthGbpsRequest", "traits": { "smithy.api#documentation": "The minimum and maximum amount of network bandwidth, in gigabits per second\n (Gbps).
\nDefault: No minimum or maximum limits
" } }, "AllowedInstanceTypes": { "target": "com.amazonaws.autoscaling#AllowedInstanceTypes", "traits": { "smithy.api#documentation": "The instance types to apply your specified attributes against. All other instance\n types are ignored, even if they match your specified attributes.
\nYou can use strings with one or more wild cards, represented by an asterisk\n (*), to allow an instance type, size, or generation. The following are\n examples: m5.8xlarge, c5*.*, m5a.*,\n r*, *3*.
For example, if you specify c5*, Amazon EC2 Auto Scaling will allow the entire C5\n instance family, which includes all C5a and C5n instance types. If you specify\n m5a.*, Amazon EC2 Auto Scaling will allow all the M5a instance types, but not the M5n\n instance types.
If you specify AllowedInstanceTypes, you can't specify\n ExcludedInstanceTypes.
Default: All instance types
" } }, "BaselinePerformanceFactors": { "target": "com.amazonaws.autoscaling#BaselinePerformanceFactorsRequest", "traits": { "smithy.api#documentation": "\n The baseline performance factors for the instance requirements.\n
" } } }, "traits": { "smithy.api#documentation": "The attributes for the instance types for a mixed instances policy. Amazon EC2 Auto Scaling uses your\n specified requirements to identify instance types. Then, it uses your On-Demand and Spot\n allocation strategies to launch instances from these instance types.
\nWhen you specify multiple attributes, you get instance types that satisfy all of the\n specified attributes. If you specify multiple values for an attribute, you get instance\n types that satisfy any of the specified values.
\nTo limit the list of instance types from which Amazon EC2 Auto Scaling can identify matching instance\n types, you can use one of the following parameters, but not both in the same\n request:
\n\n AllowedInstanceTypes - The instance types to include in the list.\n All other instance types are ignored, even if they match your specified\n attributes.
\n ExcludedInstanceTypes - The instance types to exclude from the\n list, even if they match your specified attributes.
You must specify VCpuCount and MemoryMiB. All other\n attributes are optional. Any unspecified optional attribute is set to its\n default.
For more information, see Create a mixed instances group using attribute-based instance type\n selection in the Amazon EC2 Auto Scaling User Guide. For help determining\n which instance types match your attributes before you apply them to your Auto Scaling group, see\n Preview instance types with specified attributes in the\n Amazon EC2 User Guide.
" } }, "com.amazonaws.autoscaling#InstanceReusePolicy": { "type": "structure", "members": { "ReuseOnScaleIn": { "target": "com.amazonaws.autoscaling#ReuseOnScaleIn", "traits": { "smithy.api#documentation": "Specifies whether instances in the Auto Scaling group can be returned to the warm pool on\n scale in.
" } } }, "traits": { "smithy.api#documentation": "Describes an instance reuse policy for a warm pool.
\nFor more information, see Warm pools for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#Instances": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#Instance" } }, "com.amazonaws.autoscaling#InstancesDistribution": { "type": "structure", "members": { "OnDemandAllocationStrategy": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { "smithy.api#documentation": "The allocation strategy to apply to your On-Demand Instances when they are launched.\n Possible instance types are determined by the launch template overrides that you\n specify.
\nThe following lists the valid values:
\nUses price to determine which instance types are the highest priority,\n launching the lowest priced instance types within an Availability Zone\n first. This is the default value for Auto Scaling groups that specify \n InstanceRequirements.
\nYou set the order of instance types for the launch template overrides from\n highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling\n launches your highest priority instance types first. If all your On-Demand\n capacity cannot be fulfilled using your highest priority instance type, then\n Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance\n type, and so on. This is the default value for Auto Scaling groups that don't\n specify InstanceRequirements and cannot be used for groups\n that do.
\nThe minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand\n Instances. This base portion is launched first as your group scales.
\nThis number has the same unit of measurement as the group's desired capacity. If you\n change the default unit of measurement (number of instances) by specifying weighted\n capacity values in your launch template overrides list, or by changing the default\n desired capacity type setting of the group, you must specify this number using the same\n unit of measurement.
\nDefault: 0
" } }, "OnDemandPercentageAboveBaseCapacity": { "target": "com.amazonaws.autoscaling#OnDemandPercentageAboveBaseCapacity", "traits": { "smithy.api#documentation": "Controls the percentages of On-Demand Instances and Spot Instances for your additional\n capacity beyond OnDemandBaseCapacity. Expressed as a number (for example,\n 20 specifies 20% On-Demand Instances, 80% Spot Instances). If set to 100, only On-Demand\n Instances are used.
Default: 100
" } }, "SpotAllocationStrategy": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { "smithy.api#documentation": "The allocation strategy to apply to your Spot Instances when they are launched.\n Possible instance types are determined by the launch template overrides that you\n specify.
\nThe following lists the valid values:
\nRequests Spot Instances using pools that are optimally chosen based on the\n available Spot capacity. This strategy has the lowest risk of interruption.\n To give certain instance types a higher chance of launching first, use\n capacity-optimized-prioritized.
You set the order of instance types for the launch template overrides from\n highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling honors\n the instance type priorities on a best effort basis but optimizes for\n capacity first. Note that if the On-Demand allocation strategy is set to\n prioritized, the same priority is applied when fulfilling\n On-Demand capacity. This is not a valid value for Auto Scaling groups that specify\n InstanceRequirements.
Requests Spot Instances using the lowest priced pools within an\n Availability Zone, across the number of Spot pools that you specify for the\n SpotInstancePools property. To ensure that your desired\n capacity is met, you might receive Spot Instances from several pools. This\n is the default value, but it might lead to high interruption rates because\n this strategy only considers instance price and not available\n capacity.
The price and capacity optimized allocation strategy looks at both price\n and capacity to select the Spot Instance pools that are the least likely to\n be interrupted and have the lowest possible price.
\nThe number of Spot Instance pools across which to allocate your Spot Instances. The\n Spot pools are determined from the different instance types in the overrides. Valid only\n when the SpotAllocationStrategy is lowest-price. Value must be\n in the range of 1\u201320.
Default: 2
" } }, "SpotMaxPrice": { "target": "com.amazonaws.autoscaling#MixedInstanceSpotPrice", "traits": { "smithy.api#documentation": "The maximum price per unit hour that you are willing to pay for a Spot Instance. If\n your maximum price is lower than the Spot price for the instance types that you\n selected, your Spot Instances are not launched. We do not recommend specifying a maximum\n price because it can lead to increased interruptions. When Spot Instances launch, you\n pay the current Spot price. To remove a maximum price that you previously set, include\n the property but specify an empty string (\"\") for the value.
\nIf you specify a maximum price, your instances will be interrupted more frequently\n than if you do not specify one.
\nValid Range: Minimum value of 0.001
" } }, "DistributionSegments": { "target": "com.amazonaws.autoscaling#DistributionSegments", "traits": { "smithy.api#documentation": "The Distribution Segments configuration. Each segment contains an ordered list of\n capacity types to prioritize.
\nFor more information, see Use Distribution\n Segments to target multiple capacity types in the\n Amazon EC2 Auto Scaling User Guide.
" } } }, "traits": { "smithy.api#documentation": "Use this structure to specify how a mixed instances policy distributes capacity across\n On-Demand, Spot, and supported Capacity Reservation types, and to specify the allocation\n strategies that are used to fulfill the capacity.
" } }, "com.amazonaws.autoscaling#InstancesToUpdate": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.autoscaling#IntPercent": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 100 } } }, "com.amazonaws.autoscaling#IntPercent100To200": { "type": "integer", "traits": { "smithy.api#range": { "min": 100, "max": 200 } } }, "com.amazonaws.autoscaling#IntPercent100To200Resettable": { "type": "integer", "traits": { "smithy.api#range": { "min": -1, "max": 200 } } }, "com.amazonaws.autoscaling#IntPercentResettable": { "type": "integer", "traits": { "smithy.api#range": { "min": -1, "max": 100 } } }, "com.amazonaws.autoscaling#InvalidNextToken": { "type": "structure", "members": { "message": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidNextToken", "httpResponseCode": 400 }, "smithy.api#documentation": "The NextToken value is not valid.
The request failed because a desired configuration was not found or an incompatible\n launch template (uses a Systems Manager parameter instead of an AMI ID) or launch\n template version ($Latest or $Default) is present on the Auto Scaling\n group.
The name of the launch configuration.
", "smithy.api#required": {} } }, "LaunchConfigurationARN": { "target": "com.amazonaws.autoscaling#ResourceName", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the launch configuration.
" } }, "ImageId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. For more\n information, see Find a Linux AMI in the\n Amazon EC2 User Guide.
", "smithy.api#required": {} } }, "KeyName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The name of the key pair.
\nFor more information, see Amazon EC2 key pairs and Amazon EC2\n instances in the Amazon EC2 User Guide.
" } }, "SecurityGroups": { "target": "com.amazonaws.autoscaling#SecurityGroups", "traits": { "smithy.api#documentation": "A list that contains the security groups to assign to the instances in the Auto Scaling group.\n For more information, see Control traffic to your Amazon Web Services\n resources using security groups in the Amazon Virtual Private\n Cloud User Guide.
" } }, "ClassicLinkVPCId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "Available for backward compatibility.
" } }, "ClassicLinkVPCSecurityGroups": { "target": "com.amazonaws.autoscaling#ClassicLinkVPCSecurityGroups", "traits": { "smithy.api#documentation": "Available for backward compatibility.
" } }, "UserData": { "target": "com.amazonaws.autoscaling#XmlStringUserData", "traits": { "smithy.api#documentation": "The user data to make available to the launched EC2 instances. For more information,\n see Instance metadata and user data in the Amazon EC2 User Guide.\n If you are using a command line tool, base64-encoding\n is performed for you, and you can load the text from a file. Otherwise, you must provide\n base64-encoded text. User data is limited to 16 KB.
" } }, "InstanceType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The instance type for the instances. For information about available instance types,\n see Available\n instance types in the Amazon EC2 User Guide.
", "smithy.api#required": {} } }, "KernelId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The ID of the kernel associated with the AMI.
" } }, "RamdiskId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The ID of the RAM disk associated with the AMI.
" } }, "BlockDeviceMappings": { "target": "com.amazonaws.autoscaling#BlockDeviceMappings", "traits": { "smithy.api#documentation": "The block device mapping entries that define the block devices to attach to the\n instances at launch. By default, the block devices specified in the block device mapping\n for the AMI are used. For more information, see Block device\n mappings in the Amazon EC2 User Guide.
" } }, "InstanceMonitoring": { "target": "com.amazonaws.autoscaling#InstanceMonitoring", "traits": { "smithy.api#documentation": "Controls whether instances in this group are launched with detailed\n (true) or basic (false) monitoring.
For more information, see Configure\n monitoring for Auto Scaling instances in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "SpotPrice": { "target": "com.amazonaws.autoscaling#SpotPrice", "traits": { "smithy.api#documentation": "The maximum hourly price to be paid for any Spot Instance launched to fulfill the\n request. Spot Instances are launched when the price you specify exceeds the current Spot\n price. For more information, see Requesting Spot\n Instances for fault-tolerant and flexible applications in the Amazon EC2 Auto Scaling User Guide.
" } }, "IamInstanceProfile": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen1600", "traits": { "smithy.api#documentation": "The name or the Amazon Resource Name (ARN) of the instance profile associated with the\n IAM role for the instance. The instance profile contains the IAM role. For more\n information, see IAM role for applications that run\n on Amazon EC2 instances in the Amazon EC2 Auto Scaling User Guide.
" } }, "CreatedTime": { "target": "com.amazonaws.autoscaling#TimestampType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The creation date and time for the launch configuration.
", "smithy.api#required": {} } }, "EbsOptimized": { "target": "com.amazonaws.autoscaling#EbsOptimized", "traits": { "smithy.api#documentation": "Specifies whether the launch configuration is optimized for EBS I/O\n (true) or not (false). For more information, see Amazon EBS-optimized instances in the\n Amazon EC2 User Guide.
Specifies whether to assign a public IPv4 address to the group's instances. If the\n instance is launched into a default subnet, the default is to assign a public IPv4\n address, unless you disabled the option to assign a public IPv4 address on the subnet.\n If the instance is launched into a nondefault subnet, the default is not to assign a\n public IPv4 address, unless you enabled the option to assign a public IPv4 address on\n the subnet. For more information, see Provide network connectivity for\n your Auto Scaling instances using Amazon VPC in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "PlacementTenancy": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", "traits": { "smithy.api#documentation": "The tenancy of the instance, either default or dedicated. An\n instance with dedicated tenancy runs on isolated, single-tenant hardware\n and can only be launched into a VPC.
The metadata options for the instances. For more information, see Configure the instance metadata options in the\n Amazon EC2 Auto Scaling User Guide.
" } } }, "traits": { "smithy.api#documentation": "Describes a launch configuration.
" } }, "com.amazonaws.autoscaling#LaunchConfigurationNameType": { "type": "structure", "members": { "LaunchConfigurationName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the launch configuration.
", "smithy.api#required": {} } } } }, "com.amazonaws.autoscaling#LaunchConfigurationNames": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" } }, "com.amazonaws.autoscaling#LaunchConfigurationNamesType": { "type": "structure", "members": { "LaunchConfigurationNames": { "target": "com.amazonaws.autoscaling#LaunchConfigurationNames", "traits": { "smithy.api#documentation": "The launch configuration names. If you omit this property, all launch configurations\n are described.
\nArray Members: Maximum number of 50 items.
" } }, "NextToken": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a\n previous call.)
" } }, "MaxRecords": { "target": "com.amazonaws.autoscaling#MaxRecords", "traits": { "smithy.api#documentation": "The maximum number of items to return with this call. The default value is\n 50 and the maximum value is 100.
The launch configurations.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { "smithy.api#documentation": "A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.
Launches a specified number of instances in an Auto Scaling group. Returns instance IDs and\n other details if launch is successful or error details if launch is unsuccessful.
" } }, "com.amazonaws.autoscaling#LaunchInstancesError": { "type": "structure", "members": { "InstanceType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "\n The instance type that failed to launch.\n
" } }, "MarketType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", "traits": { "smithy.api#documentation": "\n The market type (On-Demand or Spot) that encountered the launch error.\n
" } }, "SubnetId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "\n The subnet ID where the instance launch was attempted.\n
" } }, "AvailabilityZone": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "\n The Availability Zone where the instance launch was attempted.\n
" } }, "AvailabilityZoneId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "\n The Availability Zone ID where the launch error occurred.\n
" } }, "ErrorCode": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", "traits": { "smithy.api#documentation": "\n The error code representing the type of error encountered (e.g., InsufficientInstanceCapacity).\n
" } }, "ErrorMessage": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { "smithy.api#documentation": "\n A descriptive message providing details about the error encountered during the launch attempt.\n
" } } }, "traits": { "smithy.api#documentation": "\n Contains details about errors encountered during instance launch attempts.\n
" } }, "com.amazonaws.autoscaling#LaunchInstancesErrors": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#LaunchInstancesError" } }, "com.amazonaws.autoscaling#LaunchInstancesRequest": { "type": "structure", "members": { "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "\n The name of the Auto Scaling group to launch instances into.\n
", "smithy.api#required": {} } }, "RequestedCapacity": { "target": "com.amazonaws.autoscaling#RequestedCapacity", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "\n The number of instances to launch. Although this value can exceed 100 for instance weights, the actual instance count is limited to 100 instances per launch.\n
", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.autoscaling#ClientToken", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "\n A unique, case-sensitive identifier to ensure idempotency of the request. \n
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "AvailabilityZones": { "target": "com.amazonaws.autoscaling#AvailabilityZonesLimit1", "traits": { "smithy.api#documentation": "\n The Availability Zones for the instance launch. Must match or be included in the Auto Scaling group's Availability Zone configuration. Either AvailabilityZones or SubnetIds must be specified for groups with multiple Availability Zone configurations. \n
\n A list of Availability Zone IDs where instances should be launched. Must match or be included in the group's AZ configuration. You cannot specify both AvailabilityZones and AvailabilityZoneIds. Required for multi-AZ groups, optional for single-AZ groups.\n
" } }, "SubnetIds": { "target": "com.amazonaws.autoscaling#SubnetIdsLimit1", "traits": { "smithy.api#documentation": "\n The subnet IDs for the instance launch. Either AvailabilityZones or SubnetIds must be specified. If both are specified, the subnets must reside in the specified Availability Zones.\n
\n Specifies whether to retry asynchronously if the synchronous launch fails. Valid values are NONE (default, no async retry) and RETRY_WITH_GROUP_CONFIGURATION (increase desired capacity and retry with group configuration).\n
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.autoscaling#LaunchInstancesResult": { "type": "structure", "members": { "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "\n The name of the Auto Scaling group where the instances were launched.\n
" } }, "ClientToken": { "target": "com.amazonaws.autoscaling#ClientToken", "traits": { "smithy.api#documentation": "\n The idempotency token used for the request, either customer-specified or auto-generated.\n
" } }, "Instances": { "target": "com.amazonaws.autoscaling#InstanceCollections", "traits": { "smithy.api#documentation": "\n A list of successfully launched instances including details such as instance type, Availability Zone, subnet, lifecycle state, and instance IDs.\n
" } }, "Errors": { "target": "com.amazonaws.autoscaling#LaunchInstancesErrors", "traits": { "smithy.api#documentation": "\n A list of errors encountered during the launch attempt including details about failed instance launches with their corresponding error codes and messages.\n
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.autoscaling#LaunchTemplate": { "type": "structure", "members": { "LaunchTemplateSpecification": { "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", "traits": { "smithy.api#documentation": "The launch template.
" } }, "Overrides": { "target": "com.amazonaws.autoscaling#Overrides", "traits": { "smithy.api#documentation": "Any properties that you specify override the same properties in the launch\n template.
" } } }, "traits": { "smithy.api#documentation": "Use this structure to specify the launch templates and instance types (overrides) for\n a mixed instances policy.
" } }, "com.amazonaws.autoscaling#LaunchTemplateName": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9\\(\\)\\.\\-/_]+$" } }, "com.amazonaws.autoscaling#LaunchTemplateOverrides": { "type": "structure", "members": { "InstanceType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The instance type, such as m3.xlarge. You must specify an instance type\n that is supported in your requested Region and Availability Zones. For more information,\n see Instance types in the Amazon EC2 User Guide.
You can specify up to 40 instance types per Auto Scaling group.
" } }, "WeightedCapacity": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", "traits": { "smithy.api#documentation": "If you provide a list of instance types to use, you can specify the number of capacity\n units provided by each instance type in terms of virtual CPUs, memory, storage,\n throughput, or other relative performance characteristic. When a Spot or On-Demand\n Instance is launched, the capacity units count toward the desired capacity. Amazon EC2 Auto Scaling\n launches instances until the desired capacity is totally fulfilled, even if this results\n in an overage. For example, if there are two units remaining to fulfill capacity, and\n Amazon EC2 Auto Scaling can only launch an instance with a WeightedCapacity of five units,\n the instance is launched, and the desired capacity is exceeded by three units. For more\n information, see Configure an Auto Scaling group to use instance weights in the\n Amazon EC2 Auto Scaling User Guide. Value must be in the range of 1\u2013999.
If you specify a value for WeightedCapacity for one instance type, you\n must specify a value for WeightedCapacity for all of them.
Every Auto Scaling group has three size parameters (DesiredCapacity,\n MaxSize, and MinSize). Usually, you set these sizes\n based on a specific number of instances. However, if you configure a mixed instances\n policy that defines weights for the instance types, you must specify these sizes\n with the same units that you use for weighting instances.
Provides a launch template for the specified instance type or set of instance\n requirements. For example, some instance types might require a launch template with a\n different AMI. If not provided, Amazon EC2 Auto Scaling uses the launch template that's specified in\n the LaunchTemplate definition. For more information, see Specifying a different launch template for an instance type in the\n Amazon EC2 Auto Scaling User Guide.
You can specify up to 20 launch templates per Auto Scaling group. The launch templates\n specified in the overrides and in the LaunchTemplate definition count\n towards this limit.
The instance requirements. Amazon EC2 Auto Scaling uses your specified requirements to identify\n instance types. Then, it uses your On-Demand and Spot allocation strategies to launch\n instances from these instance types.
\nYou can specify up to four separate sets of instance requirements per Auto Scaling group. This\n is useful for provisioning instances from different Amazon Machine Images (AMIs) in the\n same Auto Scaling group. To do this, create the AMIs and create a new launch template for each\n AMI. Then, create a compatible set of instance requirements for each launch template.\n
\nIf you specify InstanceRequirements, you can't specify\n InstanceType.
\n The ID of the Amazon Machine Image (AMI) to use for instances launched with this override. When \n using Instance Refresh with ReplaceRootVolume strategy, this specifies the AMI for root volume \n replacement operations.\n
\n For ReplaceRootVolume operations:\n
All overrides in the MixedInstancesPolicy must specify an ImageId
The AMI must contain only a single root volume
\nRoot volume replacement doesn't support multi-volume AMIs
\nUse this structure to let Amazon EC2 Auto Scaling do the following when the Auto Scaling group has a mixed\n instances policy:
\nOverride the instance type that is specified in the launch template.
\nUse multiple instance types.
\nSpecify the instance types that you want, or define your instance requirements instead\n and let Amazon EC2 Auto Scaling provision the available instance types that meet your requirements.\n This can provide Amazon EC2 Auto Scaling with a larger selection of instance types to choose from when\n fulfilling Spot and On-Demand capacities. You can view which instance types are matched\n before you apply the instance requirements to your Auto Scaling group.
\nAfter you define your instance requirements, you don't have to keep updating these\n settings to get new EC2 instance types automatically. Amazon EC2 Auto Scaling uses the instance\n requirements of the Auto Scaling group to determine whether a new EC2 instance type can be\n used.
" } }, "com.amazonaws.autoscaling#LaunchTemplateSpecification": { "type": "structure", "members": { "LaunchTemplateId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The ID of the launch template. To get the template ID, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created\n using the Amazon EC2 CreateLaunchTemplate API.
\nConditional: You must specify either a LaunchTemplateId or a\n LaunchTemplateName.
The name of the launch template. To get the template name, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created\n using the Amazon EC2 CreateLaunchTemplate API.
\nConditional: You must specify either a LaunchTemplateId or a\n LaunchTemplateName.
The version number, $Latest, or $Default. To get the version\n number, use the Amazon EC2 DescribeLaunchTemplateVersions API operation. New launch template versions\n can be created using the Amazon EC2 CreateLaunchTemplateVersion API. If the value is $Latest,\n Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If\n the value is $Default, Amazon EC2 Auto Scaling selects the default version of the launch\n template when launching instances. The default value is $Default.
Describes the launch template and the version of the launch template that Amazon EC2 Auto Scaling\n uses to launch Amazon EC2 instances. For more information about launch templates, see Launch\n templates in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#LifecycleActionResult": { "type": "string" }, "com.amazonaws.autoscaling#LifecycleActionToken": { "type": "string", "traits": { "smithy.api#length": { "min": 36, "max": 36 } } }, "com.amazonaws.autoscaling#LifecycleHook": { "type": "structure", "members": { "LifecycleHookName": { "target": "com.amazonaws.autoscaling#AsciiStringMaxLen255", "traits": { "smithy.api#documentation": "The name of the lifecycle hook.
" } }, "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The name of the Auto Scaling group for the lifecycle hook.
" } }, "LifecycleTransition": { "target": "com.amazonaws.autoscaling#LifecycleTransition", "traits": { "smithy.api#documentation": "The lifecycle transition.
\nValid values: autoscaling:EC2_INSTANCE_LAUNCHING |\n autoscaling:EC2_INSTANCE_TERMINATING\n
The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a\n wait state for the lifecycle hook.
" } }, "RoleARN": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The ARN of the IAM role that allows the Auto Scaling group to publish to the specified\n notification target (an Amazon SNS topic or an Amazon SQS queue).
" } }, "NotificationMetadata": { "target": "com.amazonaws.autoscaling#AnyPrintableAsciiStringMaxLen4000", "traits": { "smithy.api#documentation": "Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the\n notification target.
" } }, "HeartbeatTimeout": { "target": "com.amazonaws.autoscaling#HeartbeatTimeout", "traits": { "smithy.api#documentation": "The maximum time, in seconds, that can elapse before the lifecycle hook times out. If\n the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the\n DefaultResult property.
The maximum time, in seconds, that an instance can remain in a wait state. The maximum\n is 172800 seconds (48 hours) or 100 times HeartbeatTimeout, whichever is\n smaller.
The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an\n unexpected failure occurs.
\nValid values: CONTINUE | ABANDON\n
Describes a lifecycle hook. A lifecycle hook lets you create solutions that are aware\n of events in the Auto Scaling instance lifecycle, and then perform a custom action on instances\n when the corresponding lifecycle event\n occurs.
" } }, "com.amazonaws.autoscaling#LifecycleHookNames": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#AsciiStringMaxLen255" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.autoscaling#LifecycleHookSpecification": { "type": "structure", "members": { "LifecycleHookName": { "target": "com.amazonaws.autoscaling#AsciiStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the lifecycle hook.
", "smithy.api#required": {} } }, "LifecycleTransition": { "target": "com.amazonaws.autoscaling#LifecycleTransition", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The lifecycle transition. For Auto Scaling groups, there are two major lifecycle\n transitions.
\nTo create a lifecycle hook for scale-out events, specify\n autoscaling:EC2_INSTANCE_LAUNCHING.
To create a lifecycle hook for scale-in events, specify\n autoscaling:EC2_INSTANCE_TERMINATING.
Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to\n the notification target.
" } }, "HeartbeatTimeout": { "target": "com.amazonaws.autoscaling#HeartbeatTimeout", "traits": { "smithy.api#documentation": "The maximum time, in seconds, that can elapse before the lifecycle hook times out. The\n range is from 30 to 7200 seconds. The default value is\n 3600 seconds (1 hour).
The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an\n unexpected failure occurs. The default value is ABANDON.
Valid values: CONTINUE | ABANDON\n
The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends\n notifications to when an instance is in a wait state for the lifecycle hook. You can\n specify an Amazon SNS topic or an Amazon SQS queue.
" } }, "RoleARN": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The ARN of the IAM role that allows the Auto Scaling group to publish to the specified\n notification target. For information about creating this role, see Prepare to\n add a lifecycle hook to your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
\nValid only if the notification target is an Amazon SNS topic or an Amazon SQS queue.
" } } }, "traits": { "smithy.api#documentation": "Describes information used to specify a lifecycle hook for an Auto Scaling\n group.
\nFor more information, see Amazon EC2 Auto Scaling lifecycle\n hooks in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#LifecycleHookSpecifications": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#LifecycleHookSpecification" } }, "com.amazonaws.autoscaling#LifecycleHooks": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#LifecycleHook" } }, "com.amazonaws.autoscaling#LifecycleState": { "type": "enum", "members": { "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Pending" } }, "PENDING_WAIT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Pending:Wait" } }, "PENDING_PROCEED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Pending:Proceed" } }, "QUARANTINED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Quarantined" } }, "IN_SERVICE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "InService" } }, "TERMINATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Terminating" } }, "TERMINATING_WAIT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Terminating:Wait" } }, "TERMINATING_PROCEED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Terminating:Proceed" } }, "TERMINATING_RETAINED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Terminating:Retained" } }, "TERMINATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Terminated" } }, "DETACHING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Detaching" } }, "DETACHED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Detached" } }, "ENTERING_STANDBY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EnteringStandby" } }, "STANDBY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Standby" } }, "REPLACING_ROOT_VOLUME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ReplacingRootVolume" } }, "REPLACING_ROOT_VOLUME_WAIT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ReplacingRootVolume:Wait" } }, "REPLACING_ROOT_VOLUME_PROCEED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ReplacingRootVolume:Proceed" } }, "ROOT_VOLUME_REPLACED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RootVolumeReplaced" } }, "WARMED_PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Warmed:Pending" } }, "WARMED_PENDING_WAIT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Warmed:Pending:Wait" } }, "WARMED_PENDING_PROCEED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Warmed:Pending:Proceed" } }, "WARMED_PENDING_RETAINED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Warmed:Pending:Retained" } }, "WARMED_TERMINATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Warmed:Terminating" } }, "WARMED_TERMINATING_WAIT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Warmed:Terminating:Wait" } }, "WARMED_TERMINATING_PROCEED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Warmed:Terminating:Proceed" } }, "WARMED_TERMINATING_RETAINED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Warmed:Terminating:Retained" } }, "WARMED_TERMINATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Warmed:Terminated" } }, "WARMED_STOPPED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Warmed:Stopped" } }, "WARMED_RUNNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Warmed:Running" } }, "WARMED_HIBERNATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Warmed:Hibernated" } } } }, "com.amazonaws.autoscaling#LifecycleTransition": { "type": "string" }, "com.amazonaws.autoscaling#LimitExceededFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "LimitExceeded", "httpResponseCode": 400 }, "smithy.api#documentation": "You have already reached a limit for your Amazon EC2 Auto Scaling\n resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For\n more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API\n Reference.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.autoscaling#LoadBalancerNames": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" } }, "com.amazonaws.autoscaling#LoadBalancerState": { "type": "structure", "members": { "LoadBalancerName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The name of the load balancer.
" } }, "State": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "One of the following load balancer states:
\n\n Adding - The Auto Scaling instances are being registered with the load\n balancer.
\n Added - All Auto Scaling instances are registered with the load\n balancer.
\n InService - At least one Auto Scaling instance passed an\n ELB health check. Note that the load balancer enters this\n state immediately if you attach it in the\n CreateAutoScalingGroup\n API call.
\n Removing - The Auto Scaling instances are being deregistered from the\n load balancer. If connection draining is enabled, Elastic Load Balancing waits for in-flight\n requests to complete before deregistering the instances.
\n Removed - All Auto Scaling instances are deregistered from the load\n balancer.
Describes the state of a Classic Load Balancer.
" } }, "com.amazonaws.autoscaling#LoadBalancerStates": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#LoadBalancerState" } }, "com.amazonaws.autoscaling#LoadBalancerTargetGroupState": { "type": "structure", "members": { "LoadBalancerTargetGroupARN": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen511", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the target group.
" } }, "State": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The state of the target group.
\n\n Adding - The Auto Scaling instances are being registered with the target\n group.
\n Added - All Auto Scaling instances are registered with the target\n group.
\n InService - At least one Auto Scaling instance passed an\n ELB health check. Note that the target group enters this\n state immediately if you attach it in the\n CreateAutoScalingGroup\n API call.
\n Removing - The Auto Scaling instances are being deregistered from the\n target group. If connection draining is enabled, Elastic Load Balancing waits for in-flight\n requests to complete before deregistering the instances.
\n Removed - All Auto Scaling instances are deregistered from the target\n group.
Describes the state of a target group.
" } }, "com.amazonaws.autoscaling#LoadBalancerTargetGroupStates": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#LoadBalancerTargetGroupState" } }, "com.amazonaws.autoscaling#LoadForecast": { "type": "structure", "members": { "Timestamps": { "target": "com.amazonaws.autoscaling#PredictiveScalingForecastTimestamps", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The timestamps for the data points, in UTC format.
", "smithy.api#required": {} } }, "Values": { "target": "com.amazonaws.autoscaling#PredictiveScalingForecastValues", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The values of the data points.
", "smithy.api#required": {} } }, "MetricSpecification": { "target": "com.amazonaws.autoscaling#PredictiveScalingMetricSpecification", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The metric specification for the load forecast.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A GetPredictiveScalingForecast call returns the load forecast for a\n predictive scaling policy. This structure includes the data points for that load\n forecast, along with the timestamps of those data points and the metric specification.\n
The memory minimum in GiB.
" } }, "Max": { "target": "com.amazonaws.autoscaling#NullablePositiveDouble", "traits": { "smithy.api#documentation": "The memory maximum in GiB.
" } } }, "traits": { "smithy.api#documentation": "Specifies the minimum and maximum for the MemoryGiBPerVCpu object when\n you specify InstanceRequirements for an Auto Scaling group.
The memory minimum in MiB.
", "smithy.api#required": {} } }, "Max": { "target": "com.amazonaws.autoscaling#NullablePositiveInteger", "traits": { "smithy.api#documentation": "The memory maximum in MiB.
" } } }, "traits": { "smithy.api#documentation": "Specifies the minimum and maximum for the MemoryMiB object when you\n specify InstanceRequirements for an Auto Scaling group.
The namespace of the metric. For more information, see the table in Amazon Web Services\n services that publish CloudWatch metrics in the Amazon CloudWatch User\n Guide.
", "smithy.api#required": {} } }, "MetricName": { "target": "com.amazonaws.autoscaling#MetricName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the metric.
", "smithy.api#required": {} } }, "Dimensions": { "target": "com.amazonaws.autoscaling#MetricDimensions", "traits": { "smithy.api#documentation": "The dimensions for the metric. For the list of available dimensions, see the Amazon Web Services\n documentation available from the table in Amazon Web Services\n services that publish CloudWatch metrics in the Amazon CloudWatch User\n Guide.
\nConditional: If you published your metric with dimensions, you must specify the same\n dimensions in your scaling policy.
" } } }, "traits": { "smithy.api#documentation": "Represents a specific metric.
" } }, "com.amazonaws.autoscaling#MetricCollectionType": { "type": "structure", "members": { "Metric": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "One of the following metrics:
\n\n GroupMinSize\n
\n GroupMaxSize\n
\n GroupDesiredCapacity\n
\n GroupInServiceInstances\n
\n GroupPendingInstances\n
\n GroupStandbyInstances\n
\n GroupTerminatingInstances\n
\n GroupTotalInstances\n
\n GroupInServiceCapacity\n
\n GroupPendingCapacity\n
\n GroupStandbyCapacity\n
\n GroupTerminatingCapacity\n
\n GroupTotalCapacity\n
\n WarmPoolDesiredCapacity\n
\n WarmPoolWarmedCapacity\n
\n WarmPoolPendingCapacity\n
\n WarmPoolTerminatingCapacity\n
\n WarmPoolTotalCapacity\n
\n GroupAndWarmPoolDesiredCapacity\n
\n GroupAndWarmPoolTotalCapacity\n
Describes a metric.
" } }, "com.amazonaws.autoscaling#MetricCollectionTypes": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#MetricCollectionType" } }, "com.amazonaws.autoscaling#MetricDataQueries": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#MetricDataQuery" } }, "com.amazonaws.autoscaling#MetricDataQuery": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "A short name that identifies the object's results in the response. This name must be\n unique among all MetricDataQuery objects specified for a single scaling\n policy. If you are performing math expressions on this set of data, this name represents\n that data and can serve as a variable in the mathematical expression. The valid\n characters are letters, numbers, and underscores. The first character must be a\n lowercase letter.
The math expression to perform on the returned data, if this object is performing a\n math expression. This expression can use the Id of the other metrics to\n refer to those metrics, and can also use the Id of other expressions to use\n the result of those expressions.
Conditional: Within each MetricDataQuery object, you must specify either\n Expression or MetricStat, but not both.
Information about the metric data to return.
\nConditional: Within each MetricDataQuery object, you must specify either\n Expression or MetricStat, but not both.
A human-readable label for this metric or expression. This is especially useful if\n this is a math expression, so that you know what the value represents.
" } }, "ReturnData": { "target": "com.amazonaws.autoscaling#ReturnData", "traits": { "smithy.api#documentation": "Indicates whether to return the timestamps and raw data values of this metric.
\nIf you use any math expressions, specify true for this value for only the\n final math expression that the metric specification is based on. You must specify\n false for ReturnData for all the other metrics and\n expressions used in the metric specification.
If you are only retrieving metrics and not performing any math expressions, do not\n specify anything for ReturnData. This sets it to its default\n (true).
The metric data to return. Also defines whether this call is returning data for one\n metric only, or whether it is performing a math expression on the values of returned\n metric statistics to create a new time series. A time series is a series of data points,\n each of which is associated with a timestamp.
\nFor more information and examples, see Advanced predictive scaling policy configurations using custom metrics in\n the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#MetricDimension": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.autoscaling#MetricDimensionName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the dimension.
", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.autoscaling#MetricDimensionValue", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The value of the dimension.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Describes the dimension of a metric.
" } }, "com.amazonaws.autoscaling#MetricDimensionName": { "type": "string" }, "com.amazonaws.autoscaling#MetricDimensionValue": { "type": "string" }, "com.amazonaws.autoscaling#MetricDimensions": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#MetricDimension" } }, "com.amazonaws.autoscaling#MetricGranularityInSeconds": { "type": "integer", "traits": { "smithy.api#range": { "min": 1 } } }, "com.amazonaws.autoscaling#MetricGranularityType": { "type": "structure", "members": { "Granularity": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The granularity. The only valid value is 1Minute.
Describes a granularity of a metric.
" } }, "com.amazonaws.autoscaling#MetricGranularityTypes": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#MetricGranularityType" } }, "com.amazonaws.autoscaling#MetricName": { "type": "string" }, "com.amazonaws.autoscaling#MetricNamespace": { "type": "string" }, "com.amazonaws.autoscaling#MetricScale": { "type": "double" }, "com.amazonaws.autoscaling#MetricStat": { "type": "structure", "members": { "Metric": { "target": "com.amazonaws.autoscaling#Metric", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The CloudWatch metric to return, including the metric name, namespace, and dimensions. To\n get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.
", "smithy.api#required": {} } }, "Stat": { "target": "com.amazonaws.autoscaling#XmlStringMetricStat", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The statistic to return. It can include any CloudWatch statistic or extended statistic. For\n a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide.
\nThe most commonly used metrics for predictive scaling are Average and\n Sum.
The unit to use for the returned data points. For a complete list of the units that\n CloudWatch supports, see the MetricDatum\n data type in the Amazon CloudWatch API Reference.
" } } }, "traits": { "smithy.api#documentation": "This structure defines the CloudWatch metric to return, along with the statistic and\n unit.
\nFor more information about the CloudWatch terminology below, see Amazon CloudWatch\n concepts in the Amazon CloudWatch User Guide.
" } }, "com.amazonaws.autoscaling#MetricStatistic": { "type": "enum", "members": { "Average": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Average" } }, "Minimum": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Minimum" } }, "Maximum": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Maximum" } }, "SampleCount": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SampleCount" } }, "Sum": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Sum" } } } }, "com.amazonaws.autoscaling#MetricType": { "type": "enum", "members": { "ASGAverageCPUUtilization": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ASGAverageCPUUtilization" } }, "ASGAverageCPUUtilizationHighResolution": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ASGAverageCPUUtilizationHighResolution" } }, "ASGAverageNetworkIn": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ASGAverageNetworkIn" } }, "ASGAverageNetworkOut": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ASGAverageNetworkOut" } }, "ALBRequestCountPerTarget": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALBRequestCountPerTarget" } } } }, "com.amazonaws.autoscaling#MetricUnit": { "type": "string" }, "com.amazonaws.autoscaling#Metrics": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" } }, "com.amazonaws.autoscaling#MinAdjustmentMagnitude": { "type": "integer" }, "com.amazonaws.autoscaling#MinAdjustmentStep": { "type": "integer", "traits": { "smithy.api#deprecated": {} } }, "com.amazonaws.autoscaling#MixedInstanceSpotPrice": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 255 } } }, "com.amazonaws.autoscaling#MixedInstancesPolicy": { "type": "structure", "members": { "LaunchTemplate": { "target": "com.amazonaws.autoscaling#LaunchTemplate", "traits": { "smithy.api#documentation": "One or more launch templates and the instance types (overrides) that are used to\n launch EC2 instances to fulfill the configured capacities.
" } }, "InstancesDistribution": { "target": "com.amazonaws.autoscaling#InstancesDistribution", "traits": { "smithy.api#documentation": "The instances distribution.
" } } }, "traits": { "smithy.api#documentation": "Use this structure to launch multiple instance types and configure how capacity is\n distributed across On-Demand, Spot, and supported Capacity Reservation types within a\n single Auto Scaling group.
\nA mixed instances policy contains information that Amazon EC2 Auto Scaling can use to launch\n instances, prioritize capacity types, and help optimize your costs. For more\n information, see Auto Scaling\n groups with multiple instance types and purchase options in the\n Amazon EC2 Auto Scaling User Guide. To learn how to prioritize multiple capacity\n types, see Use Distribution\n Segments to target multiple capacity types in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#MonitoringEnabled": { "type": "boolean" }, "com.amazonaws.autoscaling#NetworkBandwidthGbpsRequest": { "type": "structure", "members": { "Min": { "target": "com.amazonaws.autoscaling#NullablePositiveDouble", "traits": { "smithy.api#documentation": "The minimum amount of network bandwidth, in gigabits per second (Gbps).
" } }, "Max": { "target": "com.amazonaws.autoscaling#NullablePositiveDouble", "traits": { "smithy.api#documentation": "The maximum amount of network bandwidth, in gigabits per second (Gbps).
" } } }, "traits": { "smithy.api#documentation": "Specifies the minimum and maximum for the NetworkBandwidthGbps object\n when you specify InstanceRequirements for an Auto Scaling group.
Setting the minimum bandwidth does not guarantee that your instance will achieve\n the minimum bandwidth. Amazon EC2 will identify instance types that support the specified\n minimum bandwidth, but the actual bandwidth of your instance might go below the\n specified minimum at times. For more information, see Available instance bandwidth in the\n Amazon EC2 User Guide.
\nThe minimum number of network interfaces.
" } }, "Max": { "target": "com.amazonaws.autoscaling#NullablePositiveInteger", "traits": { "smithy.api#documentation": "The maximum number of network interfaces.
" } } }, "traits": { "smithy.api#documentation": "Specifies the minimum and maximum for the NetworkInterfaceCount object\n when you specify InstanceRequirements for an Auto Scaling group.
The name of the Auto Scaling group.
" } }, "TopicARN": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon SNS topic.
" } }, "NotificationType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "One of the following event notification types:
\n\n autoscaling:EC2_INSTANCE_LAUNCH\n
\n autoscaling:EC2_INSTANCE_LAUNCH_ERROR\n
\n autoscaling:EC2_INSTANCE_TERMINATE\n
\n autoscaling:EC2_INSTANCE_TERMINATE_ERROR\n
\n autoscaling:TEST_NOTIFICATION\n
Describes a notification.
" } }, "com.amazonaws.autoscaling#NotificationConfigurations": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#NotificationConfiguration" } }, "com.amazonaws.autoscaling#NotificationTargetResourceName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 255 }, "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" } }, "com.amazonaws.autoscaling#NullableBoolean": { "type": "boolean" }, "com.amazonaws.autoscaling#NullablePositiveDouble": { "type": "double", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.autoscaling#NullablePositiveInteger": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.autoscaling#NumberOfAutoScalingGroups": { "type": "integer" }, "com.amazonaws.autoscaling#NumberOfLaunchConfigurations": { "type": "integer" }, "com.amazonaws.autoscaling#OnDemandBaseCapacity": { "type": "integer" }, "com.amazonaws.autoscaling#OnDemandPercentageAboveBaseCapacity": { "type": "integer" }, "com.amazonaws.autoscaling#Operator": { "type": "structure", "members": { "Principal": { "target": "com.amazonaws.autoscaling#ManagerIdentifier", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The service principal that is authorized to manage the Auto Scaling group. When an operator is\n specified, only the designated operator service principal can make mutating changes to\n the Auto Scaling group.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Describes the entity that manages an Auto Scaling group.
" } }, "com.amazonaws.autoscaling#Overrides": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#LaunchTemplateOverrides" } }, "com.amazonaws.autoscaling#PerformanceFactorReferenceRequest": { "type": "structure", "members": { "InstanceFamily": { "target": "com.amazonaws.autoscaling#String", "traits": { "smithy.api#documentation": "\n The instance family to use as a baseline reference.\n
\nMake sure that you specify the correct value for the instance family. The instance family is everything before the period (.) in the instance type name. For example, in the instance c6i.large, the\n instance family is c6i, not c6. For more information, see Amazon EC2 instance type naming conventions in \n Amazon EC2 Instance Types.
The following instance types are not supported for performance protection.
\n\n c1\n
\n g3| g3s\n
\n hpc7g\n
\n m1| m2\n
\n mac1 | mac2 | mac2-m1ultra | mac2-m2 | mac2-m2pro\n
\n p3dn | p4d | p5\n
\n t1\n
\n u-12tb1 | u-18tb1 | u-24tb1 | u-3tb1 | u-6tb1 | u-9tb1 | u7i-12tb | u7in-16tb | u7in-24tb | u7in-32tb\n
If you performance protection by specifying a supported instance family, the returned instance types will exclude the preceding unsupported instance families.
\nIf you specify an unsupported instance family as a value for baseline performance, the API returns an empty response.
" } } }, "traits": { "smithy.api#documentation": "\n Specify an instance family to use as the baseline reference for CPU performance. All instance types that All instance types that match your specified attributes will be compared against the CPU performance of the\n referenced instance family, regardless of CPU manufacturer or architecture differences.\n
\nCurrently only one instance family can be specified in the list.
\nThe scaling policies.
" } }, "NextToken": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { "smithy.api#documentation": "A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.
The Amazon Resource Name (ARN) of the policy.
" } }, "Alarms": { "target": "com.amazonaws.autoscaling#Alarms", "traits": { "smithy.api#documentation": "The CloudWatch alarms created for the target tracking scaling policy.
" } } }, "traits": { "smithy.api#documentation": "Contains the output of PutScalingPolicy.
" } }, "com.amazonaws.autoscaling#PolicyIncrement": { "type": "integer" }, "com.amazonaws.autoscaling#PolicyNames": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#ResourceName" } }, "com.amazonaws.autoscaling#PolicyTypes": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen64" } }, "com.amazonaws.autoscaling#PredefinedLoadMetricType": { "type": "enum", "members": { "ASGTotalCPUUtilization": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ASGTotalCPUUtilization" } }, "ASGTotalNetworkIn": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ASGTotalNetworkIn" } }, "ASGTotalNetworkOut": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ASGTotalNetworkOut" } }, "ALBTargetGroupRequestCount": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALBTargetGroupRequestCount" } } } }, "com.amazonaws.autoscaling#PredefinedMetricPairType": { "type": "enum", "members": { "ASGCPUUtilization": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ASGCPUUtilization" } }, "ASGNetworkIn": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ASGNetworkIn" } }, "ASGNetworkOut": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ASGNetworkOut" } }, "ALBRequestCount": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALBRequestCount" } } } }, "com.amazonaws.autoscaling#PredefinedMetricSpecification": { "type": "structure", "members": { "PredefinedMetricType": { "target": "com.amazonaws.autoscaling#MetricType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The metric type. The following predefined metrics are available:
\n\n ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling\n group.
\n ASGAverageCPUUtilizationHighResolution - Average CPU utilization\n of the Auto Scaling group using a high-resolution metric.
\n ASGAverageNetworkIn - Average number of bytes received on all\n network interfaces by the Auto Scaling group.
\n ASGAverageNetworkOut - Average number of bytes sent out on all\n network interfaces by the Auto Scaling group.
\n ALBRequestCountPerTarget - Average Application Load Balancer request count per target\n for your Auto Scaling group.
To help ensure that target tracking has metric data to use for the\n ASGAverageCPUUtilizationHighResolution metric type, configure the\n Auto Scaling group's launch template and existing instances to publish high-resolution CPU\n utilization metrics.
A label that uniquely identifies a specific Application Load Balancer target group\n from which to determine the average request count served by your Auto Scaling group. You can't\n specify a resource label unless the target group is attached to the Auto Scaling group.
\nYou create the resource label by appending the final portion of the load balancer ARN\n and the final portion of the target group ARN into a single value, separated by a forward\n slash (/). The format of the resource label is:
\n\n app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
Where:
\napp/
targetgroup/
To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use\n the DescribeTargetGroups API operation.
" } } }, "traits": { "smithy.api#documentation": "Represents a predefined metric for a target tracking scaling policy to use with\n Amazon EC2 Auto Scaling.
" } }, "com.amazonaws.autoscaling#PredefinedScalingMetricType": { "type": "enum", "members": { "ASGAverageCPUUtilization": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ASGAverageCPUUtilization" } }, "ASGAverageNetworkIn": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ASGAverageNetworkIn" } }, "ASGAverageNetworkOut": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ASGAverageNetworkOut" } }, "ALBRequestCountPerTarget": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALBRequestCountPerTarget" } } } }, "com.amazonaws.autoscaling#PredictiveScalingConfiguration": { "type": "structure", "members": { "MetricSpecifications": { "target": "com.amazonaws.autoscaling#PredictiveScalingMetricSpecifications", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "This structure includes the metrics and target utilization to use for predictive\n scaling.
\nThis is an array, but we currently only support a single metric specification. That\n is, you can specify a target value and a single metric pair, or a target value and one\n scaling metric and one load metric.
", "smithy.api#required": {} } }, "Mode": { "target": "com.amazonaws.autoscaling#PredictiveScalingMode", "traits": { "smithy.api#documentation": "The predictive scaling mode. Defaults to ForecastOnly if not\n specified.
The amount of time, in seconds, by which the instance launch time can be advanced. For\n example, the forecast says to add capacity at 10:00 AM, and you choose to pre-launch\n instances by 5 minutes. In that case, the instances will be launched at 9:55 AM. The\n intention is to give resources time to be provisioned. It can take a few minutes to\n launch an EC2 instance. The actual amount of time required depends on several factors,\n such as the size of the instance and whether there are startup scripts to complete.
\nThe value must be less than the forecast interval duration of 3600 seconds (60\n minutes). Defaults to 300 seconds if not specified.
" } }, "MaxCapacityBreachBehavior": { "target": "com.amazonaws.autoscaling#PredictiveScalingMaxCapacityBreachBehavior", "traits": { "smithy.api#documentation": "Defines the behavior that should be applied if the forecast capacity approaches or\n exceeds the maximum capacity of the Auto Scaling group. Defaults to\n HonorMaxCapacity if not specified.
The following are possible values:
\n\n HonorMaxCapacity - Amazon EC2 Auto Scaling can't increase the maximum capacity\n of the group when the forecast capacity is close to or exceeds the maximum\n capacity.
\n IncreaseMaxCapacity - Amazon EC2 Auto Scaling can increase the maximum capacity\n of the group when the forecast capacity is close to or exceeds the maximum\n capacity. The upper limit is determined by the forecasted capacity and the value\n for MaxCapacityBuffer.
Use caution when allowing the maximum capacity to be automatically increased. This\n can lead to more instances being launched than intended if the increased maximum\n capacity is not monitored and managed. The increased maximum capacity then becomes\n the new normal maximum capacity for the Auto Scaling group until you manually update\n it. The maximum capacity does not automatically decrease back to the original\n maximum.
\nThe size of the capacity buffer to use when the forecast capacity is close to or\n exceeds the maximum capacity. The value is specified as a percentage relative to the\n forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer,\n such that if the forecast capacity is 50, and the maximum capacity is 40, then the\n effective maximum capacity is 55.
\nIf set to 0, Amazon EC2 Auto Scaling may scale capacity higher than the maximum capacity to equal but\n not exceed forecast capacity.
\nRequired if the MaxCapacityBreachBehavior property is set to\n IncreaseMaxCapacity, and cannot be used otherwise.
Represents a predictive scaling policy configuration to use with Amazon EC2 Auto Scaling.
" } }, "com.amazonaws.autoscaling#PredictiveScalingCustomizedCapacityMetric": { "type": "structure", "members": { "MetricDataQueries": { "target": "com.amazonaws.autoscaling#MetricDataQueries", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "One or more metric data queries to provide the data points for a capacity metric. Use\n multiple metric data queries only if you are performing a math expression on returned\n data.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Describes a customized capacity metric for a predictive scaling policy.
" } }, "com.amazonaws.autoscaling#PredictiveScalingCustomizedLoadMetric": { "type": "structure", "members": { "MetricDataQueries": { "target": "com.amazonaws.autoscaling#MetricDataQueries", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "One or more metric data queries to provide the data points for a load metric. Use\n multiple metric data queries only if you are performing a math expression on returned\n data.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Describes a custom load metric for a predictive scaling policy.
" } }, "com.amazonaws.autoscaling#PredictiveScalingCustomizedScalingMetric": { "type": "structure", "members": { "MetricDataQueries": { "target": "com.amazonaws.autoscaling#MetricDataQueries", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "One or more metric data queries to provide the data points for a scaling metric. Use\n multiple metric data queries only if you are performing a math expression on returned\n data.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Describes a custom scaling metric for a predictive scaling policy.
" } }, "com.amazonaws.autoscaling#PredictiveScalingForecastTimestamps": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#TimestampType" } }, "com.amazonaws.autoscaling#PredictiveScalingForecastValues": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#MetricScale" } }, "com.amazonaws.autoscaling#PredictiveScalingMaxCapacityBreachBehavior": { "type": "enum", "members": { "HonorMaxCapacity": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HonorMaxCapacity" } }, "IncreaseMaxCapacity": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IncreaseMaxCapacity" } } } }, "com.amazonaws.autoscaling#PredictiveScalingMaxCapacityBuffer": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 100 } } }, "com.amazonaws.autoscaling#PredictiveScalingMetricSpecification": { "type": "structure", "members": { "TargetValue": { "target": "com.amazonaws.autoscaling#MetricScale", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Specifies the target utilization.
\nSome metrics are based on a count instead of a percentage, such as the request\n count for an Application Load Balancer or the number of messages in an SQS queue. If the scaling policy\n specifies one of these metrics, specify the target utilization as the optimal\n average request or message count per instance during any one-minute interval.\n
\nThe predefined metric pair specification from which Amazon EC2 Auto Scaling determines the\n appropriate scaling metric and load metric to use.
" } }, "PredefinedScalingMetricSpecification": { "target": "com.amazonaws.autoscaling#PredictiveScalingPredefinedScalingMetric", "traits": { "smithy.api#documentation": "The predefined scaling metric specification.
" } }, "PredefinedLoadMetricSpecification": { "target": "com.amazonaws.autoscaling#PredictiveScalingPredefinedLoadMetric", "traits": { "smithy.api#documentation": "The predefined load metric specification.
" } }, "CustomizedScalingMetricSpecification": { "target": "com.amazonaws.autoscaling#PredictiveScalingCustomizedScalingMetric", "traits": { "smithy.api#documentation": "The customized scaling metric specification.
" } }, "CustomizedLoadMetricSpecification": { "target": "com.amazonaws.autoscaling#PredictiveScalingCustomizedLoadMetric", "traits": { "smithy.api#documentation": "The customized load metric specification.
" } }, "CustomizedCapacityMetricSpecification": { "target": "com.amazonaws.autoscaling#PredictiveScalingCustomizedCapacityMetric", "traits": { "smithy.api#documentation": "The customized capacity metric specification.
" } } }, "traits": { "smithy.api#documentation": "This structure specifies the metrics and target utilization settings for a predictive\n scaling policy.
\nYou must specify either a metric pair, or a load metric and a scaling metric\n individually. Specifying a metric pair instead of individual metrics provides a simpler\n way to configure metrics for a scaling policy. You choose the metric pair, and the\n policy automatically knows the correct sum and average statistics to use for the load\n metric and the scaling metric.
\nExample
\nYou create a predictive scaling policy and specify\n ALBRequestCount as the value for the metric pair and\n 1000.0 as the target value. For this type of metric, you must\n provide the metric dimension for the corresponding target group, so you also\n provide a resource label for the Application Load Balancer target group that is\n attached to your Auto Scaling group.
The number of requests the target group receives per minute provides the load\n metric, and the request count averaged between the members of the target group\n provides the scaling metric. In CloudWatch, this refers to the\n RequestCount and RequestCountPerTarget metrics,\n respectively.
For optimal use of predictive scaling, you adhere to the best practice of\n using a dynamic scaling policy to automatically scale between the minimum\n capacity and maximum capacity in response to real-time changes in resource\n utilization.
\nAmazon EC2 Auto Scaling consumes data points for the load metric over the last 14 days and\n creates an hourly load forecast for predictive scaling. (A minimum of 24 hours\n of data is required.)
\nAfter creating the load forecast, Amazon EC2 Auto Scaling determines when to reduce or\n increase the capacity of your Auto Scaling group in each hour of the forecast period so\n that the average number of requests received by each instance is as close to\n 1000 requests per minute as possible at all times.
\nFor information about using custom metrics with predictive scaling, see Advanced predictive scaling policy configurations using custom metrics in\n the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#PredictiveScalingMetricSpecifications": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#PredictiveScalingMetricSpecification" } }, "com.amazonaws.autoscaling#PredictiveScalingMode": { "type": "enum", "members": { "ForecastAndScale": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ForecastAndScale" } }, "ForecastOnly": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ForecastOnly" } } } }, "com.amazonaws.autoscaling#PredictiveScalingPredefinedLoadMetric": { "type": "structure", "members": { "PredefinedMetricType": { "target": "com.amazonaws.autoscaling#PredefinedLoadMetricType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The metric type.
", "smithy.api#required": {} } }, "ResourceLabel": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", "traits": { "smithy.api#documentation": "A label that uniquely identifies a specific Application Load Balancer target group from which to determine\n the request count served by your Auto Scaling group. You can't specify a resource label unless\n the target group is attached to the Auto Scaling group.
\nYou create the resource label by appending the final portion of the load balancer ARN\n and the final portion of the target group ARN into a single value, separated by a forward\n slash (/). The format of the resource label is:
\n\n app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
Where:
\napp/
targetgroup/
To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use\n the DescribeTargetGroups API operation.
" } } }, "traits": { "smithy.api#documentation": "Describes a load metric for a predictive scaling policy.
\nWhen returned in the output of DescribePolicies, it indicates that a\n predictive scaling policy uses individually specified load and scaling metrics instead\n of a metric pair.
Indicates which metrics to use. There are two different types of metrics for each\n metric type: one is a load metric and one is a scaling metric. For example, if the\n metric type is ASGCPUUtilization, the Auto Scaling group's total CPU metric is used\n as the load metric, and the average CPU metric is used for the scaling metric.
A label that uniquely identifies a specific Application Load Balancer target group from which to determine\n the total and average request count served by your Auto Scaling group. You can't specify a\n resource label unless the target group is attached to the Auto Scaling group.
\nYou create the resource label by appending the final portion of the load balancer ARN\n and the final portion of the target group ARN into a single value, separated by a forward\n slash (/). The format of the resource label is:
\n\n app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
Where:
\napp/
targetgroup/
To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use\n the DescribeTargetGroups API operation.
" } } }, "traits": { "smithy.api#documentation": "Represents a metric pair for a predictive scaling policy.
" } }, "com.amazonaws.autoscaling#PredictiveScalingPredefinedScalingMetric": { "type": "structure", "members": { "PredefinedMetricType": { "target": "com.amazonaws.autoscaling#PredefinedScalingMetricType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The metric type.
", "smithy.api#required": {} } }, "ResourceLabel": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", "traits": { "smithy.api#documentation": "A label that uniquely identifies a specific Application Load Balancer target group from which to determine\n the average request count served by your Auto Scaling group. You can't specify a resource label\n unless the target group is attached to the Auto Scaling group.
\nYou create the resource label by appending the final portion of the load balancer ARN\n and the final portion of the target group ARN into a single value, separated by a forward\n slash (/). The format of the resource label is:
\n\n app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
Where:
\napp/
targetgroup/
To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use\n the DescribeTargetGroups API operation.
" } } }, "traits": { "smithy.api#documentation": "Describes a scaling metric for a predictive scaling policy.
\nWhen returned in the output of DescribePolicies, it indicates that a\n predictive scaling policy uses individually specified load and scaling metrics instead\n of a metric pair.
One of the following processes:
\n\n Launch\n
\n Terminate\n
\n AddToLoadBalancer\n
\n AlarmNotification\n
\n AZRebalance\n
\n HealthCheck\n
\n InstanceRefresh\n
\n ReplaceUnhealthy\n
\n ScheduledActions\n
Describes a process type.
\nFor more information, see Types\n of processes in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#Processes": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#ProcessType" } }, "com.amazonaws.autoscaling#ProcessesType": { "type": "structure", "members": { "Processes": { "target": "com.amazonaws.autoscaling#Processes", "traits": { "smithy.api#documentation": "The names of the process types.
" } } } }, "com.amazonaws.autoscaling#Progress": { "type": "integer" }, "com.amazonaws.autoscaling#PropagateAtLaunch": { "type": "boolean" }, "com.amazonaws.autoscaling#ProtectedFromScaleIn": { "type": "boolean" }, "com.amazonaws.autoscaling#PutAccountSetting": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#PutAccountSettingType" }, "output": { "target": "com.amazonaws.autoscaling#PutAccountSettingAnswer" }, "traits": { "smithy.api#documentation": "\n Modifies an account setting for your account. You can use this operation to opt in or opt out of features provided through account settings when permitted. Account settings give you control over features that might have backwards-incompatible changes. When Amazon EC2 Auto Scaling introduces such changes, account settings allow you to test and adopt new features. Some account settings are enforced after a specified date. This means that after the enforcement date, you can no longer modify the setting.\n
" } }, "com.amazonaws.autoscaling#PutAccountSettingAnswer": { "type": "structure", "members": {} }, "com.amazonaws.autoscaling#PutAccountSettingType": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.autoscaling#AsciiStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "\n The name of the account setting to modify. Each account setting has a unique name that identifies the specific feature it controls.\n
", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.autoscaling#AsciiStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "\n The value for the account setting.\n
", "smithy.api#required": {} } } } }, "com.amazonaws.autoscaling#PutLifecycleHook": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#PutLifecycleHookType" }, "output": { "target": "com.amazonaws.autoscaling#PutLifecycleHookAnswer" }, "errors": [ { "target": "com.amazonaws.autoscaling#LimitExceededFault" }, { "target": "com.amazonaws.autoscaling#ResourceContentionFault" } ], "traits": { "smithy.api#documentation": "Creates or updates a lifecycle hook for the specified Auto Scaling group.
\nLifecycle hooks let you create solutions that are aware of events in the Auto Scaling instance\n lifecycle, and then perform a custom action on instances when the corresponding\n lifecycle event occurs.
\nThis step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:
\n(Optional) Create a launch template or launch configuration with a user data\n script that runs while an instance is in a wait state due to a lifecycle\n hook.
\n(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke\n your Lambda function when an instance is put into a wait state due to a\n lifecycle hook.
\n(Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish\n lifecycle notifications to the target.
\n\n Create the lifecycle hook. Specify whether the hook is\n used when the instances launch or terminate.\n
\nIf you need more time, record the lifecycle action heartbeat to keep the\n instance in a wait state using the RecordLifecycleActionHeartbeat API call.
\nIf you finish before the timeout period ends, send a callback by using the\n CompleteLifecycleAction API call.
\nFor more information, see Amazon EC2 Auto Scaling lifecycle\n hooks in the Amazon EC2 Auto Scaling User Guide.
\nIf you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling\n group, the call fails.
\nYou can view the lifecycle hooks for an Auto Scaling group using the \n DescribeLifecycleHooks API call. If you are no longer using a lifecycle\n hook, you can delete it by calling the DeleteLifecycleHook API.
", "smithy.api#examples": [ { "title": "To create a launch lifecycle hook", "documentation": "This example creates a lifecycle hook for instance launch.", "input": { "LifecycleHookName": "my-launch-lifecycle-hook", "HeartbeatTimeout": 300, "AutoScalingGroupName": "my-auto-scaling-group", "LifecycleTransition": "autoscaling:EC2_INSTANCE_LAUNCHING", "DefaultResult": "CONTINUE" } } ] } }, "com.amazonaws.autoscaling#PutLifecycleHookAnswer": { "type": "structure", "members": {} }, "com.amazonaws.autoscaling#PutLifecycleHookType": { "type": "structure", "members": { "LifecycleHookName": { "target": "com.amazonaws.autoscaling#AsciiStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the lifecycle hook.
", "smithy.api#required": {} } }, "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } }, "LifecycleTransition": { "target": "com.amazonaws.autoscaling#LifecycleTransition", "traits": { "smithy.api#documentation": "The lifecycle transition. For Auto Scaling groups, there are two major lifecycle\n transitions.
\nTo create a lifecycle hook for scale-out events, specify\n autoscaling:EC2_INSTANCE_LAUNCHING.
To create a lifecycle hook for scale-in events, specify\n autoscaling:EC2_INSTANCE_TERMINATING.
Required for new lifecycle hooks, but optional when updating existing hooks.
" } }, "RoleARN": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The ARN of the IAM role that allows the Auto Scaling group to publish to the specified\n notification target.
\nValid only if the notification target is an Amazon SNS topic or an Amazon SQS queue. Required\n for new lifecycle hooks, but optional when updating existing hooks.
" } }, "NotificationTargetARN": { "target": "com.amazonaws.autoscaling#NotificationTargetResourceName", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify\n you when an instance is in a wait state for the lifecycle hook. You can specify either\n an Amazon SNS topic or an Amazon SQS queue.
\nIf you specify an empty string, this overrides the current ARN.
\nThis operation uses the JSON format when sending notifications to an Amazon SQS queue, and\n an email key-value pair format when sending notifications to an Amazon SNS topic.
\nWhen you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test\n messages contain the following additional key-value pair: \"Event\":\n \"autoscaling:TEST_NOTIFICATION\".
Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to\n the notification target.
" } }, "HeartbeatTimeout": { "target": "com.amazonaws.autoscaling#HeartbeatTimeout", "traits": { "smithy.api#documentation": "The maximum time, in seconds, that can elapse before the lifecycle hook times out. The\n range is from 30 to 7200 seconds. The default value is\n 3600 seconds (1 hour).
The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an\n unexpected failure occurs. The default value is ABANDON.
Valid values: CONTINUE | ABANDON\n
Configures an Auto Scaling group to send notifications when specified events take place.\n Subscribers to the specified topic can have messages delivered to an endpoint such as a\n web server or an email address.
\nThis configuration overwrites any existing configuration.
\nFor more information, see Amazon SNS\n notification options for Amazon EC2 Auto Scaling in the\n Amazon EC2 Auto Scaling User Guide.
\nIf you exceed your maximum limit of SNS topics, which is 10 per Auto Scaling group, the call\n fails.
", "smithy.api#examples": [ { "title": "To add an Auto Scaling notification", "documentation": "This example adds the specified notification to the specified Auto Scaling group.", "input": { "AutoScalingGroupName": "my-auto-scaling-group", "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic", "NotificationTypes": [ "autoscaling:TEST_NOTIFICATION" ] } } ] } }, "com.amazonaws.autoscaling#PutNotificationConfigurationType": { "type": "structure", "members": { "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } }, "TopicARN": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon SNS topic.
", "smithy.api#required": {} } }, "NotificationTypes": { "target": "com.amazonaws.autoscaling#AutoScalingNotificationTypes", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The type of event that causes the notification to be sent. To query the notification\n types supported by Amazon EC2 Auto Scaling, call the DescribeAutoScalingNotificationTypes API.
", "smithy.api#required": {} } } } }, "com.amazonaws.autoscaling#PutScalingPolicy": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#PutScalingPolicyType" }, "output": { "target": "com.amazonaws.autoscaling#PolicyARNType" }, "errors": [ { "target": "com.amazonaws.autoscaling#LimitExceededFault" }, { "target": "com.amazonaws.autoscaling#ResourceContentionFault" }, { "target": "com.amazonaws.autoscaling#ServiceLinkedRoleFailure" } ], "traits": { "smithy.api#documentation": "Creates or updates a scaling policy for an Auto Scaling group. Scaling policies are used to\n scale an Auto Scaling group based on configurable metrics. If no policies are defined, the\n dynamic scaling and predictive scaling features are not used.
\nFor more information about using dynamic scaling, see Target tracking\n scaling policies and Step and simple scaling\n policies in the Amazon EC2 Auto Scaling User Guide.
\nFor more information about using predictive scaling, see Predictive\n scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
\nYou can view the scaling policies for an Auto Scaling group using the \n DescribePolicies API call. If you are no longer using a scaling policy,\n you can delete it by calling the DeletePolicy API.
", "smithy.api#examples": [ { "title": "To add a scaling policy to an Auto Scaling group", "documentation": "This example adds the specified policy to the specified Auto Scaling group.", "input": { "AutoScalingGroupName": "my-auto-scaling-group", "PolicyName": "alb1000-target-tracking-scaling-policy", "PolicyType": "TargetTrackingScaling", "TargetTrackingConfiguration": { "TargetValue": 1000.0, "PredefinedMetricSpecification": { "PredefinedMetricType": "ALBRequestCountPerTarget", "ResourceLabel": "app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff" } } }, "output": { "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:228f02c2-c665-4bfd-aaac-8b04080bea3c:autoScalingGroupName/my-auto-scaling-group:policyName/alb1000-target-tracking-scaling-policy", "Alarms": [ { "AlarmARN": "arn:aws:cloudwatch:us-west-2:123456789012:alarm:TargetTracking-my-asg-AlarmHigh-fc0e4183-23ac-497e-9992-691c9980c38e", "AlarmName": "TargetTracking-my-asg-AlarmHigh-fc0e4183-23ac-497e-9992-691c9980c38e" }, { "AlarmARN": "arn:aws:cloudwatch:us-west-2:123456789012:alarm:TargetTracking-my-asg-AlarmLow-61a39305-ed0c-47af-bd9e-471a352ee1a2", "AlarmName": "TargetTracking-my-asg-AlarmLow-61a39305-ed0c-47af-bd9e-471a352ee1a2" } ] } } ] } }, "com.amazonaws.autoscaling#PutScalingPolicyType": { "type": "structure", "members": { "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } }, "PolicyName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the policy.
", "smithy.api#required": {} } }, "PolicyType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", "traits": { "smithy.api#documentation": "One of the following policy types:
\n\n TargetTrackingScaling\n
\n StepScaling\n
\n SimpleScaling (default)
\n PredictiveScaling\n
Specifies how the scaling adjustment is interpreted (for example, an absolute number\n or a percentage). The valid values are ChangeInCapacity,\n ExactCapacity, and PercentChangeInCapacity.
Required if the policy type is StepScaling or SimpleScaling.\n For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User Guide.
Available for backward compatibility. Use MinAdjustmentMagnitude\n instead.
The minimum value to scale by when the adjustment type is\n PercentChangeInCapacity. For example, suppose that you create a step\n scaling policy to scale out an Auto Scaling group by 25 percent and you specify a\n MinAdjustmentMagnitude of 2. If the group has 4 instances and the\n scaling policy is performed, 25 percent of 4 is 1. However, because you specified a\n MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2\n instances.
Valid only if the policy type is StepScaling or\n SimpleScaling. For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User\n Guide.
Some Auto Scaling groups use instance weights. In this case, set the\n MinAdjustmentMagnitude to a value that is at least as large as your\n largest instance weight.
The amount by which to scale, based on the specified adjustment type. A positive value\n adds to the current capacity while a negative number removes from the current capacity.\n For exact capacity, you must specify a non-negative value.
\nRequired if the policy type is SimpleScaling. (Not used with any other\n policy type.)
A cooldown period, in seconds, that applies to a specific simple scaling policy. When\n a cooldown period is specified here, it overrides the default cooldown.
\nValid only if the policy type is SimpleScaling. For more information, see\n Scaling\n cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Default: None
" } }, "MetricAggregationType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", "traits": { "smithy.api#documentation": "The aggregation type for the CloudWatch metrics. The valid values are Minimum,\n Maximum, and Average. If the aggregation type is null, the\n value is treated as Average.
Valid only if the policy type is StepScaling.
A set of adjustments that enable you to scale based on the size of the alarm\n breach.
\nRequired if the policy type is StepScaling. (Not used with any other\n policy type.)
\n Not needed if the default instance warmup is defined for the\n group.\n
\nThe estimated time, in seconds, until a newly launched instance can contribute to the\n CloudWatch metrics. This warm-up period applies to instances launched due to a specific target\n tracking or step scaling policy. When a warm-up period is specified here, it overrides\n the default instance warmup.
\nValid only if the policy type is TargetTrackingScaling or\n StepScaling.
The default is to use the value for the default instance warmup defined for the\n group. If default instance warmup is null, then EstimatedInstanceWarmup\n falls back to the value of default cooldown.
A target tracking scaling policy. Provides support for predefined or custom\n metrics.
\nThe following predefined metrics are available:
\n\n ASGAverageCPUUtilization\n
\n ASGAverageCPUUtilizationHighResolution\n
\n ASGAverageNetworkIn\n
\n ASGAverageNetworkOut\n
\n ALBRequestCountPerTarget\n
If you specify ALBRequestCountPerTarget for the metric, you must specify\n the ResourceLabel property with the\n PredefinedMetricSpecification.
For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API\n Reference.
\nRequired if the policy type is TargetTrackingScaling.
Indicates whether the scaling policy is enabled or disabled. The default is enabled.\n For more information, see Disable a\n scaling policy for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "PredictiveScalingConfiguration": { "target": "com.amazonaws.autoscaling#PredictiveScalingConfiguration", "traits": { "smithy.api#documentation": "A predictive scaling policy. Provides support for predefined and custom\n metrics.
\nPredefined metrics include CPU utilization, network in/out, and the Application Load\n Balancer request count.
\nFor more information, see PredictiveScalingConfiguration in the Amazon EC2 Auto Scaling API\n Reference.
\nRequired if the policy type is PredictiveScaling.
Creates or updates a scheduled scaling action for an Auto Scaling group.
\nFor more information, see Scheduled scaling in the\n Amazon EC2 Auto Scaling User Guide.
\nYou can view the scheduled actions for an Auto Scaling group using the \n DescribeScheduledActions\n API call. If you are no longer using a scheduled action, you can delete it by calling the \n DeleteScheduledAction API.
\nIf you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error\n message.
", "smithy.api#examples": [ { "title": "To add a scheduled action to an Auto Scaling group", "documentation": "This example adds the specified scheduled action to the specified Auto Scaling group.", "input": { "AutoScalingGroupName": "my-auto-scaling-group", "ScheduledActionName": "my-scheduled-action", "StartTime": "2014-05-12T08:00:00Z", "EndTime": "2014-05-12T08:00:00Z", "MinSize": 2, "MaxSize": 6, "DesiredCapacity": 4 } } ] } }, "com.amazonaws.autoscaling#PutScheduledUpdateGroupActionType": { "type": "structure", "members": { "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } }, "ScheduledActionName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of this scaling action.
", "smithy.api#required": {} } }, "Time": { "target": "com.amazonaws.autoscaling#TimestampType", "traits": { "smithy.api#documentation": "This property is no longer used.
" } }, "StartTime": { "target": "com.amazonaws.autoscaling#TimestampType", "traits": { "smithy.api#documentation": "The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT\n only and in quotes (for example, \"2021-06-01T00:00:00Z\").
If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs\n the action at this time, and then performs the action based on the specified\n recurrence.
The date and time for the recurring schedule to end, in UTC. For example,\n \"2021-06-01T00:00:00Z\".
The recurring schedule for this action. This format consists of five fields separated\n by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value\n must be in quotes (for example, \"30 0 1 1,6,12 *\"). For more information\n about this format, see Crontab.
When StartTime and EndTime are specified with\n Recurrence, they form the boundaries of when the recurring action\n starts and stops.
Cron expressions use Universal Coordinated Time (UTC) by default.
" } }, "MinSize": { "target": "com.amazonaws.autoscaling#AutoScalingGroupMinSize", "traits": { "smithy.api#documentation": "The minimum size of the Auto Scaling group.
" } }, "MaxSize": { "target": "com.amazonaws.autoscaling#AutoScalingGroupMaxSize", "traits": { "smithy.api#documentation": "The maximum size of the Auto Scaling group.
" } }, "DesiredCapacity": { "target": "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity", "traits": { "smithy.api#documentation": "The desired capacity is the initial capacity of the Auto Scaling group after the scheduled\n action runs and the capacity it attempts to maintain. It can scale beyond this capacity\n if you add more scaling conditions.
\nYou must specify at least one of the following properties: MaxSize,\n MinSize, or DesiredCapacity.
Specifies the time zone for a cron expression. If a time zone is not provided, UTC is\n used by default.
\nValid values are the canonical names of the IANA time zones, derived from the IANA\n Time Zone Database (such as Etc/GMT+9 or Pacific/Tahiti). For\n more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
Creates or updates a warm pool for the specified Auto Scaling group. A warm pool is a pool of\n pre-initialized EC2 instances that sits alongside the Auto Scaling group. Whenever your\n application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new\n desired capacity.
\nThis operation must be called from the Region in which the Auto Scaling group was\n created.
\nYou can view the instances in the warm pool using the DescribeWarmPool API call.\n If you are no longer using a warm pool, you can delete it by calling the DeleteWarmPool API.
\nFor more information, see Warm pools for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
", "smithy.api#examples": [ { "title": "To create a warm pool for an Auto Scaling group", "documentation": "This example creates a warm pool for the specified Auto Scaling group.", "input": { "AutoScalingGroupName": "my-auto-scaling-group", "MinSize": 30, "PoolState": "Hibernated", "InstanceReusePolicy": { "ReuseOnScaleIn": true } } } ] } }, "com.amazonaws.autoscaling#PutWarmPoolAnswer": { "type": "structure", "members": {} }, "com.amazonaws.autoscaling#PutWarmPoolType": { "type": "structure", "members": { "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } }, "MaxGroupPreparedCapacity": { "target": "com.amazonaws.autoscaling#MaxGroupPreparedCapacity", "traits": { "smithy.api#documentation": "Specifies the maximum number of instances that are allowed to be in the warm pool or\n in any state except Terminated for the Auto Scaling group. This is an optional\n property. Specify it only if you do not want the warm pool size to be determined by the\n difference between the group's maximum capacity and its desired capacity.
If a value for MaxGroupPreparedCapacity is not specified, Amazon EC2 Auto Scaling\n launches and maintains the difference between the group's maximum capacity and its\n desired capacity. If you specify a value for MaxGroupPreparedCapacity,\n Amazon EC2 Auto Scaling uses the difference between the MaxGroupPreparedCapacity and\n the desired capacity instead.
The size of the warm pool is dynamic. Only when\n MaxGroupPreparedCapacity and MinSize are set to the\n same value does the warm pool have an absolute size.
If the desired capacity of the Auto Scaling group is higher than the\n MaxGroupPreparedCapacity, the capacity of the warm pool is 0, unless\n you specify a value for MinSize. To remove a value that you previously set,\n include the property but specify -1 for the value.
Specifies the minimum number of instances to maintain in the warm pool. This helps you\n to ensure that there is always a certain number of warmed instances available to handle\n traffic spikes. Defaults to 0 if not specified.
" } }, "PoolState": { "target": "com.amazonaws.autoscaling#WarmPoolState", "traits": { "smithy.api#documentation": "Sets the instance state to transition to after the lifecycle actions are complete.\n Default is Stopped.
Indicates whether instances in the Auto Scaling group can be returned to the warm pool on\n scale in. The default is to terminate instances in the Auto Scaling group when the group scales\n in.
" } } } }, "com.amazonaws.autoscaling#RecordLifecycleActionHeartbeat": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#RecordLifecycleActionHeartbeatType" }, "output": { "target": "com.amazonaws.autoscaling#RecordLifecycleActionHeartbeatAnswer" }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" } ], "traits": { "smithy.api#documentation": "Records a heartbeat for the lifecycle action associated with the specified token or\n instance. This extends the timeout by the length of time defined using the \n PutLifecycleHook API call.
\nThis step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:
\n(Optional) Create a launch template or launch configuration with a user data\n script that runs while an instance is in a wait state due to a lifecycle\n hook.
\n(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke\n your Lambda function when an instance is put into a wait state due to a\n lifecycle hook.
\n(Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish\n lifecycle notifications to the target.
\nCreate the lifecycle hook. Specify whether the hook is used when the instances\n launch or terminate.
\n\n If you need more time, record the lifecycle action\n heartbeat to keep the instance in a wait state.\n
\nIf you finish before the timeout period ends, send a callback by using the\n CompleteLifecycleAction API call.
\nFor more information, see Amazon EC2 Auto Scaling lifecycle\n hooks in the Amazon EC2 Auto Scaling User Guide.
", "smithy.api#examples": [ { "title": "To record a lifecycle action heartbeat", "documentation": "This example records a lifecycle action heartbeat to keep the instance in a pending state.", "input": { "LifecycleHookName": "my-lifecycle-hook", "AutoScalingGroupName": "my-auto-scaling-group", "LifecycleActionToken": "bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635" } } ] } }, "com.amazonaws.autoscaling#RecordLifecycleActionHeartbeatAnswer": { "type": "structure", "members": {} }, "com.amazonaws.autoscaling#RecordLifecycleActionHeartbeatType": { "type": "structure", "members": { "LifecycleHookName": { "target": "com.amazonaws.autoscaling#AsciiStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the lifecycle hook.
", "smithy.api#required": {} } }, "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#ResourceName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } }, "LifecycleActionToken": { "target": "com.amazonaws.autoscaling#LifecycleActionToken", "traits": { "smithy.api#documentation": "A token that uniquely identifies a specific lifecycle action associated with an\n instance. Amazon EC2 Auto Scaling sends this token to the notification target that you specified when\n you created the lifecycle hook.
" } }, "InstanceId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", "traits": { "smithy.api#documentation": "The ID of the instance.
" } } } }, "com.amazonaws.autoscaling#RefreshInstanceWarmup": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.autoscaling#RefreshPreferences": { "type": "structure", "members": { "MinHealthyPercentage": { "target": "com.amazonaws.autoscaling#IntPercent", "traits": { "smithy.api#documentation": "Specifies the minimum percentage of the group to keep in service, healthy, and ready\n to use to support your workload to allow the operation to continue. The value is\n expressed as a percentage of the desired capacity of the Auto Scaling group. Value range is 0 to\n 100.
\nIf you do not specify this property, the default is 90 percent, or the percentage set\n in the instance maintenance policy for the Auto Scaling group, if defined.
" } }, "InstanceWarmup": { "target": "com.amazonaws.autoscaling#RefreshInstanceWarmup", "traits": { "smithy.api#documentation": "A time period, in seconds, during which an instance refresh waits before moving on to\n replacing the next instance after a new instance enters the InService\n state.
This property is not required for normal usage. Instead, use the\n DefaultInstanceWarmup property of the Auto Scaling group. The\n InstanceWarmup and DefaultInstanceWarmup properties work\n the same way. Only specify this property if you must override the\n DefaultInstanceWarmup property.
If you do not specify this property, the instance warmup by default is the value of\n the DefaultInstanceWarmup property, if defined (which is recommended in all\n cases), or the HealthCheckGracePeriod property otherwise.
(Optional) Threshold values for each checkpoint in ascending order. Each number must\n be unique. To replace all instances in the Auto Scaling group, the last number in the array must\n be 100.
For usage examples, see Add checkpoints to an instance refresh in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "CheckpointDelay": { "target": "com.amazonaws.autoscaling#CheckpointDelay", "traits": { "smithy.api#documentation": "(Optional) The amount of time, in seconds, to wait after a checkpoint before\n continuing. This property is optional, but if you specify a value for it, you must also\n specify a value for CheckpointPercentages. If you specify a value for\n CheckpointPercentages and not for CheckpointDelay, the\n CheckpointDelay defaults to 3600 (1 hour).
(Optional) Indicates whether skip matching is enabled. If enabled (true),\n then Amazon EC2 Auto Scaling skips replacing instances that match the desired configuration. If no\n desired configuration is specified, then it skips replacing instances that have the same\n launch template and instance types that the Auto Scaling group was using before the start of the\n instance refresh. The default is false.
For more information, see Use an\n instance refresh with skip matching in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "AutoRollback": { "target": "com.amazonaws.autoscaling#AutoRollback", "traits": { "smithy.api#documentation": "(Optional) Indicates whether to roll back the Auto Scaling group to its previous configuration\n if the instance refresh fails or a CloudWatch alarm threshold is met. The default is\n false.
A rollback is not supported in the following situations:
\nThere is no desired configuration specified for the instance refresh.
\nThe Auto Scaling group has a launch template that uses an Amazon Web Services Systems Manager\n parameter instead of an AMI ID for the ImageId property.
The Auto Scaling group uses the launch template's $Latest or\n $Default version.
For more information, see Undo changes with a\n rollback in the Amazon EC2 Auto Scaling User Guide.
" } }, "ScaleInProtectedInstances": { "target": "com.amazonaws.autoscaling#ScaleInProtectedInstances", "traits": { "smithy.api#documentation": "Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances protected from scale in\n are found.
\nThe following lists the valid values:
\nAmazon EC2 Auto Scaling replaces instances that are protected from scale in.
\nAmazon EC2 Auto Scaling ignores instances that are protected from scale in and continues\n to replace instances that are not protected.
\nAmazon EC2 Auto Scaling waits one hour for you to remove scale-in protection. Otherwise,\n the instance refresh will fail.
\nChoose the behavior that you want Amazon EC2 Auto Scaling to use if instances in Standby\n state are found.
The following lists the valid values:
\nAmazon EC2 Auto Scaling terminates instances that are in Standby.
Amazon EC2 Auto Scaling ignores instances that are in Standby and continues\n to replace instances that are in the InService state.
Amazon EC2 Auto Scaling waits one hour for you to return the instances to service.\n Otherwise, the instance refresh will fail.
\n(Optional) The CloudWatch alarm specification. CloudWatch alarms can be used to identify any\n issues and fail the operation if an alarm threshold is met.
" } }, "MaxHealthyPercentage": { "target": "com.amazonaws.autoscaling#IntPercent100To200", "traits": { "smithy.api#documentation": "Specifies the maximum percentage of the group that can be in service and healthy, or\n pending, to support your workload when replacing instances. The value is expressed as a\n percentage of the desired capacity of the Auto Scaling group. Value range is 100 to 200.
\nIf you specify MaxHealthyPercentage, you must also specify\n MinHealthyPercentage, and the difference between them cannot be greater\n than 100. A larger range increases the number of instances that can be replaced at the\n same time.
If you do not specify this property, the default is 100 percent, or the percentage set\n in the instance maintenance policy for the Auto Scaling group, if defined.
\nExplicitly setting MaxHealthyPercentage to 100 is not equivalent to\n omitting it. When MaxHealthyPercentage is explicitly set and it is\n mathematically impossible to replace instances while honoring both\n MinHealthyPercentage and MaxHealthyPercentage bounds\n simultaneously, Auto Scaling launches a new instance before terminating an old one\n (temporarily exceeding the desired capacity). When MaxHealthyPercentage\n is omitted, Auto Scaling terminates an instance and launches its replacement\n simultaneously. This behavioral difference can affect workflows that depend on\n instance replacement ordering.
\n The amount of time, in seconds, to wait at the end of an instance refresh before the instance refresh is considered complete.\n
" } } }, "traits": { "smithy.api#documentation": "Describes the preferences for an instance refresh.
" } }, "com.amazonaws.autoscaling#RefreshStrategy": { "type": "enum", "members": { "Rolling": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Rolling" } }, "ReplaceRootVolume": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ReplaceRootVolume" } } } }, "com.amazonaws.autoscaling#RequestedCapacity": { "type": "integer", "traits": { "smithy.api#range": { "min": 1 } } }, "com.amazonaws.autoscaling#ResourceContentionFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "ResourceContention", "httpResponseCode": 500 }, "smithy.api#documentation": "You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group,\n instance, or load balancer).
", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.autoscaling#ResourceInUseFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "ResourceInUse", "httpResponseCode": 400 }, "smithy.api#documentation": "The operation can't be performed because the resource is in use.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.autoscaling#ResourceName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1600 }, "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" } }, "com.amazonaws.autoscaling#ResumeProcesses": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#ScalingProcessQuery" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" }, { "target": "com.amazonaws.autoscaling#ResourceInUseFault" } ], "traits": { "smithy.api#documentation": "Resumes the specified suspended auto scaling processes, or all suspended process, for\n the specified Auto Scaling group.
\nFor more information, see Suspend and resume\n Amazon EC2 Auto Scaling processes in the Amazon EC2 Auto Scaling User Guide.
", "smithy.api#examples": [ { "title": "To resume Auto Scaling processes", "documentation": "This example resumes the specified suspended scaling process for the specified Auto Scaling group.", "input": { "AutoScalingGroupName": "my-auto-scaling-group", "ScalingProcesses": [ "AlarmNotification" ] } } ] } }, "com.amazonaws.autoscaling#RetentionAction": { "type": "enum", "members": { "Retain": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "retain" } }, "Terminate": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "terminate" } } } }, "com.amazonaws.autoscaling#RetentionTriggers": { "type": "structure", "members": { "TerminateHookAbandon": { "target": "com.amazonaws.autoscaling#RetentionAction", "traits": { "smithy.api#documentation": "\n Specifies the action when a termination lifecycle hook is abandoned due to failure, timeout, or explicit abandonment (calling CompleteLifecycleAction).\n
\n\n Set to retain to move instances to a retained state. Set to terminate for default termination behavior.\n
\n Retained instances don't count toward desired capacity and remain until you call TerminateInstanceInAutoScalingGroup.\n
\n Defines the specific triggers that cause instances to be retained in a Retained state rather than terminated. Each trigger corresponds to a different failure scenario during the instance lifecycle. This allows fine-grained control over when to preserve instances for manual intervention.\n
" } }, "com.amazonaws.autoscaling#RetryStrategy": { "type": "enum", "members": { "RETRY_WITH_GROUP_CONFIGURATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "retry-with-group-configuration" } }, "NONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "none" } } } }, "com.amazonaws.autoscaling#ReturnData": { "type": "boolean" }, "com.amazonaws.autoscaling#ReuseOnScaleIn": { "type": "boolean" }, "com.amazonaws.autoscaling#RollbackDetails": { "type": "structure", "members": { "RollbackReason": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", "traits": { "smithy.api#documentation": "The reason for this instance refresh rollback (for example, whether a manual or\n automatic rollback was initiated).
" } }, "RollbackStartTime": { "target": "com.amazonaws.autoscaling#TimestampType", "traits": { "smithy.api#documentation": "The date and time at which the rollback began.
" } }, "PercentageCompleteOnRollback": { "target": "com.amazonaws.autoscaling#IntPercent", "traits": { "smithy.api#documentation": "Indicates the value of PercentageComplete at the time the rollback\n started.
Indicates the value of InstancesToUpdate at the time the rollback\n started.
Reports progress on replacing instances in an Auto Scaling group that has a warm pool. This\n includes separate details for instances in the warm pool and instances in the Auto Scaling group\n (the live pool).
" } } }, "traits": { "smithy.api#documentation": "Details about an instance refresh rollback.
" } }, "com.amazonaws.autoscaling#RollbackInstanceRefresh": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#RollbackInstanceRefreshType" }, "output": { "target": "com.amazonaws.autoscaling#RollbackInstanceRefreshAnswer" }, "errors": [ { "target": "com.amazonaws.autoscaling#ActiveInstanceRefreshNotFoundFault" }, { "target": "com.amazonaws.autoscaling#IrreversibleInstanceRefreshFault" }, { "target": "com.amazonaws.autoscaling#LimitExceededFault" }, { "target": "com.amazonaws.autoscaling#ResourceContentionFault" } ], "traits": { "smithy.api#documentation": "Cancels an instance refresh that is in progress and rolls back any changes that it\n made. Amazon EC2 Auto Scaling replaces any instances that were replaced during the instance refresh.\n This restores your Auto Scaling group to the configuration that it was using before the start of\n the instance refresh.
\nThis operation is part of the instance refresh\n feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group\n after you make configuration changes.
\nA rollback is not supported in the following situations:
\nThere is no desired configuration specified for the instance refresh.
\nThe Auto Scaling group has a launch template that uses an Amazon Web Services Systems Manager parameter instead\n of an AMI ID for the ImageId property.
The Auto Scaling group uses the launch template's $Latest or\n $Default version.
When you receive a successful response from this operation, Amazon EC2 Auto Scaling immediately\n begins replacing instances. You can check the status of this operation through the \n DescribeInstanceRefreshes API operation.
" } }, "com.amazonaws.autoscaling#RollbackInstanceRefreshAnswer": { "type": "structure", "members": { "InstanceRefreshId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The instance refresh ID associated with the request. This is the unique ID assigned to\n the instance refresh when it was started.
" } } } }, "com.amazonaws.autoscaling#RollbackInstanceRefreshType": { "type": "structure", "members": { "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } } } }, "com.amazonaws.autoscaling#ScaleInProtectedInstances": { "type": "enum", "members": { "Refresh": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Refresh" } }, "Ignore": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Ignore" } }, "Wait": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Wait" } } } }, "com.amazonaws.autoscaling#ScalingActivityInProgressFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "ScalingActivityInProgress", "httpResponseCode": 400 }, "smithy.api#documentation": "The operation can't be performed because there are scaling activities in\n progress.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.autoscaling#ScalingActivityStatusCode": { "type": "enum", "members": { "PendingSpotBidPlacement": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PendingSpotBidPlacement" } }, "WaitingForSpotInstanceRequestId": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WaitingForSpotInstanceRequestId" } }, "WaitingForSpotInstanceId": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WaitingForSpotInstanceId" } }, "WaitingForInstanceId": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WaitingForInstanceId" } }, "PreInService": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PreInService" } }, "InProgress": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "InProgress" } }, "WaitingForELBConnectionDraining": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WaitingForELBConnectionDraining" } }, "MidLifecycleAction": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MidLifecycleAction" } }, "WaitingForInstanceWarmup": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WaitingForInstanceWarmup" } }, "Successful": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Successful" } }, "Failed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Failed" } }, "Cancelled": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Cancelled" } }, "WaitingForConnectionDraining": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WaitingForConnectionDraining" } }, "WaitingForInPlaceUpdateToStart": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WaitingForInPlaceUpdateToStart" } }, "WaitingForInPlaceUpdateToFinalize": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WaitingForInPlaceUpdateToFinalize" } }, "InPlaceUpdateInProgress": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "InPlaceUpdateInProgress" } } } }, "com.amazonaws.autoscaling#ScalingPolicies": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#ScalingPolicy" } }, "com.amazonaws.autoscaling#ScalingPolicy": { "type": "structure", "members": { "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The name of the Auto Scaling group.
" } }, "PolicyName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The name of the scaling policy.
" } }, "PolicyARN": { "target": "com.amazonaws.autoscaling#ResourceName", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the policy.
" } }, "PolicyType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", "traits": { "smithy.api#documentation": "One of the following policy types:
\n\n TargetTrackingScaling\n
\n StepScaling\n
\n SimpleScaling (default)
\n PredictiveScaling\n
For more information, see Target tracking\n scaling policies and Step and simple scaling\n policies in the Amazon EC2 Auto Scaling User Guide.
" } }, "AdjustmentType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "Specifies how the scaling adjustment is interpreted (for example, an absolute number\n or a percentage). The valid values are ChangeInCapacity,\n ExactCapacity, and PercentChangeInCapacity.
Available for backward compatibility. Use MinAdjustmentMagnitude\n instead.
The minimum value to scale by when the adjustment type is\n PercentChangeInCapacity.
The amount by which to scale, based on the specified adjustment type. A positive value\n adds to the current capacity while a negative number removes from the current\n capacity.
" } }, "Cooldown": { "target": "com.amazonaws.autoscaling#Cooldown", "traits": { "smithy.api#documentation": "The duration of the policy's cooldown period, in seconds.
" } }, "StepAdjustments": { "target": "com.amazonaws.autoscaling#StepAdjustments", "traits": { "smithy.api#documentation": "A set of adjustments that enable you to scale based on the size of the alarm\n breach.
" } }, "MetricAggregationType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", "traits": { "smithy.api#documentation": "The aggregation type for the CloudWatch metrics. The valid values are Minimum,\n Maximum, and Average.
The estimated time, in seconds, until a newly launched instance can contribute to the\n CloudWatch metrics.
" } }, "Alarms": { "target": "com.amazonaws.autoscaling#Alarms", "traits": { "smithy.api#documentation": "The CloudWatch alarms related to the policy.
" } }, "TargetTrackingConfiguration": { "target": "com.amazonaws.autoscaling#TargetTrackingConfiguration", "traits": { "smithy.api#documentation": "A target tracking scaling policy.
" } }, "Enabled": { "target": "com.amazonaws.autoscaling#ScalingPolicyEnabled", "traits": { "smithy.api#documentation": "Indicates whether the policy is enabled (true) or disabled\n (false).
A predictive scaling policy.
" } } }, "traits": { "smithy.api#documentation": "Describes a scaling policy.
" } }, "com.amazonaws.autoscaling#ScalingPolicyEnabled": { "type": "boolean" }, "com.amazonaws.autoscaling#ScalingProcessQuery": { "type": "structure", "members": { "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } }, "ScalingProcesses": { "target": "com.amazonaws.autoscaling#ProcessNames", "traits": { "smithy.api#documentation": "One or more of the following processes:
\n\n Launch\n
\n Terminate\n
\n AddToLoadBalancer\n
\n AlarmNotification\n
\n AZRebalance\n
\n HealthCheck\n
\n InstanceRefresh\n
\n ReplaceUnhealthy\n
\n ScheduledActions\n
If you omit this property, all processes are specified.
" } } } }, "com.amazonaws.autoscaling#ScheduledActionNames": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" } }, "com.amazonaws.autoscaling#ScheduledActionsType": { "type": "structure", "members": { "ScheduledUpdateGroupActions": { "target": "com.amazonaws.autoscaling#ScheduledUpdateGroupActions", "traits": { "smithy.api#documentation": "The scheduled actions.
" } }, "NextToken": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { "smithy.api#documentation": "A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.
The name of the Auto Scaling group.
" } }, "ScheduledActionName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The name of the scheduled action.
" } }, "ScheduledActionARN": { "target": "com.amazonaws.autoscaling#ResourceName", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the scheduled action.
" } }, "Time": { "target": "com.amazonaws.autoscaling#TimestampType", "traits": { "smithy.api#documentation": "This property is no longer used.
" } }, "StartTime": { "target": "com.amazonaws.autoscaling#TimestampType", "traits": { "smithy.api#documentation": "The date and time in UTC for this action to start. For example,\n \"2019-06-01T00:00:00Z\".
The date and time in UTC for the recurring schedule to end. For example,\n \"2019-06-01T00:00:00Z\".
The recurring schedule for the action, in Unix cron syntax format.
\nWhen StartTime and EndTime are specified with\n Recurrence, they form the boundaries of when the recurring action\n starts and stops.
The minimum size of the Auto Scaling group.
" } }, "MaxSize": { "target": "com.amazonaws.autoscaling#AutoScalingGroupMaxSize", "traits": { "smithy.api#documentation": "The maximum size of the Auto Scaling group.
" } }, "DesiredCapacity": { "target": "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity", "traits": { "smithy.api#documentation": "The desired capacity is the initial capacity of the Auto Scaling group after the scheduled\n action runs and the capacity it attempts to maintain.
" } }, "TimeZone": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The time zone for the cron expression.
" } } }, "traits": { "smithy.api#documentation": "Describes a scheduled scaling\n action.
" } }, "com.amazonaws.autoscaling#ScheduledUpdateGroupActionRequest": { "type": "structure", "members": { "ScheduledActionName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the scaling action.
", "smithy.api#required": {} } }, "StartTime": { "target": "com.amazonaws.autoscaling#TimestampType", "traits": { "smithy.api#documentation": "The date and time for the action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT\n only and in quotes (for example, \"2019-06-01T00:00:00Z\").
If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs\n the action at this time, and then performs the action based on the specified\n recurrence.
If you try to schedule the action in the past, Amazon EC2 Auto Scaling returns an error\n message.
" } }, "EndTime": { "target": "com.amazonaws.autoscaling#TimestampType", "traits": { "smithy.api#documentation": "The date and time for the recurring schedule to end, in UTC.
" } }, "Recurrence": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The recurring schedule for the action, in Unix cron syntax format. This format\n consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month]\n [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, \"30 0 1\n 1,6,12 *\"). For more information about this format, see Crontab.
When StartTime and EndTime are specified with\n Recurrence, they form the boundaries of when the recurring action\n starts and stops.
Cron expressions use Universal Coordinated Time (UTC) by default.
" } }, "MinSize": { "target": "com.amazonaws.autoscaling#AutoScalingGroupMinSize", "traits": { "smithy.api#documentation": "The minimum size of the Auto Scaling group.
" } }, "MaxSize": { "target": "com.amazonaws.autoscaling#AutoScalingGroupMaxSize", "traits": { "smithy.api#documentation": "The maximum size of the Auto Scaling group.
" } }, "DesiredCapacity": { "target": "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity", "traits": { "smithy.api#documentation": "The desired capacity is the initial capacity of the Auto Scaling group after the scheduled\n action runs and the capacity it attempts to maintain.
" } }, "TimeZone": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "Specifies the time zone for a cron expression. If a time zone is not provided, UTC is\n used by default.
\nValid values are the canonical names of the IANA time zones, derived from the IANA\n Time Zone Database (such as Etc/GMT+9 or Pacific/Tahiti). For\n more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
Describes information used for one or more scheduled scaling action updates in a \n BatchPutScheduledUpdateGroupAction\n operation.
" } }, "com.amazonaws.autoscaling#ScheduledUpdateGroupActionRequests": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#ScheduledUpdateGroupActionRequest" } }, "com.amazonaws.autoscaling#ScheduledUpdateGroupActions": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#ScheduledUpdateGroupAction" } }, "com.amazonaws.autoscaling#SecurityGroups": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#XmlString" } }, "com.amazonaws.autoscaling#ServiceLinkedRoleFailure": { "type": "structure", "members": { "message": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" } }, "traits": { "aws.protocols#awsQueryError": { "code": "ServiceLinkedRoleFailure", "httpResponseCode": 500 }, "smithy.api#documentation": "The service-linked role is not yet ready for use.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.autoscaling#SetDesiredCapacity": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#SetDesiredCapacityType" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" }, { "target": "com.amazonaws.autoscaling#ScalingActivityInProgressFault" } ], "traits": { "smithy.api#documentation": "Sets the size of the specified Auto Scaling group.
\nIf a scale-in activity occurs as a result of a new DesiredCapacity value\n that is lower than the current size of the group, the Auto Scaling group uses its termination\n policy to determine which instances to terminate.
For more information, see Manual\n scaling in the Amazon EC2 Auto Scaling User Guide.
", "smithy.api#examples": [ { "title": "To set the desired capacity for an Auto Scaling group", "documentation": "This example sets the desired capacity for the specified Auto Scaling group.", "input": { "AutoScalingGroupName": "my-auto-scaling-group", "DesiredCapacity": 2, "HonorCooldown": true } } ] } }, "com.amazonaws.autoscaling#SetDesiredCapacityType": { "type": "structure", "members": { "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } }, "DesiredCapacity": { "target": "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The desired capacity is the initial capacity of the Auto Scaling group after this operation\n completes and the capacity it attempts to maintain.
", "smithy.api#required": {} } }, "HonorCooldown": { "target": "com.amazonaws.autoscaling#HonorCooldown", "traits": { "smithy.api#documentation": "Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before initiating\n a scaling activity to set your Auto Scaling group to its new capacity. By default, Amazon EC2 Auto Scaling does\n not honor the cooldown period during manual scaling activities.
" } } } }, "com.amazonaws.autoscaling#SetInstanceHealth": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#SetInstanceHealthQuery" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" } ], "traits": { "smithy.api#documentation": "Sets the health status of the specified instance.
\nFor more information, see Set up a custom\n health check for your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
", "smithy.api#examples": [ { "title": "To set the health status of an instance", "documentation": "This example sets the health status of the specified instance to Unhealthy.", "input": { "InstanceId": "i-93633f9b", "HealthStatus": "Unhealthy" } } ] } }, "com.amazonaws.autoscaling#SetInstanceHealthQuery": { "type": "structure", "members": { "InstanceId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The ID of the instance.
", "smithy.api#required": {} } }, "HealthStatus": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The health status of the instance. Set to Healthy to have the instance\n remain in service. Set to Unhealthy to have the instance be out of service.\n Amazon EC2 Auto Scaling terminates and replaces the unhealthy instance.
If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod\n specified for the group, by default, this call respects the grace period. Set this to\n False, to have the call not respect the grace period associated with\n the group.
For more information about the health check grace period, see Set the health check grace period for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
" } } } }, "com.amazonaws.autoscaling#SetInstanceProtection": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#SetInstanceProtectionQuery" }, "output": { "target": "com.amazonaws.autoscaling#SetInstanceProtectionAnswer" }, "errors": [ { "target": "com.amazonaws.autoscaling#LimitExceededFault" }, { "target": "com.amazonaws.autoscaling#ResourceContentionFault" } ], "traits": { "smithy.api#documentation": "Updates the instance protection settings of the specified instances. This operation\n cannot be called on instances in a warm pool.
\nFor more information, see Use\n instance scale-in protection in the\n Amazon EC2 Auto Scaling User Guide.
\nIf you exceed your maximum limit of instance IDs, which is 50 per Auto Scaling group, the call\n fails.
", "smithy.api#examples": [ { "title": "To enable instance protection for an instance", "documentation": "This example enables instance protection for the specified instance.", "input": { "InstanceIds": [ "i-93633f9b" ], "AutoScalingGroupName": "my-auto-scaling-group", "ProtectedFromScaleIn": true } }, { "title": "To disable instance protection for an instance", "documentation": "This example disables instance protection for the specified instance.", "input": { "InstanceIds": [ "i-93633f9b" ], "AutoScalingGroupName": "my-auto-scaling-group", "ProtectedFromScaleIn": false } } ] } }, "com.amazonaws.autoscaling#SetInstanceProtectionAnswer": { "type": "structure", "members": {} }, "com.amazonaws.autoscaling#SetInstanceProtectionQuery": { "type": "structure", "members": { "InstanceIds": { "target": "com.amazonaws.autoscaling#InstanceIds", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "One or more instance IDs. You can specify up to 50 instances.
", "smithy.api#required": {} } }, "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } }, "ProtectedFromScaleIn": { "target": "com.amazonaws.autoscaling#ProtectedFromScaleIn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling\n in.
", "smithy.api#required": {} } } } }, "com.amazonaws.autoscaling#ShouldDecrementDesiredCapacity": { "type": "boolean" }, "com.amazonaws.autoscaling#ShouldRespectGracePeriod": { "type": "boolean" }, "com.amazonaws.autoscaling#SkipMatching": { "type": "boolean" }, "com.amazonaws.autoscaling#SkipZonalShiftValidation": { "type": "boolean" }, "com.amazonaws.autoscaling#SpotInstancePools": { "type": "integer" }, "com.amazonaws.autoscaling#SpotPrice": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.autoscaling#StandbyInstances": { "type": "enum", "members": { "Terminate": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Terminate" } }, "Ignore": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Ignore" } }, "Wait": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Wait" } } } }, "com.amazonaws.autoscaling#StartInstanceRefresh": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#StartInstanceRefreshType" }, "output": { "target": "com.amazonaws.autoscaling#StartInstanceRefreshAnswer" }, "errors": [ { "target": "com.amazonaws.autoscaling#InstanceRefreshInProgressFault" }, { "target": "com.amazonaws.autoscaling#LimitExceededFault" }, { "target": "com.amazonaws.autoscaling#ResourceContentionFault" } ], "traits": { "smithy.api#documentation": "Starts an instance refresh.
\nThis operation is part of the instance refresh\n feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group.\n This feature is helpful, for example, when you have a new AMI or a new user data script.\n You just need to create a new launch template that specifies the new AMI or user data\n script. Then start an instance refresh to immediately begin the process of updating\n instances in the group.
\nIf successful, the request's response contains a unique ID that you can use to track\n the progress of the instance refresh. To query its status, call the DescribeInstanceRefreshes API.\n To describe the instance refreshes that\n have already run, call the DescribeInstanceRefreshes API. To cancel an\n instance refresh that is in progress, use the CancelInstanceRefresh\n API.
\nAn instance refresh might fail for several reasons, such as EC2 launch failures,\n misconfigured health checks, or not ignoring or allowing the termination of instances\n that are in Standby state or protected from scale in. You can monitor for\n failed EC2 launches using the scaling activities. To find the scaling activities, call\n the DescribeScalingActivities API.
If you enable auto rollback, your Auto Scaling group will be rolled back automatically when\n the instance refresh fails. You can enable this feature before starting an instance\n refresh by specifying the AutoRollback property in the instance refresh\n preferences. Otherwise, to roll back an instance refresh before it finishes, use the\n RollbackInstanceRefresh API.
A unique ID for tracking the progress of the instance refresh.
" } } } }, "com.amazonaws.autoscaling#StartInstanceRefreshType": { "type": "structure", "members": { "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } }, "Strategy": { "target": "com.amazonaws.autoscaling#RefreshStrategy", "traits": { "smithy.api#documentation": "The strategy to use for the instance refresh. The default value is\n Rolling.
The desired configuration. For example, the desired configuration can specify a new\n launch template or a new version of the current launch template.
\nOnce the instance refresh succeeds, Amazon EC2 Auto Scaling updates the settings of the Auto Scaling group to\n reflect the new desired configuration.
\nWhen you specify a new launch template or a new version of the current launch\n template for your desired configuration, consider enabling the\n SkipMatching property in preferences. If it's enabled, Amazon EC2 Auto Scaling\n skips replacing instances that already use the specified launch template and\n instance types. This can help you reduce the number of replacements that are\n required to apply updates.
Sets your preferences for the instance refresh so that it performs as expected when\n you start it. Includes the instance warmup time, the minimum and maximum healthy\n percentages, and the behaviors that you want Amazon EC2 Auto Scaling to use if instances that are in\n Standby state or protected from scale in are found. You can also choose\n to enable additional features, such as the following:
Auto rollback
\nCheckpoints
\nCloudWatch alarms
\nSkip matching
\nBake time
\nThe lower bound for the difference between the alarm threshold and the CloudWatch metric. If\n the metric value is above the breach threshold, the lower bound is inclusive (the metric\n must be greater than or equal to the threshold plus the lower bound). Otherwise, it is\n exclusive (the metric must be greater than the threshold plus the lower bound). A null\n value indicates negative infinity.
" } }, "MetricIntervalUpperBound": { "target": "com.amazonaws.autoscaling#MetricScale", "traits": { "smithy.api#documentation": "The upper bound for the difference between the alarm threshold and the CloudWatch metric. If\n the metric value is above the breach threshold, the upper bound is exclusive (the metric\n must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the\n metric must be less than or equal to the threshold plus the upper bound). A null value\n indicates positive infinity.
\nThe upper bound must be greater than the lower bound.
" } }, "ScalingAdjustment": { "target": "com.amazonaws.autoscaling#PolicyIncrement", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The amount by which to scale, based on the specified adjustment type. A positive value\n adds to the current capacity while a negative number removes from the current capacity.\n For exact capacity, you must specify a non-negative value.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Describes information used to create a step adjustment for a step scaling\n policy.
\nFor the following examples, suppose that you have an alarm with a breach threshold of\n 50:
\nTo trigger the adjustment when the metric is greater than or equal to 50 and\n less than 60, specify a lower bound of 0 and an upper bound of 10.
\nTo trigger the adjustment when the metric is greater than 40 and less than or\n equal to 50, specify a lower bound of -10 and an upper bound of 0.
\nThere are a few rules for the step adjustments for your step policy:
\nThe ranges of your step adjustments can't overlap or have a gap.
\nAt most, one step adjustment can have a null lower bound. If one step\n adjustment has a negative lower bound, then there must be a step adjustment with\n a null lower bound.
\nAt most, one step adjustment can have a null upper bound. If one step\n adjustment has a positive upper bound, then there must be a step adjustment with\n a null upper bound.
\nThe upper and lower bound can't be null in the same step adjustment.
\nFor more information, see Step\n adjustments in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#StepAdjustments": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#StepAdjustment" } }, "com.amazonaws.autoscaling#String": { "type": "string" }, "com.amazonaws.autoscaling#SubnetIdsLimit1": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" }, "traits": { "smithy.api#length": { "min": 0, "max": 1 } } }, "com.amazonaws.autoscaling#SuspendProcesses": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#ScalingProcessQuery" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" }, { "target": "com.amazonaws.autoscaling#ResourceInUseFault" } ], "traits": { "smithy.api#documentation": "Suspends the specified auto scaling processes, or all processes, for the specified\n Auto Scaling group.
\nIf you suspend either the Launch or Terminate process types,\n it can prevent other process types from functioning properly. For more information, see\n Suspend and resume\n Amazon EC2 Auto Scaling processes in the Amazon EC2 Auto Scaling User Guide.
To resume processes that have been suspended, call the ResumeProcesses API.
", "smithy.api#examples": [ { "title": "To suspend Auto Scaling processes", "documentation": "This example suspends the specified scaling process for the specified Auto Scaling group.", "input": { "AutoScalingGroupName": "my-auto-scaling-group", "ScalingProcesses": [ "AlarmNotification" ] } } ] } }, "com.amazonaws.autoscaling#SuspendedProcess": { "type": "structure", "members": { "ProcessName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The name of the suspended process.
" } }, "SuspensionReason": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The reason that the process was suspended.
" } } }, "traits": { "smithy.api#documentation": "Describes an auto scaling process that has been suspended.
\nFor more information, see Types\n of processes in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#SuspendedProcesses": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#SuspendedProcess" } }, "com.amazonaws.autoscaling#Tag": { "type": "structure", "members": { "ResourceId": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { "smithy.api#documentation": "The name of the Auto Scaling group.
" } }, "ResourceType": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { "smithy.api#documentation": "The type of resource. The only supported value is\n auto-scaling-group.
The tag key.
", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.autoscaling#TagValue", "traits": { "smithy.api#documentation": "The tag value.
" } }, "PropagateAtLaunch": { "target": "com.amazonaws.autoscaling#PropagateAtLaunch", "traits": { "smithy.api#documentation": "Determines whether the tag is added to new instances as they are launched in the\n group.
" } } }, "traits": { "smithy.api#documentation": "Describes a tag for an Auto Scaling group.
" } }, "com.amazonaws.autoscaling#TagDescription": { "type": "structure", "members": { "ResourceId": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { "smithy.api#documentation": "The name of the group.
" } }, "ResourceType": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { "smithy.api#documentation": "The type of resource. The only supported value is\n auto-scaling-group.
The tag key.
" } }, "Value": { "target": "com.amazonaws.autoscaling#TagValue", "traits": { "smithy.api#documentation": "The tag value.
" } }, "PropagateAtLaunch": { "target": "com.amazonaws.autoscaling#PropagateAtLaunch", "traits": { "smithy.api#documentation": "Determines whether the tag is added to new instances as they are launched in the\n group.
" } } }, "traits": { "smithy.api#documentation": "Describes a tag for an Auto Scaling group.
" } }, "com.amazonaws.autoscaling#TagDescriptionList": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#TagDescription" } }, "com.amazonaws.autoscaling#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" } }, "com.amazonaws.autoscaling#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" } }, "com.amazonaws.autoscaling#Tags": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#Tag" } }, "com.amazonaws.autoscaling#TagsType": { "type": "structure", "members": { "Tags": { "target": "com.amazonaws.autoscaling#TagDescriptionList", "traits": { "smithy.api#documentation": "One or more tags.
" } }, "NextToken": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { "smithy.api#documentation": "A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.
A predefined metric. You must specify either a predefined metric or a customized\n metric.
" } }, "CustomizedMetricSpecification": { "target": "com.amazonaws.autoscaling#CustomizedMetricSpecification", "traits": { "smithy.api#documentation": "A customized metric. You must specify either a predefined metric or a customized\n metric.
" } }, "TargetValue": { "target": "com.amazonaws.autoscaling#MetricScale", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The target value for the metric.
\nSome metrics are based on a count instead of a percentage, such as the request\n count for an Application Load Balancer or the number of messages in an SQS queue. If the scaling policy\n specifies one of these metrics, specify the target utilization as the optimal\n average request or message count per instance during any one-minute interval.\n
\nIndicates whether scaling in by the target tracking scaling policy is disabled. If\n scaling in is disabled, the target tracking scaling policy doesn't remove instances from\n the Auto Scaling group. Otherwise, the target tracking scaling policy can remove instances from\n the Auto Scaling group. The default is false.
Represents a target tracking scaling policy configuration to use with Amazon EC2 Auto Scaling.
" } }, "com.amazonaws.autoscaling#TargetTrackingMetricDataQueries": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#TargetTrackingMetricDataQuery" } }, "com.amazonaws.autoscaling#TargetTrackingMetricDataQuery": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "A short name that identifies the object's results in the response. This name must be\n unique among all TargetTrackingMetricDataQuery objects specified for a\n single scaling policy. If you are performing math expressions on this set of data, this\n name represents that data and can serve as a variable in the mathematical expression.\n The valid characters are letters, numbers, and underscores. The first character must be\n a lowercase letter.
The math expression to perform on the returned data, if this object is performing a\n math expression. This expression can use the Id of the other metrics to\n refer to those metrics, and can also use the Id of other expressions to use\n the result of those expressions.
Conditional: Within each TargetTrackingMetricDataQuery object, you must\n specify either Expression or MetricStat, but not both.
Information about the metric data to return.
\nConditional: Within each TargetTrackingMetricDataQuery object, you must\n specify either Expression or MetricStat, but not both.
A human-readable label for this metric or expression. This is especially useful if\n this is a math expression, so that you know what the value represents.
" } }, "Period": { "target": "com.amazonaws.autoscaling#MetricGranularityInSeconds", "traits": { "smithy.api#documentation": "\n The period of the metric in seconds. The default value is 60. Accepted values are 10, 30, and 60. For high resolution metric, set the value to less than 60. For more information, see\n Create a target tracking policy using high-resolution metrics for faster response.\n
" } }, "ReturnData": { "target": "com.amazonaws.autoscaling#ReturnData", "traits": { "smithy.api#documentation": "Indicates whether to return the timestamps and raw data values of this metric.
\nIf you use any math expressions, specify true for this value for only the\n final math expression that the metric specification is based on. You must specify\n false for ReturnData for all the other metrics and\n expressions used in the metric specification.
If you are only retrieving metrics and not performing any math expressions, do not\n specify anything for ReturnData. This sets it to its default\n (true).
The metric data to return. Also defines whether this call is returning data for one\n metric only, or whether it is performing a math expression on the values of returned\n metric statistics to create a new time series. A time series is a series of data points,\n each of which is associated with a timestamp.
" } }, "com.amazonaws.autoscaling#TargetTrackingMetricStat": { "type": "structure", "members": { "Metric": { "target": "com.amazonaws.autoscaling#Metric", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The metric to use.
", "smithy.api#required": {} } }, "Stat": { "target": "com.amazonaws.autoscaling#XmlStringMetricStat", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The statistic to return. It can include any CloudWatch statistic or extended statistic. For\n a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide.
\nThe most commonly used metric for scaling is Average.
The unit to use for the returned data points. For a complete list of the units that\n CloudWatch supports, see the MetricDatum\n data type in the Amazon CloudWatch API Reference.
" } }, "Period": { "target": "com.amazonaws.autoscaling#MetricGranularityInSeconds", "traits": { "smithy.api#documentation": "\n The period of the metric in seconds. The default value is 60. Accepted values are 10, 30, and 60. For high resolution metric, set the value to less than 60. For more information, see\n Create a target tracking policy using high-resolution metrics for faster response.\n
" } } }, "traits": { "smithy.api#documentation": "This structure defines the CloudWatch metric to return, along with the statistic and\n unit.
\nFor more information about the CloudWatch terminology below, see Amazon CloudWatch\n concepts in the Amazon CloudWatch User Guide.
" } }, "com.amazonaws.autoscaling#TerminateInstanceInAutoScalingGroup": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#TerminateInstanceInAutoScalingGroupType" }, "output": { "target": "com.amazonaws.autoscaling#ActivityType" }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" }, { "target": "com.amazonaws.autoscaling#ScalingActivityInProgressFault" } ], "traits": { "smithy.api#documentation": "Terminates the specified instance and optionally adjusts the desired group size. This\n operation cannot be called on instances in a warm pool.
\nThis call simply makes a termination request. The instances are not terminated\n immediately. When an instance is terminated, the instance status changes to\n terminated. You can't connect to or start an instance after you've\n terminated it.
If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches\n instances to replace the ones that are terminated.
\nTo terminate multiple instances in a single call, use the InstanceIds\n and AutoScalingGroupName parameters instead of InstanceId.\n When terminating multiple instances, the response populates\n Activities instead of Activity.
By default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you\n decrement the desired capacity, your Auto Scaling group can become unbalanced between\n Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might\n terminate instances in other zones. For more information, see Manual\n scaling in the Amazon EC2 Auto Scaling User Guide.
", "smithy.api#examples": [ { "title": "To terminate an instance in an Auto Scaling group", "documentation": "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.", "input": { "InstanceId": "i-93633f9b", "ShouldDecrementDesiredCapacity": false } }, { "title": "To terminate multiple instances in an Auto Scaling group", "documentation": "This example terminates multiple instances from the specified Auto Scaling group without updating the size of the group. Auto Scaling launches replacement instances after the specified instances terminate.", "input": { "InstanceIds": [ "i-93633f9b", "i-ab4d5e6f7" ], "AutoScalingGroupName": "my-asg", "ShouldDecrementDesiredCapacity": false }, "output": { "Activities": [ { "ActivityId": "12345678-1234-1234-1234-123456789012", "AutoScalingGroupName": "my-asg", "Description": "Terminating EC2 instance: i-93633f9b", "Cause": "At 2024-03-14T00:07:30Z instance i-93633f9b was taken out of service in response to a user request.", "StartTime": "2024-03-14T00:07:30.280Z", "StatusCode": "InProgress", "Progress": 0 }, { "ActivityId": "12345678-1234-1234-1234-123456789013", "AutoScalingGroupName": "my-asg", "Description": "Terminating EC2 instance: i-ab4d5e6f7", "Cause": "At 2024-03-14T00:07:30Z instance i-ab4d5e6f7 was taken out of service in response to a user request.", "StartTime": "2024-03-14T00:07:30.280Z", "StatusCode": "InProgress", "Progress": 0 } ] } } ] } }, "com.amazonaws.autoscaling#TerminateInstanceInAutoScalingGroupType": { "type": "structure", "members": { "InstanceId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", "traits": { "smithy.api#documentation": "The ID of the instance.
" } }, "InstanceIds": { "target": "com.amazonaws.autoscaling#TerminationInstanceIds", "traits": { "smithy.api#documentation": "The IDs of the instances. You can specify up to 100 instances.
\nThis parameter requires that you also specify AutoScalingGroupName.
The name of the Auto Scaling group. Required when using InstanceIds.
Indicates whether terminating the instance also decrements the size of the Auto Scaling\n group.
", "smithy.api#required": {} } } } }, "com.amazonaws.autoscaling#TerminationInstanceIds": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen19" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.autoscaling#TerminationPolicies": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen1600" } }, "com.amazonaws.autoscaling#TimestampType": { "type": "timestamp" }, "com.amazonaws.autoscaling#TotalLocalStorageGBRequest": { "type": "structure", "members": { "Min": { "target": "com.amazonaws.autoscaling#NullablePositiveDouble", "traits": { "smithy.api#documentation": "The storage minimum in GB.
" } }, "Max": { "target": "com.amazonaws.autoscaling#NullablePositiveDouble", "traits": { "smithy.api#documentation": "The storage maximum in GB.
" } } }, "traits": { "smithy.api#documentation": "Specifies the minimum and maximum for the TotalLocalStorageGB object when\n you specify InstanceRequirements for an Auto Scaling group.
Identifies the traffic source.
\nFor Application Load Balancers, Gateway Load Balancers, Network Load Balancers, and VPC Lattice, this will be the Amazon Resource Name\n (ARN) for a target group in this account and Region. For Classic Load Balancers, this will be the name\n of the Classic Load Balancer in this account and Region.
\nFor example:
\nApplication Load Balancer ARN:\n arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/1234567890123456\n
Classic Load Balancer name: my-classic-load-balancer\n
VPC Lattice ARN:\n arn:aws:vpc-lattice:us-west-2:123456789012:targetgroup/tg-1234567890123456\n
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\n Classic Load Balancer, use the Elastic Load Balancing DescribeTargetGroups and DescribeLoadBalancers API operations.
\nTo get the ARN of a target group for VPC Lattice, use the VPC Lattice GetTargetGroup API operation.
", "smithy.api#required": {} } }, "Type": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen511", "traits": { "smithy.api#documentation": "Provides additional context for the value of Identifier.
The following lists the valid values:
\n\n elb if Identifier is the name of a Classic Load Balancer.
\n elbv2 if Identifier is the ARN of an Application Load Balancer, Gateway Load Balancer,\n or Network Load Balancer target group.
\n vpc-lattice if Identifier is the ARN of a VPC Lattice\n target group.
Required if the identifier is the name of a Classic Load Balancer.
" } } }, "traits": { "smithy.api#documentation": "Identifying information for a traffic source.
" } }, "com.amazonaws.autoscaling#TrafficSourceState": { "type": "structure", "members": { "TrafficSource": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen511", "traits": { "smithy.api#deprecated": { "message": "TrafficSource has been replaced by Identifier" }, "smithy.api#documentation": "This is replaced by Identifier.
Describes the current state of a traffic source.
\nThe state values are as follows:
\n\n Adding - The Auto Scaling instances are being registered with the load\n balancer or target group.
\n Added - All Auto Scaling instances are registered with the load balancer or\n target group.
\n InService - For an Elastic Load Balancing load balancer or target group, at least\n one Auto Scaling instance passed an ELB health check. For VPC Lattice, at\n least one Auto Scaling instance passed an VPC_LATTICE health check.
\n Removing - The Auto Scaling instances are being deregistered from the\n load balancer or target group. If connection draining (deregistration delay) is\n enabled, Elastic Load Balancing or VPC Lattice waits for in-flight requests to complete before\n deregistering the instances.
\n Removed - All Auto Scaling instances are deregistered from the load\n balancer or target group.
The unique identifier of the traffic source.
" } }, "Type": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen511", "traits": { "smithy.api#documentation": "Provides additional context for the value of Identifier.
The following lists the valid values:
\n\n elb if Identifier is the name of a Classic Load Balancer.
\n elbv2 if Identifier is the ARN of an Application Load Balancer, Gateway Load Balancer,\n or Network Load Balancer target group.
\n vpc-lattice if Identifier is the ARN of a VPC Lattice\n target group.
Required if the identifier is the name of a Classic Load Balancer.
" } } }, "traits": { "smithy.api#documentation": "Describes the state of a traffic source.
" } }, "com.amazonaws.autoscaling#TrafficSourceStates": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#TrafficSourceState" } }, "com.amazonaws.autoscaling#TrafficSources": { "type": "list", "member": { "target": "com.amazonaws.autoscaling#TrafficSourceIdentifier" } }, "com.amazonaws.autoscaling#UpdateAutoScalingGroup": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#UpdateAutoScalingGroupType" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" }, { "target": "com.amazonaws.autoscaling#ScalingActivityInProgressFault" }, { "target": "com.amazonaws.autoscaling#ServiceLinkedRoleFailure" } ], "traits": { "smithy.api#documentation": "\n We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.\n
\nUpdates the configuration for the specified Auto Scaling group.
\nTo update an Auto Scaling group, specify the name of the group and the property that you want\n to change. Any properties that you don't specify are not changed by this update request.\n The new settings take effect on any scaling activities after this call returns.\n
\nIf you associate a new launch configuration or template with an Auto Scaling group, all new\n instances will get the updated configuration. Existing instances continue to run with\n the configuration that they were originally launched with. When you update a group to\n specify a mixed instances policy instead of a launch configuration or template, existing\n instances may be replaced to match the new purchasing options that you specified in the\n policy. For example, if the group currently has 100% On-Demand capacity and the policy\n specifies 50% Spot capacity, this means that half of your instances will be gradually\n terminated and relaunched as Spot Instances. When replacing instances, Amazon EC2 Auto Scaling launches\n new instances before terminating the old ones, so that updating your group does not\n compromise the performance or availability of your application.
\nNote the following about changing DesiredCapacity, MaxSize,\n or MinSize:
If a scale-in activity occurs as a result of a new\n DesiredCapacity value that is lower than the current size of\n the group, the Auto Scaling group uses its termination policy to determine which\n instances to terminate.
If you specify a new value for MinSize without specifying a value\n for DesiredCapacity, and the new MinSize is larger\n than the current size of the group, this sets the group's\n DesiredCapacity to the new MinSize value.
If you specify a new value for MaxSize without specifying a value\n for DesiredCapacity, and the new MaxSize is smaller\n than the current size of the group, this sets the group's\n DesiredCapacity to the new MaxSize value.
To see which properties have been set, call the DescribeAutoScalingGroups API.\n To view the scaling policies for an Auto Scaling\n group, call the DescribePolicies API. If the group has scaling\n policies, you can update them by calling the PutScalingPolicy API.
", "smithy.api#examples": [ { "title": "To update an Auto Scaling group", "documentation": "This example updates multiple properties at the same time.", "input": { "AutoScalingGroupName": "my-auto-scaling-group", "LaunchTemplate": { "LaunchTemplateName": "my-template-for-auto-scaling", "Version": "2" }, "MinSize": 1, "MaxSize": 5, "NewInstancesProtectedFromScaleIn": true } } ] } }, "com.amazonaws.autoscaling#UpdateAutoScalingGroupType": { "type": "structure", "members": { "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } }, "LaunchConfigurationName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The name of the launch configuration. If you specify\n LaunchConfigurationName in your update request, you can't specify\n LaunchTemplate or MixedInstancesPolicy.
The launch template and version to use to specify the updates. If you specify\n LaunchTemplate in your update request, you can't specify\n LaunchConfigurationName or MixedInstancesPolicy.
The mixed instances policy. For more information, see Auto Scaling\n groups with multiple instance types and purchase options in the\n Amazon EC2 Auto Scaling User Guide.
\nYou can remove the Distribution Segments configuration by specifying\n OnDemandBaseCapacity or\n OnDemandPercentageAboveBaseCapacity. You can also remove it explicitly\n by specifying an empty list for DistributionSegments.
The minimum size of the Auto Scaling group.
" } }, "MaxSize": { "target": "com.amazonaws.autoscaling#AutoScalingGroupMaxSize", "traits": { "smithy.api#documentation": "The maximum size of the Auto Scaling group.
\nWith a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to\n go above MaxSize to meet your capacity requirements. In this event,\n Amazon EC2 Auto Scaling will never go above MaxSize by more than your largest instance\n weight (weights that define how many units each instance contributes to the desired\n capacity of the group).
The desired capacity is the initial capacity of the Auto Scaling group after this operation\n completes and the capacity it attempts to maintain. This number must be greater than or\n equal to the minimum size of the group and less than or equal to the maximum size of the\n group.
" } }, "DefaultCooldown": { "target": "com.amazonaws.autoscaling#Cooldown", "traits": { "smithy.api#documentation": "\n Only needed if you use simple scaling policies.\n
\nThe amount of time, in seconds, between one scaling activity ending and another one\n starting due to simple scaling policies. For more information, see Scaling\n cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
" } }, "AvailabilityZones": { "target": "com.amazonaws.autoscaling#AvailabilityZones", "traits": { "smithy.api#documentation": "One or more Availability Zones for the group.
" } }, "AvailabilityZoneIds": { "target": "com.amazonaws.autoscaling#AvailabilityZoneIds", "traits": { "smithy.api#documentation": "\n A list of Availability Zone IDs for the Auto Scaling group. You cannot specify both AvailabilityZones and AvailabilityZoneIds in the same request.\n
" } }, "HealthCheckType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", "traits": { "smithy.api#documentation": "A comma-separated value string of one or more health check types.
\nThe valid values are EC2, EBS, ELB, and\n VPC_LATTICE. EC2 is the default health check and cannot be\n disabled. For more information, see Health checks\n for instances in an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
Only specify EC2 if you must clear a value that was previously\n set.
The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service and marking it unhealthy due to a failed\n health check. This is useful if your instances do not immediately pass their health\n checks after they enter the InService state. For more information, see\n Set the health check\n grace period for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
The name of an existing placement group into which to launch your instances. To remove the placement group setting, pass an empty string for placement-group. For more\n information about placement groups, see Placement groups in the\n Amazon EC2 User Guide.
A cluster placement group is a logical grouping of instances\n within a single Availability Zone. You cannot specify multiple Availability Zones\n and a cluster placement group.
\nA comma-separated list of subnet IDs for a virtual private cloud (VPC). If you specify\n VPCZoneIdentifier with AvailabilityZones, the subnets that\n you specify must reside in those Availability Zones.
A policy or a list of policies that are used to select the instances to terminate. The\n policies are executed in the order that you list them. For more information, see Configure\n termination policies for Amazon EC2 Auto Scaling in the\n Amazon EC2 Auto Scaling User Guide.
\nValid values: Default | AllocationStrategy |\n ClosestToNextInstanceHour | NewestInstance |\n OldestInstance | OldestLaunchConfiguration |\n OldestLaunchTemplate |\n arn:aws:lambda:region:account-id:function:my-function:my-alias\n
Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling\n when scaling in. For more information about preventing instances from terminating on\n scale in, see Use\n instance scale-in protection in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "ServiceLinkedRoleARN": { "target": "com.amazonaws.autoscaling#ResourceName", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to\n call other Amazon Web Services on your behalf. For more information, see Service-linked\n roles in the Amazon EC2 Auto Scaling User Guide.
" } }, "MaxInstanceLifetime": { "target": "com.amazonaws.autoscaling#MaxInstanceLifetime", "traits": { "smithy.api#documentation": "The maximum amount of time, in seconds, that an instance can be in service. The\n default is null. If specified, the value must be either 0 or a number equal to or\n greater than 86,400 seconds (1 day). To clear a previously set value, specify a new\n value of 0. For more information, see Replacing Auto Scaling\n instances based on maximum instance lifetime in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "CapacityRebalance": { "target": "com.amazonaws.autoscaling#CapacityRebalanceEnabled", "traits": { "smithy.api#documentation": "Enables or disables Capacity Rebalancing. If Capacity Rebalancing is disabled, proactive replacement of at-risk Spot Instances does not occur. For more information, see Capacity\n Rebalancing in Auto Scaling to replace at-risk Spot Instances in the Amazon EC2 Auto Scaling User Guide.
\nTo suspend rebalancing across Availability Zones, use the SuspendProcesses API.
\nReserved.
" } }, "DesiredCapacityType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling\n supports DesiredCapacityType for attribute-based instance type selection\n only. For more information, see Create a mixed instances group using attribute-based instance type\n selection in the Amazon EC2 Auto Scaling User Guide.
By default, Amazon EC2 Auto Scaling specifies units, which translates into number of\n instances.
Valid values: units | vcpu | memory-mib\n
The amount of time, in seconds, until a new instance is considered to have finished\n initializing and resource consumption to become stable after it enters the\n InService state.
During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an\n instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the\n warm-up period before aggregating the metrics for new instances with existing instances\n in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage\n data. For more information, see Set\n the default instance warmup for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
\nTo manage various warm-up settings at the group level, we recommend that you set\n the default instance warmup, even if it is set to 0 seconds. To\n remove a value that you previously set, include the property but specify\n -1 for the value. However, we strongly recommend keeping the\n default instance warmup enabled by specifying a value of 0 or other\n nominal value.
An instance maintenance policy. For more information, see Set instance maintenance policy in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "AvailabilityZoneDistribution": { "target": "com.amazonaws.autoscaling#AvailabilityZoneDistribution", "traits": { "smithy.api#documentation": "\n The instance capacity distribution across Availability Zones.\n
" } }, "AvailabilityZoneImpairmentPolicy": { "target": "com.amazonaws.autoscaling#AvailabilityZoneImpairmentPolicy", "traits": { "smithy.api#documentation": "\n The policy for Availability Zone impairment.\n
" } }, "SkipZonalShiftValidation": { "target": "com.amazonaws.autoscaling#SkipZonalShiftValidation", "traits": { "smithy.api#documentation": "\n If you enable zonal shift with cross-zone disabled load balancers, capacity could become imbalanced across Availability Zones. To skip the validation, specify true. For more information, see\n Auto Scaling group zonal shift in the Amazon EC2 Auto Scaling User Guide.\n
\n The capacity reservation specification for the Auto Scaling group. \n
" } }, "InstanceLifecyclePolicy": { "target": "com.amazonaws.autoscaling#InstanceLifecyclePolicy", "traits": { "smithy.api#documentation": "\n The instance lifecycle policy for the Auto Scaling group. This policy controls instance behavior when an instance\n transitions through its lifecycle states. Configure retention triggers to specify when instances should\n move to a Retained state instead of automatic termination.\n
For more information, see\n \n Control instance retention with instance lifecycle policies\n in the Amazon EC2 Auto Scaling User Guide.\n
" } }, "DeletionProtection": { "target": "com.amazonaws.autoscaling#DeletionProtection", "traits": { "smithy.api#documentation": "\n The deletion protection setting for the Auto Scaling group. This setting helps safeguard your Auto Scaling group and its\n instances by controlling whether the DeleteAutoScalingGroup operation is allowed. When deletion\n protection is enabled, users cannot delete the Auto Scaling group according to the specified protection level until\n the setting is changed back to a less restrictive level.\n
\n The valid values are none, prevent-force-deletion, and prevent-all-deletion.\n
\n Default: none\n
\n For more information, see\n \n Configure deletion protection for your Amazon EC2 Auto Scaling resources\n in the Amazon EC2 Auto Scaling User Guide.\n
" } } } }, "com.amazonaws.autoscaling#UpdatePlacementGroupParam": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 255 }, "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" } }, "com.amazonaws.autoscaling#VCpuCountRequest": { "type": "structure", "members": { "Min": { "target": "com.amazonaws.autoscaling#NullablePositiveInteger", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The minimum number of vCPUs.
", "smithy.api#required": {} } }, "Max": { "target": "com.amazonaws.autoscaling#NullablePositiveInteger", "traits": { "smithy.api#documentation": "The maximum number of vCPUs.
" } } }, "traits": { "smithy.api#documentation": "Specifies the minimum and maximum for the VCpuCount object when you\n specify InstanceRequirements for an Auto Scaling group.
The maximum number of instances that are allowed to be in the warm pool or in any\n state except Terminated for the Auto Scaling group.
The minimum number of instances to maintain in the warm pool.
" } }, "PoolState": { "target": "com.amazonaws.autoscaling#WarmPoolState", "traits": { "smithy.api#documentation": "The instance state to transition to after the lifecycle actions are complete.
" } }, "Status": { "target": "com.amazonaws.autoscaling#WarmPoolStatus", "traits": { "smithy.api#documentation": "The status of a warm pool that is marked for deletion.
" } }, "InstanceReusePolicy": { "target": "com.amazonaws.autoscaling#InstanceReusePolicy", "traits": { "smithy.api#documentation": "The instance reuse policy.
" } } }, "traits": { "smithy.api#documentation": "Describes a warm pool configuration.
" } }, "com.amazonaws.autoscaling#WarmPoolMinSize": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.autoscaling#WarmPoolSize": { "type": "integer" }, "com.amazonaws.autoscaling#WarmPoolState": { "type": "enum", "members": { "Stopped": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Stopped" } }, "Running": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Running" } }, "Hibernated": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Hibernated" } } } }, "com.amazonaws.autoscaling#WarmPoolStatus": { "type": "enum", "members": { "PendingDelete": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PendingDelete" } } } }, "com.amazonaws.autoscaling#XmlString": { "type": "string", "traits": { "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" } }, "com.amazonaws.autoscaling#XmlStringMaxLen1023": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1023 }, "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" } }, "com.amazonaws.autoscaling#XmlStringMaxLen1600": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1600 }, "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" } }, "com.amazonaws.autoscaling#XmlStringMaxLen19": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 19 }, "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" } }, "com.amazonaws.autoscaling#XmlStringMaxLen2047": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2047 }, "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" } }, "com.amazonaws.autoscaling#XmlStringMaxLen255": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" } }, "com.amazonaws.autoscaling#XmlStringMaxLen32": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 32 }, "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" } }, "com.amazonaws.autoscaling#XmlStringMaxLen5000": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 5000 }, "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" } }, "com.amazonaws.autoscaling#XmlStringMaxLen511": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 511 }, "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" } }, "com.amazonaws.autoscaling#XmlStringMaxLen64": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" } }, "com.amazonaws.autoscaling#XmlStringMetricLabel": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2047 }, "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" } }, "com.amazonaws.autoscaling#XmlStringMetricStat": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" } }, "com.amazonaws.autoscaling#XmlStringUserData": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 21847 }, "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" } }, "com.amazonaws.autoscaling#ZonalShiftEnabled": { "type": "boolean" } } }