AWS CDK Reference

Appearance

v2.274.0

InterfaceVpcEndpointProps Struct ​

Construction properties for an InterfaceVpcEndpoint.

Source
aws-ec2/lib/vpc-endpoint.ts

Example ​

ts
declare const vpc: ec2.Vpc;

new ec2.InterfaceVpcEndpoint(this, 'VPC Endpoint', {
  vpc,
  service: new ec2.InterfaceVpcEndpointService('com.amazonaws.vpce.us-east-1.vpce-svc-uuddlrlrbastrtsvc', 443),
  subnets: {
    subnetType: ec2.SubnetType.PRIVATE_ISOLATED,
    availabilityZones: ['us-east-1a', 'us-east-1c']
  }
});

Properties ​

dnsRecordIpTypeoptionalVpcEndpointDnsRecordIpTypedns_record_ip_typeoptionalVpcEndpointDnsRecordIpTypednsRecordIpTypeoptionalVpcEndpointDnsRecordIpTypeDnsRecordIpTypeoptionalVpcEndpointDnsRecordIpTypeDnsRecordIpTypeoptionalVpcEndpointDnsRecordIpType#
Type of DNS records created for the VPC endpoint.

Default: not specified

ipAddressTypeoptionalVpcEndpointIpAddressTypeip_address_typeoptionalVpcEndpointIpAddressTypeipAddressTypeoptionalVpcEndpointIpAddressTypeIpAddressTypeoptionalVpcEndpointIpAddressTypeIpAddressTypeoptionalVpcEndpointIpAddressType#
The IP address type for the endpoint.

Default: not specified

lookupSupportedAzsoptionalbooleanlookup_supported_azsoptionalboollookupSupportedAzsoptionalBooleanLookupSupportedAzsoptionalboolLookupSupportedAzsoptional*bool= false#
Limit to only those availability zones where the endpoint service can be created.

Setting this to 'true' requires a lookup to be performed at synthesis time. Account and region must be set on the containing stack for this to work.

openoptionalbooleanopenoptionalboolopenoptionalBooleanOpenoptionalboolOpenoptional*bool= true#
Whether to automatically allow VPC traffic to the endpoint.

If enabled, all traffic to the endpoint from within the VPC will be automatically allowed. This is done based on the VPC's CIDR range.

privateDnsEnabledoptionalbooleanprivate_dns_enabledoptionalboolprivateDnsEnabledoptionalBooleanPrivateDnsEnabledoptionalboolPrivateDnsEnabledoptional*bool#
Whether to associate a private hosted zone with the specified VPC.

Default: set by the instance of IInterfaceVpcEndpointService, or true if not defined by the instance of IInterfaceVpcEndpointService

This allows you to make requests to the service using its default DNS hostname.

privateDnsOnlyForInboundResolverEndpointoptionalVpcEndpointPrivateDnsOnlyForInboundResolverEndpointprivate_dns_only_for_inbound_resolver_endpointoptionalVpcEndpointPrivateDnsOnlyForInboundResolverEndpointprivateDnsOnlyForInboundResolverEndpointoptionalVpcEndpointPrivateDnsOnlyForInboundResolverEndpointPrivateDnsOnlyForInboundResolverEndpointoptionalVpcEndpointPrivateDnsOnlyForInboundResolverEndpointPrivateDnsOnlyForInboundResolverEndpointoptionalVpcEndpointPrivateDnsOnlyForInboundResolverEndpoint#
Whether to enable private DNS only for inbound endpoints.

Default: not specified

securityGroupsoptionalISecurityGroup[]security_groupsoptionaltyping.List[ISecurityGroup]securityGroupsoptionalList<ISecurityGroup>SecurityGroupsoptionalISecurityGroup[]SecurityGroupsoptional*[]ISecurityGroup#
The security groups to associate with this interface VPC endpoint.

Default: a new security group is created

serviceIInterfaceVpcEndpointServiceserviceIInterfaceVpcEndpointServiceserviceIInterfaceVpcEndpointServiceServiceIInterfaceVpcEndpointServiceServiceIInterfaceVpcEndpointServicerequired#
The service to use for this interface VPC endpoint.
serviceRegionoptionalstringservice_regionoptionalstrserviceRegionoptionalStringServiceRegionoptionalstringServiceRegionoptional*string#
The region where the VPC endpoint service is located.

Default: Same region as the interface VPC endpoint

Only needs to be specified for cross-region VPC endpoints.

subnetsoptionalSubnetSelectionsubnetsoptionalSubnetSelectionsubnetsoptionalSubnetSelectionSubnetsoptionalSubnetSelectionSubnetsoptionalSubnetSelection#
The subnets in which to create an endpoint network interface.

Default: private subnets

At most one per availability zone.

vpcIVpcvpcIVpcvpcIVpcVpcIVpcVpcIVpcrequired#
The VPC network in which the interface endpoint will be used.