Class VpcEndpointService

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

Basic

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var example = new Aws.Ec2.VpcEndpointService("example", new Aws.Ec2.VpcEndpointServiceArgs
    {
        AcceptanceRequired = false,
        NetworkLoadBalancerArns = 
        {
            aws_lb.Example.Arn,
        },
    });
}

}

Basic w/ Tags

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var example = new Aws.Ec2.VpcEndpointService("example", new Aws.Ec2.VpcEndpointServiceArgs
    {
        AcceptanceRequired = false,
        NetworkLoadBalancerArns = 
        {
            aws_lb.Example.Arn,
        },
        Tags = 
        {
            { "Environment", "test" },
        },
    });
}

}

Inheritance

System.Object

Resource

CustomResource

VpcEndpointService

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.Ec2

Assembly: Pulumi.Aws.dll

Syntax

public class VpcEndpointService : CustomResource

Constructors

VpcEndpointService(String, VpcEndpointServiceArgs, CustomResourceOptions)

Create a VpcEndpointService resource with the given unique name, arguments, and options.

Declaration

public VpcEndpointService(string name, VpcEndpointServiceArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
VpcEndpointServiceArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

AcceptanceRequired

Whether or not VPC endpoint connection requests to the service must be accepted by the service owner - true or false.

Declaration

public Output<bool> AcceptanceRequired { get; }

Property Value

Type	Description
Output<System.Boolean>

AllowedPrincipals

The ARNs of one or more principals allowed to discover the endpoint service.

Declaration

public Output<ImmutableArray<string>> AllowedPrincipals { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

AvailabilityZones

The Availability Zones in which the service is available.

Declaration

public Output<ImmutableArray<string>> AvailabilityZones { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

BaseEndpointDnsNames

The DNS names for the service.

Declaration

public Output<ImmutableArray<string>> BaseEndpointDnsNames { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

ManagesVpcEndpoints

Whether or not the service manages its VPC endpoints - true or false.

Declaration

public Output<bool> ManagesVpcEndpoints { get; }

Property Value

Type	Description
Output<System.Boolean>

NetworkLoadBalancerArns

The ARNs of one or more Network Load Balancers for the endpoint service.

Declaration

public Output<ImmutableArray<string>> NetworkLoadBalancerArns { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

PrivateDnsName

The private DNS name for the service.

Declaration

public Output<string> PrivateDnsName { get; }

Property Value

Type	Description
Output<System.String>

ServiceName

The service name.

Declaration

public Output<string> ServiceName { get; }

Property Value

Type	Description
Output<System.String>

ServiceType

The service type, Gateway or Interface.

Declaration

public Output<string> ServiceType { get; }

Property Value

Type	Description
Output<System.String>

State

The state of the VPC endpoint service.

Declaration

public Output<string> State { get; }

Property Value

Type	Description
Output<System.String>

Tags

A map of tags to assign to the resource.

Declaration

public Output<ImmutableDictionary<string, object>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

Methods

Get(String, Input<String>, VpcEndpointServiceState, CustomResourceOptions)

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

Declaration

public static VpcEndpointService Get(string name, Input<string> id, VpcEndpointServiceState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
VpcEndpointServiceState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
VpcEndpointService