Package software.amazon.awscdk.services.ec2

Class VpcEndpointService

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.ec2.VpcEndpointService

All Implemented Interfaces:

IEnvironmentAware, IResource, IVpcEndpointService, IVPCEndpointServiceRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-04T09:27:40.531Z")
@Stability(Stable)
public class VpcEndpointService
extends Resource
implements IVpcEndpointService

A VPC endpoint service.

Example:

 NetworkLoadBalancer networkLoadBalancer;
 VpcEndpointService.Builder.create(this, "EndpointService")
         .vpcEndpointServiceLoadBalancers(List.of(networkLoadBalancer))
         // Support both IPv4 and IPv6 connections to the endpoint service
         .supportedIpAddressTypes(List.of(IpAddressType.IPV4, IpAddressType.IPV6))
         .build();
 

Nested Class Summary

Nested Classes

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

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.IResource

IResource.Jsii$Default

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

IVpcEndpointService.Jsii$Default, IVpcEndpointService.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_PREFIX	The default value for a VPC Endpoint Service name prefix, useful if you do not have a synthesize-time region literal available (all you have is { "Ref": "AWS::Region" }).
static final String	PROPERTY_INJECTION_ID	Uniquely identifies this class.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Boolean	getAcceptanceRequired()	Whether to require manual acceptance of new connections to the service.
List<ArnPrincipal>	getAllowedPrincipals()	One or more Principal ARNs to allow inbound connections to.
Boolean	getContributorInsightsEnabled()	Whether to enable the built-in Contributor Insights rules provided by AWS PrivateLink.
String	getVpcEndpointServiceId()	The id of the VPC Endpoint Service, like vpce-svc-xxxxxxxxxxxxxxxx.
List<IVpcEndpointServiceLoadBalancer>	getVpcEndpointServiceLoadBalancers()	One or more network load balancers to host the service.
String	getVpcEndpointServiceName()	The service name of the VPC Endpoint Service that clients use to connect to, like com.amazonaws.vpce..vpce-svc-xxxxxxxxxxxxxxxx.
VPCEndpointServiceReference	getVpcEndpointServiceRef()	A reference to a VPCEndpointService resource.

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.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.awscdk.services.ec2.IVpcEndpointService

getEnv, getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

DEFAULT_PREFIX

@Stability(Stable)
public static final String DEFAULT_PREFIX

The default value for a VPC Endpoint Service name prefix, useful if you do not have a synthesize-time region literal available (all you have is { "Ref": "AWS::Region" }).

PROPERTY_INJECTION_ID

@Stability(Stable)
public static final String PROPERTY_INJECTION_ID

Uniquely identifies this class.

Constructor Details

VpcEndpointService

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

VpcEndpointService

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

VpcEndpointService

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

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

getAcceptanceRequired

@Stability(Stable)
@NotNull
public Boolean getAcceptanceRequired()

Whether to require manual acceptance of new connections to the service.

getAllowedPrincipals

@Stability(Stable)
@NotNull
public List<ArnPrincipal> getAllowedPrincipals()

One or more Principal ARNs to allow inbound connections to.

getVpcEndpointServiceId

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

The id of the VPC Endpoint Service, like vpce-svc-xxxxxxxxxxxxxxxx.

Specified by:

getVpcEndpointServiceId in interface IVpcEndpointService

getVpcEndpointServiceLoadBalancers

@Stability(Stable)
@NotNull
public List<IVpcEndpointServiceLoadBalancer> getVpcEndpointServiceLoadBalancers()

One or more network load balancers to host the service.

getVpcEndpointServiceName

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

The service name of the VPC Endpoint Service that clients use to connect to, like com.amazonaws.vpce..vpce-svc-xxxxxxxxxxxxxxxx.

Specified by:

getVpcEndpointServiceName in interface IVpcEndpointService

getVpcEndpointServiceRef

@Stability(Stable)
@NotNull
public VPCEndpointServiceReference getVpcEndpointServiceRef()

A reference to a VPCEndpointService resource.

Specified by:

getVpcEndpointServiceRef in interface IVPCEndpointServiceRef

getContributorInsightsEnabled

@Stability(Stable)
@Nullable
public Boolean getContributorInsightsEnabled()

Whether to enable the built-in Contributor Insights rules provided by AWS PrivateLink.