2016/08/11 - Auto Scaling - 3 new2 updated api methods
Changes Update autoscaling client to latest version
Detaches one or more target groups from the specified Auto Scaling group.
Request Syntax
client.detach_load_balancer_target_groups(
AutoScalingGroupName='string',
TargetGroupARNs=[
'string',
]
)
string
[REQUIRED]
The name of the Auto Scaling group.
list
[REQUIRED]
The Amazon Resource Names (ARN) of the target groups.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Describes the target groups for the specified Auto Scaling group.
Request Syntax
client.describe_load_balancer_target_groups(
AutoScalingGroupName='string',
NextToken='string',
MaxRecords=123
)
string
[REQUIRED]
The name of the Auto Scaling group.
string
The token for the next set of items to return. (You received this token from a previous call.)
integer
The maximum number of items to return with this call.
dict
Response Syntax
{
'LoadBalancerTargetGroups': [
{
'LoadBalancerTargetGroupARN': 'string',
'State': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contains the output of DescribeLoadBalancerTargetGroups.
LoadBalancerTargetGroups (list) --
Information about the target groups.
(dict) --
Describes the state of a target group.
If you attach a target group to an existing Auto Scaling group, the initial state is Adding. The state transitions to Added after all Auto Scaling instances are registered with the target group. If ELB health checks are enabled, the state transitions to InService after at least one Auto Scaling instance passes the health check. If EC2 health checks are enabled instead, the target group remains in the Added state.
LoadBalancerTargetGroupARN (string) --
The Amazon Resource Name (ARN) of the target group.
State (string) --
The state of the target group.
Adding - The Auto Scaling instances are being registered with the target group.
Added - All Auto Scaling instances are registered with the target group.
InService - At least one Auto Scaling instance passed an ELB health check.
Removing - The Auto Scaling instances are being deregistered from the target group. If connection draining is enabled, Elastic Load Balancing waits for in-flight requests to complete before deregistering the instances.
Removed - All Auto Scaling instances are deregistered from the target group.
NextToken (string) --
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
Attaches one or more target groups to the specified Auto Scaling group.
To describe the target groups for an Auto Scaling group, use DescribeLoadBalancerTargetGroups. To detach the target group from the Auto Scaling group, use DetachLoadBalancerTargetGroups.
For more information, see Attach a Load Balancer to Your Auto Scaling Group in the Auto Scaling User Guide.
Request Syntax
client.attach_load_balancer_target_groups(
AutoScalingGroupName='string',
TargetGroupARNs=[
'string',
]
)
string
[REQUIRED]
The name of the Auto Scaling group.
list
[REQUIRED]
The Amazon Resource Names (ARN) of the target groups.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
{'TargetGroupARNs': ['string']}
Creates an Auto Scaling group with the specified name and attributes.
If you exceed your maximum limit of Auto Scaling groups, which by default is 20 per region, the call fails. For information about viewing and updating this limit, see DescribeAccountLimits.
For more information, see Auto Scaling Groups in the Auto Scaling User Guide.
Request Syntax
client.create_auto_scaling_group(
AutoScalingGroupName='string',
LaunchConfigurationName='string',
InstanceId='string',
MinSize=123,
MaxSize=123,
DesiredCapacity=123,
DefaultCooldown=123,
AvailabilityZones=[
'string',
],
LoadBalancerNames=[
'string',
],
TargetGroupARNs=[
'string',
],
HealthCheckType='string',
HealthCheckGracePeriod=123,
PlacementGroup='string',
VPCZoneIdentifier='string',
TerminationPolicies=[
'string',
],
NewInstancesProtectedFromScaleIn=True|False,
Tags=[
{
'ResourceId': 'string',
'ResourceType': 'string',
'Key': 'string',
'Value': 'string',
'PropagateAtLaunch': True|False
},
]
)
string
[REQUIRED]
The name of the group. This name must be unique within the scope of your AWS account.
string
The name of the launch configuration. Alternatively, specify an EC2 instance instead of a launch configuration.
string
The ID of the instance used to create a launch configuration for the group. Alternatively, specify a launch configuration instead of an EC2 instance.
When you specify an ID of an instance, Auto Scaling creates a new launch configuration and associates it with the group. This launch configuration derives its attributes from the specified instance, with the exception of the block device mapping.
For more information, see Create an Auto Scaling Group Using an EC2 Instance in the Auto Scaling User Guide.
integer
[REQUIRED]
The minimum size of the group.
integer
[REQUIRED]
The maximum size of the group.
integer
The number of EC2 instances that should be running in the group. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group.
integer
The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default is 300.
For more information, see Auto Scaling Cooldowns in the Auto Scaling User Guide.
list
One or more Availability Zones for the group. This parameter is optional if you specify one or more subnets.
(string) --
list
One or more Classic load balancers. To specify an Application load balancer, use TargetGroupARNs instead.
For more information, see Using a Load Balancer With an Auto Scaling Group in the Auto Scaling User Guide.
(string) --
list
The Amazon Resource Names (ARN) of the target groups.
(string) --
string
The service to use for the health checks. The valid values are EC2 and ELB.
By default, health checks use Amazon EC2 instance status checks to determine the health of an instance. For more information, see Health Checks in the Auto Scaling User Guide.
integer
The amount of time, in seconds, that Auto Scaling waits before checking the health status of an EC2 instance that has come into service. During this time, any health check failures for the instance are ignored. The default is 0.
This parameter is required if you are adding an ELB health check.
For more information, see Health Checks in the Auto Scaling User Guide.
string
The name of the placement group into which you'll launch your instances, if any. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.
string
A comma-separated list of subnet identifiers for your virtual private cloud (VPC).
If you specify subnets and Availability Zones with this call, ensure that the subnets' Availability Zones match the Availability Zones specified.
For more information, see Launching Auto Scaling Instances in a VPC in the Auto Scaling User Guide.
list
One or more termination policies used to select the instance to terminate. These policies are executed in the order that they are listed.
For more information, see Controlling Which Instances Auto Scaling Terminates During Scale In in the Auto Scaling User Guide.
(string) --
boolean
Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.
list
One or more tags.
For more information, see Tagging Auto Scaling Groups and Instances in the Auto Scaling User Guide.
(dict) --
Describes a tag for an Auto Scaling group.
ResourceId (string) --
The name of the group.
ResourceType (string) --
The type of resource. The only supported value is auto-scaling-group.
Key (string) -- [REQUIRED]
The tag key.
Value (string) --
The tag value.
PropagateAtLaunch (boolean) --
Determines whether the tag is added to new instances as they are launched in the group.
None
{'AutoScalingGroups': {'TargetGroupARNs': ['string']}}
Describes one or more Auto Scaling groups.
Request Syntax
client.describe_auto_scaling_groups(
AutoScalingGroupNames=[
'string',
],
NextToken='string',
MaxRecords=123
)
list
The group names. If you omit this parameter, all Auto Scaling groups are described.
(string) --
string
The token for the next set of items to return. (You received this token from a previous call.)
integer
The maximum number of items to return with this call.
dict
Response Syntax
{
'AutoScalingGroups': [
{
'AutoScalingGroupName': 'string',
'AutoScalingGroupARN': 'string',
'LaunchConfigurationName': 'string',
'MinSize': 123,
'MaxSize': 123,
'DesiredCapacity': 123,
'DefaultCooldown': 123,
'AvailabilityZones': [
'string',
],
'LoadBalancerNames': [
'string',
],
'TargetGroupARNs': [
'string',
],
'HealthCheckType': 'string',
'HealthCheckGracePeriod': 123,
'Instances': [
{
'InstanceId': 'string',
'AvailabilityZone': 'string',
'LifecycleState': 'Pending'|'Pending:Wait'|'Pending:Proceed'|'Quarantined'|'InService'|'Terminating'|'Terminating:Wait'|'Terminating:Proceed'|'Terminated'|'Detaching'|'Detached'|'EnteringStandby'|'Standby',
'HealthStatus': 'string',
'LaunchConfigurationName': 'string',
'ProtectedFromScaleIn': True|False
},
],
'CreatedTime': datetime(2015, 1, 1),
'SuspendedProcesses': [
{
'ProcessName': 'string',
'SuspensionReason': 'string'
},
],
'PlacementGroup': 'string',
'VPCZoneIdentifier': 'string',
'EnabledMetrics': [
{
'Metric': 'string',
'Granularity': 'string'
},
],
'Status': 'string',
'Tags': [
{
'ResourceId': 'string',
'ResourceType': 'string',
'Key': 'string',
'Value': 'string',
'PropagateAtLaunch': True|False
},
],
'TerminationPolicies': [
'string',
],
'NewInstancesProtectedFromScaleIn': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contains the output for DescribeAutoScalingGroups.
AutoScalingGroups (list) --
The groups.
(dict) --
Describes an Auto Scaling group.
AutoScalingGroupName (string) --
The name of the group.
AutoScalingGroupARN (string) --
The Amazon Resource Name (ARN) of the group.
LaunchConfigurationName (string) --
The name of the associated launch configuration.
MinSize (integer) --
The minimum size of the group.
MaxSize (integer) --
The maximum size of the group.
DesiredCapacity (integer) --
The desired size of the group.
DefaultCooldown (integer) --
The amount of time, in seconds, after a scaling activity completes before another scaling activity can start.
AvailabilityZones (list) --
One or more Availability Zones for the group.
(string) --
LoadBalancerNames (list) --
One or more load balancers associated with the group.
(string) --
TargetGroupARNs (list) --
The Amazon Resource Names (ARN) of the target groups for your load balancer.
(string) --
HealthCheckType (string) --
The service to use for the health checks. The valid values are EC2 and ELB.
HealthCheckGracePeriod (integer) --
The amount of time, in seconds, that Auto Scaling waits before checking the health status of an EC2 instance that has come into service.
Instances (list) --
The EC2 instances associated with the group.
(dict) --
Describes an EC2 instance.
InstanceId (string) --
The ID of the instance.
AvailabilityZone (string) --
The Availability Zone in which the instance is running.
LifecycleState (string) --
A description of the current lifecycle state. Note that the Quarantined state is not used.
HealthStatus (string) --
The last reported health status of the instance. "Healthy" means that the instance is healthy and should remain in service. "Unhealthy" means that the instance is unhealthy and Auto Scaling should terminate and replace it.
LaunchConfigurationName (string) --
The launch configuration associated with the instance.
ProtectedFromScaleIn (boolean) --
Indicates whether the instance is protected from termination by Auto Scaling when scaling in.
CreatedTime (datetime) --
The date and time the group was created.
SuspendedProcesses (list) --
The suspended processes associated with the group.
(dict) --
Describes an Auto Scaling process that has been suspended. For more information, see ProcessType.
ProcessName (string) --
The name of the suspended process.
SuspensionReason (string) --
The reason that the process was suspended.
PlacementGroup (string) --
The name of the placement group into which you'll launch your instances, if any. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.
VPCZoneIdentifier (string) --
One or more subnet IDs, if applicable, separated by commas.
If you specify VPCZoneIdentifier and AvailabilityZones, ensure that the Availability Zones of the subnets match the values for AvailabilityZones.
EnabledMetrics (list) --
The metrics enabled for the group.
(dict) --
Describes an enabled metric.
Metric (string) --
One of the following metrics:
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
Granularity (string) --
The granularity of the metric. The only valid value is 1Minute.
Status (string) --
The current state of the group when DeleteAutoScalingGroup is in progress.
Tags (list) --
The tags for the group.
(dict) --
Describes a tag for an Auto Scaling group.
ResourceId (string) --
The name of the group.
ResourceType (string) --
The type of resource. The only supported value is auto-scaling-group.
Key (string) --
The tag key.
Value (string) --
The tag value.
PropagateAtLaunch (boolean) --
Determines whether the tag is added to new instances as they are launched in the group.
TerminationPolicies (list) --
The termination policies for the group.
(string) --
NewInstancesProtectedFromScaleIn (boolean) --
Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.
NextToken (string) --
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.