2023/11/01 - AWS Global Accelerator - 7 new4 updated api methods
Changes Global Accelerator now support accelerators with cross account endpoints.
List the accounts that have cross-account endpoints.
See also: AWS API Documentation
Request Syntax
client.list_cross_account_resource_accounts()
dict
Response Syntax
{
'ResourceOwnerAwsAccountIds': [
'string',
]
}
Response Structure
(dict) --
ResourceOwnerAwsAccountIds (list) --
The account IDs of principals (resource owners) in a cross-account attachment who can add endpoints (resources) listed in the same attachment.
(string) --
List the cross-account attachments that have been created in Global Accelerator.
See also: AWS API Documentation
Request Syntax
client.list_cross_account_attachments(
MaxResults=123,
NextToken='string'
)
integer
The number of cross-account attachment 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
{
'CrossAccountAttachments': [
{
'AttachmentArn': 'string',
'Name': 'string',
'Principals': [
'string',
],
'Resources': [
{
'EndpointId': 'string',
'Region': 'string'
},
],
'LastModifiedTime': datetime(2015, 1, 1),
'CreatedTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
CrossAccountAttachments (list) --
Information about the cross-account attachments.
(dict) --
A cross-account attachment in Global Accelerator. A cross-account attachment specifies the principals who have permission to add to accelerators in their own account the resources in your account that you also list in the attachment.
AttachmentArn (string) --
The Amazon Resource Name (ARN) of the cross-account attachment.
Name (string) --
The name of the cross-account attachment.
Principals (list) --
The principals included in the cross-account attachment.
(string) --
Resources (list) --
The resources included in the cross-account attachment.
(dict) --
An Amazon Web Services resource that is supported by Global Accelerator and can be added as an endpoint for an accelerator.
EndpointId (string) --
The endpoint ID for the endpoint (Amazon Web Services resource).
Region (string) --
The Amazon Web Services Region where a resource is located.
LastModifiedTime (datetime) --
The date and time that the cross-account attachment was last modified.
CreatedTime (datetime) --
The date and time that the cross-account attachment was created.
NextToken (string) --
The token for the next set of results. You receive this token from a previous call.
Delete a cross-account attachment. When you delete an attachment, Global Accelerator revokes the permission to use the resources in the attachment from all principals in the list of principals. Global Accelerator revokes the permission for specific resources by doing the following:
If the principal is an account ID, Global Accelerator reviews every accelerator in the account and removes cross-account endpoints from all accelerators.
If the principal is an accelerator, Global Accelerator reviews just that accelerator and removes cross-account endpoints from it.
If there are overlapping permissions provided by multiple cross-account attachments, Global Accelerator only removes endpoints if there are no current cross-account attachments that provide access permission. For example, if you delete a cross-account attachment that lists an accelerator as a principal, but another cross-account attachment includes the account ID that owns that accelerator, endpoints will not be removed from the accelerator.
See also: AWS API Documentation
Request Syntax
client.delete_cross_account_attachment(
AttachmentArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) for the cross-account attachment to delete.
None
Update a cross-account attachment to add or remove principals or resources. When you update an attachment to remove a principal (account ID or accelerator) or a resource, Global Accelerator revokes the permission for specific resources by doing the following:
If the principal is an account ID, Global Accelerator reviews every accelerator in the account and removes cross-account endpoints from all accelerators.
If the principal is an accelerator, Global Accelerator reviews just that accelerator and removes cross-account endpoints from it.
If there are overlapping permissions provided by multiple cross-account attachments, Global Accelerator only removes endpoints if there are no current cross-account attachments that provide access permission. For example, if you delete a cross-account attachment that lists an accelerator as a principal, but another cross-account attachment includes the account ID that owns that accelerator, endpoints will not be removed from the accelerator.
See also: AWS API Documentation
Request Syntax
client.update_cross_account_attachment(
AttachmentArn='string',
Name='string',
AddPrincipals=[
'string',
],
RemovePrincipals=[
'string',
],
AddResources=[
{
'EndpointId': 'string',
'Region': 'string'
},
],
RemoveResources=[
{
'EndpointId': 'string',
'Region': 'string'
},
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the cross-account attachment to update.
string
The name of the cross-account attachment.
list
The principals to add to the cross-account attachment. A principal is an account or the Amazon Resource Name (ARN) of an accelerator that the attachment gives permission to add the resources from another account, listed in the attachment.
To add more than one principal, separate the account numbers or accelerator ARNs, or both, with commas.
(string) --
list
The principals to remove from the cross-account attachment. A principal is an account or the Amazon Resource Name (ARN) of an accelerator that is given permission to add the resources from another account, listed in the cross-account attachment.
To remove more than one principal, separate the account numbers or accelerator ARNs, or both, with commas.
(string) --
list
The resources to add to the cross-account attachment. A resource listed in a cross-account attachment can be added to an accelerator by the principals that are listed in the attachment.
To add more than one resource, separate the resource ARNs with commas.
(dict) --
An Amazon Web Services resource that is supported by Global Accelerator and can be added as an endpoint for an accelerator.
EndpointId (string) -- [REQUIRED]
The endpoint ID for the endpoint (Amazon Web Services resource).
Region (string) --
The Amazon Web Services Region where a resource is located.
list
The resources to remove from the cross-account attachment. A resource listed in a cross-account attachment can be added to an accelerator fy principals that are listed in the cross-account attachment.
To remove more than one resource, separate the resource ARNs with commas.
(dict) --
An Amazon Web Services resource that is supported by Global Accelerator and can be added as an endpoint for an accelerator.
EndpointId (string) -- [REQUIRED]
The endpoint ID for the endpoint (Amazon Web Services resource).
Region (string) --
The Amazon Web Services Region where a resource is located.
dict
Response Syntax
{
'CrossAccountAttachment': {
'AttachmentArn': 'string',
'Name': 'string',
'Principals': [
'string',
],
'Resources': [
{
'EndpointId': 'string',
'Region': 'string'
},
],
'LastModifiedTime': datetime(2015, 1, 1),
'CreatedTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
CrossAccountAttachment (dict) --
Information about the updated cross-account attachment.
AttachmentArn (string) --
The Amazon Resource Name (ARN) of the cross-account attachment.
Name (string) --
The name of the cross-account attachment.
Principals (list) --
The principals included in the cross-account attachment.
(string) --
Resources (list) --
The resources included in the cross-account attachment.
(dict) --
An Amazon Web Services resource that is supported by Global Accelerator and can be added as an endpoint for an accelerator.
EndpointId (string) --
The endpoint ID for the endpoint (Amazon Web Services resource).
Region (string) --
The Amazon Web Services Region where a resource is located.
LastModifiedTime (datetime) --
The date and time that the cross-account attachment was last modified.
CreatedTime (datetime) --
The date and time that the cross-account attachment was created.
Gets configuration information about a cross-account attachment.
See also: AWS API Documentation
Request Syntax
client.describe_cross_account_attachment(
AttachmentArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) for the cross-account attachment to describe.
dict
Response Syntax
{
'CrossAccountAttachment': {
'AttachmentArn': 'string',
'Name': 'string',
'Principals': [
'string',
],
'Resources': [
{
'EndpointId': 'string',
'Region': 'string'
},
],
'LastModifiedTime': datetime(2015, 1, 1),
'CreatedTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
CrossAccountAttachment (dict) --
Information about the cross-account attachment.
AttachmentArn (string) --
The Amazon Resource Name (ARN) of the cross-account attachment.
Name (string) --
The name of the cross-account attachment.
Principals (list) --
The principals included in the cross-account attachment.
(string) --
Resources (list) --
The resources included in the cross-account attachment.
(dict) --
An Amazon Web Services resource that is supported by Global Accelerator and can be added as an endpoint for an accelerator.
EndpointId (string) --
The endpoint ID for the endpoint (Amazon Web Services resource).
Region (string) --
The Amazon Web Services Region where a resource is located.
LastModifiedTime (datetime) --
The date and time that the cross-account attachment was last modified.
CreatedTime (datetime) --
The date and time that the cross-account attachment was created.
List the cross-account endpoints available to add to an accelerator.
See also: AWS API Documentation
Request Syntax
client.list_cross_account_resources(
AcceleratorArn='string',
ResourceOwnerAwsAccountId='string',
MaxResults=123,
NextToken='string'
)
string
The Amazon Resource Name (ARN) of an accelerator in a cross-account attachment.
string
[REQUIRED]
The account ID of a resource owner in a cross-account attachment.
integer
The number of cross-account endpoints 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
{
'CrossAccountResources': [
{
'EndpointId': 'string',
'AttachmentArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
CrossAccountResources (list) --
The endpoints attached to an accelerator in a cross-account attachment.
(dict) --
An endpoint (Amazon Web Services resource) that is listed in a cross-account attachment and can be added to an accelerator by specified principals, that are also listed in the attachment.
EndpointId (string) --
The endpoint ID for the endpoint that is listed in a cross-account attachment and can be added to an accelerator by specified principals.
AttachmentArn (string) --
The Amazon Resource Name (ARN) of the cross-account attachment that specifies the endpoints (resources) that can be added to accelerators and principals that have permission to add the endpoints to accelerators.
NextToken (string) --
The token for the next set of results. You receive this token from a previous call.
Create a cross-account attachment in Global Accelerator. You create a cross-account attachment to specify the principals who have permission to add to accelerators in their own account the resources in your account that you also list in the attachment.
A principal can be an Amazon Web Services account number or the Amazon Resource Name (ARN) for an accelerator. For account numbers that are listed as principals, to add a resource listed in the attachment to an accelerator, you must sign in to an account specified as a principal. Then you can add the resources that are listed to any of your accelerators. If an accelerator ARN is listed in the cross-account attachment as a principal, anyone with permission to make updates to the accelerator can add as endpoints resources that are listed in the attachment.
See also: AWS API Documentation
Request Syntax
client.create_cross_account_attachment(
Name='string',
Principals=[
'string',
],
Resources=[
{
'EndpointId': 'string',
'Region': 'string'
},
],
IdempotencyToken='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The name of the cross-account attachment.
list
The principals to list in the cross-account attachment. A principal can be an Amazon Web Services account number or the Amazon Resource Name (ARN) for an accelerator.
(string) --
list
The Amazon Resource Names (ARNs) for the resources to list in the cross-account attachment. A resource can be any supported Amazon Web Services resource type for Global Accelerator.
(dict) --
An Amazon Web Services resource that is supported by Global Accelerator and can be added as an endpoint for an accelerator.
EndpointId (string) -- [REQUIRED]
The endpoint ID for the endpoint (Amazon Web Services resource).
Region (string) --
The Amazon Web Services Region where a resource is located.
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
Create tags for cross-account attachment.
For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.
(dict) --
A complex type that contains a Tag key and Tag value.
Key (string) -- [REQUIRED]
A string that contains a Tag key.
Value (string) -- [REQUIRED]
A string that contains a Tag value.
dict
Response Syntax
{
'CrossAccountAttachment': {
'AttachmentArn': 'string',
'Name': 'string',
'Principals': [
'string',
],
'Resources': [
{
'EndpointId': 'string',
'Region': 'string'
},
],
'LastModifiedTime': datetime(2015, 1, 1),
'CreatedTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
CrossAccountAttachment (dict) --
Information about the cross-account attachment.
AttachmentArn (string) --
The Amazon Resource Name (ARN) of the cross-account attachment.
Name (string) --
The name of the cross-account attachment.
Principals (list) --
The principals included in the cross-account attachment.
(string) --
Resources (list) --
The resources included in the cross-account attachment.
(dict) --
An Amazon Web Services resource that is supported by Global Accelerator and can be added as an endpoint for an accelerator.
EndpointId (string) --
The endpoint ID for the endpoint (Amazon Web Services resource).
Region (string) --
The Amazon Web Services Region where a resource is located.
LastModifiedTime (datetime) --
The date and time that the cross-account attachment was last modified.
CreatedTime (datetime) --
The date and time that the cross-account attachment was created.
{'EndpointConfigurations': {'AttachmentArn': 'string'}}
Associate a virtual private cloud (VPC) subnet endpoint with your custom routing accelerator.
The listener port range must be large enough to support the number of IP addresses that can be specified in your subnet. The number of ports required is: subnet size times the number of ports per destination EC2 instances. For example, a subnet defined as /24 requires a listener port range of at least 255 ports.
Note: You must have enough remaining listener ports available to map to the subnet ports, or the call will fail with a LimitExceededException.
By default, all destinations in a subnet in a custom routing accelerator cannot receive traffic. To enable all destinations to receive traffic, or to specify individual port mappings that can receive traffic, see the AllowCustomRoutingTraffic operation.
See also: AWS API Documentation
Request Syntax
client.add_custom_routing_endpoints(
EndpointConfigurations=[
{
'EndpointId': 'string',
'AttachmentArn': 'string'
},
],
EndpointGroupArn='string'
)
list
[REQUIRED]
The list of endpoint objects to add to a custom routing accelerator.
(dict) --
The list of endpoint objects. For custom routing, this is a list of virtual private cloud (VPC) subnet IDs.
EndpointId (string) --
An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.
AttachmentArn (string) --
The Amazon Resource Name (ARN) of the cross-account attachment that specifies the endpoints (resources) that can be added to accelerators and principals that have permission to add the endpoints to accelerators.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the endpoint group for the custom routing endpoint.
dict
Response Syntax
{
'EndpointDescriptions': [
{
'EndpointId': 'string'
},
],
'EndpointGroupArn': 'string'
}
Response Structure
(dict) --
EndpointDescriptions (list) --
The endpoint objects added to the custom routing accelerator.
(dict) --
A complex type for an endpoint for a custom routing accelerator. Each endpoint group can include one or more endpoints, which are virtual private cloud (VPC) subnets.
EndpointId (string) --
An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.
EndpointGroupArn (string) --
The Amazon Resource Name (ARN) of the endpoint group for the custom routing endpoint.
{'EndpointConfigurations': {'AttachmentArn': 'string'}}
Add endpoints to an endpoint group. The AddEndpoints API operation is the recommended option for adding endpoints. The alternative options are to add endpoints when you create an endpoint group (with the CreateEndpointGroup API) or when you update an endpoint group (with the UpdateEndpointGroup API).
There are two advantages to using AddEndpoints to add endpoints in Global Accelerator:
It's faster, because Global Accelerator only has to resolve the new endpoints that you're adding, rather than resolving new and existing endpoints.
It's more convenient, because you don't need to specify the current endpoints that are already in the endpoint group, in addition to the new endpoints that you want to add.
For information about endpoint types and requirements for endpoints that you can add to Global Accelerator, see Endpoints for standard accelerators in the Global Accelerator Developer Guide.
See also: AWS API Documentation
Request Syntax
client.add_endpoints(
EndpointConfigurations=[
{
'EndpointId': 'string',
'Weight': 123,
'ClientIPPreservationEnabled': True|False,
'AttachmentArn': 'string'
},
],
EndpointGroupArn='string'
)
list
[REQUIRED]
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 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 Global Accelerator Developer Guide.
ClientIPPreservationEnabled (boolean) --
Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false. The default value is true for Application Load Balancer endpoints.
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 endpoint fronted by the accelerator.
Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load Balancers, Amazon EC2 instances, and Network Load Balancers with security groups. IMPORTANT: You cannot use client IP address preservation with Network Load Balancers with TLS listeners.
For more information, see Preserve client IP addresses in Global Accelerator in the Global Accelerator Developer Guide.
AttachmentArn (string) --
The Amazon Resource Name (ARN) of the cross-account attachment that specifies the endpoints (resources) that can be added to accelerators and principals that have permission to add the endpoints to accelerators.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the endpoint group.
dict
Response Syntax
{
'EndpointDescriptions': [
{
'EndpointId': 'string',
'Weight': 123,
'HealthState': 'INITIAL'|'HEALTHY'|'UNHEALTHY',
'HealthReason': 'string',
'ClientIPPreservationEnabled': True|False
},
],
'EndpointGroupArn': 'string'
}
Response Structure
(dict) --
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 Amazon 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 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 Global Accelerator Developer Guide.
HealthState (string) --
The health status of the endpoint.
HealthReason (string) --
Returns a null result.
ClientIPPreservationEnabled (boolean) --
Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false. The default value is true for Application Load Balancers endpoints.
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 endpoint fronted by the accelerator.
Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load Balancers, Amazon EC2 instances, and Network Load Balancers with security groups. IMPORTANT: You cannot use client IP address preservation with Network Load Balancers with TLS listeners.
For more information, see Preserve client IP addresses in Global Accelerator in the Global Accelerator Developer Guide.
EndpointGroupArn (string) --
The Amazon Resource Name (ARN) of the endpoint group.
{'EndpointConfigurations': {'AttachmentArn': 'string'}}
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.
For more information about endpoint types and requirements for endpoints that you can add to Global Accelerator, see Endpoints for standard accelerators in the Global Accelerator Developer Guide.
See also: AWS API Documentation
Request Syntax
client.create_endpoint_group(
ListenerArn='string',
EndpointGroupRegion='string',
EndpointConfigurations=[
{
'EndpointId': 'string',
'Weight': 123,
'ClientIPPreservationEnabled': True|False,
'AttachmentArn': 'string'
},
],
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 Amazon Web Services 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 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 Global Accelerator Developer Guide.
ClientIPPreservationEnabled (boolean) --
Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false. The default value is true for Application Load Balancer endpoints.
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 endpoint fronted by the accelerator.
Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load Balancers, Amazon EC2 instances, and Network Load Balancers with security groups. IMPORTANT: You cannot use client IP address preservation with Network Load Balancers with TLS listeners.
For more information, see Preserve client IP addresses in Global Accelerator in the Global Accelerator Developer Guide.
AttachmentArn (string) --
The Amazon Resource Name (ARN) of the cross-account attachment that specifies the endpoints (resources) that can be added to accelerators and principals that have permission to add the endpoints to accelerators.
float
The percentage of traffic to send to an Amazon Web Services 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 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 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 Overriding listener ports in the 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 Overriding listener ports in the 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 Amazon Web Services 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 Amazon 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 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 Global Accelerator Developer Guide.
HealthState (string) --
The health status of the endpoint.
HealthReason (string) --
Returns a null result.
ClientIPPreservationEnabled (boolean) --
Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false. The default value is true for Application Load Balancers endpoints.
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 endpoint fronted by the accelerator.
Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load Balancers, Amazon EC2 instances, and Network Load Balancers with security groups. IMPORTANT: You cannot use client IP address preservation with Network Load Balancers with TLS listeners.
For more information, see Preserve client IP addresses in Global Accelerator in the Global Accelerator Developer Guide.
TrafficDialPercentage (float) --
The percentage of traffic to send to an Amazon Web Services 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 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 Overriding listener ports in the 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.
{'EndpointConfigurations': {'AttachmentArn': 'string'}}
Update an endpoint group. A resource must be valid and active when you add it as an endpoint.
See also: AWS API Documentation
Request Syntax
client.update_endpoint_group(
EndpointGroupArn='string',
EndpointConfigurations=[
{
'EndpointId': 'string',
'Weight': 123,
'ClientIPPreservationEnabled': True|False,
'AttachmentArn': 'string'
},
],
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 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 Global Accelerator Developer Guide.
ClientIPPreservationEnabled (boolean) --
Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false. The default value is true for Application Load Balancer endpoints.
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 endpoint fronted by the accelerator.
Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load Balancers, Amazon EC2 instances, and Network Load Balancers with security groups. IMPORTANT: You cannot use client IP address preservation with Network Load Balancers with TLS listeners.
For more information, see Preserve client IP addresses in Global Accelerator in the Global Accelerator Developer Guide.
AttachmentArn (string) --
The Amazon Resource Name (ARN) of the cross-account attachment that specifies the endpoints (resources) that can be added to accelerators and principals that have permission to add the endpoints to accelerators.
float
The percentage of traffic to send to an Amazon Web Services 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 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 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 Overriding listener ports in the 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 Overriding listener ports in the 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 Amazon Web Services 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 Amazon 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 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 Global Accelerator Developer Guide.
HealthState (string) --
The health status of the endpoint.
HealthReason (string) --
Returns a null result.
ClientIPPreservationEnabled (boolean) --
Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false. The default value is true for Application Load Balancers endpoints.
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 endpoint fronted by the accelerator.
Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load Balancers, Amazon EC2 instances, and Network Load Balancers with security groups. IMPORTANT: You cannot use client IP address preservation with Network Load Balancers with TLS listeners.
For more information, see Preserve client IP addresses in Global Accelerator in the Global Accelerator Developer Guide.
TrafficDialPercentage (float) --
The percentage of traffic to send to an Amazon Web Services 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 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 Overriding listener ports in the 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.