Package 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, IVPCEndpointRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:35.149Z") @Stability(Stable) public class CfnVPCEndpoint extends CfnResource implements IInspectable, IVPCEndpointRef, ITaggableV2
Specifies a VPC endpoint.

A VPC endpoint provides a private connection between your VPC and an endpoint service. You can use an endpoint service provided by AWS , an AWS Marketplace Partner, or another AWS accounts in your organization. For more information, see the AWS PrivateLink User Guide .

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

An endpoint of type gateway serves as a target for a route in your route table for traffic destined for Amazon S3 or 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 more information about connectivity to Amazon S3 , see Why can't I connect to an S3 bucket using a gateway VPC endpoint?

An endpoint of type GatewayLoadBalancer 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")
         .vpcId("vpcId")
         // the properties below are optional
         .dnsOptions(DnsOptionsSpecificationProperty.builder()
                 .dnsRecordIpType("dnsRecordIpType")
                 .privateDnsOnlyForInboundResolverEndpoint("privateDnsOnlyForInboundResolverEndpoint")
                 .privateDnsPreference("privateDnsPreference")
                 .privateDnsSpecifiedDomains(List.of("privateDnsSpecifiedDomains"))
                 .build())
         .ipAddressType("ipAddressType")
         .policyDocument(policyDocument)
         .privateDnsEnabled(false)
         .resourceConfigurationArn("resourceConfigurationArn")
         .routeTableIds(List.of("routeTableIds"))
         .securityGroupIds(List.of("securityGroupIds"))
         .serviceName("serviceName")
         .serviceNetworkArn("serviceNetworkArn")
         .serviceRegion("serviceRegion")
         .subnetIds(List.of("subnetIds"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vpcEndpointType("vpcEndpointType")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnVPCEndpoint

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

    • CfnVPCEndpoint

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

    • CfnVPCEndpoint

      @Stability(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 - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForVPCEndpoint

      @Stability(Stable) @NotNull public static String arnForVPCEndpoint(@NotNull IVPCEndpointRef resource)
      Parameters:
      resource - This parameter is required.

    • fromVpcEndpointId

      @Stability(Stable) @NotNull public static IVPCEndpointRef fromVpcEndpointId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String vpcEndpointId)
      Creates a new IVPCEndpointRef from a vpcEndpointId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      vpcEndpointId - This parameter is required.

    • isCfnVPCEndpoint

      @Stability(Stable) @NotNull public static Boolean isCfnVPCEndpoint(@NotNull Object x)
      Checks whether the given object is a CfnVPCEndpoint.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(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(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(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(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.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The ID of the VPC endpoint.

    • getAttrNetworkInterfaceIds

      @Stability(Stable) @NotNull public List<String> getAttrNetworkInterfaceIds()
      (Interface endpoints) The network interface IDs.

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

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getVpcEndpointRef

      @Stability(Stable) @NotNull public VPCEndpointReference getVpcEndpointRef()
      A reference to a VPCEndpoint resource.
      Specified by:
      getVpcEndpointRef in interface IVPCEndpointRef

    • getVpcId

      @Stability(Stable) @NotNull public String getVpcId()
      The ID of the VPC.

    • setVpcId

      @Stability(Stable) public void setVpcId(@NotNull String value)
      The ID of the VPC.

    • getDnsOptions

      @Stability(Stable) @Nullable public Object getDnsOptions()
      Describes the DNS options for an endpoint.

      Returns union: either IResolvable or CfnVPCEndpoint.DnsOptionsSpecificationProperty

    • setDnsOptions

      @Stability(Stable) public void setDnsOptions(@Nullable IResolvable value)
      Describes the DNS options for an endpoint.

    • setDnsOptions

      @Stability(Stable) public void setDnsOptions(@Nullable CfnVPCEndpoint.DnsOptionsSpecificationProperty value)
      Describes the DNS options for an endpoint.

    • getIpAddressType

      @Stability(Stable) @Nullable public String getIpAddressType()
      The supported IP address types.

    • setIpAddressType

      @Stability(Stable) public void setIpAddressType(@Nullable String value)
      The supported IP address types.

    • getPolicyDocument

      @Stability(Stable) @Nullable public Object getPolicyDocument()
      An endpoint policy, which controls access to the service from the VPC.

    • setPolicyDocument

      @Stability(Stable) public void setPolicyDocument(@Nullable Object value)
      An endpoint policy, which controls access to the service from the VPC.

    • getPrivateDnsEnabled

      @Stability(Stable) @Nullable public Object getPrivateDnsEnabled()
      Indicate whether to associate a private hosted zone with the specified VPC.

      Returns union: either Boolean or IResolvable

    • setPrivateDnsEnabled

      @Stability(Stable) public void setPrivateDnsEnabled(@Nullable Boolean value)
      Indicate whether to associate a private hosted zone with the specified VPC.

    • setPrivateDnsEnabled

      @Stability(Stable) public void setPrivateDnsEnabled(@Nullable IResolvable value)
      Indicate whether to associate a private hosted zone with the specified VPC.

    • getResourceConfigurationArn

      @Stability(Stable) @Nullable public String getResourceConfigurationArn()
      The Amazon Resource Name (ARN) of the resource configuration.

    • setResourceConfigurationArn

      @Stability(Stable) public void setResourceConfigurationArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the resource configuration.

    • getRouteTableIds

      @Stability(Stable) @Nullable public List<String> getRouteTableIds()
      The IDs of the route tables.

    • setRouteTableIds

      @Stability(Stable) public void setRouteTableIds(@Nullable List<String> value)
      The IDs of the route tables.

    • getSecurityGroupIds

      @Stability(Stable) @Nullable public List<String> getSecurityGroupIds()
      The IDs of the security groups to associate with the endpoint network interfaces.

    • setSecurityGroupIds

      @Stability(Stable) public void setSecurityGroupIds(@Nullable List<String> value)
      The IDs of the security groups to associate with the endpoint network interfaces.

    • getServiceName

      @Stability(Stable) @Nullable public String getServiceName()
      The name of the endpoint service.

    • setServiceName

      @Stability(Stable) public void setServiceName(@Nullable String value)
      The name of the endpoint service.

    • getServiceNetworkArn

      @Stability(Stable) @Nullable public String getServiceNetworkArn()
      The Amazon Resource Name (ARN) of the service network.

    • setServiceNetworkArn

      @Stability(Stable) public void setServiceNetworkArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the service network.

    • getServiceRegion

      @Stability(Stable) @Nullable public String getServiceRegion()
      Describes a Region.

    • setServiceRegion

      @Stability(Stable) public void setServiceRegion(@Nullable String value)
      Describes a Region.

    • getSubnetIds

      @Stability(Stable) @Nullable public List<String> getSubnetIds()
      The IDs of the subnets in which to create endpoint network interfaces.

    • setSubnetIds

      @Stability(Stable) public void setSubnetIds(@Nullable List<String> value)
      The IDs of the subnets in which to create endpoint network interfaces.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags to associate with the endpoint.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags to associate with the endpoint.

    • getVpcEndpointType

      @Stability(Stable) @Nullable public String getVpcEndpointType()
      The type of endpoint.

    • setVpcEndpointType

      @Stability(Stable) public void setVpcEndpointType(@Nullable String value)
      The type of endpoint.