CfnEndpointGroupPropsMixin

class aws_cdk.mixins_preview.aws_globalaccelerator.mixins.CfnEndpointGroupPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::GlobalAccelerator::EndpointGroup resource is a Global Accelerator resource type that contains information about how you create an endpoint group for the specified listener.

An endpoint group is a collection of endpoints in one AWS Region .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html
CloudformationResource:: AWS::GlobalAccelerator::EndpointGroup
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

cfn_endpoint_group_props_mixin = globalaccelerator_mixins.CfnEndpointGroupPropsMixin(globalaccelerator_mixins.CfnEndpointGroupMixinProps(
    endpoint_configurations=[globalaccelerator_mixins.CfnEndpointGroupPropsMixin.EndpointConfigurationProperty(
        attachment_arn="attachmentArn",
        client_ip_preservation_enabled=False,
        endpoint_id="endpointId",
        weight=123
    )],
    endpoint_group_region="endpointGroupRegion",
    health_check_interval_seconds=123,
    health_check_path="healthCheckPath",
    health_check_port=123,
    health_check_protocol="healthCheckProtocol",
    listener_arn="listenerArn",
    port_overrides=[globalaccelerator_mixins.CfnEndpointGroupPropsMixin.PortOverrideProperty(
        endpoint_port=123,
        listener_port=123
    )],
    threshold_count=123,
    traffic_dial_percentage=123
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::GlobalAccelerator::EndpointGroup.

Parameters:

props (Union[CfnEndpointGroupMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['endpointConfigurations', 'endpointGroupRegion', 'healthCheckIntervalSeconds', 'healthCheckPath', 'healthCheckPort', 'healthCheckProtocol', 'listenerArn', 'portOverrides', 'thresholdCount', 'trafficDialPercentage']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

EndpointConfigurationProperty

class CfnEndpointGroupPropsMixin.EndpointConfigurationProperty(*, attachment_arn=None, client_ip_preservation_enabled=None, endpoint_id=None, weight=None)

Bases: object

A complex type for endpoints.

A resource must be valid and active when you add it as an endpoint.

Parameters:

attachment_arn (Optional[str]) – The Amazon Resource Name (ARN) of the cross-account attachment that specifies the endpoints (resources) that can be added to accelerators and principals that have permission to add the endpoints.
client_ip_preservation_enabled (Union[bool, IResolvable, None]) – Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators. If the value is set to true, the client’s IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator. For more information, see Preserve Client IP Addresses in the AWS Global Accelerator Developer Guide . Default: - true
endpoint_id (Optional[str]) – An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. For Amazon EC2 instances, this is the EC2 instance ID. A resource must be valid and active when you add it as an endpoint. For cross-account endpoints, this must be the ARN of the resource.
weight (Union[int, float, None]) – The weight associated with the endpoint. When you add weights to endpoints, you configure Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide . Default: - 100

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

endpoint_configuration_property = globalaccelerator_mixins.CfnEndpointGroupPropsMixin.EndpointConfigurationProperty(
    attachment_arn="attachmentArn",
    client_ip_preservation_enabled=False,
    endpoint_id="endpointId",
    weight=123
)

Attributes

attachment_arn

The Amazon Resource Name (ARN) of the cross-account attachment that specifies the endpoints (resources) that can be added to accelerators and principals that have permission to add the endpoints.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-globalaccelerator-endpointgroup-endpointconfiguration.html#cfn-globalaccelerator-endpointgroup-endpointconfiguration-attachmentarn

client_ip_preservation_enabled

Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint.

The value is true or false. The default value is true for new accelerators.

If the value is set to true, the client’s IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.

For more information, see Preserve Client IP Addresses in the AWS Global Accelerator Developer Guide .

Default:

true

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-globalaccelerator-endpointgroup-endpointconfiguration.html#cfn-globalaccelerator-endpointgroup-endpointconfiguration-clientippreservationenabled

endpoint_id

An ID for the endpoint.

If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. For Amazon EC2 instances, this is the EC2 instance ID. A resource must be valid and active when you add it as an endpoint.

For cross-account endpoints, this must be the ARN of the resource.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-globalaccelerator-endpointgroup-endpointconfiguration.html#cfn-globalaccelerator-endpointgroup-endpointconfiguration-endpointid

weight

The weight associated with the endpoint.

When you add weights to endpoints, you configure Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide .

Default:

100

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-globalaccelerator-endpointgroup-endpointconfiguration.html#cfn-globalaccelerator-endpointgroup-endpointconfiguration-weight

PortOverrideProperty

class CfnEndpointGroupPropsMixin.PortOverrideProperty(*, endpoint_port=None, listener_port=None)

Bases: object

Override specific listener ports used to route traffic to endpoints that are part of an endpoint group.

For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints.

For more information, see Port overrides in the AWS Global Accelerator Developer Guide .

Parameters:

endpoint_port (Union[int, float, None]) – 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 (Union[int, float, None]) – 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.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

port_override_property = globalaccelerator_mixins.CfnEndpointGroupPropsMixin.PortOverrideProperty(
    endpoint_port=123,
    listener_port=123
)

Attributes

endpoint_port

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-globalaccelerator-endpointgroup-portoverride.html#cfn-globalaccelerator-endpointgroup-portoverride-endpointport

listener_port

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-globalaccelerator-endpointgroup-portoverride.html#cfn-globalaccelerator-endpointgroup-portoverride-listenerport