aws.ec2.VpcEndpointService
Explore with Pulumi AI
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],
});
import pulumi
import pulumi_aws as aws
example = aws.ec2.VpcEndpointService("example",
acceptance_required=False,
network_load_balancer_arns=[example_aws_lb["arn"]])
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
})
}
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,
},
});
});
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());
}
}
resources:
example:
type: aws:ec2:VpcEndpointService
properties:
acceptanceRequired: false
networkLoadBalancerArns:
- ${exampleAwsLb.arn}
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],
});
import pulumi
import pulumi_aws as aws
example = aws.ec2.VpcEndpointService("example",
acceptance_required=False,
gateway_load_balancer_arns=[example_aws_lb["arn"]])
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
})
}
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,
},
});
});
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());
}
}
resources:
example:
type: aws:ec2:VpcEndpointService
properties:
acceptanceRequired: false
gatewayLoadBalancerArns:
- ${exampleAwsLb.arn}
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,
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 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 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 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 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 String
- The unique name of the resource.
- args 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",
},
Tags =
{
{ "string", "string" },
},
});
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"),
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var vpcEndpointServiceResource = new VpcEndpointService("vpcEndpointServiceResource", VpcEndpointServiceArgs.builder()
.acceptanceRequired(false)
.allowedPrincipals("string")
.gatewayLoadBalancerArns("string")
.networkLoadBalancerArns("string")
.privateDnsName("string")
.supportedIpAddressTypes("string")
.tags(Map.of("string", "string"))
.build());
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"],
tags={
"string": "string",
})
const vpcEndpointServiceResource = new aws.ec2.VpcEndpointService("vpcEndpointServiceResource", {
acceptanceRequired: false,
allowedPrincipals: ["string"],
gatewayLoadBalancerArns: ["string"],
networkLoadBalancerArns: ["string"],
privateDnsName: "string",
supportedIpAddressTypes: ["string"],
tags: {
string: "string",
},
});
type: aws:ec2:VpcEndpointService
properties:
acceptanceRequired: false
allowedPrincipals:
- string
gatewayLoadBalancerArns:
- string
networkLoadBalancerArns:
- string
privateDnsName: string
supportedIpAddressTypes:
- string
tags:
string: string
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:
- Acceptance
Required bool - Whether or not VPC endpoint connection requests to the service must be accepted by the service owner -
true
orfalse
. - Allowed
Principals List<string> - The ARNs of one or more principals allowed to discover the endpoint service.
- Gateway
Load List<string>Balancer Arns - Amazon Resource Names (ARNs) of one or more Gateway Load Balancers for the endpoint service.
- Network
Load List<string>Balancer Arns - Amazon Resource Names (ARNs) of one or more Network Load Balancers for the endpoint service.
- Private
Dns stringName - The private DNS name for the service.
- Supported
Ip List<string>Address Types - The supported IP address types. The possible values are
ipv4
andipv6
. - 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.
- Acceptance
Required bool - Whether or not VPC endpoint connection requests to the service must be accepted by the service owner -
true
orfalse
. - Allowed
Principals []string - The ARNs of one or more principals allowed to discover the endpoint service.
- Gateway
Load []stringBalancer Arns - Amazon Resource Names (ARNs) of one or more Gateway Load Balancers for the endpoint service.
- Network
Load []stringBalancer Arns - Amazon Resource Names (ARNs) of one or more Network Load Balancers for the endpoint service.
- Private
Dns stringName - The private DNS name for the service.
- Supported
Ip []stringAddress Types - The supported IP address types. The possible values are
ipv4
andipv6
. - 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.
- acceptance
Required Boolean - Whether or not VPC endpoint connection requests to the service must be accepted by the service owner -
true
orfalse
. - allowed
Principals List<String> - The ARNs of one or more principals allowed to discover the endpoint service.
- gateway
Load List<String>Balancer Arns - Amazon Resource Names (ARNs) of one or more Gateway Load Balancers for the endpoint service.
- network
Load List<String>Balancer Arns - Amazon Resource Names (ARNs) of one or more Network Load Balancers for the endpoint service.
- private
Dns StringName - The private DNS name for the service.
- supported
Ip List<String>Address Types - The supported IP address types. The possible values are
ipv4
andipv6
. - 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.
- acceptance
Required boolean - Whether or not VPC endpoint connection requests to the service must be accepted by the service owner -
true
orfalse
. - allowed
Principals string[] - The ARNs of one or more principals allowed to discover the endpoint service.
- gateway
Load string[]Balancer Arns - Amazon Resource Names (ARNs) of one or more Gateway Load Balancers for the endpoint service.
- network
Load string[]Balancer Arns - Amazon Resource Names (ARNs) of one or more Network Load Balancers for the endpoint service.
- private
Dns stringName - The private DNS name for the service.
- supported
Ip string[]Address Types - The supported IP address types. The possible values are
ipv4
andipv6
. - {[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 bool - Whether or not VPC endpoint connection requests to the service must be accepted by the service owner -
true
orfalse
. - allowed_
principals Sequence[str] - The ARNs of one or more principals allowed to discover the endpoint service.
- gateway_
load_ Sequence[str]balancer_ arns - Amazon Resource Names (ARNs) of one or more Gateway Load Balancers for the endpoint service.
- network_
load_ Sequence[str]balancer_ arns - Amazon Resource Names (ARNs) of one or more Network Load Balancers for the endpoint service.
- private_
dns_ strname - The private DNS name for the service.
- supported_
ip_ Sequence[str]address_ types - The supported IP address types. The possible values are
ipv4
andipv6
. - 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.
- acceptance
Required Boolean - Whether or not VPC endpoint connection requests to the service must be accepted by the service owner -
true
orfalse
. - allowed
Principals List<String> - The ARNs of one or more principals allowed to discover the endpoint service.
- gateway
Load List<String>Balancer Arns - Amazon Resource Names (ARNs) of one or more Gateway Load Balancers for the endpoint service.
- network
Load List<String>Balancer Arns - Amazon Resource Names (ARNs) of one or more Network Load Balancers for the endpoint service.
- private
Dns StringName - The private DNS name for the service.
- supported
Ip List<String>Address Types - The supported IP address types. The possible values are
ipv4
andipv6
. - 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.
- Availability
Zones List<string> - A set of Availability Zones in which the service is available.
- Base
Endpoint List<string>Dns Names - A set of DNS names for the service.
- Id string
- The provider-assigned unique ID for this managed resource.
- Manages
Vpc boolEndpoints - Whether or not the service manages its VPC endpoints -
true
orfalse
. - Private
Dns List<VpcName Configurations Endpoint Service Private Dns Name Configuration> - List of objects containing information about the endpoint service private DNS name configuration.
- Service
Name string - The service name.
- Service
Type string - The service type,
Gateway
orInterface
. - 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
. - Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- Arn string
- The Amazon Resource Name (ARN) of the VPC endpoint service.
- Availability
Zones []string - A set of Availability Zones in which the service is available.
- Base
Endpoint []stringDns Names - A set of DNS names for the service.
- Id string
- The provider-assigned unique ID for this managed resource.
- Manages
Vpc boolEndpoints - Whether or not the service manages its VPC endpoints -
true
orfalse
. - Private
Dns []VpcName Configurations Endpoint Service Private Dns Name Configuration - List of objects containing information about the endpoint service private DNS name configuration.
- Service
Name string - The service name.
- Service
Type string - The service type,
Gateway
orInterface
. - 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
. - map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn String
- The Amazon Resource Name (ARN) of the VPC endpoint service.
- availability
Zones List<String> - A set of Availability Zones in which the service is available.
- base
Endpoint List<String>Dns Names - A set of DNS names for the service.
- id String
- The provider-assigned unique ID for this managed resource.
- manages
Vpc BooleanEndpoints - Whether or not the service manages its VPC endpoints -
true
orfalse
. - private
Dns List<VpcName Configurations Endpoint Service Private Dns Name Configuration> - List of objects containing information about the endpoint service private DNS name configuration.
- service
Name String - The service name.
- service
Type String - The service type,
Gateway
orInterface
. - 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
. - Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn string
- The Amazon Resource Name (ARN) of the VPC endpoint service.
- availability
Zones string[] - A set of Availability Zones in which the service is available.
- base
Endpoint string[]Dns Names - A set of DNS names for the service.
- id string
- The provider-assigned unique ID for this managed resource.
- manages
Vpc booleanEndpoints - Whether or not the service manages its VPC endpoints -
true
orfalse
. - private
Dns VpcName Configurations Endpoint Service Private Dns Name Configuration[] - List of objects containing information about the endpoint service private DNS name configuration.
- service
Name string - The service name.
- service
Type string - The service type,
Gateway
orInterface
. - 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
. - {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- 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_ Sequence[str]dns_ names - A set of DNS names for the service.
- id str
- The provider-assigned unique ID for this managed resource.
- manages_
vpc_ boolendpoints - Whether or not the service manages its VPC endpoints -
true
orfalse
. - private_
dns_ Sequence[Vpcname_ configurations Endpoint Service Private Dns Name Configuration] - 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
orInterface
. - 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
. - Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn String
- The Amazon Resource Name (ARN) of the VPC endpoint service.
- availability
Zones List<String> - A set of Availability Zones in which the service is available.
- base
Endpoint List<String>Dns Names - A set of DNS names for the service.
- id String
- The provider-assigned unique ID for this managed resource.
- manages
Vpc BooleanEndpoints - Whether or not the service manages its VPC endpoints -
true
orfalse
. - private
Dns List<Property Map>Name Configurations - List of objects containing information about the endpoint service private DNS name configuration.
- service
Name String - The service name.
- service
Type String - The service type,
Gateway
orInterface
. - 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
. - Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
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,
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)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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.
- Acceptance
Required bool - Whether or not VPC endpoint connection requests to the service must be accepted by the service owner -
true
orfalse
. - Allowed
Principals 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.
- Availability
Zones List<string> - A set of Availability Zones in which the service is available.
- Base
Endpoint List<string>Dns Names - A set of DNS names for the service.
- Gateway
Load List<string>Balancer Arns - Amazon Resource Names (ARNs) of one or more Gateway Load Balancers for the endpoint service.
- Manages
Vpc boolEndpoints - Whether or not the service manages its VPC endpoints -
true
orfalse
. - Network
Load List<string>Balancer Arns - Amazon Resource Names (ARNs) of one or more Network Load Balancers for the endpoint service.
- Private
Dns stringName - The private DNS name for the service.
- Private
Dns List<VpcName Configurations Endpoint Service Private Dns Name Configuration> - List of objects containing information about the endpoint service private DNS name configuration.
- Service
Name string - The service name.
- Service
Type string - The service type,
Gateway
orInterface
. - 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
. - Supported
Ip List<string>Address Types - The supported IP address types. The possible values are
ipv4
andipv6
. - 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. - Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- Acceptance
Required bool - Whether or not VPC endpoint connection requests to the service must be accepted by the service owner -
true
orfalse
. - Allowed
Principals []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.
- Availability
Zones []string - A set of Availability Zones in which the service is available.
- Base
Endpoint []stringDns Names - A set of DNS names for the service.
- Gateway
Load []stringBalancer Arns - Amazon Resource Names (ARNs) of one or more Gateway Load Balancers for the endpoint service.
- Manages
Vpc boolEndpoints - Whether or not the service manages its VPC endpoints -
true
orfalse
. - Network
Load []stringBalancer Arns - Amazon Resource Names (ARNs) of one or more Network Load Balancers for the endpoint service.
- Private
Dns stringName - The private DNS name for the service.
- Private
Dns []VpcName Configurations Endpoint Service Private Dns Name Configuration Args - List of objects containing information about the endpoint service private DNS name configuration.
- Service
Name string - The service name.
- Service
Type string - The service type,
Gateway
orInterface
. - 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
. - Supported
Ip []stringAddress Types - The supported IP address types. The possible values are
ipv4
andipv6
. - 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. - map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- acceptance
Required Boolean - Whether or not VPC endpoint connection requests to the service must be accepted by the service owner -
true
orfalse
. - allowed
Principals 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.
- availability
Zones List<String> - A set of Availability Zones in which the service is available.
- base
Endpoint List<String>Dns Names - A set of DNS names for the service.
- gateway
Load List<String>Balancer Arns - Amazon Resource Names (ARNs) of one or more Gateway Load Balancers for the endpoint service.
- manages
Vpc BooleanEndpoints - Whether or not the service manages its VPC endpoints -
true
orfalse
. - network
Load List<String>Balancer Arns - Amazon Resource Names (ARNs) of one or more Network Load Balancers for the endpoint service.
- private
Dns StringName - The private DNS name for the service.
- private
Dns List<VpcName Configurations Endpoint Service Private Dns Name Configuration> - List of objects containing information about the endpoint service private DNS name configuration.
- service
Name String - The service name.
- service
Type String - The service type,
Gateway
orInterface
. - 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
. - supported
Ip List<String>Address Types - The supported IP address types. The possible values are
ipv4
andipv6
. - 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. - Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- acceptance
Required boolean - Whether or not VPC endpoint connection requests to the service must be accepted by the service owner -
true
orfalse
. - allowed
Principals 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.
- availability
Zones string[] - A set of Availability Zones in which the service is available.
- base
Endpoint string[]Dns Names - A set of DNS names for the service.
- gateway
Load string[]Balancer Arns - Amazon Resource Names (ARNs) of one or more Gateway Load Balancers for the endpoint service.
- manages
Vpc booleanEndpoints - Whether or not the service manages its VPC endpoints -
true
orfalse
. - network
Load string[]Balancer Arns - Amazon Resource Names (ARNs) of one or more Network Load Balancers for the endpoint service.
- private
Dns stringName - The private DNS name for the service.
- private
Dns VpcName Configurations Endpoint Service Private Dns Name Configuration[] - List of objects containing information about the endpoint service private DNS name configuration.
- service
Name string - The service name.
- service
Type string - The service type,
Gateway
orInterface
. - 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
. - supported
Ip string[]Address Types - The supported IP address types. The possible values are
ipv4
andipv6
. - {[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. - {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- acceptance_
required bool - Whether or not VPC endpoint connection requests to the service must be accepted by the service owner -
true
orfalse
. - 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_ Sequence[str]dns_ names - A set of DNS names for the service.
- gateway_
load_ Sequence[str]balancer_ arns - Amazon Resource Names (ARNs) of one or more Gateway Load Balancers for the endpoint service.
- manages_
vpc_ boolendpoints - Whether or not the service manages its VPC endpoints -
true
orfalse
. - network_
load_ Sequence[str]balancer_ arns - Amazon Resource Names (ARNs) of one or more Network Load Balancers for the endpoint service.
- private_
dns_ strname - The private DNS name for the service.
- private_
dns_ Sequence[Vpcname_ configurations Endpoint Service Private Dns Name Configuration Args] - 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
orInterface
. - 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_ Sequence[str]address_ types - The supported IP address types. The possible values are
ipv4
andipv6
. - 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. - Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- acceptance
Required Boolean - Whether or not VPC endpoint connection requests to the service must be accepted by the service owner -
true
orfalse
. - allowed
Principals 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.
- availability
Zones List<String> - A set of Availability Zones in which the service is available.
- base
Endpoint List<String>Dns Names - A set of DNS names for the service.
- gateway
Load List<String>Balancer Arns - Amazon Resource Names (ARNs) of one or more Gateway Load Balancers for the endpoint service.
- manages
Vpc BooleanEndpoints - Whether or not the service manages its VPC endpoints -
true
orfalse
. - network
Load List<String>Balancer Arns - Amazon Resource Names (ARNs) of one or more Network Load Balancers for the endpoint service.
- private
Dns StringName - The private DNS name for the service.
- private
Dns List<Property Map>Name Configurations - List of objects containing information about the endpoint service private DNS name configuration.
- service
Name String - The service name.
- service
Type String - The service type,
Gateway
orInterface
. - 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
. - supported
Ip List<String>Address Types - The supported IP address types. The possible values are
ipv4
andipv6
. - 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. - Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
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
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.