java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.globalaccelerator.EndpointGroup
All Implemented Interfaces:
IResource, IEndpointGroup, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.99.0 (build 8f757e4)", date="2024-06-13T18:49:19.507Z") @Stability(Stable) public class EndpointGroup extends Resource implements IEndpointGroup
EndpointGroup construct.

Example:

 Listener listener;
 // Non-open ALB
 ApplicationLoadBalancer alb;
 // Remember that there is only one AGA security group per VPC.
 Vpc vpc;
 EndpointGroup endpointGroup = listener.addEndpointGroup("Group", EndpointGroupOptions.builder()
         .endpoints(List.of(
             ApplicationLoadBalancerEndpoint.Builder.create(alb)
                     .preserveClientIp(true)
                     .build()))
         .build());
 IPeer agaSg = endpointGroup.connectionsPeer("GlobalAcceleratorSG", vpc);
 // Allow connections from the AGA to the ALB
 alb.connections.allowFrom(agaSg, Port.tcp(443));
 
  • Constructor Details

    • EndpointGroup

      protected EndpointGroup(software.amazon.jsii.JsiiObjectRef objRef)
    • EndpointGroup

      protected EndpointGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
    • EndpointGroup

      @Stability(Stable) public EndpointGroup(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull EndpointGroupProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.
  • Method Details

    • fromEndpointGroupArn

      @Stability(Stable) @NotNull public static IEndpointGroup fromEndpointGroupArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String endpointGroupArn)
      import from ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      endpointGroupArn - This parameter is required.
    • addEndpoint

      @Stability(Stable) public void addEndpoint(@NotNull IEndpoint endpoint)
      Add an endpoint.

      Parameters:
      endpoint - This parameter is required.
    • connectionsPeer

      @Stability(Stable) @NotNull public IPeer connectionsPeer(@NotNull String id, @NotNull IVpc vpc)
      Return an object that represents the Accelerator's Security Group.

      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.

      Parameters:
      id - This parameter is required.
      vpc - This parameter is required.
    • getEndpointGroupArn

      @Stability(Stable) @NotNull public String getEndpointGroupArn()
      EndpointGroup ARN.
      Specified by:
      getEndpointGroupArn in interface IEndpointGroup
    • getEndpointGroupName

      @Stability(Stable) @NotNull public String getEndpointGroupName()
      The name of the endpoint group.
    • getEndpoints

      @Stability(Stable) @NotNull protected List<IEndpoint> getEndpoints()
      The array of the endpoints in this endpoint group.