VpcEndpointService

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

Bases: Resource

A VPC endpoint service.

Resource:: AWS::EC2::VPCEndpointService
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")]
)

Parameters:

scope (Construct) –
id (str) –
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

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy (RemovalPolicy) –

Return type:

None

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.

allowed_principals: One or more Principal ARNs to allow inbound connections to.

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.

node: The construct tree node associated with this construct.

stack: The stack in which this resource is defined.

vpc_endpoint_service_id

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

Attribute:: true

vpc_endpoint_service_load_balancers

One or more network load balancers to host the service.

Attribute:: true

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.

Attribute:: true

whitelisted_principals

(deprecated) One or more Principal ARNs to allow inbound connections to.

Deprecated:: use allowedPrincipals
Stability:: deprecated

Static Methods

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:

x (Any) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool