software.amazon.awscdk.services.ec2

Class CfnVPCEndpoint

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.ec2.CfnVPCEndpoint

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.372Z")
 @Stability(value=Stable)
public class CfnVPCEndpoint
extends CfnResource
implements IInspectable

A CloudFormation `AWS::EC2::VPCEndpoint`.

Specifies a VPC endpoint for a service. An endpoint enables you to create a private connection between your VPC and the service. The service may be provided by AWS , an AWS Marketplace Partner, or another AWS account. For more information, see the AWS PrivateLink User Guide .

An interface endpoint establishes connections between the subnets in your VPC and an AWS service, your own service, or a service hosted by another AWS account . You can specify the subnets in which to create the endpoint and the security groups to associate with the endpoint network interface.

A gateway endpoint serves as a target for a route in your route table for traffic destined for Amazon S3 or Amazon DynamoDB. You can specify an endpoint policy for the endpoint, which controls access to the service from your VPC. You can also specify the VPC route tables that use the endpoint. For information about connectivity to Amazon S3, see Why can’t I connect to an S3 bucket using a gateway VPC endpoint?

A Gateway Load Balancer endpoint provides private connectivity between your VPC and virtual appliances from a service provider.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 Object policyDocument;
 CfnVPCEndpoint cfnVPCEndpoint = CfnVPCEndpoint.Builder.create(this, "MyCfnVPCEndpoint")
         .serviceName("serviceName")
         .vpcId("vpcId")
         // the properties below are optional
         .policyDocument(policyDocument)
         .privateDnsEnabled(false)
         .routeTableIds(List.of("routeTableIds"))
         .securityGroupIds(List.of("securityGroupIds"))
         .subnetIds(List.of("subnetIds"))
         .vpcEndpointType("vpcEndpointType")
         .build();
 

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnVPCEndpoint(software.constructs.Construct scope, String id, CfnVPCEndpointProps props) Create a new `AWS::EC2::VPCEndpoint`.
protected	CfnVPCEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnVPCEndpoint(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrCreationTimestamp() The date and time the VPC endpoint was created.
List<String>	getAttrDnsEntries() (Interface endpoints) The DNS entries for the endpoint.
List<String>	getAttrNetworkInterfaceIds() (Interface endpoints) One or more network interface IDs.
protected Map<String,Object>	getCfnProperties()
Object	getPolicyDocument() A policy that controls access to the service from the VPC.
Object	getPrivateDnsEnabled() Indicate whether to associate a private hosted zone with the specified VPC.
List<String>	getRouteTableIds() The route table IDs.
List<String>	getSecurityGroupIds() The IDs of the security groups to associate with the endpoint network interface.
String	getServiceName() The service name.
List<String>	getSubnetIds() The ID of the subnets in which to create an endpoint network interface.
String	getVpcEndpointType() The type of endpoint.
String	getVpcId() The ID of the VPC in which the endpoint will be used.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setPolicyDocument(Object value) A policy that controls access to the service from the VPC.
void	setPrivateDnsEnabled(Boolean value) Indicate whether to associate a private hosted zone with the specified VPC.
void	setPrivateDnsEnabled(IResolvable value) Indicate whether to associate a private hosted zone with the specified VPC.
void	setRouteTableIds(List<String> value) The route table IDs.
void	setSecurityGroupIds(List<String> value) The IDs of the security groups to associate with the endpoint network interface.
void	setServiceName(String value) The service name.
void	setSubnetIds(List<String> value) The ID of the subnets in which to create an endpoint network interface.
void	setVpcEndpointType(String value) The type of endpoint.
void	setVpcId(String value) The ID of the VPC in which the endpoint will be used.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnVPCEndpoint

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

CfnVPCEndpoint

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

CfnVPCEndpoint

@Stability(value=Stable)
public CfnVPCEndpoint(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @NotNull
                                               CfnVPCEndpointProps props)

Create a new `AWS::EC2::VPCEndpoint`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrCreationTimestamp

@Stability(value=Stable)
 @NotNull
public String getAttrCreationTimestamp()

The date and time the VPC endpoint was created.

For example: Fri Sep 28 23:34:36 UTC 2018.

getAttrDnsEntries

@Stability(value=Stable)
 @NotNull
public List<String> getAttrDnsEntries()

(Interface endpoints) The DNS entries for the endpoint.

Each entry is a combination of the hosted zone ID and the DNS name. The entries are ordered as follows: regional public DNS, zonal public DNS, private DNS, and wildcard DNS. This order is not enforced for AWS Marketplace services.

The following is an example. In the first entry, the hosted zone ID is Z1HUB23UULQXV and the DNS name is vpce-01abc23456de78f9g-12abccd3.ec2.us-east-1.vpce.amazonaws.com.

["Z1HUB23UULQXV:vpce-01abc23456de78f9g-12abccd3.ec2.us-east-1.vpce.amazonaws.com", "Z1HUB23UULQXV:vpce-01abc23456de78f9g-12abccd3-us-east-1a.ec2.us-east-1.vpce.amazonaws.com", "Z1C12344VYDITB0:ec2.us-east-1.amazonaws.com"]

If you update the PrivateDnsEnabled or SubnetIds properties, the DNS entries in the list will change.

getAttrNetworkInterfaceIds

@Stability(value=Stable)
 @NotNull
public List<String> getAttrNetworkInterfaceIds()

(Interface endpoints) One or more network interface IDs.

If you update the PrivateDnsEnabled or SubnetIds properties, the items in this list might change.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getPolicyDocument

@Stability(value=Stable)
 @NotNull
public Object getPolicyDocument()

A policy that controls access to the service from the VPC.

If this parameter is not specified, the default policy allows full access to the service. Endpoint policies are supported only for gateway and interface endpoints.

For CloudFormation templates in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation converts YAML policies to JSON format before calling the API to create or modify the VPC endpoint.

setPolicyDocument

@Stability(value=Stable)
public void setPolicyDocument(@NotNull
                                                       Object value)

A policy that controls access to the service from the VPC.

If this parameter is not specified, the default policy allows full access to the service. Endpoint policies are supported only for gateway and interface endpoints.

For CloudFormation templates in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation converts YAML policies to JSON format before calling the API to create or modify the VPC endpoint.

getServiceName

@Stability(value=Stable)
 @NotNull
public String getServiceName()

The service name.

To list the available services, use DescribeVpcEndpointServices . Otherwise, get the name from the service provider.

setServiceName

@Stability(value=Stable)
public void setServiceName(@NotNull
                                                    String value)

The service name.

To list the available services, use DescribeVpcEndpointServices . Otherwise, get the name from the service provider.

getVpcId

@Stability(value=Stable)
 @NotNull
public String getVpcId()

The ID of the VPC in which the endpoint will be used.

setVpcId

@Stability(value=Stable)
public void setVpcId(@NotNull
                                              String value)

The ID of the VPC in which the endpoint will be used.

getPrivateDnsEnabled

@Stability(value=Stable)
 @Nullable
public Object getPrivateDnsEnabled()

Indicate whether to associate a private hosted zone with the specified VPC.

The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, kinesis.us-east-1.amazonaws.com ), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.

To use a private hosted zone, you must set the following VPC attributes to true : enableDnsHostnames and enableDnsSupport .

This property is supported only for interface endpoints.

Default: false

setPrivateDnsEnabled

@Stability(value=Stable)
public void setPrivateDnsEnabled(@Nullable
                                                          Boolean value)

Indicate whether to associate a private hosted zone with the specified VPC.

The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, kinesis.us-east-1.amazonaws.com ), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.

To use a private hosted zone, you must set the following VPC attributes to true : enableDnsHostnames and enableDnsSupport .

This property is supported only for interface endpoints.

Default: false

setPrivateDnsEnabled

@Stability(value=Stable)
public void setPrivateDnsEnabled(@Nullable
                                                          IResolvable value)

Indicate whether to associate a private hosted zone with the specified VPC.

The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, kinesis.us-east-1.amazonaws.com ), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.

To use a private hosted zone, you must set the following VPC attributes to true : enableDnsHostnames and enableDnsSupport .

This property is supported only for interface endpoints.

Default: false

getRouteTableIds

@Stability(value=Stable)
 @Nullable
public List<String> getRouteTableIds()

The route table IDs.

Routing is supported only for gateway endpoints.

setRouteTableIds

@Stability(value=Stable)
public void setRouteTableIds(@Nullable
                                                      List<String> value)

The route table IDs.

Routing is supported only for gateway endpoints.

getSecurityGroupIds

@Stability(value=Stable)
 @Nullable
public List<String> getSecurityGroupIds()

The IDs of the security groups to associate with the endpoint network interface.

Security groups are supported only for interface endpoints.

setSecurityGroupIds

@Stability(value=Stable)
public void setSecurityGroupIds(@Nullable
                                                         List<String> value)

The IDs of the security groups to associate with the endpoint network interface.

Security groups are supported only for interface endpoints.

getSubnetIds

@Stability(value=Stable)
 @Nullable
public List<String> getSubnetIds()

The ID of the subnets in which to create an endpoint network interface.

You must specify this property for an interface endpoints or a Gateway Load Balancer endpoint. You can't specify this property for a gateway endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.

setSubnetIds

@Stability(value=Stable)
public void setSubnetIds(@Nullable
                                                  List<String> value)

The ID of the subnets in which to create an endpoint network interface.

You must specify this property for an interface endpoints or a Gateway Load Balancer endpoint. You can't specify this property for a gateway endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.

getVpcEndpointType

@Stability(value=Stable)
 @Nullable
public String getVpcEndpointType()

The type of endpoint.

Default: Gateway

setVpcEndpointType

@Stability(value=Stable)
public void setVpcEndpointType(@Nullable
                                                        String value)

The type of endpoint.

Default: Gateway