Package software.amazon.awscdk.services.ec2

Interface CfnVPCEndpointProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnVPCEndpointProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.110.0 (build 336b265)",
           date="2025-04-22T23:08:11.089Z")
@Stability(Stable)
public interface CfnVPCEndpointProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnVPCEndpoint.

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;
 CfnVPCEndpointProps cfnVPCEndpointProps = CfnVPCEndpointProps.builder()
         .vpcId("vpcId")
         // the properties below are optional
         .dnsOptions(DnsOptionsSpecificationProperty.builder()
                 .dnsRecordIpType("dnsRecordIpType")
                 .privateDnsOnlyForInboundResolverEndpoint("privateDnsOnlyForInboundResolverEndpoint")
                 .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnVPCEndpointProps.Builder	A builder for CfnVPCEndpointProps
static final class	CfnVPCEndpointProps.Jsii$Proxy	An implementation for CfnVPCEndpointProps

Method Summary

Modifier and Type	Method	Description
static CfnVPCEndpointProps.Builder	builder()
default Object	getDnsOptions()	Describes the DNS options for an endpoint.
default String	getIpAddressType()	The supported IP address types.
default Object	getPolicyDocument()	An endpoint policy, which controls access to the service from the VPC.
default Object	getPrivateDnsEnabled()	Indicate whether to associate a private hosted zone with the specified VPC.
default String	getResourceConfigurationArn()	The Amazon Resource Name (ARN) of the resource configuration.
default List<String>	getRouteTableIds()	The IDs of the route tables.
default List<String>	getSecurityGroupIds()	The IDs of the security groups to associate with the endpoint network interfaces.
default String	getServiceName()	The name of the endpoint service.
default String	getServiceNetworkArn()	The Amazon Resource Name (ARN) of the service network.
default String	getServiceRegion()	Describes a Region.
default List<String>	getSubnetIds()	The IDs of the subnets in which to create endpoint network interfaces.
default List<CfnTag>	getTags()	The tags to associate with the endpoint.
default String	getVpcEndpointType()	The type of endpoint.
String	getVpcId()	The ID of the VPC.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getVpcId

@Stability(Stable)
@NotNull
String getVpcId()

The ID of the VPC.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-vpcid

getDnsOptions

@Stability(Stable)
@Nullable
default Object getDnsOptions()

Describes the DNS options for an endpoint.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-dnsoptions

getIpAddressType

@Stability(Stable)
@Nullable
default String getIpAddressType()

The supported IP address types.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-ipaddresstype

getPolicyDocument

@Stability(Stable)
@Nullable
default Object getPolicyDocument()

An endpoint policy, which controls access to the service from the VPC.

The default endpoint 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. For example, if you have a JSON policy, you can convert it to YAML before including it in the YAML template, and AWS CloudFormation converts the policy to JSON format before calling the API actions for AWS PrivateLink . Alternatively, you can include the JSON directly in the YAML, as shown in the following Properties section:

Properties: VpcEndpointType: 'Interface' ServiceName: !Sub 'com.amazonaws.${AWS::Region}.logs' PolicyDocument: '{ "Version":"2012-10-17", "Statement": [{ "Effect":"Allow", "Principal":"*", "Action":["logs:Describe*","logs:Get*","logs:List*","logs:FilterLogEvents"], "Resource":"*" }] }'

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-policydocument

getPrivateDnsEnabled

@Stability(Stable)
@Nullable
default 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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-privatednsenabled

getResourceConfigurationArn

@Stability(Stable)
@Nullable
default String getResourceConfigurationArn()

The Amazon Resource Name (ARN) of the resource configuration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-resourceconfigurationarn

getRouteTableIds

@Stability(Stable)
@Nullable
default List<String> getRouteTableIds()

The IDs of the route tables.

Routing is supported only for gateway endpoints.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-routetableids

getSecurityGroupIds

@Stability(Stable)
@Nullable
default List<String> getSecurityGroupIds()

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

If this parameter is not specified, we use the default security group for the VPC. Security groups are supported only for interface endpoints.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-securitygroupids

getServiceName

@Stability(Stable)
@Nullable
default String getServiceName()

The name of the endpoint service.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-servicename

getServiceNetworkArn

@Stability(Stable)
@Nullable
default String getServiceNetworkArn()

The Amazon Resource Name (ARN) of the service network.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-servicenetworkarn

getServiceRegion

@Stability(Stable)
@Nullable
default String getServiceRegion()

Describes a Region.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-serviceregion

getSubnetIds

@Stability(Stable)
@Nullable
default List<String> getSubnetIds()

The IDs of the subnets in which to create endpoint network interfaces.

You must specify this property for an interface endpoint 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-subnetids

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags to associate with the endpoint.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-tags

getVpcEndpointType

@Stability(Stable)
@Nullable
default String getVpcEndpointType()

The type of endpoint.

Default: Gateway

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-vpcendpointtype

builder

@Stability(Stable)
static CfnVPCEndpointProps.Builder builder()

Returns:

a CfnVPCEndpointProps.Builder of CfnVPCEndpointProps