Class EndpointGroup

EndpointGroup construct.

Inheritance
System.Object
Resource
EndpointGroup
Implements
Constructs.IConstruct
Constructs.IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.GlobalAccelerator
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class EndpointGroup : Resource, IEndpointGroup, IResource
Syntax (vb)
Public Class EndpointGroup
    Inherits Resource
    Implements IEndpointGroup, IResource
Remarks

ExampleMetadata: infused

Examples
Listener listener;

// Non-open ALB
ApplicationLoadBalancer alb;

// Remember that there is only one AGA security group per VPC.
Vpc vpc;


var endpointGroup = listener.AddEndpointGroup("Group", new EndpointGroupOptions {
    Endpoints = new [] {
        new ApplicationLoadBalancerEndpoint(alb, new ApplicationLoadBalancerEndpointOptions {
            PreserveClientIp = true
        }) }
});
var agaSg = endpointGroup.ConnectionsPeer("GlobalAcceleratorSG", vpc);

// Allow connections from the AGA to the ALB
alb.Connections.AllowFrom(agaSg, Port.Tcp(443));

Synopsis

Constructors

EndpointGroup(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
EndpointGroup(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
EndpointGroup(Construct, String, IEndpointGroupProps)

Properties

EndpointGroupArn

EndpointGroup ARN.
EndpointGroupName

The name of the endpoint group.
Endpoints

The array of the endpoints in this endpoint group.

Methods

AddEndpoint(IEndpoint)

Add an endpoint.
ConnectionsPeer(String, IVpc)

Return an object that represents the Accelerator's Security Group.
FromEndpointGroupArn(Construct, String, String)

import from ARN.

Constructors

EndpointGroup(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected EndpointGroup(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

EndpointGroup(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected EndpointGroup(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

EndpointGroup(Construct, String, IEndpointGroupProps)

public EndpointGroup(Construct scope, string id, IEndpointGroupProps props)
Parameters
scope Constructs.Construct
id System.String
props IEndpointGroupProps

Properties

EndpointGroupArn

EndpointGroup ARN.

public virtual string EndpointGroupArn { get; }
Property Value

System.String

EndpointGroupName

The name of the endpoint group.

public virtual string EndpointGroupName { get; }
Property Value

System.String

Remarks

Attribute: true

Endpoints

The array of the endpoints in this endpoint group.

protected virtual IEndpoint[] Endpoints { get; }
Property Value

IEndpoint[]

Methods

AddEndpoint(IEndpoint)

Add an endpoint.

public virtual void AddEndpoint(IEndpoint endpoint)
Parameters
endpoint IEndpoint

ConnectionsPeer(String, IVpc)

Return an object that represents the Accelerator's Security Group.

public virtual IPeer ConnectionsPeer(string id, IVpc vpc)
Parameters
id System.String
vpc IVpc
Returns

IPeer

Remarks

Uses a Custom Resource to look up the Security Group that Accelerator creates at deploy time. Requires your VPC ID to perform the lookup.

The Security Group will only be created if you enable Client IP Preservation on any of the endpoints.

You cannot manipulate the rules inside this security group, but you can use this security group as a Peer in Connections rules on other constructs.

FromEndpointGroupArn(Construct, String, String)

import from ARN.

public static IEndpointGroup FromEndpointGroupArn(Construct scope, string id, string endpointGroupArn)
Parameters
scope Constructs.Construct
id System.String
endpointGroupArn System.String
Returns

IEndpointGroup

Implements

Constructs.IConstruct
Constructs.IDependable