Class CfnVPCEndpointProps
Properties for defining a CfnVPCEndpoint.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnVPCEndpointProps : Object, ICfnVPCEndpointPropsSyntax (vb)
Public Class CfnVPCEndpointProps
Inherits Object
Implements ICfnVPCEndpointPropsRemarks
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"
},
IpAddressType = "ipAddressType",
PolicyDocument = policyDocument,
PrivateDnsEnabled = false,
ResourceConfigurationArn = "resourceConfigurationArn",
RouteTableIds = new [] { "routeTableIds" },
SecurityGroupIds = new [] { "securityGroupIds" },
ServiceName = "serviceName",
ServiceNetworkArn = "serviceNetworkArn",
SubnetIds = new [] { "subnetIds" },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
VpcEndpointType = "vpcEndpointType"
};Synopsis
Constructors
| CfnVPCEndpointProps() |
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. |
| 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()
public CfnVPCEndpointProps()Properties
DnsOptions
Describes the DNS options for an endpoint.
public object DnsOptions { get; set; }Property Value
System.Object
Remarks
IpAddressType
The supported IP address types.
public string IpAddressType { get; set; }Property Value
System.String
Remarks
PolicyDocument
An endpoint policy, which controls access to the service from the VPC.
public object PolicyDocument { get; set; }Property Value
System.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":"*" }] }'
PrivateDnsEnabled
Indicate whether to associate a private hosted zone with the specified VPC.
public object PrivateDnsEnabled { get; set; }Property Value
System.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
ResourceConfigurationArn
The Amazon Resource Name (ARN) of the resource configuration.
public string ResourceConfigurationArn { get; set; }Property Value
System.String
Remarks
RouteTableIds
The IDs of the route tables.
public string[] RouteTableIds { get; set; }Property Value
System.String[]
Remarks
Routing is supported only for gateway endpoints.
SecurityGroupIds
The IDs of the security groups to associate with the endpoint network interfaces.
public string[] SecurityGroupIds { get; set; }Property Value
System.String[]
Remarks
If this parameter is not specified, we use the default security group for the VPC. Security groups are supported only for interface endpoints.
ServiceName
The name of the endpoint service.
public string ServiceName { get; set; }Property Value
System.String
Remarks
ServiceNetworkArn
The Amazon Resource Name (ARN) of the service network.
public string ServiceNetworkArn { get; set; }Property Value
System.String
Remarks
SubnetIds
The IDs of the subnets in which to create endpoint network interfaces.
public string[] SubnetIds { get; set; }Property Value
System.String[]
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.
Tags
The tags to associate with the endpoint.
public ICfnTag[] Tags { get; set; }Property Value
ICfnTag[]
Remarks
VpcEndpointType
The type of endpoint.
public string VpcEndpointType { get; set; }Property Value
System.String
Remarks
VpcId
The ID of the VPC.
public string VpcId { get; set; }Property Value
System.String