Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. globalaccelerator
  5. getEndpointGroup

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.globalaccelerator.getEndpointGroup

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    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)
// 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
    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 (/).
    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>
    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.
    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
    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 (/).
    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
    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.
    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
    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 (/).
    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>
    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.
    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
    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 (/).
    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[]
    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.
    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
    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_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]
    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_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
    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 (/).
    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>
    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.
    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
    AttachmentArn 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.
    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
    AttachmentArn 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.
    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
    attachmentArn 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.
    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
    attachmentArn 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.
    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
    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_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
    attachmentArn 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.
    clientIpPreservationEnabled Boolean
    true if client ip should be preserved
    weight Number
    The weight for the endpoint.

    EndpointGroupHealthCheckProtocol

    EndpointGroupPortOverride

    EndpointPort 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.
    ListenerPort 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.
    EndpointPort 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.
    ListenerPort 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.
    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.
    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 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.
    listenerPort 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.
    endpointPort 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.
    listenerPort 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
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native