aws-native.globalaccelerator.getEndpointGroup

Explore with Pulumi AI

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.65.0 published on Wednesday, Jun 7, 2023 by Pulumi

pulumi/pulumi-aws-native

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)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws-native:globalaccelerator:getEndpointGroup
  arguments:
    # arguments dictionary

The following arguments are supported:

EndpointGroupArn string: The Amazon Resource Name (ARN) of the endpoint group

EndpointGroupArn string: The Amazon Resource Name (ARN) of the endpoint group

endpointGroupArn String: The Amazon Resource Name (ARN) of the endpoint group

endpointGroupArn string: The Amazon Resource Name (ARN) of the endpoint group

endpoint_group_arn str: The Amazon Resource Name (ARN) of the endpoint group

endpointGroupArn String: The Amazon Resource Name (ARN) of the endpoint group

getEndpointGroup Result

The following output properties are available:

EndpointConfigurations List<Pulumi.AwsNative.GlobalAccelerator.Outputs.EndpointGroupEndpointConfiguration>: The list of endpoint objects.
EndpointGroupArn string: The Amazon Resource Name (ARN) of the endpoint group
HealthCheckIntervalSeconds int: The time in seconds between each health check for an endpoint. Must be a value of 10 or 30
HealthCheckPath string
HealthCheckPort int: The port that AWS Global Accelerator uses to check the health of endpoints in this endpoint group.
HealthCheckProtocol Pulumi.AwsNative.GlobalAccelerator.EndpointGroupHealthCheckProtocol: The protocol that AWS Global Accelerator uses to check the health of endpoints in this endpoint group.
PortOverrides List<Pulumi.AwsNative.GlobalAccelerator.Outputs.EndpointGroupPortOverride>
ThresholdCount int: The number of consecutive health checks required to set the state of the endpoint to unhealthy.
TrafficDialPercentage double: The percentage of traffic to sent to an AWS Region

EndpointConfigurations []EndpointGroupEndpointConfiguration: The list of endpoint objects.
EndpointGroupArn string: The Amazon Resource Name (ARN) of the endpoint group
HealthCheckIntervalSeconds int: The time in seconds between each health check for an endpoint. Must be a value of 10 or 30
HealthCheckPath string
HealthCheckPort int: The port that AWS Global Accelerator uses to check the health of endpoints in this endpoint group.
HealthCheckProtocol EndpointGroupHealthCheckProtocol: The protocol that AWS Global Accelerator uses to check the health of endpoints in this endpoint group.
PortOverrides []EndpointGroupPortOverride
ThresholdCount int: The number of consecutive health checks required to set the state of the endpoint to unhealthy.
TrafficDialPercentage float64: The percentage of traffic to sent to an AWS Region

endpointConfigurations List<EndpointGroupEndpointConfiguration>: The list of endpoint objects.
endpointGroupArn String: The Amazon Resource Name (ARN) of the endpoint group
healthCheckIntervalSeconds Integer: The time in seconds between each health check for an endpoint. Must be a value of 10 or 30
healthCheckPath String
healthCheckPort Integer: The port that AWS Global Accelerator uses to check the health of endpoints in this endpoint group.
healthCheckProtocol EndpointGroupHealthCheckProtocol: The protocol that AWS Global Accelerator uses to check the health of endpoints in this endpoint group.
portOverrides List<EndpointGroupPortOverride>
thresholdCount Integer: The number of consecutive health checks required to set the state of the endpoint to unhealthy.
trafficDialPercentage Double: The percentage of traffic to sent to an AWS Region

endpointConfigurations EndpointGroupEndpointConfiguration[]: The list of endpoint objects.
endpointGroupArn string: The Amazon Resource Name (ARN) of the endpoint group
healthCheckIntervalSeconds number: The time in seconds between each health check for an endpoint. Must be a value of 10 or 30
healthCheckPath string
healthCheckPort number: The port that AWS Global Accelerator uses to check the health of endpoints in this endpoint group.
healthCheckProtocol EndpointGroupHealthCheckProtocol: The protocol that AWS Global Accelerator uses to check the health of endpoints in this endpoint group.
portOverrides EndpointGroupPortOverride[]
thresholdCount number: The number of consecutive health checks required to set the state of the endpoint to unhealthy.
trafficDialPercentage number: The percentage of traffic to sent to an AWS Region

endpoint_configurations Sequence[EndpointGroupEndpointConfiguration]: The list of endpoint objects.
endpoint_group_arn str: The Amazon Resource Name (ARN) of the endpoint group
health_check_interval_seconds int: The time in seconds between each health check for an endpoint. Must be a value of 10 or 30
health_check_path str
health_check_port int: The port that AWS Global Accelerator uses to check the health of endpoints in this endpoint group.
health_check_protocol EndpointGroupHealthCheckProtocol: The protocol that AWS Global Accelerator uses to check the health of endpoints in this endpoint group.
port_overrides Sequence[EndpointGroupPortOverride]
threshold_count int: The number of consecutive health checks required to set the state of the endpoint to unhealthy.
traffic_dial_percentage float: The percentage of traffic to sent to an AWS Region

endpointConfigurations List<Property Map>: The list of endpoint objects.
endpointGroupArn String: The Amazon Resource Name (ARN) of the endpoint group
healthCheckIntervalSeconds Number: The time in seconds between each health check for an endpoint. Must be a value of 10 or 30
healthCheckPath String
healthCheckPort Number: The port that AWS Global Accelerator uses to check the health of endpoints in this endpoint group.
healthCheckProtocol "TCP" | "HTTP" | "HTTPS": The protocol that AWS Global Accelerator uses to check the health of endpoints in this endpoint group.
portOverrides List<Property Map>
thresholdCount Number: The number of consecutive health checks required to set the state of the endpoint to unhealthy.
trafficDialPercentage Number: The percentage of traffic to sent to an AWS Region

Supporting Types

EndpointGroupEndpointConfiguration

EndpointId 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
ClientIPPreservationEnabled bool: true if client ip should be preserved
Weight int: The weight for the endpoint.

EndpointId 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
ClientIPPreservationEnabled bool: true if client ip should be preserved
Weight int: The weight for the endpoint.

endpointId 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
clientIPPreservationEnabled Boolean: true if client ip should be preserved
weight Integer: The weight for the endpoint.

endpointId 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
clientIPPreservationEnabled boolean: 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
client_ip_preservation_enabled bool: true if client ip should be preserved
weight int: The weight for the endpoint.

endpointId 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
clientIPPreservationEnabled Boolean: true if client ip should be preserved
weight Number: The weight for the endpoint.