Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. ec2
  5. getVpcEndpointService

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

aws.ec2.getVpcEndpointService

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

    The VPC Endpoint Service data source details about a specific service that can be specified when creating a VPC endpoint within the region configured in the provider.

    Example Usage

    AWS Service

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

// Declare the data source
const s3 = aws.ec2.getVpcEndpointService({
    service: "s3",
    serviceType: "Gateway",
});
// Create a VPC
const foo = new aws.ec2.Vpc("foo", {cidrBlock: "10.0.0.0/16"});
// Create a VPC endpoint
const ep = new aws.ec2.VpcEndpoint("ep", {
    vpcId: foo.id,
    serviceName: s3.then(s3 => s3.serviceName),
});

    import pulumi
import pulumi_aws as aws

# Declare the data source
s3 = aws.ec2.get_vpc_endpoint_service(service="s3",
    service_type="Gateway")
# Create a VPC
foo = aws.ec2.Vpc("foo", cidr_block="10.0.0.0/16")
# Create a VPC endpoint
ep = aws.ec2.VpcEndpoint("ep",
    vpc_id=foo.id,
    service_name=s3.service_name)

    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 {
		// Declare the data source
		s3, err := ec2.LookupVpcEndpointService(ctx, &ec2.LookupVpcEndpointServiceArgs{
			Service:     pulumi.StringRef("s3"),
			ServiceType: pulumi.StringRef("Gateway"),
		}, nil)
		if err != nil {
			return err
		}
		// Create a VPC
		foo, err := ec2.NewVpc(ctx, "foo", &ec2.VpcArgs{
			CidrBlock: pulumi.String("10.0.0.0/16"),
		})
		if err != nil {
			return err
		}
		// Create a VPC endpoint
		_, err = ec2.NewVpcEndpoint(ctx, "ep", &ec2.VpcEndpointArgs{
			VpcId:       foo.ID(),
			ServiceName: pulumi.String(s3.ServiceName),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    // Declare the data source
    var s3 = Aws.Ec2.GetVpcEndpointService.Invoke(new()
    {
        Service = "s3",
        ServiceType = "Gateway",
    });

    // Create a VPC
    var foo = new Aws.Ec2.Vpc("foo", new()
    {
        CidrBlock = "10.0.0.0/16",
    });

    // Create a VPC endpoint
    var ep = new Aws.Ec2.VpcEndpoint("ep", new()
    {
        VpcId = foo.Id,
        ServiceName = s3.Apply(getVpcEndpointServiceResult => getVpcEndpointServiceResult.ServiceName),
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.Ec2Functions;
import com.pulumi.aws.ec2.inputs.GetVpcEndpointServiceArgs;
import com.pulumi.aws.ec2.Vpc;
import com.pulumi.aws.ec2.VpcArgs;
import com.pulumi.aws.ec2.VpcEndpoint;
import com.pulumi.aws.ec2.VpcEndpointArgs;
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) {
        // Declare the data source
        final var s3 = Ec2Functions.getVpcEndpointService(GetVpcEndpointServiceArgs.builder()
            .service("s3")
            .serviceType("Gateway")
            .build());

        // Create a VPC
        var foo = new Vpc("foo", VpcArgs.builder()
            .cidrBlock("10.0.0.0/16")
            .build());

        // Create a VPC endpoint
        var ep = new VpcEndpoint("ep", VpcEndpointArgs.builder()
            .vpcId(foo.id())
            .serviceName(s3.applyValue(getVpcEndpointServiceResult -> getVpcEndpointServiceResult.serviceName()))
            .build());

    }
}

    resources:
  # Create a VPC
  foo:
    type: aws:ec2:Vpc
    properties:
      cidrBlock: 10.0.0.0/16
  # Create a VPC endpoint
  ep:
    type: aws:ec2:VpcEndpoint
    properties:
      vpcId: ${foo.id}
      serviceName: ${s3.serviceName}
variables:
  # Declare the data source
  s3:
    fn::invoke:
      Function: aws:ec2:getVpcEndpointService
      Arguments:
        service: s3
        serviceType: Gateway

    Non-AWS Service

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

const custome = aws.ec2.getVpcEndpointService({
    serviceName: "com.amazonaws.vpce.us-west-2.vpce-svc-0e87519c997c63cd8",
});

    import pulumi
import pulumi_aws as aws

custome = aws.ec2.get_vpc_endpoint_service(service_name="com.amazonaws.vpce.us-west-2.vpce-svc-0e87519c997c63cd8")

    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.LookupVpcEndpointService(ctx, &ec2.LookupVpcEndpointServiceArgs{
			ServiceName: pulumi.StringRef("com.amazonaws.vpce.us-west-2.vpce-svc-0e87519c997c63cd8"),
		}, nil)
		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 custome = Aws.Ec2.GetVpcEndpointService.Invoke(new()
    {
        ServiceName = "com.amazonaws.vpce.us-west-2.vpce-svc-0e87519c997c63cd8",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.Ec2Functions;
import com.pulumi.aws.ec2.inputs.GetVpcEndpointServiceArgs;
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) {
        final var custome = Ec2Functions.getVpcEndpointService(GetVpcEndpointServiceArgs.builder()
            .serviceName("com.amazonaws.vpce.us-west-2.vpce-svc-0e87519c997c63cd8")
            .build());

    }
}

    variables:
  custome:
    fn::invoke:
      Function: aws:ec2:getVpcEndpointService
      Arguments:
        serviceName: com.amazonaws.vpce.us-west-2.vpce-svc-0e87519c997c63cd8

    Filter

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

const test = aws.ec2.getVpcEndpointService({
    filters: [{
        name: "service-name",
        values: ["some-service"],
    }],
});

    import pulumi
import pulumi_aws as aws

test = aws.ec2.get_vpc_endpoint_service(filters=[{
    "name": "service-name",
    "values": ["some-service"],
}])

    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.LookupVpcEndpointService(ctx, &ec2.LookupVpcEndpointServiceArgs{
			Filters: []ec2.GetVpcEndpointServiceFilter{
				{
					Name: "service-name",
					Values: []string{
						"some-service",
					},
				},
			},
		}, nil)
		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 test = Aws.Ec2.GetVpcEndpointService.Invoke(new()
    {
        Filters = new[]
        {
            new Aws.Ec2.Inputs.GetVpcEndpointServiceFilterInputArgs
            {
                Name = "service-name",
                Values = new[]
                {
                    "some-service",
                },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.Ec2Functions;
import com.pulumi.aws.ec2.inputs.GetVpcEndpointServiceArgs;
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) {
        final var test = Ec2Functions.getVpcEndpointService(GetVpcEndpointServiceArgs.builder()
            .filters(GetVpcEndpointServiceFilterArgs.builder()
                .name("service-name")
                .values("some-service")
                .build())
            .build());

    }
}

    variables:
  test:
    fn::invoke:
      Function: aws:ec2:getVpcEndpointService
      Arguments:
        filters:
          - name: service-name
            values:
              - some-service

    Using getVpcEndpointService

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getVpcEndpointService(args: GetVpcEndpointServiceArgs, opts?: InvokeOptions): Promise<GetVpcEndpointServiceResult>
function getVpcEndpointServiceOutput(args: GetVpcEndpointServiceOutputArgs, opts?: InvokeOptions): Output<GetVpcEndpointServiceResult>
    def get_vpc_endpoint_service(filters: Optional[Sequence[GetVpcEndpointServiceFilter]] = None,
                             service: Optional[str] = None,
                             service_name: Optional[str] = None,
                             service_type: Optional[str] = None,
                             tags: Optional[Mapping[str, str]] = None,
                             opts: Optional[InvokeOptions] = None) -> GetVpcEndpointServiceResult
def get_vpc_endpoint_service_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetVpcEndpointServiceFilterArgs]]]] = None,
                             service: Optional[pulumi.Input[str]] = None,
                             service_name: Optional[pulumi.Input[str]] = None,
                             service_type: Optional[pulumi.Input[str]] = None,
                             tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetVpcEndpointServiceResult]
    func LookupVpcEndpointService(ctx *Context, args *LookupVpcEndpointServiceArgs, opts ...InvokeOption) (*LookupVpcEndpointServiceResult, error)
func LookupVpcEndpointServiceOutput(ctx *Context, args *LookupVpcEndpointServiceOutputArgs, opts ...InvokeOption) LookupVpcEndpointServiceResultOutput

    > Note: This function is named LookupVpcEndpointService in the Go SDK.

    public static class GetVpcEndpointService 
{
    public static Task<GetVpcEndpointServiceResult> InvokeAsync(GetVpcEndpointServiceArgs args, InvokeOptions? opts = null)
    public static Output<GetVpcEndpointServiceResult> Invoke(GetVpcEndpointServiceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVpcEndpointServiceResult> getVpcEndpointService(GetVpcEndpointServiceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws:ec2/getVpcEndpointService:getVpcEndpointService
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Filters List<GetVpcEndpointServiceFilter>
    Configuration block(s) for filtering. Detailed below.
    Service string
    Common name of an AWS service (e.g., s3).
    ServiceName string
    Service name that is specified when creating a VPC endpoint. For AWS services the service name is usually in the form com.amazonaws.<region>.<service> (the SageMaker Notebook service is an exception to this rule, the service name is in the form aws.sagemaker.<region>.notebook).
    ServiceType string
    Service type, Gateway or Interface.
    Tags Dictionary<string, string>

    Map of tags, each pair of which must exactly match a pair on the desired VPC Endpoint Service.

    NOTE: Specifying service will not work for non-AWS services or AWS services that don't follow the standard service_name pattern of com.amazonaws.<region>.<service>.

    Filters []GetVpcEndpointServiceFilter
    Configuration block(s) for filtering. Detailed below.
    Service string
    Common name of an AWS service (e.g., s3).
    ServiceName string
    Service name that is specified when creating a VPC endpoint. For AWS services the service name is usually in the form com.amazonaws.<region>.<service> (the SageMaker Notebook service is an exception to this rule, the service name is in the form aws.sagemaker.<region>.notebook).
    ServiceType string
    Service type, Gateway or Interface.
    Tags map[string]string

    Map of tags, each pair of which must exactly match a pair on the desired VPC Endpoint Service.

    NOTE: Specifying service will not work for non-AWS services or AWS services that don't follow the standard service_name pattern of com.amazonaws.<region>.<service>.

    filters List<GetVpcEndpointServiceFilter>
    Configuration block(s) for filtering. Detailed below.
    service String
    Common name of an AWS service (e.g., s3).
    serviceName String
    Service name that is specified when creating a VPC endpoint. For AWS services the service name is usually in the form com.amazonaws.<region>.<service> (the SageMaker Notebook service is an exception to this rule, the service name is in the form aws.sagemaker.<region>.notebook).
    serviceType String
    Service type, Gateway or Interface.
    tags Map<String,String>

    Map of tags, each pair of which must exactly match a pair on the desired VPC Endpoint Service.

    NOTE: Specifying service will not work for non-AWS services or AWS services that don't follow the standard service_name pattern of com.amazonaws.<region>.<service>.

    filters GetVpcEndpointServiceFilter[]
    Configuration block(s) for filtering. Detailed below.
    service string
    Common name of an AWS service (e.g., s3).
    serviceName string
    Service name that is specified when creating a VPC endpoint. For AWS services the service name is usually in the form com.amazonaws.<region>.<service> (the SageMaker Notebook service is an exception to this rule, the service name is in the form aws.sagemaker.<region>.notebook).
    serviceType string
    Service type, Gateway or Interface.
    tags {[key: string]: string}

    Map of tags, each pair of which must exactly match a pair on the desired VPC Endpoint Service.

    NOTE: Specifying service will not work for non-AWS services or AWS services that don't follow the standard service_name pattern of com.amazonaws.<region>.<service>.

    filters Sequence[GetVpcEndpointServiceFilter]
    Configuration block(s) for filtering. Detailed below.
    service str
    Common name of an AWS service (e.g., s3).
    service_name str
    Service name that is specified when creating a VPC endpoint. For AWS services the service name is usually in the form com.amazonaws.<region>.<service> (the SageMaker Notebook service is an exception to this rule, the service name is in the form aws.sagemaker.<region>.notebook).
    service_type str
    Service type, Gateway or Interface.
    tags Mapping[str, str]

    Map of tags, each pair of which must exactly match a pair on the desired VPC Endpoint Service.

    NOTE: Specifying service will not work for non-AWS services or AWS services that don't follow the standard service_name pattern of com.amazonaws.<region>.<service>.

    filters List<Property Map>
    Configuration block(s) for filtering. Detailed below.
    service String
    Common name of an AWS service (e.g., s3).
    serviceName String
    Service name that is specified when creating a VPC endpoint. For AWS services the service name is usually in the form com.amazonaws.<region>.<service> (the SageMaker Notebook service is an exception to this rule, the service name is in the form aws.sagemaker.<region>.notebook).
    serviceType String
    Service type, Gateway or Interface.
    tags Map<String>

    Map of tags, each pair of which must exactly match a pair on the desired VPC Endpoint Service.

    NOTE: Specifying service will not work for non-AWS services or AWS services that don't follow the standard service_name pattern of com.amazonaws.<region>.<service>.

    getVpcEndpointService Result

    The following output properties are available:

    AcceptanceRequired bool
    Whether or not VPC endpoint connection requests to the service must be accepted by the service owner - true or false.
    Arn string
    ARN of the VPC endpoint service.
    AvailabilityZones List<string>
    Availability Zones in which the service is available.
    BaseEndpointDnsNames List<string>
    The 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.
    Owner string
    AWS account ID of the service owner or amazon.
    PrivateDnsName string
    Private DNS name for the service.
    ServiceId string
    ID of the endpoint service.
    ServiceName string
    ServiceType string
    SupportedIpAddressTypes List<string>
    The supported IP address types.
    Tags Dictionary<string, string>
    Map of tags assigned to the resource.
    VpcEndpointPolicySupported bool
    Whether or not the service supports endpoint policies - true or false.
    Filters List<GetVpcEndpointServiceFilter>
    Service string
    AcceptanceRequired bool
    Whether or not VPC endpoint connection requests to the service must be accepted by the service owner - true or false.
    Arn string
    ARN of the VPC endpoint service.
    AvailabilityZones []string
    Availability Zones in which the service is available.
    BaseEndpointDnsNames []string
    The 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.
    Owner string
    AWS account ID of the service owner or amazon.
    PrivateDnsName string
    Private DNS name for the service.
    ServiceId string
    ID of the endpoint service.
    ServiceName string
    ServiceType string
    SupportedIpAddressTypes []string
    The supported IP address types.
    Tags map[string]string
    Map of tags assigned to the resource.
    VpcEndpointPolicySupported bool
    Whether or not the service supports endpoint policies - true or false.
    Filters []GetVpcEndpointServiceFilter
    Service string
    acceptanceRequired Boolean
    Whether or not VPC endpoint connection requests to the service must be accepted by the service owner - true or false.
    arn String
    ARN of the VPC endpoint service.
    availabilityZones List<String>
    Availability Zones in which the service is available.
    baseEndpointDnsNames List<String>
    The 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.
    owner String
    AWS account ID of the service owner or amazon.
    privateDnsName String
    Private DNS name for the service.
    serviceId String
    ID of the endpoint service.
    serviceName String
    serviceType String
    supportedIpAddressTypes List<String>
    The supported IP address types.
    tags Map<String,String>
    Map of tags assigned to the resource.
    vpcEndpointPolicySupported Boolean
    Whether or not the service supports endpoint policies - true or false.
    filters List<GetVpcEndpointServiceFilter>
    service String
    acceptanceRequired boolean
    Whether or not VPC endpoint connection requests to the service must be accepted by the service owner - true or false.
    arn string
    ARN of the VPC endpoint service.
    availabilityZones string[]
    Availability Zones in which the service is available.
    baseEndpointDnsNames string[]
    The 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.
    owner string
    AWS account ID of the service owner or amazon.
    privateDnsName string
    Private DNS name for the service.
    serviceId string
    ID of the endpoint service.
    serviceName string
    serviceType string
    supportedIpAddressTypes string[]
    The supported IP address types.
    tags {[key: string]: string}
    Map of tags assigned to the resource.
    vpcEndpointPolicySupported boolean
    Whether or not the service supports endpoint policies - true or false.
    filters GetVpcEndpointServiceFilter[]
    service string
    acceptance_required bool
    Whether or not VPC endpoint connection requests to the service must be accepted by the service owner - true or false.
    arn str
    ARN of the VPC endpoint service.
    availability_zones Sequence[str]
    Availability Zones in which the service is available.
    base_endpoint_dns_names Sequence[str]
    The 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.
    owner str
    AWS account ID of the service owner or amazon.
    private_dns_name str
    Private DNS name for the service.
    service_id str
    ID of the endpoint service.
    service_name str
    service_type str
    supported_ip_address_types Sequence[str]
    The supported IP address types.
    tags Mapping[str, str]
    Map of tags assigned to the resource.
    vpc_endpoint_policy_supported bool
    Whether or not the service supports endpoint policies - true or false.
    filters Sequence[GetVpcEndpointServiceFilter]
    service str
    acceptanceRequired Boolean
    Whether or not VPC endpoint connection requests to the service must be accepted by the service owner - true or false.
    arn String
    ARN of the VPC endpoint service.
    availabilityZones List<String>
    Availability Zones in which the service is available.
    baseEndpointDnsNames List<String>
    The 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.
    owner String
    AWS account ID of the service owner or amazon.
    privateDnsName String
    Private DNS name for the service.
    serviceId String
    ID of the endpoint service.
    serviceName String
    serviceType String
    supportedIpAddressTypes List<String>
    The supported IP address types.
    tags Map<String>
    Map of tags assigned to the resource.
    vpcEndpointPolicySupported Boolean
    Whether or not the service supports endpoint policies - true or false.
    filters List<Property Map>
    service String

    Supporting Types

    GetVpcEndpointServiceFilter

    Name string
    Name of the filter field. Valid values can be found in the EC2 DescribeVpcEndpointServices API Reference.
    Values List<string>
    Set of values that are accepted for the given filter field. Results will be selected if any given value matches.
    Name string
    Name of the filter field. Valid values can be found in the EC2 DescribeVpcEndpointServices API Reference.
    Values []string
    Set of values that are accepted for the given filter field. Results will be selected if any given value matches.
    name String
    Name of the filter field. Valid values can be found in the EC2 DescribeVpcEndpointServices API Reference.
    values List<String>
    Set of values that are accepted for the given filter field. Results will be selected if any given value matches.
    name string
    Name of the filter field. Valid values can be found in the EC2 DescribeVpcEndpointServices API Reference.
    values string[]
    Set of values that are accepted for the given filter field. Results will be selected if any given value matches.
    name str
    Name of the filter field. Valid values can be found in the EC2 DescribeVpcEndpointServices API Reference.
    values Sequence[str]
    Set of values that are accepted for the given filter field. Results will be selected if any given value matches.
    name String
    Name of the filter field. Valid values can be found in the EC2 DescribeVpcEndpointServices API Reference.
    values List<String>
    Set of values that are accepted for the given filter field. Results will be selected if any given value matches.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws