Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. ec2
  5. VpcEndpoint

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.ec2.VpcEndpoint

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

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.

Create VpcEndpoint Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new VpcEndpoint(name: string, args: VpcEndpointArgs, opts?: CustomResourceOptions);
@overload
def VpcEndpoint(resource_name: str,
                args: VpcEndpointArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def VpcEndpoint(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                vpc_id: Optional[str] = None,
                security_group_ids: Optional[Sequence[str]] = None,
                policy_document: Optional[Any] = None,
                private_dns_enabled: Optional[bool] = None,
                resource_configuration_arn: Optional[str] = None,
                route_table_ids: Optional[Sequence[str]] = None,
                dns_options: Optional[VpcEndpointDnsOptionsSpecificationArgs] = None,
                service_name: Optional[str] = None,
                service_network_arn: Optional[str] = None,
                service_region: Optional[str] = None,
                subnet_ids: Optional[Sequence[str]] = None,
                tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                vpc_endpoint_type: Optional[VpcEndpointType] = None,
                ip_address_type: Optional[VpcEndpointIpAddressType] = None)
func NewVpcEndpoint(ctx *Context, name string, args VpcEndpointArgs, opts ...ResourceOption) (*VpcEndpoint, error)
public VpcEndpoint(string name, VpcEndpointArgs args, CustomResourceOptions? opts = null)
public VpcEndpoint(String name, VpcEndpointArgs args)
public VpcEndpoint(String name, VpcEndpointArgs args, CustomResourceOptions options)

type: aws-native:ec2:VpcEndpoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. VpcEndpointArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. VpcEndpointArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. VpcEndpointArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. VpcEndpointArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. VpcEndpointArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

VpcEndpoint Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The VpcEndpoint resource accepts the following input properties:

VpcId This property is required. string
The ID of the VPC.
DnsOptions Pulumi.AwsNative.Ec2.Inputs.VpcEndpointDnsOptionsSpecification
Describes the DNS options for an endpoint.
IpAddressType Pulumi.AwsNative.Ec2.VpcEndpointIpAddressType
The supported IP address types.
PolicyDocument object

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 CFNlong converts the policy to JSON format before calling the API actions for 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":"*" }] }'

Search the CloudFormation User Guide for AWS::EC2::VPCEndpoint for more information about the expected schema for this property.

PrivateDnsEnabled bool
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
ResourceConfigurationArn string
The Amazon Resource Name (ARN) of the resource configuration.
RouteTableIds List<string>
The IDs of the route tables. Routing is supported only for gateway endpoints.
SecurityGroupIds List<string>
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.
ServiceName string
The name of the endpoint service.
ServiceNetworkArn string
The Amazon Resource Name (ARN) of the service network.
ServiceRegion string
SubnetIds List<string>
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.
Tags List<Pulumi.AwsNative.Inputs.Tag>
The tags to associate with the endpoint.
VpcEndpointType Pulumi.AwsNative.Ec2.VpcEndpointType
The type of endpoint. Default: Gateway
VpcId This property is required. string
The ID of the VPC.
DnsOptions VpcEndpointDnsOptionsSpecificationArgs
Describes the DNS options for an endpoint.
IpAddressType VpcEndpointIpAddressType
The supported IP address types.
PolicyDocument interface{}

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 CFNlong converts the policy to JSON format before calling the API actions for 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":"*" }] }'

Search the CloudFormation User Guide for AWS::EC2::VPCEndpoint for more information about the expected schema for this property.

PrivateDnsEnabled bool
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
ResourceConfigurationArn string
The Amazon Resource Name (ARN) of the resource configuration.
RouteTableIds []string
The IDs of the route tables. Routing is supported only for gateway endpoints.
SecurityGroupIds []string
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.
ServiceName string
The name of the endpoint service.
ServiceNetworkArn string
The Amazon Resource Name (ARN) of the service network.
ServiceRegion string
SubnetIds []string
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.
Tags TagArgs
The tags to associate with the endpoint.
VpcEndpointType VpcEndpointType
The type of endpoint. Default: Gateway
vpcId This property is required. String
The ID of the VPC.
dnsOptions VpcEndpointDnsOptionsSpecification
Describes the DNS options for an endpoint.
ipAddressType VpcEndpointIpAddressType
The supported IP address types.
policyDocument Object

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 CFNlong converts the policy to JSON format before calling the API actions for 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":"*" }] }'

Search the CloudFormation User Guide for AWS::EC2::VPCEndpoint for more information about the expected schema for this property.

privateDnsEnabled Boolean
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
resourceConfigurationArn String
The Amazon Resource Name (ARN) of the resource configuration.
routeTableIds List<String>
The IDs of the route tables. Routing is supported only for gateway endpoints.
securityGroupIds List<String>
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.
serviceName String
The name of the endpoint service.
serviceNetworkArn String
The Amazon Resource Name (ARN) of the service network.
serviceRegion String
subnetIds List<String>
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.
tags List<Tag>
The tags to associate with the endpoint.
vpcEndpointType VpcEndpointType
The type of endpoint. Default: Gateway
vpcId This property is required. string
The ID of the VPC.
dnsOptions VpcEndpointDnsOptionsSpecification
Describes the DNS options for an endpoint.
ipAddressType VpcEndpointIpAddressType
The supported IP address types.
policyDocument any

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 CFNlong converts the policy to JSON format before calling the API actions for 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":"*" }] }'

Search the CloudFormation User Guide for AWS::EC2::VPCEndpoint for more information about the expected schema for this property.

privateDnsEnabled boolean
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
resourceConfigurationArn string
The Amazon Resource Name (ARN) of the resource configuration.
routeTableIds string[]
The IDs of the route tables. Routing is supported only for gateway endpoints.
securityGroupIds string[]
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.
serviceName string
The name of the endpoint service.
serviceNetworkArn string
The Amazon Resource Name (ARN) of the service network.
serviceRegion string
subnetIds string[]
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.
tags Tag[]
The tags to associate with the endpoint.
vpcEndpointType VpcEndpointType
The type of endpoint. Default: Gateway
vpc_id This property is required. str
The ID of the VPC.
dns_options VpcEndpointDnsOptionsSpecificationArgs
Describes the DNS options for an endpoint.
ip_address_type VpcEndpointIpAddressType
The supported IP address types.
policy_document Any

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 CFNlong converts the policy to JSON format before calling the API actions for 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":"*" }] }'

Search the CloudFormation User Guide for AWS::EC2::VPCEndpoint for more information about the expected schema for this property.

private_dns_enabled bool
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
resource_configuration_arn str
The Amazon Resource Name (ARN) of the resource configuration.
route_table_ids Sequence[str]
The IDs of the route tables. Routing is supported only for gateway endpoints.
security_group_ids Sequence[str]
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.
service_name str
The name of the endpoint service.
service_network_arn str
The Amazon Resource Name (ARN) of the service network.
service_region str
subnet_ids Sequence[str]
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.
tags Sequence[TagArgs]
The tags to associate with the endpoint.
vpc_endpoint_type VpcEndpointType
The type of endpoint. Default: Gateway
vpcId This property is required. String
The ID of the VPC.
dnsOptions Property Map
Describes the DNS options for an endpoint.
ipAddressType "ipv4" | "ipv6" | "dualstack" | "not-specified"
The supported IP address types.
policyDocument Any

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 CFNlong converts the policy to JSON format before calling the API actions for 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":"*" }] }'

Search the CloudFormation User Guide for AWS::EC2::VPCEndpoint for more information about the expected schema for this property.

privateDnsEnabled Boolean
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
resourceConfigurationArn String
The Amazon Resource Name (ARN) of the resource configuration.
routeTableIds List<String>
The IDs of the route tables. Routing is supported only for gateway endpoints.
securityGroupIds List<String>
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.
serviceName String
The name of the endpoint service.
serviceNetworkArn String
The Amazon Resource Name (ARN) of the service network.
serviceRegion String
subnetIds List<String>
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.
tags List<Property Map>
The tags to associate with the endpoint.
vpcEndpointType "Interface" | "Gateway" | "GatewayLoadBalancer" | "ServiceNetwork" | "Resource"
The type of endpoint. Default: Gateway

Outputs

All input properties are implicitly available as output properties. Additionally, the VpcEndpoint resource produces the following output properties:

AwsId string
The ID of the VPC endpoint.
CreationTimestamp string
The date and time the VPC endpoint was created. For example: Fri Sep 28 23:34:36 UTC 2018.
DnsEntries List<string>

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

Id string
The provider-assigned unique ID for this managed resource.
NetworkInterfaceIds List<string>
(Interface endpoints) The network interface IDs. If you update the PrivateDnsEnabled or SubnetIds properties, the items in this list might change.
AwsId string
The ID of the VPC endpoint.
CreationTimestamp string
The date and time the VPC endpoint was created. For example: Fri Sep 28 23:34:36 UTC 2018.
DnsEntries []string

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

Id string
The provider-assigned unique ID for this managed resource.
NetworkInterfaceIds []string
(Interface endpoints) The network interface IDs. If you update the PrivateDnsEnabled or SubnetIds properties, the items in this list might change.
awsId String
The ID of the VPC endpoint.
creationTimestamp String
The date and time the VPC endpoint was created. For example: Fri Sep 28 23:34:36 UTC 2018.
dnsEntries List<String>

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

id String
The provider-assigned unique ID for this managed resource.
networkInterfaceIds List<String>
(Interface endpoints) The network interface IDs. If you update the PrivateDnsEnabled or SubnetIds properties, the items in this list might change.
awsId string
The ID of the VPC endpoint.
creationTimestamp string
The date and time the VPC endpoint was created. For example: Fri Sep 28 23:34:36 UTC 2018.
dnsEntries string[]

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

id string
The provider-assigned unique ID for this managed resource.
networkInterfaceIds string[]
(Interface endpoints) The network interface IDs. If you update the PrivateDnsEnabled or SubnetIds properties, the items in this list might change.
aws_id str
The ID of the VPC endpoint.
creation_timestamp str
The date and time the VPC endpoint was created. For example: Fri Sep 28 23:34:36 UTC 2018.
dns_entries Sequence[str]

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

id str
The provider-assigned unique ID for this managed resource.
network_interface_ids Sequence[str]
(Interface endpoints) The network interface IDs. If you update the PrivateDnsEnabled or SubnetIds properties, the items in this list might change.
awsId String
The ID of the VPC endpoint.
creationTimestamp String
The date and time the VPC endpoint was created. For example: Fri Sep 28 23:34:36 UTC 2018.
dnsEntries List<String>

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

id String
The provider-assigned unique ID for this managed resource.
networkInterfaceIds List<String>
(Interface endpoints) The network interface IDs. If you update the PrivateDnsEnabled or SubnetIds properties, the items in this list might change.

Supporting Types

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

VpcEndpointDnsOptionsSpecification
, VpcEndpointDnsOptionsSpecificationArgs

DnsRecordIpType Pulumi.AwsNative.Ec2.VpcEndpointDnsOptionsSpecificationDnsRecordIpType
The DNS records created for the endpoint.
PrivateDnsOnlyForInboundResolverEndpoint Pulumi.AwsNative.Ec2.VpcEndpointDnsOptionsSpecificationPrivateDnsOnlyForInboundResolverEndpoint
Indicates whether to enable private DNS only for inbound endpoints. This option is available only for services that support both gateway and interface endpoints. It routes traffic that originates from the VPC to the gateway endpoint and traffic that originates from on-premises to the interface endpoint.
DnsRecordIpType VpcEndpointDnsOptionsSpecificationDnsRecordIpType
The DNS records created for the endpoint.
PrivateDnsOnlyForInboundResolverEndpoint VpcEndpointDnsOptionsSpecificationPrivateDnsOnlyForInboundResolverEndpoint
Indicates whether to enable private DNS only for inbound endpoints. This option is available only for services that support both gateway and interface endpoints. It routes traffic that originates from the VPC to the gateway endpoint and traffic that originates from on-premises to the interface endpoint.
dnsRecordIpType VpcEndpointDnsOptionsSpecificationDnsRecordIpType
The DNS records created for the endpoint.
privateDnsOnlyForInboundResolverEndpoint VpcEndpointDnsOptionsSpecificationPrivateDnsOnlyForInboundResolverEndpoint
Indicates whether to enable private DNS only for inbound endpoints. This option is available only for services that support both gateway and interface endpoints. It routes traffic that originates from the VPC to the gateway endpoint and traffic that originates from on-premises to the interface endpoint.
dnsRecordIpType VpcEndpointDnsOptionsSpecificationDnsRecordIpType
The DNS records created for the endpoint.
privateDnsOnlyForInboundResolverEndpoint VpcEndpointDnsOptionsSpecificationPrivateDnsOnlyForInboundResolverEndpoint
Indicates whether to enable private DNS only for inbound endpoints. This option is available only for services that support both gateway and interface endpoints. It routes traffic that originates from the VPC to the gateway endpoint and traffic that originates from on-premises to the interface endpoint.
dns_record_ip_type VpcEndpointDnsOptionsSpecificationDnsRecordIpType
The DNS records created for the endpoint.
private_dns_only_for_inbound_resolver_endpoint VpcEndpointDnsOptionsSpecificationPrivateDnsOnlyForInboundResolverEndpoint
Indicates whether to enable private DNS only for inbound endpoints. This option is available only for services that support both gateway and interface endpoints. It routes traffic that originates from the VPC to the gateway endpoint and traffic that originates from on-premises to the interface endpoint.
dnsRecordIpType "ipv4" | "ipv6" | "dualstack" | "service-defined" | "not-specified"
The DNS records created for the endpoint.
privateDnsOnlyForInboundResolverEndpoint "OnlyInboundResolver" | "AllResolvers" | "NotSpecified"
Indicates whether to enable private DNS only for inbound endpoints. This option is available only for services that support both gateway and interface endpoints. It routes traffic that originates from the VPC to the gateway endpoint and traffic that originates from on-premises to the interface endpoint.

VpcEndpointDnsOptionsSpecificationDnsRecordIpType
, VpcEndpointDnsOptionsSpecificationDnsRecordIpTypeArgs

Ipv4
ipv4
Ipv6
ipv6
Dualstack
dualstack
ServiceDefined
service-defined
NotSpecified
not-specified
VpcEndpointDnsOptionsSpecificationDnsRecordIpTypeIpv4
ipv4
VpcEndpointDnsOptionsSpecificationDnsRecordIpTypeIpv6
ipv6
VpcEndpointDnsOptionsSpecificationDnsRecordIpTypeDualstack
dualstack
VpcEndpointDnsOptionsSpecificationDnsRecordIpTypeServiceDefined
service-defined
VpcEndpointDnsOptionsSpecificationDnsRecordIpTypeNotSpecified
not-specified
Ipv4
ipv4
Ipv6
ipv6
Dualstack
dualstack
ServiceDefined
service-defined
NotSpecified
not-specified
Ipv4
ipv4
Ipv6
ipv6
Dualstack
dualstack
ServiceDefined
service-defined
NotSpecified
not-specified
IPV4
ipv4
IPV6
ipv6
DUALSTACK
dualstack
SERVICE_DEFINED
service-defined
NOT_SPECIFIED
not-specified
"ipv4"
ipv4
"ipv6"
ipv6
"dualstack"
dualstack
"service-defined"
service-defined
"not-specified"
not-specified

VpcEndpointDnsOptionsSpecificationPrivateDnsOnlyForInboundResolverEndpoint
, VpcEndpointDnsOptionsSpecificationPrivateDnsOnlyForInboundResolverEndpointArgs

OnlyInboundResolver
OnlyInboundResolver
AllResolvers
AllResolvers
NotSpecified
NotSpecified
VpcEndpointDnsOptionsSpecificationPrivateDnsOnlyForInboundResolverEndpointOnlyInboundResolver
OnlyInboundResolver
VpcEndpointDnsOptionsSpecificationPrivateDnsOnlyForInboundResolverEndpointAllResolvers
AllResolvers
VpcEndpointDnsOptionsSpecificationPrivateDnsOnlyForInboundResolverEndpointNotSpecified
NotSpecified
OnlyInboundResolver
OnlyInboundResolver
AllResolvers
AllResolvers
NotSpecified
NotSpecified
OnlyInboundResolver
OnlyInboundResolver
AllResolvers
AllResolvers
NotSpecified
NotSpecified
ONLY_INBOUND_RESOLVER
OnlyInboundResolver
ALL_RESOLVERS
AllResolvers
NOT_SPECIFIED
NotSpecified
"OnlyInboundResolver"
OnlyInboundResolver
"AllResolvers"
AllResolvers
"NotSpecified"
NotSpecified

VpcEndpointIpAddressType
, VpcEndpointIpAddressTypeArgs

Ipv4
ipv4
Ipv6
ipv6
Dualstack
dualstack
NotSpecified
not-specified
VpcEndpointIpAddressTypeIpv4
ipv4
VpcEndpointIpAddressTypeIpv6
ipv6
VpcEndpointIpAddressTypeDualstack
dualstack
VpcEndpointIpAddressTypeNotSpecified
not-specified
Ipv4
ipv4
Ipv6
ipv6
Dualstack
dualstack
NotSpecified
not-specified
Ipv4
ipv4
Ipv6
ipv6
Dualstack
dualstack
NotSpecified
not-specified
IPV4
ipv4
IPV6
ipv6
DUALSTACK
dualstack
NOT_SPECIFIED
not-specified
"ipv4"
ipv4
"ipv6"
ipv6
"dualstack"
dualstack
"not-specified"
not-specified

VpcEndpointType
, VpcEndpointTypeArgs

Interface
Interface
Gateway
Gateway
GatewayLoadBalancer
GatewayLoadBalancer
ServiceNetwork
ServiceNetwork
Resource
Resource
VpcEndpointTypeInterface
Interface
VpcEndpointTypeGateway
Gateway
VpcEndpointTypeGatewayLoadBalancer
GatewayLoadBalancer
VpcEndpointTypeServiceNetwork
ServiceNetwork
VpcEndpointTypeResource
Resource
Interface
Interface
Gateway
Gateway
GatewayLoadBalancer
GatewayLoadBalancer
ServiceNetwork
ServiceNetwork
Resource
Resource
Interface
Interface
Gateway
Gateway
GatewayLoadBalancer
GatewayLoadBalancer
ServiceNetwork
ServiceNetwork
Resource
Resource
INTERFACE
Interface
GATEWAY
Gateway
GATEWAY_LOAD_BALANCER
GatewayLoadBalancer
SERVICE_NETWORK
ServiceNetwork
RESOURCE
Resource
"Interface"
Interface
"Gateway"
Gateway
"GatewayLoadBalancer"
GatewayLoadBalancer
"ServiceNetwork"
ServiceNetwork
"Resource"
Resource

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native