CfnVPNConnection
- class aws_cdk.aws_ec2.CfnVPNConnection(scope, id, *, customer_gateway_id, type, static_routes_only=None, tags=None, transit_gateway_id=None, vpn_gateway_id=None, vpn_tunnel_options_specifications=None)
Bases:
CfnResource
A CloudFormation
AWS::EC2::VPNConnection
.Specifies a VPN connection between a virtual private gateway and a VPN customer gateway or a transit gateway and a VPN customer gateway.
To specify a VPN connection between a transit gateway and customer gateway, use the
TransitGatewayId
andCustomerGatewayId
properties.To specify a VPN connection between a virtual private gateway and customer gateway, use the
VpnGatewayId
andCustomerGatewayId
properties.For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide .
- CloudformationResource:
AWS::EC2::VPNConnection
- Link:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_ec2 as ec2 cfn_vPNConnection = ec2.CfnVPNConnection(self, "MyCfnVPNConnection", customer_gateway_id="customerGatewayId", type="type", # the properties below are optional static_routes_only=False, tags=[CfnTag( key="key", value="value" )], transit_gateway_id="transitGatewayId", vpn_gateway_id="vpnGatewayId", vpn_tunnel_options_specifications=[ec2.CfnVPNConnection.VpnTunnelOptionsSpecificationProperty( pre_shared_key="preSharedKey", tunnel_inside_cidr="tunnelInsideCidr" )] )
Create a new
AWS::EC2::VPNConnection
.- Parameters:
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
customer_gateway_id (
str
) – The ID of the customer gateway at your end of the VPN connection.type (
str
) – The type of VPN connection.static_routes_only (
Union
[bool
,IResolvable
,None
]) – Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don’t support BGP. If you are creating a VPN connection for a device that does not support Border Gateway Protocol (BGP), you must specifytrue
.tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – Any tags assigned to the VPN connection.transit_gateway_id (
Optional
[str
]) – The ID of the transit gateway associated with the VPN connection. You must specify eitherTransitGatewayId
orVpnGatewayId
, but not both.vpn_gateway_id (
Optional
[str
]) – The ID of the virtual private gateway at the AWS side of the VPN connection. You must specify eitherTransitGatewayId
orVpnGatewayId
, but not both.vpn_tunnel_options_specifications (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,VpnTunnelOptionsSpecificationProperty
,Dict
[str
,Any
]]],None
]) – The tunnel options for the VPN connection.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined)
.- Parameters:
path (
str
) – The path of the value to delete.- Return type:
None
- add_depends_on(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters:
target (
CfnResource
) –- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –value (
Any
) –
- See:
- Return type:
None
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
with “Properties.” (i.e.Properties.TopicName
).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.
in the property name, prefix with a\
. In most programming languages you will need to write this as"\\."
because the\
itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str
) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters:
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
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 (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.
- Return type:
None
- get_att(attribute_name)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn
), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str
) – The name of the attribute.- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –- See:
- Return type:
Any
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector
) –tree inspector to collect and process attributes.
- Return type:
None
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str
- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::EC2::VPNConnection'
- attr_vpn_connection_id
The ID of the VPN connection.
- CloudformationAttribute:
VpnConnectionId
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- customer_gateway_id
The ID of the customer gateway at your end of the VPN connection.
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId)
.- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- node
The construct tree node associated with this construct.
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }
for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref })
.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- static_routes_only
Indicates whether the VPN connection uses static routes only.
Static routes must be used for devices that don’t support BGP.
If you are creating a VPN connection for a device that does not support Border Gateway Protocol (BGP), you must specify
true
.
- tags
Any tags assigned to the VPN connection.
- transit_gateway_id
The ID of the transit gateway associated with the VPN connection.
You must specify either
TransitGatewayId
orVpnGatewayId
, but not both.
- type
The type of VPN connection.
- vpn_gateway_id
The ID of the virtual private gateway at the AWS side of the VPN connection.
You must specify either
TransitGatewayId
orVpnGatewayId
, but not both.
- vpn_tunnel_options_specifications
The tunnel options for the VPN connection.
Static Methods
- classmethod is_cfn_element(x)
Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any
) –- Return type:
bool
- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(construct)
Check whether the given construct is a CfnResource.
- Parameters:
construct (
IConstruct
) –- Return type:
bool
- classmethod is_construct(x)
Return whether the given object is a Construct.
- Parameters:
x (
Any
) –- Return type:
bool
VpnTunnelOptionsSpecificationProperty
- class CfnVPNConnection.VpnTunnelOptionsSpecificationProperty(*, pre_shared_key=None, tunnel_inside_cidr=None)
Bases:
object
The tunnel options for a single VPN tunnel.
- Parameters:
pre_shared_key (
Optional
[str
]) – The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and customer gateway. Constraints: Allowed characters are alphanumeric characters, periods (.), and underscores (_). Must be between 8 and 64 characters in length and cannot start with zero (0).tunnel_inside_cidr (
Optional
[str
]) – The range of inside IP addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same virtual private gateway. Constraints: A size /30 CIDR block from the169.254.0.0/16
range. The following CIDR blocks are reserved and cannot be used: -169.254.0.0/30
-169.254.1.0/30
-169.254.2.0/30
-169.254.3.0/30
-169.254.4.0/30
-169.254.5.0/30
-169.254.169.252/30
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_ec2 as ec2 vpn_tunnel_options_specification_property = ec2.CfnVPNConnection.VpnTunnelOptionsSpecificationProperty( pre_shared_key="preSharedKey", tunnel_inside_cidr="tunnelInsideCidr" )
Attributes
The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and customer gateway.
Constraints: Allowed characters are alphanumeric characters, periods (.), and underscores (_). Must be between 8 and 64 characters in length and cannot start with zero (0).
- tunnel_inside_cidr
The range of inside IP addresses for the tunnel.
Any specified CIDR blocks must be unique across all VPN connections that use the same virtual private gateway.
Constraints: A size /30 CIDR block from the
169.254.0.0/16
range. The following CIDR blocks are reserved and cannot be used:169.254.0.0/30
169.254.1.0/30
169.254.2.0/30
169.254.3.0/30
169.254.4.0/30
169.254.5.0/30
169.254.169.252/30