GatewayVpcEndpoint

class aws_cdk.aws_ec2.GatewayVpcEndpoint(scope, id, *, vpc, service, subnets=None)

Bases: VpcEndpoint

A gateway VPC endpoint.

Resource: AWS::EC2::VPCEndpoint
ExampleMetadata: lit=test/integ.vpc-endpoint.lit.ts infused

Example:

# Add gateway endpoints when creating the VPC
vpc = ec2.Vpc(self, "MyVpc",
    gateway_endpoints={
        "S3": ec2.GatewayVpcEndpointOptions(
            service=ec2.GatewayVpcEndpointAwsService.S3
        )
    }
)

# Alternatively gateway endpoints can be added on the VPC
dynamo_db_endpoint = vpc.add_gateway_endpoint("DynamoDbEndpoint",
    service=ec2.GatewayVpcEndpointAwsService.DYNAMODB
)

# This allows to customize the endpoint policy
dynamo_db_endpoint.add_to_policy(
    iam.PolicyStatement( # Restrict to listing and describing tables
        principals=[iam.AnyPrincipal()],
        actions=["dynamodb:DescribeTable", "dynamodb:ListTables"],
        resources=["*"]))

# Add an interface endpoint
vpc.add_interface_endpoint("EcrDockerEndpoint",
    service=ec2.InterfaceVpcEndpointAwsService.ECR_DOCKER
)

Parameters

scope (Construct) –
id (str) –
vpc (IVpc) – The VPC network in which the gateway endpoint will be used.
service (IGatewayVpcEndpointService) – The service to use for this gateway VPC endpoint.
subnets (Optional[Sequence[Union[SubnetSelection, Dict[str, Any]]]]) – Where to add endpoint routing. By default, this endpoint will be routable from all subnets in the VPC. Specify a list of subnet selection objects here to be more specific. Default: - All subnets in the VPC

Methods

add_to_policy(statement)

Adds a statement to the policy document of the VPC endpoint. The statement must have a Principal.

Not all interface VPC endpoints support policy. For more information see https://docs.aws.amazon.com/vpc/latest/userguide/vpce-interface.html

Parameters: statement (PolicyStatement) – the IAM statement to add.
Return type: None

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

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_creation_timestamp

The date and time the gateway VPC endpoint was created.

Attribute: true
Return type: str

vpc_endpoint_dns_entries

true

Type: attribute
Return type: List[str]

vpc_endpoint_id

The gateway VPC endpoint identifier.

Return type: str

vpc_endpoint_network_interface_ids

true

Type: attribute
Return type: List[str]

Static Methods

classmethod from_gateway_vpc_endpoint_id(scope, id, gateway_vpc_endpoint_id)

Parameters

scope (Construct) –
id (str) –
gateway_vpc_endpoint_id (str) –

Return type

IGatewayVpcEndpoint

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