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

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.globalaccelerator.EndpointGroup

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::GlobalAccelerator::EndpointGroup

    Create EndpointGroup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new EndpointGroup(name: string, args: EndpointGroupArgs, opts?: CustomResourceOptions);
    @overload
def EndpointGroup(resource_name: str,
                  args: EndpointGroupArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def EndpointGroup(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  endpoint_group_region: Optional[str] = None,
                  listener_arn: Optional[str] = None,
                  endpoint_configurations: Optional[Sequence[EndpointGroupEndpointConfigurationArgs]] = None,
                  health_check_interval_seconds: Optional[int] = None,
                  health_check_path: Optional[str] = None,
                  health_check_port: Optional[int] = None,
                  health_check_protocol: Optional[EndpointGroupHealthCheckProtocol] = None,
                  port_overrides: Optional[Sequence[EndpointGroupPortOverrideArgs]] = None,
                  threshold_count: Optional[int] = None,
                  traffic_dial_percentage: Optional[float] = None)
    func NewEndpointGroup(ctx *Context, name string, args EndpointGroupArgs, opts ...ResourceOption) (*EndpointGroup, error)
    public EndpointGroup(string name, EndpointGroupArgs args, CustomResourceOptions? opts = null)
    public EndpointGroup(String name, EndpointGroupArgs args)
public EndpointGroup(String name, EndpointGroupArgs args, CustomResourceOptions options)

    type: aws-native:globalaccelerator:EndpointGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args EndpointGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args EndpointGroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args EndpointGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EndpointGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EndpointGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    EndpointGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The EndpointGroup resource accepts the following input properties:

    EndpointGroupRegion string
    The name of the AWS Region where the endpoint group is located
    ListenerArn string
    The Amazon Resource Name (ARN) of the listener
    EndpointConfigurations List<Pulumi.AwsNative.GlobalAccelerator.Inputs.EndpointGroupEndpointConfiguration>
    The list of endpoint objects.
    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.Inputs.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
    EndpointGroupRegion string
    The name of the AWS Region where the endpoint group is located
    ListenerArn string
    The Amazon Resource Name (ARN) of the listener
    EndpointConfigurations []EndpointGroupEndpointConfigurationArgs
    The list of endpoint objects.
    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 []EndpointGroupPortOverrideArgs
    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
    endpointGroupRegion String
    The name of the AWS Region where the endpoint group is located
    listenerArn String
    The Amazon Resource Name (ARN) of the listener
    endpointConfigurations List<EndpointGroupEndpointConfiguration>
    The list of endpoint objects.
    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
    endpointGroupRegion string
    The name of the AWS Region where the endpoint group is located
    listenerArn string
    The Amazon Resource Name (ARN) of the listener
    endpointConfigurations EndpointGroupEndpointConfiguration[]
    The list of endpoint objects.
    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_group_region str
    The name of the AWS Region where the endpoint group is located
    listener_arn str
    The Amazon Resource Name (ARN) of the listener
    endpoint_configurations Sequence[EndpointGroupEndpointConfigurationArgs]
    The list of endpoint objects.
    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[EndpointGroupPortOverrideArgs]
    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
    endpointGroupRegion String
    The name of the AWS Region where the endpoint group is located
    listenerArn String
    The Amazon Resource Name (ARN) of the listener
    endpointConfigurations List<Property Map>
    The list of endpoint objects.
    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

    Outputs

    All input properties are implicitly available as output properties. Additionally, the EndpointGroup resource produces the following output properties:

    EndpointGroupArn string
    The Amazon Resource Name (ARN) of the endpoint group
    Id string
    The provider-assigned unique ID for this managed resource.
    EndpointGroupArn string
    The Amazon Resource Name (ARN) of the endpoint group
    Id string
    The provider-assigned unique ID for this managed resource.
    endpointGroupArn String
    The Amazon Resource Name (ARN) of the endpoint group
    id String
    The provider-assigned unique ID for this managed resource.
    endpointGroupArn string
    The Amazon Resource Name (ARN) of the endpoint group
    id string
    The provider-assigned unique ID for this managed resource.
    endpoint_group_arn str
    The Amazon Resource Name (ARN) of the endpoint group
    id str
    The provider-assigned unique ID for this managed resource.
    endpointGroupArn String
    The Amazon Resource Name (ARN) of the endpoint group
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    EndpointGroupEndpointConfiguration, EndpointGroupEndpointConfigurationArgs

    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, EndpointGroupHealthCheckProtocolArgs

    Tcp
    TCP
    Http
    HTTP
    Https
    HTTPS
    EndpointGroupHealthCheckProtocolTcp
    TCP
    EndpointGroupHealthCheckProtocolHttp
    HTTP
    EndpointGroupHealthCheckProtocolHttps
    HTTPS
    Tcp
    TCP
    Http
    HTTP
    Https
    HTTPS
    Tcp
    TCP
    Http
    HTTP
    Https
    HTTPS
    TCP
    TCP
    HTTP
    HTTP
    HTTPS
    HTTPS
    "TCP"
    TCP
    "HTTP"
    HTTP
    "HTTPS"
    HTTPS

    EndpointGroupPortOverride, EndpointGroupPortOverrideArgs

    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.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native