2020/10/21 - AWS Global Accelerator - 4 updated api methods
Changes Update globalaccelerator client to latest version
{'PortOverrides': [{'EndpointPort': 'integer', 'ListenerPort': 'integer'}]}
Response {'EndpointGroup': {'PortOverrides': [{'EndpointPort': 'integer',
'ListenerPort': 'integer'}]}}
Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one AWS Region. A resource must be valid and active when you add it as an endpoint.
To see an AWS CLI example of creating an endpoint group, scroll down to Example.
See also: AWS API Documentation
Request Syntax
client.create_endpoint_group(
ListenerArn='string',
EndpointGroupRegion='string',
EndpointConfigurations=[
{
'EndpointId': 'string',
'Weight': 123,
'ClientIPPreservationEnabled': True|False
},
],
TrafficDialPercentage=...,
HealthCheckPort=123,
HealthCheckProtocol='TCP'|'HTTP'|'HTTPS',
HealthCheckPath='string',
HealthCheckIntervalSeconds=123,
ThresholdCount=123,
IdempotencyToken='string',
PortOverrides=[
{
'ListenerPort': 123,
'EndpointPort': 123
},
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the listener.
string
[REQUIRED]
The AWS Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region.
list
The list of endpoint objects.
(dict) --
A complex type for endpoints. A resource must be valid and active when you add it as an endpoint.
EndpointId (string) --
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.
An Application Load Balancer can be either internal or internet-facing.
Weight (integer) --
The weight associated with the endpoint. When you add weights to endpoints, you configure AWS 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 Endpoint Weights in the AWS Global Accelerator Developer Guide.
ClientIPPreservationEnabled (boolean) --
Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators.
If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.
For more information, see Preserve Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.
float
The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener.
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.
The default value is 100.
integer
The port that AWS 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.
string
The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.
string
If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).
integer
The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.
integer
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.
string
[REQUIRED]
A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.
This field is autopopulated if not provided.
list
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.
For more information, see Port overrides in the AWS Global Accelerator Developer Guide.
(dict) --
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.
For more information, see Port overrides in the AWS Global Accelerator Developer Guide.
ListenerPort (integer) --
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 (integer) --
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.
dict
Response Syntax
{
'EndpointGroup': {
'EndpointGroupArn': 'string',
'EndpointGroupRegion': 'string',
'EndpointDescriptions': [
{
'EndpointId': 'string',
'Weight': 123,
'HealthState': 'INITIAL'|'HEALTHY'|'UNHEALTHY',
'HealthReason': 'string',
'ClientIPPreservationEnabled': True|False
},
],
'TrafficDialPercentage': ...,
'HealthCheckPort': 123,
'HealthCheckProtocol': 'TCP'|'HTTP'|'HTTPS',
'HealthCheckPath': 'string',
'HealthCheckIntervalSeconds': 123,
'ThresholdCount': 123,
'PortOverrides': [
{
'ListenerPort': 123,
'EndpointPort': 123
},
]
}
}
Response Structure
(dict) --
EndpointGroup (dict) --
The information about the endpoint group that was created.
EndpointGroupArn (string) --
The Amazon Resource Name (ARN) of the endpoint group.
EndpointGroupRegion (string) --
The AWS Region where the endpoint group is located.
EndpointDescriptions (list) --
The list of endpoint objects.
(dict) --
A complex type for an endpoint. Each endpoint group can include one or more endpoints, such as load balancers.
EndpointId (string) --
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 EC2 instances, this is the EC2 instance ID.
An Application Load Balancer can be either internal or internet-facing.
Weight (integer) --
The weight associated with the endpoint. When you add weights to endpoints, you configure AWS 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 Endpoint Weights in the AWS Global Accelerator Developer Guide.
HealthState (string) --
The health status of the endpoint.
HealthReason (string) --
The reason code associated with why the endpoint is not healthy. If the endpoint state is healthy, a reason code is not provided.
If the endpoint state is unhealthy, the reason code can be one of the following values:
Timeout: The health check requests to the endpoint are timing out before returning a status.
Failed: The health check failed, for example because the endpoint response was invalid (malformed).
If the endpoint state is initial, the reason code can be one of the following values:
ProvisioningInProgress: The endpoint is in the process of being provisioned.
InitialHealthChecking: Global Accelerator is still setting up the minimum number of health checks for the endpoint that are required to determine its health status.
ClientIPPreservationEnabled (boolean) --
Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators.
If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.
For more information, see Viewing Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.
TrafficDialPercentage (float) --
The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener.
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.
The default value is 100.
HealthCheckPort (integer) --
The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
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.
HealthCheckProtocol (string) --
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 (string) --
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 (integer) --
The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.
ThresholdCount (integer) --
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 (list) --
Allows you to override the destination ports used to route traffic to an endpoint. Using a port override lets you to 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.
(dict) --
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.
For more information, see Port overrides in the AWS Global Accelerator Developer Guide.
ListenerPort (integer) --
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 (integer) --
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.
{'EndpointGroup': {'PortOverrides': [{'EndpointPort': 'integer',
'ListenerPort': 'integer'}]}}
Describe an endpoint group. To see an AWS CLI example of describing an endpoint group, scroll down to Example.
See also: AWS API Documentation
Request Syntax
client.describe_endpoint_group(
EndpointGroupArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the endpoint group to describe.
dict
Response Syntax
{
'EndpointGroup': {
'EndpointGroupArn': 'string',
'EndpointGroupRegion': 'string',
'EndpointDescriptions': [
{
'EndpointId': 'string',
'Weight': 123,
'HealthState': 'INITIAL'|'HEALTHY'|'UNHEALTHY',
'HealthReason': 'string',
'ClientIPPreservationEnabled': True|False
},
],
'TrafficDialPercentage': ...,
'HealthCheckPort': 123,
'HealthCheckProtocol': 'TCP'|'HTTP'|'HTTPS',
'HealthCheckPath': 'string',
'HealthCheckIntervalSeconds': 123,
'ThresholdCount': 123,
'PortOverrides': [
{
'ListenerPort': 123,
'EndpointPort': 123
},
]
}
}
Response Structure
(dict) --
EndpointGroup (dict) --
The description of an endpoint group.
EndpointGroupArn (string) --
The Amazon Resource Name (ARN) of the endpoint group.
EndpointGroupRegion (string) --
The AWS Region where the endpoint group is located.
EndpointDescriptions (list) --
The list of endpoint objects.
(dict) --
A complex type for an endpoint. Each endpoint group can include one or more endpoints, such as load balancers.
EndpointId (string) --
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 EC2 instances, this is the EC2 instance ID.
An Application Load Balancer can be either internal or internet-facing.
Weight (integer) --
The weight associated with the endpoint. When you add weights to endpoints, you configure AWS 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 Endpoint Weights in the AWS Global Accelerator Developer Guide.
HealthState (string) --
The health status of the endpoint.
HealthReason (string) --
The reason code associated with why the endpoint is not healthy. If the endpoint state is healthy, a reason code is not provided.
If the endpoint state is unhealthy, the reason code can be one of the following values:
Timeout: The health check requests to the endpoint are timing out before returning a status.
Failed: The health check failed, for example because the endpoint response was invalid (malformed).
If the endpoint state is initial, the reason code can be one of the following values:
ProvisioningInProgress: The endpoint is in the process of being provisioned.
InitialHealthChecking: Global Accelerator is still setting up the minimum number of health checks for the endpoint that are required to determine its health status.
ClientIPPreservationEnabled (boolean) --
Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators.
If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.
For more information, see Viewing Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.
TrafficDialPercentage (float) --
The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener.
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.
The default value is 100.
HealthCheckPort (integer) --
The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
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.
HealthCheckProtocol (string) --
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 (string) --
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 (integer) --
The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.
ThresholdCount (integer) --
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 (list) --
Allows you to override the destination ports used to route traffic to an endpoint. Using a port override lets you to 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.
(dict) --
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.
For more information, see Port overrides in the AWS Global Accelerator Developer Guide.
ListenerPort (integer) --
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 (integer) --
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.
{'EndpointGroups': {'PortOverrides': [{'EndpointPort': 'integer',
'ListenerPort': 'integer'}]}}
List the endpoint groups that are associated with a listener. To see an AWS CLI example of listing the endpoint groups for listener, scroll down to Example.
See also: AWS API Documentation
Request Syntax
client.list_endpoint_groups(
ListenerArn='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the listener.
integer
The number of endpoint group objects that you want to return with this call. The default value is 10.
string
The token for the next set of results. You receive this token from a previous call.
dict
Response Syntax
{
'EndpointGroups': [
{
'EndpointGroupArn': 'string',
'EndpointGroupRegion': 'string',
'EndpointDescriptions': [
{
'EndpointId': 'string',
'Weight': 123,
'HealthState': 'INITIAL'|'HEALTHY'|'UNHEALTHY',
'HealthReason': 'string',
'ClientIPPreservationEnabled': True|False
},
],
'TrafficDialPercentage': ...,
'HealthCheckPort': 123,
'HealthCheckProtocol': 'TCP'|'HTTP'|'HTTPS',
'HealthCheckPath': 'string',
'HealthCheckIntervalSeconds': 123,
'ThresholdCount': 123,
'PortOverrides': [
{
'ListenerPort': 123,
'EndpointPort': 123
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
EndpointGroups (list) --
The list of the endpoint groups associated with a listener.
(dict) --
A complex type for the endpoint group. An AWS Region can have only one endpoint group for a specific listener.
EndpointGroupArn (string) --
The Amazon Resource Name (ARN) of the endpoint group.
EndpointGroupRegion (string) --
The AWS Region where the endpoint group is located.
EndpointDescriptions (list) --
The list of endpoint objects.
(dict) --
A complex type for an endpoint. Each endpoint group can include one or more endpoints, such as load balancers.
EndpointId (string) --
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 EC2 instances, this is the EC2 instance ID.
An Application Load Balancer can be either internal or internet-facing.
Weight (integer) --
The weight associated with the endpoint. When you add weights to endpoints, you configure AWS 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 Endpoint Weights in the AWS Global Accelerator Developer Guide.
HealthState (string) --
The health status of the endpoint.
HealthReason (string) --
The reason code associated with why the endpoint is not healthy. If the endpoint state is healthy, a reason code is not provided.
If the endpoint state is unhealthy, the reason code can be one of the following values:
Timeout: The health check requests to the endpoint are timing out before returning a status.
Failed: The health check failed, for example because the endpoint response was invalid (malformed).
If the endpoint state is initial, the reason code can be one of the following values:
ProvisioningInProgress: The endpoint is in the process of being provisioned.
InitialHealthChecking: Global Accelerator is still setting up the minimum number of health checks for the endpoint that are required to determine its health status.
ClientIPPreservationEnabled (boolean) --
Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators.
If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.
For more information, see Viewing Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.
TrafficDialPercentage (float) --
The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener.
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.
The default value is 100.
HealthCheckPort (integer) --
The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
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.
HealthCheckProtocol (string) --
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 (string) --
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 (integer) --
The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.
ThresholdCount (integer) --
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 (list) --
Allows you to override the destination ports used to route traffic to an endpoint. Using a port override lets you to 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.
(dict) --
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.
For more information, see Port overrides in the AWS Global Accelerator Developer Guide.
ListenerPort (integer) --
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 (integer) --
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.
NextToken (string) --
The token for the next set of results. You receive this token from a previous call.
{'PortOverrides': [{'EndpointPort': 'integer', 'ListenerPort': 'integer'}]}
Response {'EndpointGroup': {'PortOverrides': [{'EndpointPort': 'integer',
'ListenerPort': 'integer'}]}}
Update an endpoint group. A resource must be valid and active when you add it as an endpoint.
To see an AWS CLI example of updating an endpoint group, scroll down to Example.
See also: AWS API Documentation
Request Syntax
client.update_endpoint_group(
EndpointGroupArn='string',
EndpointConfigurations=[
{
'EndpointId': 'string',
'Weight': 123,
'ClientIPPreservationEnabled': True|False
},
],
TrafficDialPercentage=...,
HealthCheckPort=123,
HealthCheckProtocol='TCP'|'HTTP'|'HTTPS',
HealthCheckPath='string',
HealthCheckIntervalSeconds=123,
ThresholdCount=123,
PortOverrides=[
{
'ListenerPort': 123,
'EndpointPort': 123
},
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the endpoint group.
list
The list of endpoint objects. A resource must be valid and active when you add it as an endpoint.
(dict) --
A complex type for endpoints. A resource must be valid and active when you add it as an endpoint.
EndpointId (string) --
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.
An Application Load Balancer can be either internal or internet-facing.
Weight (integer) --
The weight associated with the endpoint. When you add weights to endpoints, you configure AWS 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 Endpoint Weights in the AWS Global Accelerator Developer Guide.
ClientIPPreservationEnabled (boolean) --
Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators.
If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.
For more information, see Preserve Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.
float
The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener.
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.
The default value is 100.
integer
The port that AWS 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 the listener port is a list of ports, Global Accelerator uses the first port in the list.
string
The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.
string
If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).
integer
The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.
integer
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.
list
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.
For more information, see Port overrides in the AWS Global Accelerator Developer Guide.
(dict) --
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.
For more information, see Port overrides in the AWS Global Accelerator Developer Guide.
ListenerPort (integer) --
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 (integer) --
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.
dict
Response Syntax
{
'EndpointGroup': {
'EndpointGroupArn': 'string',
'EndpointGroupRegion': 'string',
'EndpointDescriptions': [
{
'EndpointId': 'string',
'Weight': 123,
'HealthState': 'INITIAL'|'HEALTHY'|'UNHEALTHY',
'HealthReason': 'string',
'ClientIPPreservationEnabled': True|False
},
],
'TrafficDialPercentage': ...,
'HealthCheckPort': 123,
'HealthCheckProtocol': 'TCP'|'HTTP'|'HTTPS',
'HealthCheckPath': 'string',
'HealthCheckIntervalSeconds': 123,
'ThresholdCount': 123,
'PortOverrides': [
{
'ListenerPort': 123,
'EndpointPort': 123
},
]
}
}
Response Structure
(dict) --
EndpointGroup (dict) --
The information about the endpoint group that was updated.
EndpointGroupArn (string) --
The Amazon Resource Name (ARN) of the endpoint group.
EndpointGroupRegion (string) --
The AWS Region where the endpoint group is located.
EndpointDescriptions (list) --
The list of endpoint objects.
(dict) --
A complex type for an endpoint. Each endpoint group can include one or more endpoints, such as load balancers.
EndpointId (string) --
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 EC2 instances, this is the EC2 instance ID.
An Application Load Balancer can be either internal or internet-facing.
Weight (integer) --
The weight associated with the endpoint. When you add weights to endpoints, you configure AWS 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 Endpoint Weights in the AWS Global Accelerator Developer Guide.
HealthState (string) --
The health status of the endpoint.
HealthReason (string) --
The reason code associated with why the endpoint is not healthy. If the endpoint state is healthy, a reason code is not provided.
If the endpoint state is unhealthy, the reason code can be one of the following values:
Timeout: The health check requests to the endpoint are timing out before returning a status.
Failed: The health check failed, for example because the endpoint response was invalid (malformed).
If the endpoint state is initial, the reason code can be one of the following values:
ProvisioningInProgress: The endpoint is in the process of being provisioned.
InitialHealthChecking: Global Accelerator is still setting up the minimum number of health checks for the endpoint that are required to determine its health status.
ClientIPPreservationEnabled (boolean) --
Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators.
If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.
For more information, see Viewing Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.
TrafficDialPercentage (float) --
The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener.
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.
The default value is 100.
HealthCheckPort (integer) --
The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
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.
HealthCheckProtocol (string) --
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 (string) --
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 (integer) --
The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.
ThresholdCount (integer) --
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 (list) --
Allows you to override the destination ports used to route traffic to an endpoint. Using a port override lets you to 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.
(dict) --
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.
For more information, see Port overrides in the AWS Global Accelerator Developer Guide.
ListenerPort (integer) --
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 (integer) --
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.