VpcEndpointService

class aws_cdk.aws_ec2.VpcEndpointService(scope, id, *, vpc_endpoint_service_load_balancers, acceptance_required=None, vpc_endpoint_service_name=None, whitelisted_principals=None)

Bases: aws_cdk.core.Resource

A VPC endpoint service.

stability :stability: experimental resource: :resource:: AWS::EC2::VPCEndpointService

__init__(scope, id, *, vpc_endpoint_service_load_balancers, acceptance_required=None, vpc_endpoint_service_name=None, whitelisted_principals=None)
Parameters
  • scope (Construct) –

  • id (str) –

  • vpc_endpoint_service_load_balancers (List[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

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

  • whitelisted_principals (Optional[List[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

stability :stability: experimental

Return type

None

Methods

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

acceptance_required

Whether to require manual acceptance of new connections to the service.

stability :stability: experimental

Return type

bool

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Return type

ResourceEnvironment

node

The construct tree node associated with this construct.

Return type

ConstructNode

stack

The stack in which this resource is defined.

Return type

Stack

vpc_endpoint_service_id

The id of the VPC Endpoint Service, like vpce-svc-xxxxxxxxxxxxxxxx.

stability :stability: experimental attribute: :attribute:: true

Return type

str

vpc_endpoint_service_load_balancers

One or more network load balancers to host the service.

stability :stability: experimental attribute: :attribute:: true

Return type

List[IVpcEndpointServiceLoadBalancer]

vpc_endpoint_service_name

The service name of the VPC Endpoint Service that clients use to connect to, like com.amazonaws.vpce..vpce-svc-xxxxxxxxxxxxxxxx.

stability :stability: experimental attribute: :attribute:: true

Return type

str

whitelisted_principals

One or more Principal ARNs to allow inbound connections to.

stability :stability: experimental

Return type

List[ArnPrincipal]

Static Methods

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool