EndpointGroup

class aws_cdk.aws_globalaccelerator.EndpointGroup(scope, id, *, listener, endpoint_group_name=None, region=None)

Bases: aws_cdk.core.Resource

(experimental) EndpointGroup construct.

Stability

experimental

Parameters
  • scope (Construct) –

  • id (str) –

  • listener (IListener) – (experimental) The Amazon Resource Name (ARN) of the listener.

  • endpoint_group_name (Optional[str]) – (experimental) Name of the endpoint group. Default: - logical ID of the resource

  • region (Optional[str]) – (experimental) The AWS Region where the endpoint group is located. Default: - the region of the current stack

Stability

experimental

Methods

add_ec2_instance(id, instance, *, client_ip_reservation=None, weight=None)

(experimental) Add an EC2 Instance as an endpoint in this endpoint group.

Parameters
  • id (str) –

  • instance (Ec2Instance) –

  • client_ip_reservation (Optional[bool]) – (experimental) Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. Default: true

  • weight (Union[int, float, None]) – (experimental) The weight associated with the endpoint. When you add weights to endpoints, you configure AWS 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. Default: - not specified

Stability

experimental

Return type

EndpointConfiguration

add_elastic_ip_address(id, eip, *, client_ip_reservation=None, weight=None)

(experimental) Add an EIP as an endpoint in this endpoint group.

Parameters
  • id (str) –

  • eip (ElasticIpAddress) –

  • client_ip_reservation (Optional[bool]) – (experimental) Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. Default: true

  • weight (Union[int, float, None]) – (experimental) The weight associated with the endpoint. When you add weights to endpoints, you configure AWS 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. Default: - not specified

Stability

experimental

Return type

EndpointConfiguration

add_endpoint(id, endpoint_id, *, client_ip_reservation=None, weight=None)

(experimental) Add an endpoint.

Parameters
  • id (str) –

  • endpoint_id (str) –

  • client_ip_reservation (Optional[bool]) – (experimental) Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. Default: true

  • weight (Union[int, float, None]) – (experimental) The weight associated with the endpoint. When you add weights to endpoints, you configure AWS 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. Default: - not specified

Stability

experimental

Return type

EndpointConfiguration

add_load_balancer(id, lb, *, client_ip_reservation=None, weight=None)

(experimental) Add an Elastic Load Balancer as an endpoint in this endpoint group.

Parameters
  • id (str) –

  • lb (LoadBalancer) –

  • client_ip_reservation (Optional[bool]) – (experimental) Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. Default: true

  • weight (Union[int, float, None]) – (experimental) The weight associated with the endpoint. When you add weights to endpoints, you configure AWS 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. Default: - not specified

Stability

experimental

Return type

EndpointConfiguration

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

endpoint_group_arn

(experimental) EndpointGroup ARN.

Stability

experimental

Return type

str

endpoint_group_name

(experimental) The name of the endpoint group.

Stability

experimental

Attribute

true

Return type

str

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Return type

ResourceEnvironment

node

The construct tree node associated with this construct.

Return type

ConstructNode

stack

The stack in which this resource is defined.

Return type

Stack

Static Methods

classmethod from_endpoint_group_arn(scope, id, endpoint_group_arn)

(experimental) import from ARN.

Parameters
  • scope (Construct) –

  • id (str) –

  • endpoint_group_arn (str) –

Stability

experimental

Return type

IEndpointGroup

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool