Skip to content

aws.globalaccelerator.describe_endpoint_group

Example SQL Queries

SELECT * FROM
aws.globalaccelerator.describe_endpoint_group
WHERE
"endpoint_group_arn" = 'VALUE';

Description

Describe an endpoint group.

Table Definition

Column NameColumn Data Type
endpoint_group_arn Required Input Column

The Amazon Resource Name (ARN) of the endpoint group to describe.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
endpoint_group

The description of an endpoint group.

STRUCT(
"endpoint_group_arn" VARCHAR,
"endpoint_group_region" VARCHAR,
"endpoint_descriptions" STRUCT(
"endpoint_id" VARCHAR,
"weight" BIGINT,
"health_state" VARCHAR,
"health_reason" VARCHAR,
"client_ip_preservation_enabled" BOOLEAN
)[],
"traffic_dial_percentage" DOUBLE,
"health_check_port" BIGINT,
"health_check_protocol" VARCHAR,
"health_check_path" VARCHAR,
"health_check_interval_seconds" BIGINT,
"threshold_count" BIGINT,
"port_overrides" STRUCT(
"listener_port" BIGINT,
"endpoint_port" BIGINT
)[]
)
Show child fields
endpoint_group.endpoint_descriptions[]
Show child fields
endpoint_group.endpoint_descriptions[].client_ip_preservation_enabled

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.

endpoint_group.endpoint_descriptions[].endpoint_id

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.

endpoint_group.endpoint_descriptions[].health_reason

Returns a null result.

endpoint_group.endpoint_descriptions[].health_state

The health status of the endpoint.

endpoint_group.endpoint_descriptions[].weight

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.

endpoint_group.endpoint_group_arn

The Amazon Resource Name (ARN) of the endpoint group.

endpoint_group.endpoint_group_region

The Amazon Web Services Region where the endpoint group is located.

endpoint_group.health_check_interval_seconds

The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.

endpoint_group.health_check_path

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 (/).

endpoint_group.health_check_port

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.

endpoint_group.health_check_protocol

The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default value is TCP.

endpoint_group.port_overrides[]
Show child fields
endpoint_group.port_overrides[].endpoint_port

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.

endpoint_group.port_overrides[].listener_port

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.

endpoint_group.threshold_count

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.

endpoint_group.traffic_dial_percentage

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.