Package software.amazon.awscdk.services.ec2

Class GatewayVpcEndpoint

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.ec2.VpcEndpoint

software.amazon.awscdk.services.ec2.GatewayVpcEndpoint

All Implemented Interfaces:

IResource, IGatewayVpcEndpoint, IVpcEndpoint, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.106.0 (build e852934)",
           date="2025-02-12T12:32:01.748Z")
@Stability(Stable)
public class GatewayVpcEndpoint
extends VpcEndpoint
implements IGatewayVpcEndpoint

A gateway VPC endpoint.

Example:

 // Add gateway endpoints when creating the VPC
 Vpc vpc = Vpc.Builder.create(this, "MyVpc")
         .gatewayEndpoints(Map.of(
                 "S3", GatewayVpcEndpointOptions.builder()
                         .service(GatewayVpcEndpointAwsService.S3)
                         .build()))
         .build();
 // Alternatively gateway endpoints can be added on the VPC
 GatewayVpcEndpoint dynamoDbEndpoint = vpc.addGatewayEndpoint("DynamoDbEndpoint", GatewayVpcEndpointOptions.builder()
         .service(GatewayVpcEndpointAwsService.DYNAMODB)
         .build());
 // This allows to customize the endpoint policy
 dynamoDbEndpoint.addToPolicy(
 PolicyStatement.Builder.create() // Restrict to listing and describing tables
         .principals(List.of(new AnyPrincipal()))
         .actions(List.of("dynamodb:DescribeTable", "dynamodb:ListTables"))
         .resources(List.of("*")).build());
 // Add an interface endpoint
 vpc.addInterfaceEndpoint("EcrDockerEndpoint", InterfaceVpcEndpointOptions.builder()
         .service(InterfaceVpcEndpointAwsService.ECR_DOCKER)
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	GatewayVpcEndpoint.Builder	A fluent builder for GatewayVpcEndpoint.

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.ec2.IGatewayVpcEndpoint

IGatewayVpcEndpoint.Jsii$Default, IGatewayVpcEndpoint.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ec2.IVpcEndpoint

IVpcEndpoint.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GatewayVpcEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	GatewayVpcEndpoint(software.amazon.jsii.JsiiObjectRef objRef)
	GatewayVpcEndpoint(software.constructs.Construct scope, String id, GatewayVpcEndpointProps props)

Method Summary

Modifier and Type	Method	Description
static IGatewayVpcEndpoint	fromGatewayVpcEndpointId(software.constructs.Construct scope, String id, String gatewayVpcEndpointId)
String	getVpcEndpointCreationTimestamp()	The date and time the gateway VPC endpoint was created.
List<String>	getVpcEndpointDnsEntries()
String	getVpcEndpointId()	The gateway VPC endpoint identifier.
List<String>	getVpcEndpointNetworkInterfaceIds()

Methods inherited from class software.amazon.awscdk.services.ec2.VpcEndpoint

addToPolicy, getPolicyDocument, setPolicyDocument

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

GatewayVpcEndpoint

protected GatewayVpcEndpoint(software.amazon.jsii.JsiiObjectRef objRef)

GatewayVpcEndpoint

protected GatewayVpcEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

GatewayVpcEndpoint

@Stability(Stable)
public GatewayVpcEndpoint(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 GatewayVpcEndpointProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

fromGatewayVpcEndpointId

@Stability(Stable)
@NotNull
public static IGatewayVpcEndpoint fromGatewayVpcEndpointId(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String gatewayVpcEndpointId)

Parameters:

scope - This parameter is required.

id - This parameter is required.

gatewayVpcEndpointId - This parameter is required.

getVpcEndpointCreationTimestamp

@Stability(Stable)
@NotNull
public String getVpcEndpointCreationTimestamp()

The date and time the gateway VPC endpoint was created.

getVpcEndpointDnsEntries

@Stability(Stable)
@NotNull
public List<String> getVpcEndpointDnsEntries()

getVpcEndpointId

@Stability(Stable)
@NotNull
public String getVpcEndpointId()

The gateway VPC endpoint identifier.

Specified by:

getVpcEndpointId in interface IVpcEndpoint

Specified by:

getVpcEndpointId in class VpcEndpoint

getVpcEndpointNetworkInterfaceIds

@Stability(Stable)
@NotNull
public List<String> getVpcEndpointNetworkInterfaceIds()