Package software.amazon.awscdk.services.ec2

Class VpcEndpointService

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.ec2.VpcEndpointService

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:39.560Z")
@Stability(Stable)
public class VpcEndpointService
extends Resource
implements IVpcEndpointService

A VPC endpoint service.

Example:

 NetworkLoadBalancer networkLoadBalancer1;
 NetworkLoadBalancer networkLoadBalancer2;
 VpcEndpointService.Builder.create(this, "EndpointService")
         .vpcEndpointServiceLoadBalancers(List.of(networkLoadBalancer1, networkLoadBalancer2))
         .acceptanceRequired(true)
         .allowedPrincipals(List.of(new ArnPrincipal("arn:aws:iam::123456789012:root")))
         .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.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

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

IResource.Jsii$Default

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

IVpcEndpointService.Jsii$Default, IVpcEndpointService.Jsii$Proxy

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.
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.
List<ArnPrincipal>	getWhitelistedPrincipals()	Deprecated. use allowedPrincipals

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

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.core.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

getWhitelistedPrincipals

@Stability(Deprecated)
@Deprecated
@NotNull
public List<ArnPrincipal> getWhitelistedPrincipals()

Deprecated.

use allowedPrincipals

(deprecated) One or more Principal ARNs to allow inbound connections to.