VpcEndpointServiceProps

class aws_cdk.aws_ec2.VpcEndpointServiceProps(*, vpc_endpoint_service_load_balancers, acceptance_required=None, allowed_principals=None, vpc_endpoint_service_name=None, whitelisted_principals=None)

Bases: object

Construction properties for a VpcEndpointService.

Parameters:

  • vpc_endpoint_service_load_balancers (Sequence[IVpcEndpointServiceLoadBalancer]) – One or more load balancers to host the VPC Endpoint Service.

  • acceptance_required (Optional[bool]) – Whether requests from service consumers to connect to the service through an endpoint must be accepted. Default: true

  • allowed_principals (Optional[Sequence[ArnPrincipal]]) – 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. Default: - no principals

  • vpc_endpoint_service_name (Optional[str]) – (deprecated) Name of the Vpc Endpoint Service. Default: - CDK generated name

  • whitelisted_principals (Optional[Sequence[ArnPrincipal]]) – (deprecated) 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. Default: - no principals

ExampleMetadata:

infused

Example:

# network_load_balancer1: elbv2.NetworkLoadBalancer
# network_load_balancer2: elbv2.NetworkLoadBalancer


ec2.VpcEndpointService(self, "EndpointService",
    vpc_endpoint_service_load_balancers=[network_load_balancer1, network_load_balancer2],
    acceptance_required=True,
    allowed_principals=[iam.ArnPrincipal("arn:aws:iam::123456789012:root")]
)

Attributes

acceptance_required

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

Default:

true

allowed_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.

Default:

  • no principals

vpc_endpoint_service_load_balancers

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

vpc_endpoint_service_name

(deprecated) Name of the Vpc Endpoint Service.

Default:

  • CDK generated name

Deprecated:

This property is not used

Stability:

deprecated

whitelisted_principals

(deprecated) 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.

Default:

  • no principals

Deprecated:

use allowedPrincipals

Stability:

deprecated