VpcLink¶
-
class
aws_cdk.aws_apigateway.
VpcLink
(scope, id, *, description=None, targets=None, vpc_link_name=None)¶ Bases:
aws_cdk.core.Resource
Define a new VPC Link Specifies an API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).
- Parameters
scope (
Construct
) –id (
str
) –description (
Optional
[str
]) – The description of the VPC link. Default: no descriptiontargets (
Optional
[List
[INetworkLoadBalancer
]]) – The network load balancers of the VPC targeted by the VPC link. The network load balancers must be owned by the same AWS account of the API owner. Default: - no targets. UseaddTargets
to add targetsvpc_link_name (
Optional
[str
]) – The name used to label and identify the VPC link. Default: - automatically generated name
Methods
-
add_targets
(*targets)¶ - Parameters
targets (
INetworkLoadBalancer
) –- 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.DELETE
), 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
-
node
¶ The construct tree node associated with this construct.
- Return type
-
vpc_link_id
¶ Physical ID of the VpcLink resource.
- Attribute
true
- Return type
str
Static Methods
-
classmethod
from_vpc_link_id
(scope, id, vpc_link_id)¶ Import a VPC Link by its Id.
-
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