Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. ec2
  5. VpcEndpointService
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

aws.ec2.VpcEndpointService

Explore with Pulumi AI

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

Provides a VPC Endpoint Service resource. Service consumers can create an Interface VPC Endpoint to connect to the service.

NOTE on VPC Endpoint Services and VPC Endpoint Service Allowed Principals: This provider provides both a standalone VPC Endpoint Service Allowed Principal resource and a VPC Endpoint Service resource with an allowed_principals attribute. Do not use the same principal ARN in both a VPC Endpoint Service resource and a VPC Endpoint Service Allowed Principal resource. Doing so will cause a conflict and will overwrite the association.

Example Usage

Network Load Balancers

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.ec2.VpcEndpointService("example", {
    acceptanceRequired: false,
    networkLoadBalancerArns: [exampleAwsLb.arn],
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.ec2.VpcEndpointService("example",
    acceptance_required=False,
    network_load_balancer_arns=[example_aws_lb["arn"]])
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2.NewVpcEndpointService(ctx, "example", &ec2.VpcEndpointServiceArgs{
			AcceptanceRequired: pulumi.Bool(false),
			NetworkLoadBalancerArns: pulumi.StringArray{
				exampleAwsLb.Arn,
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Ec2.VpcEndpointService("example", new()
    {
        AcceptanceRequired = false,
        NetworkLoadBalancerArns = new[]
        {
            exampleAwsLb.Arn,
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.VpcEndpointService;
import com.pulumi.aws.ec2.VpcEndpointServiceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new VpcEndpointService("example", VpcEndpointServiceArgs.builder()
            .acceptanceRequired(false)
            .networkLoadBalancerArns(exampleAwsLb.arn())
            .build());

    }
}
Copy
resources:
  example:
    type: aws:ec2:VpcEndpointService
    properties:
      acceptanceRequired: false
      networkLoadBalancerArns:
        - ${exampleAwsLb.arn}
Copy

Gateway Load Balancers

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.ec2.VpcEndpointService("example", {
    acceptanceRequired: false,
    gatewayLoadBalancerArns: [exampleAwsLb.arn],
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.ec2.VpcEndpointService("example",
    acceptance_required=False,
    gateway_load_balancer_arns=[example_aws_lb["arn"]])
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2.NewVpcEndpointService(ctx, "example", &ec2.VpcEndpointServiceArgs{
			AcceptanceRequired: pulumi.Bool(false),
			GatewayLoadBalancerArns: pulumi.StringArray{
				exampleAwsLb.Arn,
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Ec2.VpcEndpointService("example", new()
    {
        AcceptanceRequired = false,
        GatewayLoadBalancerArns = new[]
        {
            exampleAwsLb.Arn,
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.VpcEndpointService;
import com.pulumi.aws.ec2.VpcEndpointServiceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new VpcEndpointService("example", VpcEndpointServiceArgs.builder()
            .acceptanceRequired(false)
            .gatewayLoadBalancerArns(exampleAwsLb.arn())
            .build());

    }
}
Copy
resources:
  example:
    type: aws:ec2:VpcEndpointService
    properties:
      acceptanceRequired: false
      gatewayLoadBalancerArns:
        - ${exampleAwsLb.arn}
Copy

Create VpcEndpointService Resource

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

Constructor syntax

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

@overload
def VpcEndpointService(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       acceptance_required: Optional[bool] = None,
                       allowed_principals: Optional[Sequence[str]] = None,
                       gateway_load_balancer_arns: Optional[Sequence[str]] = None,
                       network_load_balancer_arns: Optional[Sequence[str]] = None,
                       private_dns_name: Optional[str] = None,
                       supported_ip_address_types: Optional[Sequence[str]] = None,
                       supported_regions: Optional[Sequence[str]] = None,
                       tags: Optional[Mapping[str, str]] = None)
func NewVpcEndpointService(ctx *Context, name string, args VpcEndpointServiceArgs, opts ...ResourceOption) (*VpcEndpointService, error)
public VpcEndpointService(string name, VpcEndpointServiceArgs args, CustomResourceOptions? opts = null)
public VpcEndpointService(String name, VpcEndpointServiceArgs args)
public VpcEndpointService(String name, VpcEndpointServiceArgs args, CustomResourceOptions options)

type: aws:ec2:VpcEndpointService
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. VpcEndpointServiceArgs
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. VpcEndpointServiceArgs
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. VpcEndpointServiceArgs
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. VpcEndpointServiceArgs
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. VpcEndpointServiceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var vpcEndpointServiceResource = new Aws.Ec2.VpcEndpointService("vpcEndpointServiceResource", new()
{
    AcceptanceRequired = false,
    AllowedPrincipals = new[]
    {
        "string",
    },
    GatewayLoadBalancerArns = new[]
    {
        "string",
    },
    NetworkLoadBalancerArns = new[]
    {
        "string",
    },
    PrivateDnsName = "string",
    SupportedIpAddressTypes = new[]
    {
        "string",
    },
    SupportedRegions = new[]
    {
        "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := ec2.NewVpcEndpointService(ctx, "vpcEndpointServiceResource", &ec2.VpcEndpointServiceArgs{
	AcceptanceRequired: pulumi.Bool(false),
	AllowedPrincipals: pulumi.StringArray{
		pulumi.String("string"),
	},
	GatewayLoadBalancerArns: pulumi.StringArray{
		pulumi.String("string"),
	},
	NetworkLoadBalancerArns: pulumi.StringArray{
		pulumi.String("string"),
	},
	PrivateDnsName: pulumi.String("string"),
	SupportedIpAddressTypes: pulumi.StringArray{
		pulumi.String("string"),
	},
	SupportedRegions: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var vpcEndpointServiceResource = new VpcEndpointService("vpcEndpointServiceResource", VpcEndpointServiceArgs.builder()
    .acceptanceRequired(false)
    .allowedPrincipals("string")
    .gatewayLoadBalancerArns("string")
    .networkLoadBalancerArns("string")
    .privateDnsName("string")
    .supportedIpAddressTypes("string")
    .supportedRegions("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
vpc_endpoint_service_resource = aws.ec2.VpcEndpointService("vpcEndpointServiceResource",
    acceptance_required=False,
    allowed_principals=["string"],
    gateway_load_balancer_arns=["string"],
    network_load_balancer_arns=["string"],
    private_dns_name="string",
    supported_ip_address_types=["string"],
    supported_regions=["string"],
    tags={
        "string": "string",
    })
Copy
const vpcEndpointServiceResource = new aws.ec2.VpcEndpointService("vpcEndpointServiceResource", {
    acceptanceRequired: false,
    allowedPrincipals: ["string"],
    gatewayLoadBalancerArns: ["string"],
    networkLoadBalancerArns: ["string"],
    privateDnsName: "string",
    supportedIpAddressTypes: ["string"],
    supportedRegions: ["string"],
    tags: {
        string: "string",
    },
});
Copy
type: aws:ec2:VpcEndpointService
properties:
    acceptanceRequired: false
    allowedPrincipals:
        - string
    gatewayLoadBalancerArns:
        - string
    networkLoadBalancerArns:
        - string
    privateDnsName: string
    supportedIpAddressTypes:
        - string
    supportedRegions:
        - string
    tags:
        string: string
Copy

VpcEndpointService 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 VpcEndpointService resource accepts the following input properties:

AcceptanceRequired This property is required. bool
Whether or not VPC endpoint connection requests to the service must be accepted by the service owner - true or false.
AllowedPrincipals List<string>
The ARNs of one or more principals allowed to discover the endpoint service.
GatewayLoadBalancerArns List<string>
Amazon Resource Names (ARNs) of one or more Gateway Load Balancers for the endpoint service.
NetworkLoadBalancerArns List<string>
Amazon Resource Names (ARNs) of one or more Network Load Balancers for the endpoint service.
PrivateDnsName string
The private DNS name for the service.
SupportedIpAddressTypes List<string>
The supported IP address types. The possible values are ipv4 and ipv6.
SupportedRegions List<string>
The set of regions from which service consumers can access the service.
Tags Dictionary<string, string>
A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
AcceptanceRequired This property is required. bool
Whether or not VPC endpoint connection requests to the service must be accepted by the service owner - true or false.
AllowedPrincipals []string
The ARNs of one or more principals allowed to discover the endpoint service.
GatewayLoadBalancerArns []string
Amazon Resource Names (ARNs) of one or more Gateway Load Balancers for the endpoint service.
NetworkLoadBalancerArns []string
Amazon Resource Names (ARNs) of one or more Network Load Balancers for the endpoint service.
PrivateDnsName string
The private DNS name for the service.
SupportedIpAddressTypes []string
The supported IP address types. The possible values are ipv4 and ipv6.
SupportedRegions []string
The set of regions from which service consumers can access the service.
Tags map[string]string
A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
acceptanceRequired This property is required. Boolean
Whether or not VPC endpoint connection requests to the service must be accepted by the service owner - true or false.
allowedPrincipals List<String>
The ARNs of one or more principals allowed to discover the endpoint service.
gatewayLoadBalancerArns List<String>
Amazon Resource Names (ARNs) of one or more Gateway Load Balancers for the endpoint service.
networkLoadBalancerArns List<String>
Amazon Resource Names (ARNs) of one or more Network Load Balancers for the endpoint service.
privateDnsName String
The private DNS name for the service.
supportedIpAddressTypes List<String>
The supported IP address types. The possible values are ipv4 and ipv6.
supportedRegions List<String>
The set of regions from which service consumers can access the service.
tags Map<String,String>
A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
acceptanceRequired This property is required. boolean
Whether or not VPC endpoint connection requests to the service must be accepted by the service owner - true or false.
allowedPrincipals string[]
The ARNs of one or more principals allowed to discover the endpoint service.
gatewayLoadBalancerArns string[]
Amazon Resource Names (ARNs) of one or more Gateway Load Balancers for the endpoint service.
networkLoadBalancerArns string[]
Amazon Resource Names (ARNs) of one or more Network Load Balancers for the endpoint service.
privateDnsName string
The private DNS name for the service.
supportedIpAddressTypes string[]
The supported IP address types. The possible values are ipv4 and ipv6.
supportedRegions string[]
The set of regions from which service consumers can access the service.
tags {[key: string]: string}
A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
acceptance_required This property is required. bool
Whether or not VPC endpoint connection requests to the service must be accepted by the service owner - true or false.
allowed_principals Sequence[str]
The ARNs of one or more principals allowed to discover the endpoint service.
gateway_load_balancer_arns Sequence[str]
Amazon Resource Names (ARNs) of one or more Gateway Load Balancers for the endpoint service.
network_load_balancer_arns Sequence[str]
Amazon Resource Names (ARNs) of one or more Network Load Balancers for the endpoint service.
private_dns_name str
The private DNS name for the service.
supported_ip_address_types Sequence[str]
The supported IP address types. The possible values are ipv4 and ipv6.
supported_regions Sequence[str]
The set of regions from which service consumers can access the service.
tags Mapping[str, str]
A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
acceptanceRequired This property is required. Boolean
Whether or not VPC endpoint connection requests to the service must be accepted by the service owner - true or false.
allowedPrincipals List<String>
The ARNs of one or more principals allowed to discover the endpoint service.
gatewayLoadBalancerArns List<String>
Amazon Resource Names (ARNs) of one or more Gateway Load Balancers for the endpoint service.
networkLoadBalancerArns List<String>
Amazon Resource Names (ARNs) of one or more Network Load Balancers for the endpoint service.
privateDnsName String
The private DNS name for the service.
supportedIpAddressTypes List<String>
The supported IP address types. The possible values are ipv4 and ipv6.
supportedRegions List<String>
The set of regions from which service consumers can access the service.
tags Map<String>
A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Outputs

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

Arn string
The Amazon Resource Name (ARN) of the VPC endpoint service.
AvailabilityZones List<string>
A set of Availability Zones in which the service is available.
BaseEndpointDnsNames List<string>
A set of DNS names for the service.
Id string
The provider-assigned unique ID for this managed resource.
ManagesVpcEndpoints bool
Whether or not the service manages its VPC endpoints - true or false.
PrivateDnsNameConfigurations List<VpcEndpointServicePrivateDnsNameConfiguration>
List of objects containing information about the endpoint service private DNS name configuration.
ServiceName string
The service name.
ServiceType string
The service type, Gateway or Interface.
State string
Verification state of the VPC endpoint service. Consumers of the endpoint service can use the private name only when the state is verified.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Arn string
The Amazon Resource Name (ARN) of the VPC endpoint service.
AvailabilityZones []string
A set of Availability Zones in which the service is available.
BaseEndpointDnsNames []string
A set of DNS names for the service.
Id string
The provider-assigned unique ID for this managed resource.
ManagesVpcEndpoints bool
Whether or not the service manages its VPC endpoints - true or false.
PrivateDnsNameConfigurations []VpcEndpointServicePrivateDnsNameConfiguration
List of objects containing information about the endpoint service private DNS name configuration.
ServiceName string
The service name.
ServiceType string
The service type, Gateway or Interface.
State string
Verification state of the VPC endpoint service. Consumers of the endpoint service can use the private name only when the state is verified.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
The Amazon Resource Name (ARN) of the VPC endpoint service.
availabilityZones List<String>
A set of Availability Zones in which the service is available.
baseEndpointDnsNames List<String>
A set of DNS names for the service.
id String
The provider-assigned unique ID for this managed resource.
managesVpcEndpoints Boolean
Whether or not the service manages its VPC endpoints - true or false.
privateDnsNameConfigurations List<VpcEndpointServicePrivateDnsNameConfiguration>
List of objects containing information about the endpoint service private DNS name configuration.
serviceName String
The service name.
serviceType String
The service type, Gateway or Interface.
state String
Verification state of the VPC endpoint service. Consumers of the endpoint service can use the private name only when the state is verified.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn string
The Amazon Resource Name (ARN) of the VPC endpoint service.
availabilityZones string[]
A set of Availability Zones in which the service is available.
baseEndpointDnsNames string[]
A set of DNS names for the service.
id string
The provider-assigned unique ID for this managed resource.
managesVpcEndpoints boolean
Whether or not the service manages its VPC endpoints - true or false.
privateDnsNameConfigurations VpcEndpointServicePrivateDnsNameConfiguration[]
List of objects containing information about the endpoint service private DNS name configuration.
serviceName string
The service name.
serviceType string
The service type, Gateway or Interface.
state string
Verification state of the VPC endpoint service. Consumers of the endpoint service can use the private name only when the state is verified.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn str
The Amazon Resource Name (ARN) of the VPC endpoint service.
availability_zones Sequence[str]
A set of Availability Zones in which the service is available.
base_endpoint_dns_names Sequence[str]
A set of DNS names for the service.
id str
The provider-assigned unique ID for this managed resource.
manages_vpc_endpoints bool
Whether or not the service manages its VPC endpoints - true or false.
private_dns_name_configurations Sequence[VpcEndpointServicePrivateDnsNameConfiguration]
List of objects containing information about the endpoint service private DNS name configuration.
service_name str
The service name.
service_type str
The service type, Gateway or Interface.
state str
Verification state of the VPC endpoint service. Consumers of the endpoint service can use the private name only when the state is verified.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
The Amazon Resource Name (ARN) of the VPC endpoint service.
availabilityZones List<String>
A set of Availability Zones in which the service is available.
baseEndpointDnsNames List<String>
A set of DNS names for the service.
id String
The provider-assigned unique ID for this managed resource.
managesVpcEndpoints Boolean
Whether or not the service manages its VPC endpoints - true or false.
privateDnsNameConfigurations List<Property Map>
List of objects containing information about the endpoint service private DNS name configuration.
serviceName String
The service name.
serviceType String
The service type, Gateway or Interface.
state String
Verification state of the VPC endpoint service. Consumers of the endpoint service can use the private name only when the state is verified.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Look up Existing VpcEndpointService Resource

Get an existing VpcEndpointService resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: VpcEndpointServiceState, opts?: CustomResourceOptions): VpcEndpointService
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        acceptance_required: Optional[bool] = None,
        allowed_principals: Optional[Sequence[str]] = None,
        arn: Optional[str] = None,
        availability_zones: Optional[Sequence[str]] = None,
        base_endpoint_dns_names: Optional[Sequence[str]] = None,
        gateway_load_balancer_arns: Optional[Sequence[str]] = None,
        manages_vpc_endpoints: Optional[bool] = None,
        network_load_balancer_arns: Optional[Sequence[str]] = None,
        private_dns_name: Optional[str] = None,
        private_dns_name_configurations: Optional[Sequence[VpcEndpointServicePrivateDnsNameConfigurationArgs]] = None,
        service_name: Optional[str] = None,
        service_type: Optional[str] = None,
        state: Optional[str] = None,
        supported_ip_address_types: Optional[Sequence[str]] = None,
        supported_regions: Optional[Sequence[str]] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> VpcEndpointService
func GetVpcEndpointService(ctx *Context, name string, id IDInput, state *VpcEndpointServiceState, opts ...ResourceOption) (*VpcEndpointService, error)
public static VpcEndpointService Get(string name, Input<string> id, VpcEndpointServiceState? state, CustomResourceOptions? opts = null)
public static VpcEndpointService get(String name, Output<String> id, VpcEndpointServiceState state, CustomResourceOptions options)
resources:  _:    type: aws:ec2:VpcEndpointService    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AcceptanceRequired bool
Whether or not VPC endpoint connection requests to the service must be accepted by the service owner - true or false.
AllowedPrincipals List<string>
The ARNs of one or more principals allowed to discover the endpoint service.
Arn string
The Amazon Resource Name (ARN) of the VPC endpoint service.
AvailabilityZones List<string>
A set of Availability Zones in which the service is available.
BaseEndpointDnsNames List<string>
A set of DNS names for the service.
GatewayLoadBalancerArns List<string>
Amazon Resource Names (ARNs) of one or more Gateway Load Balancers for the endpoint service.
ManagesVpcEndpoints bool
Whether or not the service manages its VPC endpoints - true or false.
NetworkLoadBalancerArns List<string>
Amazon Resource Names (ARNs) of one or more Network Load Balancers for the endpoint service.
PrivateDnsName string
The private DNS name for the service.
PrivateDnsNameConfigurations List<VpcEndpointServicePrivateDnsNameConfiguration>
List of objects containing information about the endpoint service private DNS name configuration.
ServiceName string
The service name.
ServiceType string
The service type, Gateway or Interface.
State string
Verification state of the VPC endpoint service. Consumers of the endpoint service can use the private name only when the state is verified.
SupportedIpAddressTypes List<string>
The supported IP address types. The possible values are ipv4 and ipv6.
SupportedRegions List<string>
The set of regions from which service consumers can access the service.
Tags Dictionary<string, string>
A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

AcceptanceRequired bool
Whether or not VPC endpoint connection requests to the service must be accepted by the service owner - true or false.
AllowedPrincipals []string
The ARNs of one or more principals allowed to discover the endpoint service.
Arn string
The Amazon Resource Name (ARN) of the VPC endpoint service.
AvailabilityZones []string
A set of Availability Zones in which the service is available.
BaseEndpointDnsNames []string
A set of DNS names for the service.
GatewayLoadBalancerArns []string
Amazon Resource Names (ARNs) of one or more Gateway Load Balancers for the endpoint service.
ManagesVpcEndpoints bool
Whether or not the service manages its VPC endpoints - true or false.
NetworkLoadBalancerArns []string
Amazon Resource Names (ARNs) of one or more Network Load Balancers for the endpoint service.
PrivateDnsName string
The private DNS name for the service.
PrivateDnsNameConfigurations []VpcEndpointServicePrivateDnsNameConfigurationArgs
List of objects containing information about the endpoint service private DNS name configuration.
ServiceName string
The service name.
ServiceType string
The service type, Gateway or Interface.
State string
Verification state of the VPC endpoint service. Consumers of the endpoint service can use the private name only when the state is verified.
SupportedIpAddressTypes []string
The supported IP address types. The possible values are ipv4 and ipv6.
SupportedRegions []string
The set of regions from which service consumers can access the service.
Tags map[string]string
A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

acceptanceRequired Boolean
Whether or not VPC endpoint connection requests to the service must be accepted by the service owner - true or false.
allowedPrincipals List<String>
The ARNs of one or more principals allowed to discover the endpoint service.
arn String
The Amazon Resource Name (ARN) of the VPC endpoint service.
availabilityZones List<String>
A set of Availability Zones in which the service is available.
baseEndpointDnsNames List<String>
A set of DNS names for the service.
gatewayLoadBalancerArns List<String>
Amazon Resource Names (ARNs) of one or more Gateway Load Balancers for the endpoint service.
managesVpcEndpoints Boolean
Whether or not the service manages its VPC endpoints - true or false.
networkLoadBalancerArns List<String>
Amazon Resource Names (ARNs) of one or more Network Load Balancers for the endpoint service.
privateDnsName String
The private DNS name for the service.
privateDnsNameConfigurations List<VpcEndpointServicePrivateDnsNameConfiguration>
List of objects containing information about the endpoint service private DNS name configuration.
serviceName String
The service name.
serviceType String
The service type, Gateway or Interface.
state String
Verification state of the VPC endpoint service. Consumers of the endpoint service can use the private name only when the state is verified.
supportedIpAddressTypes List<String>
The supported IP address types. The possible values are ipv4 and ipv6.
supportedRegions List<String>
The set of regions from which service consumers can access the service.
tags Map<String,String>
A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

acceptanceRequired boolean
Whether or not VPC endpoint connection requests to the service must be accepted by the service owner - true or false.
allowedPrincipals string[]
The ARNs of one or more principals allowed to discover the endpoint service.
arn string
The Amazon Resource Name (ARN) of the VPC endpoint service.
availabilityZones string[]
A set of Availability Zones in which the service is available.
baseEndpointDnsNames string[]
A set of DNS names for the service.
gatewayLoadBalancerArns string[]
Amazon Resource Names (ARNs) of one or more Gateway Load Balancers for the endpoint service.
managesVpcEndpoints boolean
Whether or not the service manages its VPC endpoints - true or false.
networkLoadBalancerArns string[]
Amazon Resource Names (ARNs) of one or more Network Load Balancers for the endpoint service.
privateDnsName string
The private DNS name for the service.
privateDnsNameConfigurations VpcEndpointServicePrivateDnsNameConfiguration[]
List of objects containing information about the endpoint service private DNS name configuration.
serviceName string
The service name.
serviceType string
The service type, Gateway or Interface.
state string
Verification state of the VPC endpoint service. Consumers of the endpoint service can use the private name only when the state is verified.
supportedIpAddressTypes string[]
The supported IP address types. The possible values are ipv4 and ipv6.
supportedRegions string[]
The set of regions from which service consumers can access the service.
tags {[key: string]: string}
A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

acceptance_required bool
Whether or not VPC endpoint connection requests to the service must be accepted by the service owner - true or false.
allowed_principals Sequence[str]
The ARNs of one or more principals allowed to discover the endpoint service.
arn str
The Amazon Resource Name (ARN) of the VPC endpoint service.
availability_zones Sequence[str]
A set of Availability Zones in which the service is available.
base_endpoint_dns_names Sequence[str]
A set of DNS names for the service.
gateway_load_balancer_arns Sequence[str]
Amazon Resource Names (ARNs) of one or more Gateway Load Balancers for the endpoint service.
manages_vpc_endpoints bool
Whether or not the service manages its VPC endpoints - true or false.
network_load_balancer_arns Sequence[str]
Amazon Resource Names (ARNs) of one or more Network Load Balancers for the endpoint service.
private_dns_name str
The private DNS name for the service.
private_dns_name_configurations Sequence[VpcEndpointServicePrivateDnsNameConfigurationArgs]
List of objects containing information about the endpoint service private DNS name configuration.
service_name str
The service name.
service_type str
The service type, Gateway or Interface.
state str
Verification state of the VPC endpoint service. Consumers of the endpoint service can use the private name only when the state is verified.
supported_ip_address_types Sequence[str]
The supported IP address types. The possible values are ipv4 and ipv6.
supported_regions Sequence[str]
The set of regions from which service consumers can access the service.
tags Mapping[str, str]
A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

acceptanceRequired Boolean
Whether or not VPC endpoint connection requests to the service must be accepted by the service owner - true or false.
allowedPrincipals List<String>
The ARNs of one or more principals allowed to discover the endpoint service.
arn String
The Amazon Resource Name (ARN) of the VPC endpoint service.
availabilityZones List<String>
A set of Availability Zones in which the service is available.
baseEndpointDnsNames List<String>
A set of DNS names for the service.
gatewayLoadBalancerArns List<String>
Amazon Resource Names (ARNs) of one or more Gateway Load Balancers for the endpoint service.
managesVpcEndpoints Boolean
Whether or not the service manages its VPC endpoints - true or false.
networkLoadBalancerArns List<String>
Amazon Resource Names (ARNs) of one or more Network Load Balancers for the endpoint service.
privateDnsName String
The private DNS name for the service.
privateDnsNameConfigurations List<Property Map>
List of objects containing information about the endpoint service private DNS name configuration.
serviceName String
The service name.
serviceType String
The service type, Gateway or Interface.
state String
Verification state of the VPC endpoint service. Consumers of the endpoint service can use the private name only when the state is verified.
supportedIpAddressTypes List<String>
The supported IP address types. The possible values are ipv4 and ipv6.
supportedRegions List<String>
The set of regions from which service consumers can access the service.
tags Map<String>
A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Supporting Types

VpcEndpointServicePrivateDnsNameConfiguration
, VpcEndpointServicePrivateDnsNameConfigurationArgs

Name string
Name of the record subdomain the service provider needs to create.
State string
Verification state of the VPC endpoint service. Consumers of the endpoint service can use the private name only when the state is verified.
Type string
Endpoint service verification type, for example TXT.
Value string
Value the service provider adds to the private DNS name domain record before verification.
Name string
Name of the record subdomain the service provider needs to create.
State string
Verification state of the VPC endpoint service. Consumers of the endpoint service can use the private name only when the state is verified.
Type string
Endpoint service verification type, for example TXT.
Value string
Value the service provider adds to the private DNS name domain record before verification.
name String
Name of the record subdomain the service provider needs to create.
state String
Verification state of the VPC endpoint service. Consumers of the endpoint service can use the private name only when the state is verified.
type String
Endpoint service verification type, for example TXT.
value String
Value the service provider adds to the private DNS name domain record before verification.
name string
Name of the record subdomain the service provider needs to create.
state string
Verification state of the VPC endpoint service. Consumers of the endpoint service can use the private name only when the state is verified.
type string
Endpoint service verification type, for example TXT.
value string
Value the service provider adds to the private DNS name domain record before verification.
name str
Name of the record subdomain the service provider needs to create.
state str
Verification state of the VPC endpoint service. Consumers of the endpoint service can use the private name only when the state is verified.
type str
Endpoint service verification type, for example TXT.
value str
Value the service provider adds to the private DNS name domain record before verification.
name String
Name of the record subdomain the service provider needs to create.
state String
Verification state of the VPC endpoint service. Consumers of the endpoint service can use the private name only when the state is verified.
type String
Endpoint service verification type, for example TXT.
value String
Value the service provider adds to the private DNS name domain record before verification.

Import

Using pulumi import, import VPC Endpoint Services using the VPC endpoint service id. For example:

$ pulumi import aws:ec2/vpcEndpointService:VpcEndpointService foo vpce-svc-0f97a19d3fa8220bc
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws