openapi: 3.0.0
info:
version: '2018-08-08'
x-release: v4
title: 'AWS Global Accelerator #X Amz Target=GlobalAccelerator V20180706.AddCustomRoutingEndpoints #X Amz Target=GlobalAccelerator V20180706.AddCustomRoutingEndpoints #X Amz Target=GlobalAccelerator V20180706.CreateEndpointGroup API'
description: '<fullname>Global Accelerator</fullname> <p>This is the <i>Global Accelerator API Reference</i>. This guide is for developers who need detailed information about Global Accelerator API actions, data types, and errors. For more information about Global Accelerator features, see the <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/what-is-global-accelerator.html">Global Accelerator Developer Guide</a>.</p> <p>Global Accelerator is a service in which you create <i>accelerators</i> to improve the performance of your applications for local and global users. Depending on the type of accelerator you choose, you can gain additional benefits. </p> <ul> <li> <p>By using a standard accelerator, you can improve availability of your internet applications that are used by a global audience. With a standard accelerator, Global Accelerator directs traffic to optimal endpoints over the Amazon Web Services global network. </p> </li> <li> <p>For other scenarios, you might choose a custom routing accelerator. With a custom routing accelerator, you can use application logic to directly map one or more users to a specific endpoint among many endpoints.</p> </li> </ul> <important> <p>Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify <code>--region us-west-2</code> on AWS CLI commands.</p> </important> <p>By default, Global Accelerator provides you with static IP addresses that you associate with your accelerator. The static IP addresses are anycast from the Amazon Web Services edge network. For IPv4, Global Accelerator provides two static IPv4 addresses. For dual-stack, Global Accelerator provides a total of four addresses: two static IPv4 addresses and two static IPv6 addresses. With a standard accelerator for IPv4, instead of using the addresses that Global Accelerator provides, you can configure these entry points to be IPv4 addresses from your own IP address ranges that you bring toGlobal Accelerator (BYOIP). </p> <p>For a standard accelerator, they distribute incoming application traffic across multiple endpoint resources in multiple Amazon Web Services Regions , which increases the availability of your applications. Endpoints for standard accelerators can be Network Load Balancers, Application Load Balancers, Amazon EC2 instances, or Elastic IP addresses that are located in one Amazon Web Services Region or multiple Amazon Web Services Regions. For custom routing accelerators, you map traffic that arrives to the static IP addresses to specific Amazon EC2 servers in endpoints that are virtual private cloud (VPC) subnets.</p> <important> <p>The static IP addresses remain assigned to your accelerator for as long as it exists, even if you disable the accelerator and it no longer accepts or routes traffic. However, when you <i>delete</i> an accelerator, you lose the static IP addresses that are assigned to it, so you can no longer route traffic by using them. You can use IAM policies like tag-based permissions with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/access-control-manage-access-tag-policies.html">Tag-based policies</a>.</p> </important> <p>For standard accelerators, Global Accelerator uses the Amazon Web Services global network to route traffic to the optimal regional endpoint based on health, client location, and policies that you configure. The service reacts instantly to changes in health or configuration to ensure that internet traffic from clients is always directed to healthy endpoints.</p> <p>For more information about understanding and using Global Accelerator, see the <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/what-is-global-accelerator.html">Global Accelerator Developer Guide</a>.</p>'
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: globalaccelerator
x-aws-signingName: globalaccelerator
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/globalaccelerator-2018-08-08.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://globalaccelerator.{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 AWS Global Accelerator multi-region endpoint
- url: https://globalaccelerator.{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 AWS Global Accelerator multi-region endpoint
- url: http://globalaccelerator.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The AWS Global Accelerator endpoint for China (Beijing) and China (Ningxia)
- url: https://globalaccelerator.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The AWS Global Accelerator endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=GlobalAccelerator V20180706.CreateEndpointGroup'
paths:
/#X-Amz-Target=GlobalAccelerator_V20180706.CreateEndpointGroup:
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'
post:
operationId: CreateEndpointGroup
description: Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one Amazon Web Services Region. A resource must be valid and active when you add it as an endpoint.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateEndpointGroupResponse'
examples:
CreateEndpointGroup200Example:
summary: Default CreateEndpointGroup 200 response
x-microcks-default: true
value:
acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
status: DEPLOYED
'480':
description: AcceleratorNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/AcceleratorNotFoundException'
examples:
CreateEndpointGroup480Example:
summary: Default CreateEndpointGroup 480 response
x-microcks-default: true
value:
acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
status: DEPLOYED
'481':
description: EndpointGroupAlreadyExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/EndpointGroupAlreadyExistsException'
examples:
CreateEndpointGroup481Example:
summary: Default CreateEndpointGroup 481 response
x-microcks-default: true
value:
acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
status: DEPLOYED
'482':
description: ListenerNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ListenerNotFoundException'
examples:
CreateEndpointGroup482Example:
summary: Default CreateEndpointGroup 482 response
x-microcks-default: true
value:
acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
status: DEPLOYED
'483':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
examples:
CreateEndpointGroup483Example:
summary: Default CreateEndpointGroup 483 response
x-microcks-default: true
value:
acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
status: DEPLOYED
'484':
description: InvalidArgumentException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidArgumentException'
examples:
CreateEndpointGroup484Example:
summary: Default CreateEndpointGroup 484 response
x-microcks-default: true
value:
acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
status: DEPLOYED
'485':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
examples:
CreateEndpointGroup485Example:
summary: Default CreateEndpointGroup 485 response
x-microcks-default: true
value:
acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
status: DEPLOYED
'486':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
CreateEndpointGroup486Example:
summary: Default CreateEndpointGroup 486 response
x-microcks-default: true
value:
acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
status: DEPLOYED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateEndpointGroupRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- GlobalAccelerator_V20180706.CreateEndpointGroup
summary: Amazon Global Accelerator Create Endpoint Group
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#X Amz Target=GlobalAccelerator V20180706.CreateEndpointGroup'
components:
schemas:
InvalidArgumentException: {}
HealthCheckPath:
type: string
pattern: ^/[-a-zA-Z0-9@:%_\\+.~#?&/=]*$
maxLength: 255
AccessDeniedException: {}
CreateEndpointGroupRequest:
type: object
required:
- ListenerArn
- EndpointGroupRegion
- IdempotencyToken
title: CreateEndpointGroupRequest
properties:
ListenerArn:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The Amazon Resource Name (ARN) of the listener.
EndpointGroupRegion:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The Amazon Web Services Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region.
EndpointConfigurations:
allOf:
- $ref: '#/components/schemas/EndpointConfigurations'
- description: The list of endpoint objects.
TrafficDialPercentage:
allOf:
- $ref: '#/components/schemas/TrafficDialPercentage'
- description: <p>The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for this listener. </p> <p>Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.</p> <p>The default value is 100.</p>
HealthCheckPort:
allOf:
- $ref: '#/components/schemas/HealthCheckPort'
- description: The port that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the first port in the list.
HealthCheckProtocol:
allOf:
- $ref: '#/components/schemas/HealthCheckProtocol'
- description: The protocol that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.
HealthCheckPath:
allOf:
- $ref: '#/components/schemas/HealthCheckPath'
- description: If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).
HealthCheckIntervalSeconds:
allOf:
- $ref: '#/components/schemas/HealthCheckIntervalSeconds'
- description: The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.
ThresholdCount:
allOf:
- $ref: '#/components/schemas/ThresholdCount'
- description: The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.
IdempotencyToken:
allOf:
- $ref: '#/components/schemas/IdempotencyToken'
- description: A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.
PortOverrides:
allOf:
- $ref: '#/components/schemas/PortOverrides'
- description: <p>Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoint-groups-port-override.html"> Overriding listener ports</a> in the <i>Global Accelerator Developer Guide</i>.</p>
EndpointGroup:
type: object
properties:
EndpointGroupArn:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The Amazon Resource Name (ARN) of the endpoint group.
EndpointGroupRegion:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The Amazon Web Services Region where the endpoint group is located.
EndpointDescriptions:
allOf:
- $ref: '#/components/schemas/EndpointDescriptions'
- description: The list of endpoint objects.
TrafficDialPercentage:
allOf:
- $ref: '#/components/schemas/TrafficDialPercentage'
- description: <p>The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for this listener. </p> <p>Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.</p> <p>The default value is 100.</p>
HealthCheckPort:
allOf:
- $ref: '#/components/schemas/HealthCheckPort'
- description: <p>The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. </p> <p>The default port is the port for the listener that this endpoint group is associated with. If the listener port is a list, Global Accelerator uses the first specified port in the list of ports.</p>
HealthCheckProtocol:
allOf:
- $ref: '#/components/schemas/HealthCheckProtocol'
- description: The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default value is TCP.
HealthCheckPath:
allOf:
- $ref: '#/components/schemas/HealthCheckPath'
- description: If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks. The default is slash (/).
HealthCheckIntervalSeconds:
allOf:
- $ref: '#/components/schemas/HealthCheckIntervalSeconds'
- description: The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.
ThresholdCount:
allOf:
- $ref: '#/components/schemas/ThresholdCount'
- description: The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.
PortOverrides:
allOf:
- $ref: '#/components/schemas/PortOverrides'
- description: 'Allows you to override the destination ports used to route traffic to an endpoint. Using a port override lets you map a list of external destination ports (that your users send traffic to) to a list of internal destination ports that you want an application endpoint to receive traffic on. '
description: 'A complex type for the endpoint group. An Amazon Web Services Region can have only one endpoint group for a specific listener. '
HealthCheckIntervalSeconds:
type: integer
minimum: 10
maximum: 30
EndpointDescription:
type: object
properties:
EndpointId:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: <p>An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. For Amazon EC2 instances, this is the EC2 instance ID. </p> <p>An Application Load Balancer can be either internal or internet-facing.</p>
Weight:
allOf:
- $ref: '#/components/schemas/EndpointWeight'
- description: 'The weight associated with the endpoint. When you add weights to endpoints, you configure Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoints-endpoint-weights.html">Endpoint weights</a> in the <i>Global Accelerator Developer Guide</i>. '
HealthState:
allOf:
- $ref: '#/components/schemas/HealthState'
- description: The health status of the endpoint.
HealthReason:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: Returns a null result.
ClientIPPreservationEnabled:
allOf:
- $ref: '#/components/schemas/GenericBoolean'
- description: <p>Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false. The default value is true for new accelerators. </p> <p>If the value is set to true, the client's IP address is preserved in the <code>X-Forwarded-For</code> request header as traffic travels to applications on the endpoint fronted by the accelerator.</p> <p>Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load Balancers and Amazon EC2 instances.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/preserve-client-ip-address.html"> Preserve client IP addresses in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p>
description: A complex type for an endpoint. Each endpoint group can include one or more endpoints, such as load balancers.
EndpointGroupAlreadyExistsException: {}
ThresholdCount:
type: integer
minimum: 1
maximum: 10
HealthCheckPort:
type: integer
minimum: 1
maximum: 65535
LimitExceededException: {}
TrafficDialPercentage:
type: number
format: float
minimum: 0
maximum: 100
EndpointDescriptions:
type: array
items:
$ref: '#/components/schemas/EndpointDescription'
EndpointWeight:
type: integer
minimum: 0
maximum: 255
IdempotencyToken:
type: string
maxLength: 255
GenericString:
type: string
maxLength: 255
ListenerNotFoundException: {}
HealthCheckProtocol:
type: string
enum:
- TCP
- HTTP
- HTTPS
AcceleratorNotFoundException: {}
PortOverrides:
type: array
items:
$ref: '#/components/schemas/PortOverride'
minItems: 0
maxItems: 10
PortOverride:
type: object
properties:
ListenerPort:
allOf:
- $ref: '#/components/schemas/PortNumber'
- description: The listener port that you want to map to a specific endpoint port. This is the port that user traffic arrives to the Global Accelerator on.
EndpointPort:
allOf:
- $ref: '#/components/schemas/PortNumber'
- description: The endpoint port that you want a listener port to be mapped to. This is the port on the endpoint, such as the Application Load Balancer or Amazon EC2 instance.
description: <p>Override specific listener ports used to route traffic to endpoints that are part of an endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoint-groups-port-override.html"> Overriding listener ports</a> in the <i>Global Accelerator Developer Guide</i>.</p>
HealthState:
type: string
enum:
- INITIAL
- HEALTHY
- UNHEALTHY
CreateEndpointGroupResponse:
type: object
properties:
EndpointGroup:
allOf:
- $ref: '#/components/schemas/EndpointGroup'
- description: The information about the endpoint group that was created.
EndpointConfigurations:
type: array
items:
$ref: '#/components/schemas/EndpointConfiguration'
minItems: 0
maxItems: 10
EndpointConfiguration:
type: object
properties:
EndpointId:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: <p>An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. For Amazon EC2 instances, this is the EC2 instance ID. A resource must be valid and active when you add it as an endpoint.</p> <p>An Application Load Balancer can be either internal or internet-facing.</p>
Weight:
allOf:
- $ref: '#/components/schemas/EndpointWeight'
- description: The weight associated with the endpoint. When you add weights to endpoints, you configure Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoints-endpoint-weights.html">Endpoint weights</a> in the <i>Global Accelerator Developer Guide</i>.
ClientIPPreservationEnabled:
allOf:
- $ref: '#/components/schemas/GenericBoolean'
- description: <p>Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false. The default value is true for new accelerators. </p> <p>If the value is set to true, the client's IP address is preserved in the <code>X-Forwarded-For</code> request header as traffic travels to applications on the endpoint fronted by the accelerator.</p> <p>Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load Balancers and Amazon EC2 instances.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/preserve-client-ip-address.html"> Preserve client IP addresses in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p>
description: A complex type for endpoints. A resource must be valid and active when you add it as an endpoint.
GenericBoolean:
type: boolean
InternalServiceErrorException: {}
PortNumber:
type: integer
minimum: 1
maximum: 65535
parameters:
X-Amz-Signature:
name: X-Amz-Signature
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-Algorithm:
name: X-Amz-Algorithm
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-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
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/globalaccelerator/
x-hasEquivalentPaths: true