Class CfnVPCEndpointProps

Properties for defining a CfnVPCEndpoint.

Inheritance

object

CfnVPCEndpointProps

Implements

ICfnVPCEndpointProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.EC2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnVPCEndpointProps : ICfnVPCEndpointProps

Syntax (vb)

Public Class CfnVPCEndpointProps Implements ICfnVPCEndpointProps

Remarks

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

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 policyDocument;

             var cfnVPCEndpointProps = new CfnVPCEndpointProps {
                 VpcId = "vpcId",

                 // the properties below are optional
                 DnsOptions = new DnsOptionsSpecificationProperty {
                     DnsRecordIpType = "dnsRecordIpType",
                     PrivateDnsOnlyForInboundResolverEndpoint = "privateDnsOnlyForInboundResolverEndpoint",
                     PrivateDnsPreference = "privateDnsPreference",
                     PrivateDnsSpecifiedDomains = new [] { "privateDnsSpecifiedDomains" }
                 },
                 IpAddressType = "ipAddressType",
                 PolicyDocument = policyDocument,
                 PrivateDnsEnabled = false,
                 ResourceConfigurationArn = "resourceConfigurationArn",
                 RouteTableIds = new [] { "routeTableIds" },
                 SecurityGroupIds = new [] { "securityGroupIds" },
                 ServiceName = "serviceName",
                 ServiceNetworkArn = "serviceNetworkArn",
                 ServiceRegion = "serviceRegion",
                 SubnetIds = new [] { "subnetIds" },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 VpcEndpointType = "vpcEndpointType"
             };

Synopsis

Constructors

CfnVPCEndpointProps()

Properties for defining a CfnVPCEndpoint.

Properties

DnsOptions	Describes the DNS options for an endpoint.
IpAddressType	The supported IP address types.
PolicyDocument	An endpoint policy, which controls access to the service from the VPC.
PrivateDnsEnabled	Indicate whether to associate a private hosted zone with the specified VPC.
ResourceConfigurationArn	The Amazon Resource Name (ARN) of the resource configuration.
RouteTableIds	The IDs of the route tables.
SecurityGroupIds	The IDs of the security groups to associate with the endpoint network interfaces.
ServiceName	The name of the endpoint service.
ServiceNetworkArn	The Amazon Resource Name (ARN) of the service network.
ServiceRegion	Describes a Region.
SubnetIds	The IDs of the subnets in which to create endpoint network interfaces.
Tags	The tags to associate with the endpoint.
VpcEndpointType	The type of endpoint.
VpcId	The ID of the VPC.

Constructors

CfnVPCEndpointProps()

Properties for defining a CfnVPCEndpoint.

public CfnVPCEndpointProps()

Remarks

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

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 policyDocument;

             var cfnVPCEndpointProps = new CfnVPCEndpointProps {
                 VpcId = "vpcId",

                 // the properties below are optional
                 DnsOptions = new DnsOptionsSpecificationProperty {
                     DnsRecordIpType = "dnsRecordIpType",
                     PrivateDnsOnlyForInboundResolverEndpoint = "privateDnsOnlyForInboundResolverEndpoint",
                     PrivateDnsPreference = "privateDnsPreference",
                     PrivateDnsSpecifiedDomains = new [] { "privateDnsSpecifiedDomains" }
                 },
                 IpAddressType = "ipAddressType",
                 PolicyDocument = policyDocument,
                 PrivateDnsEnabled = false,
                 ResourceConfigurationArn = "resourceConfigurationArn",
                 RouteTableIds = new [] { "routeTableIds" },
                 SecurityGroupIds = new [] { "securityGroupIds" },
                 ServiceName = "serviceName",
                 ServiceNetworkArn = "serviceNetworkArn",
                 ServiceRegion = "serviceRegion",
                 SubnetIds = new [] { "subnetIds" },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 VpcEndpointType = "vpcEndpointType"
             };

Properties

DnsOptions

Describes the DNS options for an endpoint.

public object? DnsOptions { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-dnsoptions

Type union: either IResolvable or CfnVPCEndpoint.IDnsOptionsSpecificationProperty

IpAddressType

The supported IP address types.

public string? IpAddressType { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-ipaddresstype

PolicyDocument

An endpoint policy, which controls access to the service from the VPC.

public object? PolicyDocument { get; set; }

Property Value

object

Remarks

The default endpoint policy allows full access to the service. Endpoint policies are supported only for gateway and interface endpoints.

For CloudFormation templates in YAML, you can provide the policy in JSON or YAML format. For example, if you have a JSON policy, you can convert it to YAML before including it in the YAML template, and AWS CloudFormation converts the policy to JSON format before calling the API actions for AWS PrivateLink . Alternatively, you can include the JSON directly in the YAML, as shown in the following Properties section:

Properties: VpcEndpointType: 'Interface' ServiceName: !Sub 'com.amazonaws.${AWS::Region}.logs' PolicyDocument: '{ "Version":"2012-10-17", "Statement": [{ "Effect":"Allow", "Principal":"", "Action":["logs:Describe","logs:Get*","logs:List*","logs:FilterLogEvents"], "Resource":"*" }] }'

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-policydocument

PrivateDnsEnabled

Indicate whether to associate a private hosted zone with the specified VPC.

public object? PrivateDnsEnabled { get; set; }

Property Value

object

Remarks

The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, kinesis.us-east-1.amazonaws.com ), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.

To use a private hosted zone, you must set the following VPC attributes to true : enableDnsHostnames and enableDnsSupport .

This property is supported only for interface endpoints.

Default: false

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-privatednsenabled

Type union: either bool or IResolvable

ResourceConfigurationArn

The Amazon Resource Name (ARN) of the resource configuration.

public string? ResourceConfigurationArn { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-resourceconfigurationarn

RouteTableIds

The IDs of the route tables.

public object[]? RouteTableIds { get; set; }

Property Value

object[]

Remarks

Routing is supported only for gateway endpoints.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-routetableids

Type union: (either string or IRouteTableRef)[]

SecurityGroupIds

The IDs of the security groups to associate with the endpoint network interfaces.

public object[]? SecurityGroupIds { get; set; }

Property Value

object[]

Remarks

If this parameter is not specified, we use the default security group for the VPC. Security groups are supported only for interface endpoints.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-securitygroupids

Type union: (either string or ISecurityGroupRef)[]

ServiceName

The name of the endpoint service.

public string? ServiceName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-servicename

ServiceNetworkArn

The Amazon Resource Name (ARN) of the service network.

public string? ServiceNetworkArn { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-servicenetworkarn

ServiceRegion

Describes a Region.

public string? ServiceRegion { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-serviceregion

SubnetIds

The IDs of the subnets in which to create endpoint network interfaces.

public object[]? SubnetIds { get; set; }

Property Value

object[]

Remarks

You must specify this property for an interface endpoint or a Gateway Load Balancer endpoint. You can't specify this property for a gateway endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-subnetids

Type union: (either string or ISubnetRef)[]

Tags

The tags to associate with the endpoint.

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

Property Value

ICfnTag[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-tags

VpcEndpointType

The type of endpoint.

public string? VpcEndpointType { get; set; }

Property Value

string

Remarks

Default: Gateway

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-vpcendpointtype

VpcId

The ID of the VPC.

public object VpcId { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-vpcid

Type union: either string or IVPCRef

Implements

ICfnVPCEndpointProps