Skip to content
v2.275.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 ​

acceptanceRequiredoptionalbooleanacceptance_requiredoptionalboolacceptanceRequiredoptionalBooleanAcceptanceRequiredoptionalboolAcceptanceRequiredoptional*bool= true#
Whether requests from service consumers to connect to the service through an endpoint must be accepted.
allowedPrincipalsoptionalArnPrincipal[]allowed_principalsoptionaltyping.List[ArnPrincipal]allowedPrincipalsoptionalList<ArnPrincipal>AllowedPrincipalsoptionalArnPrincipal[]AllowedPrincipalsoptional*[]ArnPrincipal#
IAM users, IAM roles, or AWS accounts to allow inbound connections from.

Default: no principals

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

allowedRegionsoptionalstring[]allowed_regionsoptionaltyping.List[str]allowedRegionsoptionalList<String>AllowedRegionsoptionalstring[]AllowedRegionsoptional*[]*string#
The Regions from which service consumers can access the service.

Default: the region hosting the service only

contributorInsightsoptionalbooleancontributor_insightsoptionalboolcontributorInsightsoptionalBooleanContributorInsightsoptionalboolContributorInsightsoptional*bool= false#
Indicates whether to enable the built-in Contributor Insights rules provided by AWS PrivateLink.
supportedIpAddressTypesoptionalIpAddressType[]supported_ip_address_typesoptionaltyping.List[IpAddressType]supportedIpAddressTypesoptionalList<IpAddressType>SupportedIpAddressTypesoptionalIpAddressType[]SupportedIpAddressTypesoptional*[]IpAddressType#
Specify which IP address types are supported for VPC endpoint service.

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.