Interface ICfnVPCEndpointMixinProps
Properties for CfnVPCEndpointPropsMixin.
Namespace: Amazon.CDK.CfnPropertyMixins.AWS.EC2
Assembly: Amazon.CDK.CfnPropertyMixins.dll
Syntax (csharp)
public interface ICfnVPCEndpointMixinPropsSyntax (vb)
Public Interface ICfnVPCEndpointMixinPropsRemarks
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.CfnPropertyMixins.AWS.EC2;
var policyDocument;
var cfnVPCEndpointMixinProps = new CfnVPCEndpointMixinProps {
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",
VpcId = "vpcId"
};Synopsis
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. |
Properties
DnsOptions
Describes the DNS options for an endpoint.
object? DnsOptions { get; }Property Value
Remarks
IpAddressType
The supported IP address types.
string? IpAddressType { get; }Property Value
Remarks
PolicyDocument
An endpoint policy, which controls access to the service from the VPC.
object? PolicyDocument { get; }Property Value
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.
object? PrivateDnsEnabled { get; }Property Value
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
Type union: either bool or IResolvable
ResourceConfigurationArn
The Amazon Resource Name (ARN) of the resource configuration.
string? ResourceConfigurationArn { get; }Property Value
Remarks
RouteTableIds
The IDs of the route tables.
object[]? RouteTableIds { get; }Property Value
object[]
Remarks
Routing is supported only for gateway endpoints.
Type union: (either string or IRouteTableRef)[]
SecurityGroupIds
The IDs of the security groups to associate with the endpoint network interfaces.
object[]? SecurityGroupIds { get; }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.
Type union: (either string or ISecurityGroupRef)[]
ServiceName
The name of the endpoint service.
string? ServiceName { get; }Property Value
Remarks
ServiceNetworkArn
The Amazon Resource Name (ARN) of the service network.
string? ServiceNetworkArn { get; }Property Value
Remarks
ServiceRegion
Describes a Region.
string? ServiceRegion { get; }Property Value
Remarks
SubnetIds
The IDs of the subnets in which to create endpoint network interfaces.
object[]? SubnetIds { get; }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.
Type union: (either string or ISubnetRef)[]
Tags
VpcEndpointType
The type of endpoint.
string? VpcEndpointType { get; }Property Value
Remarks
VpcId
The ID of the VPC.
object? VpcId { get; }Property Value
Remarks
Type union: either string or IVPCRef