interface VpcEndpointServiceProps

Language	Type name
.NET	`Amazon.CDK.AWS.EC2.VpcEndpointServiceProps`
Java	`software.amazon.awscdk.services.ec2.VpcEndpointServiceProps`
Python	`aws_cdk.aws_ec2.VpcEndpointServiceProps`
TypeScript (source)	`@aws-cdk/aws-ec2` » `VpcEndpointServiceProps`

Construction properties for a VpcEndpointService.

Example

declare const networkLoadBalancer1: elbv2.NetworkLoadBalancer;
declare const networkLoadBalancer2: elbv2.NetworkLoadBalancer;

new ec2.VpcEndpointService(this, 'EndpointService', {
  vpcEndpointServiceLoadBalancers: [networkLoadBalancer1, networkLoadBalancer2],
  acceptanceRequired: true,
  allowedPrincipals: [new iam.ArnPrincipal('arn:aws:iam::123456789012:root')]
});

Properties

Name	Type	Description
vpcEndpointServiceLoadBalancers	`IVpcEndpointServiceLoadBalancer[]`	One or more load balancers to host the VPC Endpoint Service.
acceptanceRequired?	`boolean`	Whether requests from service consumers to connect to the service through an endpoint must be accepted.
allowedPrincipals?	`ArnPrincipal[]`	IAM users, IAM roles, or AWS accounts to allow inbound connections from.
vpcEndpointServiceName?⚠️	`string`	Name of the Vpc Endpoint Service.
whitelistedPrincipals?⚠️	`ArnPrincipal[]`	IAM users, IAM roles, or AWS accounts to allow inbound connections from.

vpcEndpointServiceLoadBalancers

Type: IVpcEndpointServiceLoadBalancer[]

One or more load balancers to host the VPC Endpoint Service.

acceptanceRequired?

Type: boolean (optional, default: true)

Whether requests from service consumers to connect to the service through an endpoint must be accepted.

allowedPrincipals?

Type: ArnPrincipal[] (optional, default: 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.

vpcEndpointServiceName?⚠️

⚠️ Deprecated: This property is not used

Type: string (optional, default: CDK generated name)

Name of the Vpc Endpoint Service.

whitelistedPrincipals?⚠️

⚠️ Deprecated: use allowedPrincipals

Type: ArnPrincipal[] (optional, default: 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.