InterfaceVpcEndpoint
- class aws_cdk.aws_ec2.InterfaceVpcEndpoint(scope, id, *, vpc, service, lookup_supported_azs=None, open=None, private_dns_enabled=None, security_groups=None, subnets=None)
Bases:
VpcEndpoint
A interface VPC endpoint.
- Resource:
AWS::EC2::VPCEndpoint
- ExampleMetadata:
infused
Example:
# vpc: ec2.Vpc ec2.InterfaceVpcEndpoint(self, "VPC Endpoint", vpc=vpc, service=ec2.InterfaceVpcEndpointService("com.amazonaws.vpce.us-east-1.vpce-svc-uuddlrlrbastrtsvc", 443), subnets=ec2.SubnetSelection( subnet_type=ec2.SubnetType.PRIVATE_ISOLATED, availability_zones=["us-east-1a", "us-east-1c"] ) )
- Parameters:
scope (
Construct
) –id (
str
) –vpc (
IVpc
) – The VPC network in which the interface endpoint will be used.service (
IInterfaceVpcEndpointService
) – The service to use for this interface VPC endpoint.lookup_supported_azs (
Optional
[bool
]) – Limit to only those availability zones where the endpoint service can be created. Setting this to ‘true’ requires a lookup to be performed at synthesis time. Account and region must be set on the containing stack for this to work. Default: falseopen (
Optional
[bool
]) – Whether to automatically allow VPC traffic to the endpoint. If enabled, all traffic to the endpoint from within the VPC will be automatically allowed. This is done based on the VPC’s CIDR range. Default: trueprivate_dns_enabled (
Optional
[bool
]) – Whether to associate a private hosted zone with the specified VPC. This allows you to make requests to the service using its default DNS hostname. Default: set by the instance of IInterfaceVpcEndpointService, or true if not defined by the instance of IInterfaceVpcEndpointServicesecurity_groups (
Optional
[Sequence
[ISecurityGroup
]]) – The security groups to associate with this interface VPC endpoint. Default: - a new security group is createdsubnets (
Union
[SubnetSelection
,Dict
[str
,Any
],None
]) – The subnets in which to create an endpoint network interface. At most one per availability zone. Default: - private subnets
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
- connections
Access to network connections.
- 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 tree node.
- stack
The stack in which this resource is defined.
- vpc_endpoint_creation_timestamp
The date and time the interface VPC endpoint was created.
- Attribute:
true
- vpc_endpoint_dns_entries
The DNS entries for the interface VPC endpoint.
Each entry is a combination of the hosted zone ID and the DNS name. The entries are ordered as follows: regional public DNS, zonal public DNS, private DNS, and wildcard DNS. This order is not enforced for AWS Marketplace services.
The following is an example. In the first entry, the hosted zone ID is Z1HUB23UULQXV and the DNS name is vpce-01abc23456de78f9g-12abccd3.ec2.us-east-1.vpce.amazonaws.com.
[“Z1HUB23UULQXV:vpce-01abc23456de78f9g-12abccd3.ec2.us-east-1.vpce.amazonaws.com”, “Z1HUB23UULQXV:vpce-01abc23456de78f9g-12abccd3-us-east-1a.ec2.us-east-1.vpce.amazonaws.com”, “Z1C12344VYDITB0:ec2.us-east-1.amazonaws.com”]
If you update the PrivateDnsEnabled or SubnetIds properties, the DNS entries in the list will change.
- Attribute:
true
- vpc_endpoint_id
The interface VPC endpoint identifier.
- vpc_endpoint_network_interface_ids
One or more network interfaces for the interface VPC endpoint.
- Attribute:
true
Static Methods
- classmethod from_interface_vpc_endpoint_attributes(scope, id, *, port, vpc_endpoint_id, security_groups=None)
Imports an existing interface VPC endpoint.
- Parameters:
scope (
Construct
) –id (
str
) –port (
Union
[int
,float
]) – The port of the service of the interface VPC endpoint.vpc_endpoint_id (
str
) – The interface VPC endpoint identifier.security_groups (
Optional
[Sequence
[ISecurityGroup
]]) – The security groups associated with the interface VPC endpoint. If you wish to manage the network connections associated with this endpoint, you will need to specify its security groups.
- Return type:
- classmethod is_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructs
library on disk are seen as independent, completely different libraries. As a consequence, the classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
the other class.npm install
will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
x (
Any
) – Any object.- Return type:
bool
- Returns:
true if
x
is an object created from a class which extendsConstruct
.
- classmethod is_owned_resource(construct)
Returns true if the construct was created by CDK, and false otherwise.
- Parameters:
construct (
IConstruct
) –- Return type:
bool
- classmethod is_resource(construct)
Check whether the given construct is a Resource.
- Parameters:
construct (
IConstruct
) –- Return type:
bool