CfnEndpointGroupProps

class aws_cdk.aws_globalaccelerator.CfnEndpointGroupProps(*, endpoint_configurations=None, endpoint_group_region, health_check_interval_seconds=None, health_check_path=None, health_check_port=None, health_check_protocol=None, listener_arn, port_overrides=None, threshold_count=None, traffic_dial_percentage=None)

Bases: object

Properties for defining a AWS::GlobalAccelerator::EndpointGroup.

Parameters
  • endpoint_configurations (Union[IResolvable, Sequence[Union[IResolvable, EndpointConfigurationProperty]], None]) – AWS::GlobalAccelerator::EndpointGroup.EndpointConfigurations.

  • endpoint_group_region (str) – AWS::GlobalAccelerator::EndpointGroup.EndpointGroupRegion.

  • health_check_interval_seconds (Union[int, float, None]) – AWS::GlobalAccelerator::EndpointGroup.HealthCheckIntervalSeconds.

  • health_check_path (Optional[str]) – AWS::GlobalAccelerator::EndpointGroup.HealthCheckPath.

  • health_check_port (Union[int, float, None]) – AWS::GlobalAccelerator::EndpointGroup.HealthCheckPort.

  • health_check_protocol (Optional[str]) – AWS::GlobalAccelerator::EndpointGroup.HealthCheckProtocol.

  • listener_arn (str) – AWS::GlobalAccelerator::EndpointGroup.ListenerArn.

  • port_overrides (Union[IResolvable, Sequence[Union[IResolvable, PortOverrideProperty]], None]) – AWS::GlobalAccelerator::EndpointGroup.PortOverrides.

  • threshold_count (Union[int, float, None]) – AWS::GlobalAccelerator::EndpointGroup.ThresholdCount.

  • traffic_dial_percentage (Union[int, float, None]) – AWS::GlobalAccelerator::EndpointGroup.TrafficDialPercentage.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_globalaccelerator as globalaccelerator

cfn_endpoint_group_props = globalaccelerator.CfnEndpointGroupProps(
    endpoint_group_region="endpointGroupRegion",
    listener_arn="listenerArn",

    # the properties below are optional
    endpoint_configurations=[globalaccelerator.CfnEndpointGroup.EndpointConfigurationProperty(
        endpoint_id="endpointId",

        # the properties below are optional
        client_ip_preservation_enabled=False,
        weight=123
    )],
    health_check_interval_seconds=123,
    health_check_path="healthCheckPath",
    health_check_port=123,
    health_check_protocol="healthCheckProtocol",
    port_overrides=[globalaccelerator.CfnEndpointGroup.PortOverrideProperty(
        endpoint_port=123,
        listener_port=123
    )],
    threshold_count=123,
    traffic_dial_percentage=123
)

Attributes

endpoint_configurations

AWS::GlobalAccelerator::EndpointGroup.EndpointConfigurations.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-endpointconfigurations

Return type

Union[IResolvable, List[Union[IResolvable, EndpointConfigurationProperty]], None]

endpoint_group_region

AWS::GlobalAccelerator::EndpointGroup.EndpointGroupRegion.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-endpointgroupregion

Return type

str

health_check_interval_seconds

AWS::GlobalAccelerator::EndpointGroup.HealthCheckIntervalSeconds.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-healthcheckintervalseconds

Return type

Union[int, float, None]

health_check_path

AWS::GlobalAccelerator::EndpointGroup.HealthCheckPath.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-healthcheckpath

Return type

Optional[str]

health_check_port

AWS::GlobalAccelerator::EndpointGroup.HealthCheckPort.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-healthcheckport

Return type

Union[int, float, None]

health_check_protocol

AWS::GlobalAccelerator::EndpointGroup.HealthCheckProtocol.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-healthcheckprotocol

Return type

Optional[str]

listener_arn

AWS::GlobalAccelerator::EndpointGroup.ListenerArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-listenerarn

Return type

str

port_overrides

AWS::GlobalAccelerator::EndpointGroup.PortOverrides.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-portoverrides

Return type

Union[IResolvable, List[Union[IResolvable, PortOverrideProperty]], None]

threshold_count

AWS::GlobalAccelerator::EndpointGroup.ThresholdCount.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-thresholdcount

Return type

Union[int, float, None]

traffic_dial_percentage

AWS::GlobalAccelerator::EndpointGroup.TrafficDialPercentage.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-trafficdialpercentage

Return type

Union[int, float, None]