Skip to content
v2.273.0

VpcEndpointServiceProps Struct ​

Construction properties for a VpcEndpointService.

Example ​

ts
declare const networkLoadBalancer: elbv2.NetworkLoadBalancer;

new ec2.VpcEndpointService(this, 'EndpointService', {
  vpcEndpointServiceLoadBalancers: [networkLoadBalancer],
  // Support both IPv4 and IPv6 connections to the endpoint service
  supportedIpAddressTypes: [
    ec2.IpAddressType.IPV4,
    ec2.IpAddressType.IPV6,
  ],
});

Properties ​

acceptanceRequiredbooleanacceptance_requiredboolacceptanceRequiredBooleanAcceptanceRequiredboolAcceptanceRequired*bool= true#
Whether requests from service consumers to connect to the service through an endpoint must be accepted.
allowedPrincipalsArnPrincipal[]allowed_principalstyping.List[ArnPrincipal]allowedPrincipalsList<ArnPrincipal>AllowedPrincipalsArnPrincipal[]AllowedPrincipals*[]ArnPrincipal= no principals#
IAM users, IAM roles, or AWS accounts to allow inbound connections from.

These principals can connect to your service using VPC endpoints. Takes a list of one or more ArnPrincipal.

allowedRegionsstring[]allowed_regionstyping.List[str]allowedRegionsList<String>AllowedRegionsstring[]AllowedRegions*[]*string= the region hosting the service o…#
The Regions from which service consumers can access the service.
default

Default: the region hosting the service only

contributorInsightsbooleancontributor_insightsboolcontributorInsightsBooleanContributorInsightsboolContributorInsights*bool= false#
Indicates whether to enable the built-in Contributor Insights rules provided by AWS PrivateLink.
supportedIpAddressTypesIpAddressType[]supported_ip_address_typestyping.List[IpAddressType]supportedIpAddressTypesList<IpAddressType>SupportedIpAddressTypesIpAddressType[]SupportedIpAddressTypes*[]IpAddressType= No specific IP address types con…#
Specify which IP address types are supported for VPC endpoint service.
default

Default: No specific IP address types configured

vpcEndpointServiceLoadBalancersIVpcEndpointServiceLoadBalancer[]vpc_endpoint_service_load_balancerstyping.List[IVpcEndpointServiceLoadBalancer]vpcEndpointServiceLoadBalancersList<IVpcEndpointServiceLoadBalancer>VpcEndpointServiceLoadBalancersIVpcEndpointServiceLoadBalancer[]VpcEndpointServiceLoadBalancers*[]IVpcEndpointServiceLoadBalancerrequired#
One or more load balancers to host the VPC Endpoint Service.

Used as props by ​