We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.37.0 published on Wednesday, Oct 15, 2025 by Pulumi
aws-native.globalaccelerator.getEndpointGroup
We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.37.0 published on Wednesday, Oct 15, 2025 by Pulumi
Resource Type definition for AWS::GlobalAccelerator::EndpointGroup
Using getEndpointGroup
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getEndpointGroup(args: GetEndpointGroupArgs, opts?: InvokeOptions): Promise<GetEndpointGroupResult>
function getEndpointGroupOutput(args: GetEndpointGroupOutputArgs, opts?: InvokeOptions): Output<GetEndpointGroupResult>
def get_endpoint_group(endpoint_group_arn: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetEndpointGroupResult
def get_endpoint_group_output(endpoint_group_arn: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetEndpointGroupResult]
func LookupEndpointGroup(ctx *Context, args *LookupEndpointGroupArgs, opts ...InvokeOption) (*LookupEndpointGroupResult, error)
func LookupEndpointGroupOutput(ctx *Context, args *LookupEndpointGroupOutputArgs, opts ...InvokeOption) LookupEndpointGroupResultOutput
> Note: This function is named LookupEndpointGroup
in the Go SDK.
public static class GetEndpointGroup
{
public static Task<GetEndpointGroupResult> InvokeAsync(GetEndpointGroupArgs args, InvokeOptions? opts = null)
public static Output<GetEndpointGroupResult> Invoke(GetEndpointGroupInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetEndpointGroupResult> getEndpointGroup(GetEndpointGroupArgs args, InvokeOptions options)
public static Output<GetEndpointGroupResult> getEndpointGroup(GetEndpointGroupArgs args, InvokeOptions options)
fn::invoke:
function: aws-native:globalaccelerator:getEndpointGroup
arguments:
# arguments dictionary
The following arguments are supported:
- Endpoint
Group stringArn - The Amazon Resource Name (ARN) of the endpoint group
- Endpoint
Group stringArn - The Amazon Resource Name (ARN) of the endpoint group
- endpoint
Group StringArn - The Amazon Resource Name (ARN) of the endpoint group
- endpoint
Group stringArn - The Amazon Resource Name (ARN) of the endpoint group
- endpoint_
group_ strarn - The Amazon Resource Name (ARN) of the endpoint group
- endpoint
Group StringArn - The Amazon Resource Name (ARN) of the endpoint group
getEndpointGroup Result
The following output properties are available:
- Endpoint
Configurations List<Pulumi.Aws Native. Global Accelerator. Outputs. Endpoint Group Endpoint Configuration> - The list of endpoint objects.
- Endpoint
Group stringArn - The Amazon Resource Name (ARN) of the endpoint group
- Health
Check intInterval Seconds - The time in seconds between each health check for an endpoint. Must be a value of 10 or 30
- Health
Check stringPath - 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 (/).
- Health
Check intPort - The port that AWS Global Accelerator uses to check the health of endpoints in this endpoint group.
- Health
Check Pulumi.Protocol Aws Native. Global Accelerator. Endpoint Group Health Check Protocol - The protocol that AWS Global Accelerator uses to check the health of endpoints in this endpoint group.
- Port
Overrides List<Pulumi.Aws Native. Global Accelerator. Outputs. Endpoint Group Port Override> - 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.
- Threshold
Count int - The number of consecutive health checks required to set the state of the endpoint to unhealthy.
- Traffic
Dial doublePercentage - The percentage of traffic to sent to an AWS Region
- Endpoint
Configurations []EndpointGroup Endpoint Configuration - The list of endpoint objects.
- Endpoint
Group stringArn - The Amazon Resource Name (ARN) of the endpoint group
- Health
Check intInterval Seconds - The time in seconds between each health check for an endpoint. Must be a value of 10 or 30
- Health
Check stringPath - 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 (/).
- Health
Check intPort - The port that AWS Global Accelerator uses to check the health of endpoints in this endpoint group.
- Health
Check EndpointProtocol Group Health Check Protocol - The protocol that AWS Global Accelerator uses to check the health of endpoints in this endpoint group.
- Port
Overrides []EndpointGroup Port Override - 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.
- Threshold
Count int - The number of consecutive health checks required to set the state of the endpoint to unhealthy.
- Traffic
Dial float64Percentage - The percentage of traffic to sent to an AWS Region
- endpoint
Configurations List<EndpointGroup Endpoint Configuration> - The list of endpoint objects.
- endpoint
Group StringArn - The Amazon Resource Name (ARN) of the endpoint group
- health
Check IntegerInterval Seconds - The time in seconds between each health check for an endpoint. Must be a value of 10 or 30
- health
Check StringPath - 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 (/).
- health
Check IntegerPort - The port that AWS Global Accelerator uses to check the health of endpoints in this endpoint group.
- health
Check EndpointProtocol Group Health Check Protocol - The protocol that AWS Global Accelerator uses to check the health of endpoints in this endpoint group.
- port
Overrides List<EndpointGroup Port Override> - 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.
- threshold
Count Integer - The number of consecutive health checks required to set the state of the endpoint to unhealthy.
- traffic
Dial DoublePercentage - The percentage of traffic to sent to an AWS Region
- endpoint
Configurations EndpointGroup Endpoint Configuration[] - The list of endpoint objects.
- endpoint
Group stringArn - The Amazon Resource Name (ARN) of the endpoint group
- health
Check numberInterval Seconds - The time in seconds between each health check for an endpoint. Must be a value of 10 or 30
- health
Check stringPath - 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 (/).
- health
Check numberPort - The port that AWS Global Accelerator uses to check the health of endpoints in this endpoint group.
- health
Check EndpointProtocol Group Health Check Protocol - The protocol that AWS Global Accelerator uses to check the health of endpoints in this endpoint group.
- port
Overrides EndpointGroup Port Override[] - 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.
- threshold
Count number - The number of consecutive health checks required to set the state of the endpoint to unhealthy.
- traffic
Dial numberPercentage - The percentage of traffic to sent to an AWS Region
- endpoint_
configurations Sequence[EndpointGroup Endpoint Configuration] - The list of endpoint objects.
- endpoint_
group_ strarn - The Amazon Resource Name (ARN) of the endpoint group
- health_
check_ intinterval_ seconds - The time in seconds between each health check for an endpoint. Must be a value of 10 or 30
- health_
check_ strpath - 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 (/).
- health_
check_ intport - The port that AWS Global Accelerator uses to check the health of endpoints in this endpoint group.
- health_
check_ Endpointprotocol Group Health Check Protocol - The protocol that AWS Global Accelerator uses to check the health of endpoints in this endpoint group.
- port_
overrides Sequence[EndpointGroup Port Override] - 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.
- threshold_
count int - The number of consecutive health checks required to set the state of the endpoint to unhealthy.
- traffic_
dial_ floatpercentage - The percentage of traffic to sent to an AWS Region
- endpoint
Configurations List<Property Map> - The list of endpoint objects.
- endpoint
Group StringArn - The Amazon Resource Name (ARN) of the endpoint group
- health
Check NumberInterval Seconds - The time in seconds between each health check for an endpoint. Must be a value of 10 or 30
- health
Check StringPath - 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 (/).
- health
Check NumberPort - The port that AWS Global Accelerator uses to check the health of endpoints in this endpoint group.
- health
Check "TCP" | "HTTP" | "HTTPS"Protocol - The protocol that AWS Global Accelerator uses to check the health of endpoints in this endpoint group.
- port
Overrides List<Property Map> - 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.
- threshold
Count Number - The number of consecutive health checks required to set the state of the endpoint to unhealthy.
- traffic
Dial NumberPercentage - The percentage of traffic to sent to an AWS Region
Supporting Types
EndpointGroupEndpointConfiguration
- Endpoint
Id string - Id of the endpoint. For Network/Application Load Balancer this value is the ARN. For EIP, this value is the allocation ID. For EC2 instances, this is the EC2 instance ID
- Attachment
Arn string - Attachment ARN that provides access control to the cross account endpoint. Not required for resources hosted in the same account as the endpoint group.
- Client
Ip boolPreservation Enabled - true if client ip should be preserved
- Weight int
- The weight for the endpoint.
- Endpoint
Id string - Id of the endpoint. For Network/Application Load Balancer this value is the ARN. For EIP, this value is the allocation ID. For EC2 instances, this is the EC2 instance ID
- Attachment
Arn string - Attachment ARN that provides access control to the cross account endpoint. Not required for resources hosted in the same account as the endpoint group.
- Client
Ip boolPreservation Enabled - true if client ip should be preserved
- Weight int
- The weight for the endpoint.
- endpoint
Id String - Id of the endpoint. For Network/Application Load Balancer this value is the ARN. For EIP, this value is the allocation ID. For EC2 instances, this is the EC2 instance ID
- attachment
Arn String - Attachment ARN that provides access control to the cross account endpoint. Not required for resources hosted in the same account as the endpoint group.
- client
Ip BooleanPreservation Enabled - true if client ip should be preserved
- weight Integer
- The weight for the endpoint.
- endpoint
Id string - Id of the endpoint. For Network/Application Load Balancer this value is the ARN. For EIP, this value is the allocation ID. For EC2 instances, this is the EC2 instance ID
- attachment
Arn string - Attachment ARN that provides access control to the cross account endpoint. Not required for resources hosted in the same account as the endpoint group.
- client
Ip booleanPreservation Enabled - true if client ip should be preserved
- weight number
- The weight for the endpoint.
- endpoint_
id str - Id of the endpoint. For Network/Application Load Balancer this value is the ARN. For EIP, this value is the allocation ID. For EC2 instances, this is the EC2 instance ID
- attachment_
arn str - Attachment ARN that provides access control to the cross account endpoint. Not required for resources hosted in the same account as the endpoint group.
- client_
ip_ boolpreservation_ enabled - true if client ip should be preserved
- weight int
- The weight for the endpoint.
- endpoint
Id String - Id of the endpoint. For Network/Application Load Balancer this value is the ARN. For EIP, this value is the allocation ID. For EC2 instances, this is the EC2 instance ID
- attachment
Arn String - Attachment ARN that provides access control to the cross account endpoint. Not required for resources hosted in the same account as the endpoint group.
- client
Ip BooleanPreservation Enabled - true if client ip should be preserved
- weight Number
- The weight for the endpoint.
EndpointGroupHealthCheckProtocol
EndpointGroupPortOverride
- Endpoint
Port int - 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.
- Listener
Port int - 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
Port int - 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.
- Listener
Port int - 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
Port 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.
- listener
Port 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.
- endpoint
Port number - 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.
- listener
Port number - 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_
port int - 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.
- listener_
port int - 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
Port Number - 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.
- listener
Port Number - 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.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.37.0 published on Wednesday, Oct 15, 2025 by Pulumi