VpnConnection L2 construct
Define a VPN Connection.
Example
ts
// Across all tunnels in the account/region
const allDataOut = ec2.VpnConnection.metricAllTunnelDataOut();
// For a specific vpn connection
const vpnConnection = vpc.addVpnConnection('Dynamic', {
ip: '1.2.3.4'
});
const state = vpnConnection.metricTunnelState();
python
# Across all tunnels in the account/region
all_data_out = ec2.VpnConnection.metric_all_tunnel_data_out()
# For a specific vpn connection
vpn_connection = vpc.add_vpn_connection("Dynamic",
ip="1.2.3.4"
)
state = vpn_connection.metric_tunnel_state()
java
// Across all tunnels in the account/region
Metric allDataOut = VpnConnection.metricAllTunnelDataOut();
// For a specific vpn connection
VpnConnection vpnConnection = vpc.addVpnConnection("Dynamic", VpnConnectionOptions.builder()
.ip("1.2.3.4")
.build());
Metric state = vpnConnection.metricTunnelState();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// Across all tunnels in the account/region
var allDataOut = VpnConnection.MetricAllTunnelDataOut();
// For a specific vpn connection
var vpnConnection = vpc.AddVpnConnection("Dynamic", new VpnConnectionOptions {
Ip = "1.2.3.4"
});
var state = vpnConnection.MetricTunnelState();
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// Across all tunnels in the account/region
allDataOut := ec2.VpnConnection_MetricAllTunnelDataOut()
// For a specific vpn connection
vpnConnection := vpc.addVpnConnection(jsii.String("Dynamic"), &VpnConnectionOptions{
Ip: jsii.String("1.2.3.4"),
})
state := vpnConnection.metricTunnelState()
Initializer
ts
new VpnConnection(scope: Construct, id: string, props: VpnConnectionProps)
python
VpnConnection(scope: Construct, id: str, props: VpnConnectionProps)
java
new VpnConnection(Construct scope, String id, VpnConnectionProps props)
csharp
new VpnConnection(Construct scope, string id, VpnConnectionProps props)
go
NewVpnConnection(Scope Construct, Id *string, Props VpnConnectionProps)
Construct Props
The ASN of the customer gateway.
The ip address of the customer gateway.
staticRoutesstring[]static_routestyping.List[str]staticRoutesList<String>StaticRoutesstring[]StaticRoutes*[]*string= Dynamic routing (BGP)#The static routes to be routed from the VPN gateway to the customer gateway.
tunnelOptionsVpnTunnelOption[]tunnel_optionstyping.List[VpnTunnelOption]tunnelOptionsList<VpnTunnelOption>TunnelOptionsVpnTunnelOption[]TunnelOptions*[]VpnTunnelOption= Amazon generated tunnel options#The tunnel options for the VPN connection.
At most two elements (one per tunnel). Duplicates not allowed.
Properties
customerGatewayAsnnumbercustomer_gateway_asnint | floatcustomerGatewayAsnNumberCustomerGatewayAsndoubleCustomerGatewayAsn*float64required#The ASN of the customer gateway.
customerGatewayIdstringcustomer_gateway_idstrcustomerGatewayIdStringCustomerGatewayIdstringCustomerGatewayId*stringrequired#The id of the customer gateway.
customerGatewayIpstringcustomer_gateway_ipstrcustomerGatewayIpStringCustomerGatewayIpstringCustomerGatewayIp*stringrequired#The ip address of the customer gateway.
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#The environment this resource belongs to.
notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#Uniquely identifies this class.
The stack in which this resource is defined.
vpnConnectionRefVPNConnectionReferencevpn_connection_refVPNConnectionReferencevpnConnectionRefVPNConnectionReferenceVpnConnectionRefVPNConnectionReferenceVpnConnectionRefVPNConnectionReferencerequired#A reference to a VPNConnection resource.
The id of the VPN connection.
Methods
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#Override the cross-stack reference strength for this resource.
notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#Apply the given removal policy to this resource.
notes
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).
fromVpnConnectionAttributes(scope: Construct, id: string, attrs: VpnConnectionAttributes): IVpnConnection@staticmethod def from_vpn_connection_attributes(scope: Construct, id: str, attrs: VpnConnectionAttributes) -> IVpnConnectionpublic static IVpnConnection fromVpnConnectionAttributes(Construct scope, String id, VpnConnectionAttributes attrs)public static IVpnConnection FromVpnConnectionAttributes(Construct scope, string id, VpnConnectionAttributes attrs)func FromVpnConnectionAttributes(Scope Construct, Id *string, Attrs VpnConnectionAttributes) IVpnConnectionstatic#Import a VPN connection by supplying all attributes directly.
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#Checks if `x` is a construct.
notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct 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 class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof 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 the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#Returns true if the construct was created by CDK, and false otherwise.
isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#Check whether the given construct is a Resource.
metric(metricName: string, props?: MetricOptions): Metricdef metric(self, metric_name: str, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metric(String metricName, MetricOptions props)public Metric Metric(string metricName, MetricOptions? props = null)func Metric(MetricName *string, Props MetricOptions) Metric#Return the given named metric for this VPNConnection.
metricAll(metricName: string, props?: MetricOptions): Metric@staticmethod def metric_all(metric_name: str, props: typing.Optional[MetricOptions] = None) -> Metricpublic static Metric metricAll(String metricName, MetricOptions props)public static Metric MetricAll(string metricName, MetricOptions? props = null)func MetricAll(MetricName *string, Props MetricOptions) Metricstatic#Return the given named metric for all VPN connections in the account/region.
metricAllTunnelDataIn(props?: MetricOptions): Metric@staticmethod def metric_all_tunnel_data_in(props: typing.Optional[MetricOptions] = None) -> Metricpublic static Metric metricAllTunnelDataIn(MetricOptions props)public static Metric MetricAllTunnelDataIn(MetricOptions? props = null)func MetricAllTunnelDataIn(Props MetricOptions) Metricstatic#Metric for the tunnel data in of all VPN connections in the account/region.
metricAllTunnelDataOut(props?: MetricOptions): Metric@staticmethod def metric_all_tunnel_data_out(props: typing.Optional[MetricOptions] = None) -> Metricpublic static Metric metricAllTunnelDataOut(MetricOptions props)public static Metric MetricAllTunnelDataOut(MetricOptions? props = null)func MetricAllTunnelDataOut(Props MetricOptions) Metricstatic#Metric for the tunnel data out of all VPN connections.
metricAllTunnelState(props?: MetricOptions): Metric@staticmethod def metric_all_tunnel_state(props: typing.Optional[MetricOptions] = None) -> Metricpublic static Metric metricAllTunnelState(MetricOptions props)public static Metric MetricAllTunnelState(MetricOptions? props = null)func MetricAllTunnelState(Props MetricOptions) Metricstatic#Metric for the tunnel state of all VPN connections in the account/region.
metricTunnelDataIn(props?: MetricOptions): Metricdef metric_tunnel_data_in(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricTunnelDataIn(MetricOptions props)public Metric MetricTunnelDataIn(MetricOptions? props = null)func MetricTunnelDataIn(Props MetricOptions) Metric#The bytes received through the VPN tunnel.
Sum over 5 minutes
metricTunnelDataOut(props?: MetricOptions): Metricdef metric_tunnel_data_out(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricTunnelDataOut(MetricOptions props)public Metric MetricTunnelDataOut(MetricOptions? props = null)func MetricTunnelDataOut(Props MetricOptions) Metric#The bytes sent through the VPN tunnel.
Sum over 5 minutes
metricTunnelState(props?: MetricOptions): Metricdef metric_tunnel_state(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricTunnelState(MetricOptions props)public Metric MetricTunnelState(MetricOptions? props = null)func MetricTunnelState(Props MetricOptions) Metric#The state of the tunnel. 0 indicates DOWN and 1 indicates UP.
Average over 5 minutes
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#Returns a string representation of this construct.
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.