Interface ICfnVPCEndpointProps
Properties for defining a CfnVPCEndpoint
.
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.AWS.EC2.dll
Syntax (csharp)
public interface ICfnVPCEndpointProps
Syntax (vb)
Public Interface ICfnVPCEndpointProps
Remarks
Link: 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 {
ServiceName = "serviceName",
VpcId = "vpcId",
// the properties below are optional
PolicyDocument = policyDocument,
PrivateDnsEnabled = false,
RouteTableIds = new [] { "routeTableIds" },
SecurityGroupIds = new [] { "securityGroupIds" },
SubnetIds = new [] { "subnetIds" },
VpcEndpointType = "vpcEndpointType"
};
Synopsis
Properties
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. |
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. |
SubnetIds | The IDs of the subnets in which to create endpoint network interfaces. |
VpcEndpointType | The type of endpoint. |
VpcId | The ID of the VPC. |
Properties
PolicyDocument
An endpoint policy, which controls access to the service from the VPC.
virtual object PolicyDocument { get; }
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. AWS CloudFormation converts YAML policies to JSON format before calling the API to create or modify the VPC endpoint.
PrivateDnsEnabled
Indicate whether to associate a private hosted zone with the specified VPC.
virtual object PrivateDnsEnabled { get; }
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
RouteTableIds
The IDs of the route tables.
virtual string[] RouteTableIds { get; }
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.
virtual string[] SecurityGroupIds { get; }
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.
string ServiceName { get; }
Property Value
System.String
Remarks
SubnetIds
The IDs of the subnets in which to create endpoint network interfaces.
virtual string[] SubnetIds { get; }
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.
VpcEndpointType
The type of endpoint.
virtual string VpcEndpointType { get; }
Property Value
System.String
Remarks
VpcId
The ID of the VPC.
string VpcId { get; }
Property Value
System.String