Class EndpointGroup
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.103.1 (build bef2dea)",
date="2024-10-05T03:43:44.025Z")
@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));
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.globalaccelerator.IEndpointGroup
IEndpointGroup.Jsii$Default, IEndpointGroup.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource
IResource.Jsii$Default
-
Constructor Summary
ModifierConstructorDescriptionprotected
EndpointGroup
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
EndpointGroup
(software.amazon.jsii.JsiiObjectRef objRef) EndpointGroup
(software.constructs.Construct scope, String id, EndpointGroupProps props) -
Method Summary
Modifier and TypeMethodDescriptionvoid
addEndpoint
(IEndpoint endpoint) Add an endpoint.connectionsPeer
(String id, IVpc vpc) Return an object that represents the Accelerator's Security Group.static IEndpointGroup
fromEndpointGroupArn
(software.constructs.Construct scope, String id, String endpointGroupArn) import from ARN.EndpointGroup ARN.The name of the endpoint group.The array of the endpoints in this endpoint group.Methods inherited from class software.amazon.awscdk.Resource
applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource
Methods inherited from class software.constructs.Construct
getNode, isConstruct, toString
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.constructs.IConstruct
getNode
Methods inherited from interface software.amazon.awscdk.IResource
applyRemovalPolicy, getEnv, getStack
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
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
Add an endpoint.- Parameters:
endpoint
- This parameter is required.
-
connectionsPeer
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
EndpointGroup ARN.- Specified by:
getEndpointGroupArn
in interfaceIEndpointGroup
-
getEndpointGroupName
The name of the endpoint group. -
getEndpoints
The array of the endpoints in this endpoint group.
-