openapi: 3.0.0
info:
version: 2011-01-01
x-release: v4
title: 'Auto Scaling #Action=AttachInstances #Action=AttachInstances #Action=AttachTrafficSources API'
description:
Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances based on user-defined scaling policies, scheduled actions, and health checks.
For more information, see the Amazon EC2 Auto Scaling User Guide and the Amazon EC2 Auto Scaling API Reference.
x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: autoscaling x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/autoscaling-2011-01-01.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://autoscaling.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Auto Scaling multi-region endpoint - url: https://autoscaling.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Auto Scaling multi-region endpoint - url: http://autoscaling.amazonaws.com variables: {} description: The general Auto Scaling endpoint for US East (N. Virginia) - url: https://autoscaling.amazonaws.com variables: {} description: The general Auto Scaling endpoint for US East (N. Virginia) - url: http://autoscaling.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Auto Scaling endpoint for China (Beijing) and China (Ningxia) - url: https://autoscaling.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Auto Scaling endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: '#Action=AttachTrafficSources' paths: /#Action=AttachTrafficSources: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: x-aws-operation-name: AttachTrafficSources operationId: GET_AttachTrafficSources description:Attaches one or more traffic sources to the specified Auto Scaling group.
You can use any of the following as traffic sources for an Auto Scaling group:
Application Load Balancer
Classic Load Balancer
Gateway Load Balancer
Network Load Balancer
VPC Lattice
This operation is additive and does not detach existing traffic sources from the Auto Scaling group.
After the operation completes, use the DescribeTrafficSources API to return details about the state of the attachments between traffic sources and your Auto Scaling group. To detach a traffic source from the Auto Scaling group, call the DetachTrafficSources API.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AttachTrafficSourcesResultType' examples: GET_AttachTrafficSources200Example: summary: Default GET_AttachTrafficSources 200 response x-microcks-default: true value: {} '480': description: ResourceContentionFault content: text/xml: schema: $ref: '#/components/schemas/ResourceContentionFault' examples: GET_AttachTrafficSources480Example: summary: Default GET_AttachTrafficSources 480 response x-microcks-default: true value: {} '481': description: ServiceLinkedRoleFailure content: text/xml: schema: $ref: '#/components/schemas/ServiceLinkedRoleFailure' examples: GET_AttachTrafficSources481Example: summary: Default GET_AttachTrafficSources 481 response x-microcks-default: true value: {} parameters: - name: AutoScalingGroupName in: query required: true description: The name of the Auto Scaling group. schema: type: string minLength: 1 maxLength: 255 x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*' - name: TrafficSources in: query required: true description: The unique identifiers of one or more traffic sources. You can specify up to 10 traffic sources. schema: type: array items: $ref: '#/components/schemas/TrafficSourceIdentifier' - name: Action in: query required: true schema: type: string enum: - AttachTrafficSources - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling GET_ Attach Traffic Sources x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - '#Action=AttachTrafficSources' post: x-aws-operation-name: AttachTrafficSources operationId: POST_AttachTrafficSources description:Attaches one or more traffic sources to the specified Auto Scaling group.
You can use any of the following as traffic sources for an Auto Scaling group:
Application Load Balancer
Classic Load Balancer
Gateway Load Balancer
Network Load Balancer
VPC Lattice
This operation is additive and does not detach existing traffic sources from the Auto Scaling group.
After the operation completes, use the DescribeTrafficSources API to return details about the state of the attachments between traffic sources and your Auto Scaling group. To detach a traffic source from the Auto Scaling group, call the DetachTrafficSources API.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AttachTrafficSourcesResultType' examples: POST_AttachTrafficSources200Example: summary: Default POST_AttachTrafficSources 200 response x-microcks-default: true value: {} '480': description: ResourceContentionFault content: text/xml: schema: $ref: '#/components/schemas/ResourceContentionFault' examples: POST_AttachTrafficSources480Example: summary: Default POST_AttachTrafficSources 480 response x-microcks-default: true value: {} '481': description: ServiceLinkedRoleFailure content: text/xml: schema: $ref: '#/components/schemas/ServiceLinkedRoleFailure' examples: POST_AttachTrafficSources481Example: summary: Default POST_AttachTrafficSources 481 response x-microcks-default: true value: {} requestBody: content: text/xml: schema: $ref: '#/components/schemas/AttachTrafficSourcesType' parameters: - name: Action in: query required: true schema: type: string enum: - AttachTrafficSources - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Attach Traffic Sources x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - '#Action=AttachTrafficSources' components: parameters: X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false schemas: XmlStringMaxLen255: type: string minLength: 1 maxLength: 255 x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*' ServiceLinkedRoleFailure: {} XmlStringMaxLen511: type: string minLength: 1 maxLength: 511 x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*' TrafficSourceIdentifier: type: object required: - Identifier properties: Identifier: allOf: - $ref: '#/components/schemas/XmlStringMaxLen511' - description: 'Identifies the traffic source.
For Application Load Balancers, Gateway Load Balancers, Network Load Balancers, and VPC Lattice, this will be the Amazon Resource Name (ARN) for a target group in this account and Region. For Classic Load Balancers, this will be the name of the Classic Load Balancer in this account and Region.
For example:
Application Load Balancer ARN: arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/1234567890123456
Classic Load Balancer name: my-classic-load-balancer
VPC Lattice ARN: arn:aws:vpc-lattice:us-west-2:123456789012:targetgroup/tg-1234567890123456
To get the ARN of a target group for a Application Load Balancer, Gateway Load Balancer, or Network Load Balancer, or the name of a Classic Load Balancer, use the Elastic Load Balancing DescribeTargetGroups and DescribeLoadBalancers API operations.
To get the ARN of a target group for VPC Lattice, use the VPC Lattice GetTargetGroup API operation.
' example: example-id-1234 Type: allOf: - $ref: '#/components/schemas/XmlStringMaxLen511' - description:Provides additional context for the value of Identifier.
The following lists the valid values:
elb if Identifier is the name of a Classic Load Balancer.
elbv2 if Identifier is the ARN of an Application Load Balancer, Gateway Load Balancer, or Network Load Balancer target group.
vpc-lattice if Identifier is the ARN of a VPC Lattice target group.
Required if the identifier is the name of a Classic Load Balancer.
example: example-string description: Identifying information for a traffic source. TrafficSources: type: array items: $ref: '#/components/schemas/TrafficSourceIdentifier' ResourceContentionFault: {} AttachTrafficSourcesType: type: object required: - AutoScalingGroupName - TrafficSources title: AttachTrafficSourcesType properties: AutoScalingGroupName: allOf: - $ref: '#/components/schemas/XmlStringMaxLen255' - description: The name of the Auto Scaling group. TrafficSources: allOf: - $ref: '#/components/schemas/TrafficSources' - description: The unique identifiers of one or more traffic sources. You can specify up to 10 traffic sources. AttachTrafficSourcesResultType: type: object example: {} properties: {} securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/autoscaling/ x-hasEquivalentPaths: true