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

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

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

Resource Type definition for AWS::EC2::VPCEndpointService

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: Optional[VpcEndpointServiceArgs] = None,
                       opts: Optional[ResourceOptions] = None)

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

type: aws-native: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 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 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 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 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.

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 bool
Indicates whether requests from service consumers to create an endpoint to your service must be accepted.
ContributorInsightsEnabled bool
Indicates whether to enable the built-in Contributor Insights rules provided by AWS PrivateLink .
GatewayLoadBalancerArns List<string>
The Amazon Resource Names (ARNs) of the Gateway Load Balancers.
NetworkLoadBalancerArns List<string>
The Amazon Resource Names (ARNs) of the Network Load Balancers.
PayerResponsibility string
The entity that is responsible for the endpoint costs. The default is the endpoint owner. If you set the payer responsibility to the service owner, you cannot set it back to the endpoint owner.
SupportedIpAddressTypes List<Pulumi.AwsNative.Ec2.VpcEndpointServiceIpAddressType>
Specify which Ip Address types are supported for VPC endpoint service.
SupportedRegions List<string>
The Regions from which service consumers can access the service.
Tags List<Pulumi.AwsNative.Inputs.Tag>
The tags to add to the VPC endpoint service.
AcceptanceRequired bool
Indicates whether requests from service consumers to create an endpoint to your service must be accepted.
ContributorInsightsEnabled bool
Indicates whether to enable the built-in Contributor Insights rules provided by AWS PrivateLink .
GatewayLoadBalancerArns []string
The Amazon Resource Names (ARNs) of the Gateway Load Balancers.
NetworkLoadBalancerArns []string
The Amazon Resource Names (ARNs) of the Network Load Balancers.
PayerResponsibility string
The entity that is responsible for the endpoint costs. The default is the endpoint owner. If you set the payer responsibility to the service owner, you cannot set it back to the endpoint owner.
SupportedIpAddressTypes []VpcEndpointServiceIpAddressType
Specify which Ip Address types are supported for VPC endpoint service.
SupportedRegions []string
The Regions from which service consumers can access the service.
Tags TagArgs
The tags to add to the VPC endpoint service.
acceptanceRequired Boolean
Indicates whether requests from service consumers to create an endpoint to your service must be accepted.
contributorInsightsEnabled Boolean
Indicates whether to enable the built-in Contributor Insights rules provided by AWS PrivateLink .
gatewayLoadBalancerArns List<String>
The Amazon Resource Names (ARNs) of the Gateway Load Balancers.
networkLoadBalancerArns List<String>
The Amazon Resource Names (ARNs) of the Network Load Balancers.
payerResponsibility String
The entity that is responsible for the endpoint costs. The default is the endpoint owner. If you set the payer responsibility to the service owner, you cannot set it back to the endpoint owner.
supportedIpAddressTypes List<VpcEndpointServiceIpAddressType>
Specify which Ip Address types are supported for VPC endpoint service.
supportedRegions List<String>
The Regions from which service consumers can access the service.
tags List<Tag>
The tags to add to the VPC endpoint service.
acceptanceRequired boolean
Indicates whether requests from service consumers to create an endpoint to your service must be accepted.
contributorInsightsEnabled boolean
Indicates whether to enable the built-in Contributor Insights rules provided by AWS PrivateLink .
gatewayLoadBalancerArns string[]
The Amazon Resource Names (ARNs) of the Gateway Load Balancers.
networkLoadBalancerArns string[]
The Amazon Resource Names (ARNs) of the Network Load Balancers.
payerResponsibility string
The entity that is responsible for the endpoint costs. The default is the endpoint owner. If you set the payer responsibility to the service owner, you cannot set it back to the endpoint owner.
supportedIpAddressTypes VpcEndpointServiceIpAddressType[]
Specify which Ip Address types are supported for VPC endpoint service.
supportedRegions string[]
The Regions from which service consumers can access the service.
tags Tag[]
The tags to add to the VPC endpoint service.
acceptance_required bool
Indicates whether requests from service consumers to create an endpoint to your service must be accepted.
contributor_insights_enabled bool
Indicates whether to enable the built-in Contributor Insights rules provided by AWS PrivateLink .
gateway_load_balancer_arns Sequence[str]
The Amazon Resource Names (ARNs) of the Gateway Load Balancers.
network_load_balancer_arns Sequence[str]
The Amazon Resource Names (ARNs) of the Network Load Balancers.
payer_responsibility str
The entity that is responsible for the endpoint costs. The default is the endpoint owner. If you set the payer responsibility to the service owner, you cannot set it back to the endpoint owner.
supported_ip_address_types Sequence[VpcEndpointServiceIpAddressType]
Specify which Ip Address types are supported for VPC endpoint service.
supported_regions Sequence[str]
The Regions from which service consumers can access the service.
tags Sequence[TagArgs]
The tags to add to the VPC endpoint service.
acceptanceRequired Boolean
Indicates whether requests from service consumers to create an endpoint to your service must be accepted.
contributorInsightsEnabled Boolean
Indicates whether to enable the built-in Contributor Insights rules provided by AWS PrivateLink .
gatewayLoadBalancerArns List<String>
The Amazon Resource Names (ARNs) of the Gateway Load Balancers.
networkLoadBalancerArns List<String>
The Amazon Resource Names (ARNs) of the Network Load Balancers.
payerResponsibility String
The entity that is responsible for the endpoint costs. The default is the endpoint owner. If you set the payer responsibility to the service owner, you cannot set it back to the endpoint owner.
supportedIpAddressTypes List<"ipv4" | "ipv6">
Specify which Ip Address types are supported for VPC endpoint service.
supportedRegions List<String>
The Regions from which service consumers can access the service.
tags List<Property Map>
The tags to add to the VPC endpoint service.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
ServiceId string
The ID of the endpoint service.
Id string
The provider-assigned unique ID for this managed resource.
ServiceId string
The ID of the endpoint service.
id String
The provider-assigned unique ID for this managed resource.
serviceId String
The ID of the endpoint service.
id string
The provider-assigned unique ID for this managed resource.
serviceId string
The ID of the endpoint service.
id str
The provider-assigned unique ID for this managed resource.
service_id str
The ID of the endpoint service.
id String
The provider-assigned unique ID for this managed resource.
serviceId String
The ID of the endpoint service.

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

VpcEndpointServiceIpAddressType
, VpcEndpointServiceIpAddressTypeArgs

Ipv4
ipv4
Ipv6
ipv6
VpcEndpointServiceIpAddressTypeIpv4
ipv4
VpcEndpointServiceIpAddressTypeIpv6
ipv6
Ipv4
ipv4
Ipv6
ipv6
Ipv4
ipv4
Ipv6
ipv6
IPV4
ipv4
IPV6
ipv6
"ipv4"
ipv4
"ipv6"
ipv6

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