Show / Hide Table of Contents

Class VpcEndpointService

A VPC endpoint service.

Inheritance
object
Resource
VpcEndpointService
Implements
IVpcEndpointService
IResource
IConstruct
IDependable
Inherited Members
Resource.IsOwnedResource(IConstruct)
Resource.IsResource(IConstruct)
Resource.ApplyRemovalPolicy(RemovalPolicy)
Resource.GeneratePhysicalName()
Resource.GetResourceArnAttribute(string, IArnComponents)
Resource.GetResourceNameAttribute(string)
Resource.Env
Resource.PhysicalName
Resource.Stack
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class VpcEndpointService : Resource, IVpcEndpointService, IResource, IConstruct, IDependable
Syntax (vb)
Public Class VpcEndpointService Inherits Resource Implements IVpcEndpointService, IResource, IConstruct, IDependable
Remarks

Resource: AWS::EC2::VPCEndpointService

ExampleMetadata: infused

Examples
NetworkLoadBalancer networkLoadBalancer;


             new VpcEndpointService(this, "EndpointService", new VpcEndpointServiceProps {
                 VpcEndpointServiceLoadBalancers = new [] { networkLoadBalancer },
                 // Support both IPv4 and IPv6 connections to the endpoint service
                 SupportedIpAddressTypes = new [] { IpAddressType.IPV4, IpAddressType.IPV6 }
             });

Synopsis

Constructors

VpcEndpointService(Construct, string, IVpcEndpointServiceProps)

A VPC endpoint service.

Properties

AcceptanceRequired

Whether to require manual acceptance of new connections to the service.

AllowedPrincipals

One or more Principal ARNs to allow inbound connections to.

ContributorInsightsEnabled

Whether to enable the built-in Contributor Insights rules provided by AWS PrivateLink.

DEFAULT_PREFIX

The default value for a VPC Endpoint Service name prefix, useful if you do not have a synthesize-time region literal available (all you have is { "Ref": "AWS::Region" }).

PROPERTY_INJECTION_ID

Uniquely identifies this class.

VpcEndpointServiceId

The id of the VPC Endpoint Service, like vpce-svc-xxxxxxxxxxxxxxxx.

VpcEndpointServiceLoadBalancers

One or more network load balancers to host the service.

VpcEndpointServiceName

The service name of the VPC Endpoint Service that clients use to connect to, like com.amazonaws.vpce.<region>.vpce-svc-xxxxxxxxxxxxxxxx.

Constructors

VpcEndpointService(Construct, string, IVpcEndpointServiceProps)

A VPC endpoint service.

public VpcEndpointService(Construct scope, string id, IVpcEndpointServiceProps props)
Parameters
scope Construct
id string
props IVpcEndpointServiceProps
Remarks

Resource: AWS::EC2::VPCEndpointService

ExampleMetadata: infused

Examples
NetworkLoadBalancer networkLoadBalancer;


             new VpcEndpointService(this, "EndpointService", new VpcEndpointServiceProps {
                 VpcEndpointServiceLoadBalancers = new [] { networkLoadBalancer },
                 // Support both IPv4 and IPv6 connections to the endpoint service
                 SupportedIpAddressTypes = new [] { IpAddressType.IPV4, IpAddressType.IPV6 }
             });

Properties

AcceptanceRequired

Whether to require manual acceptance of new connections to the service.

public virtual bool AcceptanceRequired { get; }
Property Value

bool

Remarks

Resource: AWS::EC2::VPCEndpointService

ExampleMetadata: infused

AllowedPrincipals

One or more Principal ARNs to allow inbound connections to.

public virtual ArnPrincipal[] AllowedPrincipals { get; }
Property Value

ArnPrincipal[]

Remarks

Resource: AWS::EC2::VPCEndpointService

ExampleMetadata: infused

ContributorInsightsEnabled

Whether to enable the built-in Contributor Insights rules provided by AWS PrivateLink.

public virtual bool? ContributorInsightsEnabled { get; }
Property Value

bool?

Remarks

Resource: AWS::EC2::VPCEndpointService

ExampleMetadata: infused

DEFAULT_PREFIX

The default value for a VPC Endpoint Service name prefix, useful if you do not have a synthesize-time region literal available (all you have is { "Ref": "AWS::Region" }).

public static string DEFAULT_PREFIX { get; }
Property Value

string

Remarks

Resource: AWS::EC2::VPCEndpointService

ExampleMetadata: infused

PROPERTY_INJECTION_ID

Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }
Property Value

string

Remarks

Resource: AWS::EC2::VPCEndpointService

ExampleMetadata: infused

VpcEndpointServiceId

The id of the VPC Endpoint Service, like vpce-svc-xxxxxxxxxxxxxxxx.

public virtual string VpcEndpointServiceId { get; }
Property Value

string

Remarks

Attribute: true

VpcEndpointServiceLoadBalancers

One or more network load balancers to host the service.

public virtual IVpcEndpointServiceLoadBalancer[] VpcEndpointServiceLoadBalancers { get; }
Property Value

IVpcEndpointServiceLoadBalancer[]

Remarks

Attribute: true

VpcEndpointServiceName

The service name of the VPC Endpoint Service that clients use to connect to, like com.amazonaws.vpce.<region>.vpce-svc-xxxxxxxxxxxxxxxx.

public virtual string VpcEndpointServiceName { get; }
Property Value

string

Remarks

Attribute: true

Implements

IVpcEndpointService
IResource
Constructs.IConstruct
Constructs.IDependable
Back to top Generated by DocFX