AWS Native v0.63.0, May 25 23

aws-native.globalaccelerator.EndpointGroup

Explore with Pulumi AI

Resource Type definition for AWS::GlobalAccelerator::EndpointGroup

Create EndpointGroup Resource

new EndpointGroup(name: string, args: EndpointGroupArgs, opts?: CustomResourceOptions);

@overload
def EndpointGroup(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  endpoint_configurations: Optional[Sequence[EndpointGroupEndpointConfigurationArgs]] = None,
                  endpoint_group_region: Optional[str] = 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,
                  listener_arn: Optional[str] = None,
                  port_overrides: Optional[Sequence[EndpointGroupPortOverrideArgs]] = None,
                  threshold_count: Optional[int] = None,
                  traffic_dial_percentage: Optional[float] = None)
@overload
def EndpointGroup(resource_name: str,
                  args: EndpointGroupArgs,
                  opts: Optional[ResourceOptions] = 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.

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

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.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
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.EndpointGroupPortOverrideArgs>
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
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
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<EndpointGroupEndpointConfigurationArgs>: 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
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<EndpointGroupPortOverrideArgs>
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 EndpointGroupEndpointConfigurationArgs[]: 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
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 EndpointGroupPortOverrideArgs[]
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
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]
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
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

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

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.