Package software.amazon.awscdk.services.ec2

Class VpcEndpoint

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

All Implemented Interfaces:

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

Direct Known Subclasses:

GatewayVpcEndpoint, InterfaceVpcEndpoint

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

Nested Class Summary

Nested classes/interfaces inherited from class software.constructs.Construct

software.constructs.Construct.Builder

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

IVpcEndpoint.Jsii$Default

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	addToPolicy(PolicyStatement statement)	Adds a statement to the policy document of the VPC endpoint.
protected PolicyDocument	getPolicyDocument()
abstract String	getVpcEndpointId()	The VPC endpoint identifier.
protected void	setPolicyDocument(PolicyDocument value)

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

VpcEndpoint

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

VpcEndpoint

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

VpcEndpoint

@Stability(Stable)
protected VpcEndpoint(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 ResourceProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

VpcEndpoint

@Stability(Stable)
protected VpcEndpoint(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Details

addToPolicy

@Stability(Stable)
public void addToPolicy(@NotNull
 PolicyStatement statement)

Adds a statement to the policy document of the VPC endpoint. The statement must have a Principal.

Not all interface VPC endpoints support policy. For more information see https://docs.aws.amazon.com/vpc/latest/userguide/vpce-interface.html

Parameters:

statement - the IAM statement to add. This parameter is required.

getVpcEndpointId

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

The VPC endpoint identifier.

Specified by:

getVpcEndpointId in interface IVpcEndpoint

getPolicyDocument

@Stability(Stable)
@Nullable
protected PolicyDocument getPolicyDocument()

setPolicyDocument

@Stability(Stable)
protected void setPolicyDocument(@Nullable
 PolicyDocument value)