Class CfnVPCEndpointService

Creates a VPC endpoint service configuration to which service consumers ( AWS accounts, users, and IAM roles) can connect.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnVPCEndpointService

Implements

IInspectable

IVPCEndpointServiceRef

IConstruct

IDependable

IEnvironmentAware

ITaggableV2

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.EC2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnVPCEndpointService : CfnResource, IInspectable, IVPCEndpointServiceRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Syntax (vb)

Public Class CfnVPCEndpointService Inherits CfnResource Implements IInspectable, IVPCEndpointServiceRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Remarks

To create an endpoint service configuration, you must first create one of the following for your service:

For more information, see the AWS PrivateLink User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html

CloudformationResource: AWS::EC2::VPCEndpointService

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.EC2;

             var cfnVPCEndpointService = new CfnVPCEndpointService(this, "MyCfnVPCEndpointService", new CfnVPCEndpointServiceProps {
                 AcceptanceRequired = false,
                 ContributorInsightsEnabled = false,
                 GatewayLoadBalancerArns = new [] { "gatewayLoadBalancerArns" },
                 NetworkLoadBalancerArns = new [] { "networkLoadBalancerArns" },
                 PayerResponsibility = "payerResponsibility",
                 SupportedIpAddressTypes = new [] { "supportedIpAddressTypes" },
                 SupportedRegions = new [] { "supportedRegions" },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnVPCEndpointService(Construct, string, ICfnVPCEndpointServiceProps?)

Create a new AWS::EC2::VPCEndpointService.

Properties

AcceptanceRequired	Indicates whether requests from service consumers to create an endpoint to your service must be accepted.
AttrServiceId	The ID of the endpoint service.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CdkTagManager	Tag Manager which manages the tags for this resource.
CfnProperties	Creates a VPC endpoint service configuration to which service consumers ( AWS accounts, users, and IAM roles) can connect.
ContributorInsightsEnabled	Indicates whether to enable the built-in Contributor Insights rules provided by AWS PrivateLink .
GatewayLoadBalancerArns	The Amazon Resource Names (ARNs) of the Gateway Load Balancers.
NetworkLoadBalancerArns	The Amazon Resource Names (ARNs) of the Network Load Balancers.
PayerResponsibility	The entity that is responsible for the endpoint costs.
SupportedIpAddressTypes	The supported IP address types.
SupportedRegions	The Regions from which service consumers can access the service.
Tags	The tags to associate with the service.
VpcEndpointServiceRef	A reference to a VPCEndpointService resource.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnVPCEndpointService(object)	Checks whether the given object is a CfnVPCEndpointService.
RenderProperties(IDictionary<string, object>)	Creates a VPC endpoint service configuration to which service consumers ( AWS accounts, users, and IAM roles) can connect.

Constructors

CfnVPCEndpointService(Construct, string, ICfnVPCEndpointServiceProps?)

Create a new AWS::EC2::VPCEndpointService.

public CfnVPCEndpointService(Construct scope, string id, ICfnVPCEndpointServiceProps? props = null)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnVPCEndpointServiceProps

Resource properties.

Remarks

To create an endpoint service configuration, you must first create one of the following for your service:

For more information, see the AWS PrivateLink User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html

CloudformationResource: AWS::EC2::VPCEndpointService

ExampleMetadata: fixture=_generated

Properties

AcceptanceRequired

Indicates whether requests from service consumers to create an endpoint to your service must be accepted.

public virtual object? AcceptanceRequired { get; set; }

Property Value

object

Remarks

Type union: either bool or IResolvable

AttrServiceId

The ID of the endpoint service.

public virtual string AttrServiceId { get; }

Property Value

string

Remarks

CloudformationAttribute: ServiceId

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

To create an endpoint service configuration, you must first create one of the following for your service:

For more information, see the AWS PrivateLink User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html

CloudformationResource: AWS::EC2::VPCEndpointService

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }

Property Value

TagManager

Remarks

To create an endpoint service configuration, you must first create one of the following for your service:

For more information, see the AWS PrivateLink User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html

CloudformationResource: AWS::EC2::VPCEndpointService

ExampleMetadata: fixture=_generated

CfnProperties

Creates a VPC endpoint service configuration to which service consumers ( AWS accounts, users, and IAM roles) can connect.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

To create an endpoint service configuration, you must first create one of the following for your service:

For more information, see the AWS PrivateLink User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html

CloudformationResource: AWS::EC2::VPCEndpointService

ExampleMetadata: fixture=_generated

ContributorInsightsEnabled

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

public virtual object? ContributorInsightsEnabled { get; set; }

Property Value

object

Remarks

Type union: either bool or IResolvable

GatewayLoadBalancerArns

The Amazon Resource Names (ARNs) of the Gateway Load Balancers.

public virtual string[]? GatewayLoadBalancerArns { get; set; }

Property Value

string[]

Remarks

To create an endpoint service configuration, you must first create one of the following for your service:

For more information, see the AWS PrivateLink User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html

CloudformationResource: AWS::EC2::VPCEndpointService

ExampleMetadata: fixture=_generated

NetworkLoadBalancerArns

The Amazon Resource Names (ARNs) of the Network Load Balancers.

public virtual string[]? NetworkLoadBalancerArns { get; set; }

Property Value

string[]

Remarks

To create an endpoint service configuration, you must first create one of the following for your service:

For more information, see the AWS PrivateLink User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html

CloudformationResource: AWS::EC2::VPCEndpointService

ExampleMetadata: fixture=_generated

PayerResponsibility

The entity that is responsible for the endpoint costs.

public virtual string? PayerResponsibility { get; set; }

Property Value

string

Remarks

To create an endpoint service configuration, you must first create one of the following for your service:

For more information, see the AWS PrivateLink User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html

CloudformationResource: AWS::EC2::VPCEndpointService

ExampleMetadata: fixture=_generated

SupportedIpAddressTypes

The supported IP address types.

public virtual string[]? SupportedIpAddressTypes { get; set; }

Property Value

string[]

Remarks

To create an endpoint service configuration, you must first create one of the following for your service:

For more information, see the AWS PrivateLink User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html

CloudformationResource: AWS::EC2::VPCEndpointService

ExampleMetadata: fixture=_generated

SupportedRegions

The Regions from which service consumers can access the service.

public virtual string[]? SupportedRegions { get; set; }

Property Value

string[]

Remarks

To create an endpoint service configuration, you must first create one of the following for your service:

For more information, see the AWS PrivateLink User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html

CloudformationResource: AWS::EC2::VPCEndpointService

ExampleMetadata: fixture=_generated

Tags

The tags to associate with the service.

public virtual ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

To create an endpoint service configuration, you must first create one of the following for your service:

For more information, see the AWS PrivateLink User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html

CloudformationResource: AWS::EC2::VPCEndpointService

ExampleMetadata: fixture=_generated

VpcEndpointServiceRef

A reference to a VPCEndpointService resource.

public virtual IVPCEndpointServiceReference VpcEndpointServiceRef { get; }

Property Value

IVPCEndpointServiceReference

Remarks

To create an endpoint service configuration, you must first create one of the following for your service:

For more information, see the AWS PrivateLink User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html

CloudformationResource: AWS::EC2::VPCEndpointService

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

To create an endpoint service configuration, you must first create one of the following for your service:

For more information, see the AWS PrivateLink User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html

CloudformationResource: AWS::EC2::VPCEndpointService

ExampleMetadata: fixture=_generated

IsCfnVPCEndpointService(object)

Checks whether the given object is a CfnVPCEndpointService.

public static bool IsCfnVPCEndpointService(object x)

Parameters

x object

Returns

bool

Remarks

To create an endpoint service configuration, you must first create one of the following for your service:

For more information, see the AWS PrivateLink User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html

CloudformationResource: AWS::EC2::VPCEndpointService

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates a VPC endpoint service configuration to which service consumers ( AWS accounts, users, and IAM roles) can connect.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

To create an endpoint service configuration, you must first create one of the following for your service:

For more information, see the AWS PrivateLink User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html

CloudformationResource: AWS::EC2::VPCEndpointService

ExampleMetadata: fixture=_generated

Implements

IInspectable

IVPCEndpointServiceRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggableV2