software.amazon.awscdk.services.ec2

Interface IVpnConnection.Jsii$Default

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IResource, IResource.Jsii$Default, IVpnConnection, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IVpnConnection.Jsii$Proxy

Enclosing interface:

IVpnConnection

@Internal
public static interface IVpnConnection.Jsii$Default
extends IVpnConnection, IResource.Jsii$Default

Internal default implementation for IVpnConnection.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ec2.IVpnConnection

IVpnConnection.Jsii$Default, IVpnConnection.Jsii$Proxy

Method Summary

Modifier and Type	Method and Description
default void	applyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.
default Number	getCustomerGatewayAsn() The ASN of the customer gateway.
default String	getCustomerGatewayId() The id of the customer gateway.
default String	getCustomerGatewayIp() The ip address of the customer gateway.
default ResourceEnvironment	getEnv() The environment this resource belongs to.
default software.constructs.Node	getNode() The tree node.
default Stack	getStack() The stack in which this resource is defined.
default String	getVpnId() The id of the VPN connection.
default Metric	metric(String metricName, MetricOptions props) Return the given named metric for this VPNConnection.
default Metric	metricTunnelDataIn(MetricOptions props) The bytes received through the VPN tunnel.
default Metric	metricTunnelDataOut(MetricOptions props) The bytes sent through the VPN tunnel.
default Metric	metricTunnelState(MetricOptions props) The state of the tunnel.

Methods inherited from interface software.amazon.awscdk.services.ec2.IVpnConnection

metric, metricTunnelDataIn, metricTunnelDataOut, metricTunnelState

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getNode

@Stability(value=Stable)
 @NotNull
default software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

getNode in interface software.constructs.IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(value=Stable)
 @NotNull
default ResourceEnvironment getEnv()

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.

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

@Stability(value=Stable)
 @NotNull
default Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getCustomerGatewayAsn

@Stability(value=Stable)
 @NotNull
default Number getCustomerGatewayAsn()

The ASN of the customer gateway.

Specified by:

getCustomerGatewayAsn in interface IVpnConnection

getCustomerGatewayId

@Stability(value=Stable)
 @NotNull
default String getCustomerGatewayId()

The id of the customer gateway.

Specified by:

getCustomerGatewayId in interface IVpnConnection

getCustomerGatewayIp

@Stability(value=Stable)
 @NotNull
default String getCustomerGatewayIp()

The ip address of the customer gateway.

Specified by:

getCustomerGatewayIp in interface IVpnConnection

getVpnId

@Stability(value=Stable)
 @NotNull
default String getVpnId()

The id of the VPN connection.

Specified by:

getVpnId in interface IVpnConnection

applyRemovalPolicy

@Stability(value=Stable)
default void applyRemovalPolicy(@NotNull
                                                         RemovalPolicy 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).

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Parameters:

policy - This parameter is required.

metric

@Stability(value=Stable)
 @NotNull
default Metric metric(@NotNull
                                                         String metricName,
                                                         @Nullable
                                                         MetricOptions props)

Return the given named metric for this VPNConnection.

Specified by:

metric in interface IVpnConnection

Parameters:

metricName - This parameter is required.

props -

metricTunnelDataIn

@Stability(value=Stable)
 @NotNull
default Metric metricTunnelDataIn(@Nullable
                                                                     MetricOptions props)

The bytes received through the VPN tunnel.

Sum over 5 minutes

Specified by:

metricTunnelDataIn in interface IVpnConnection

Parameters:

props -

metricTunnelDataOut

@Stability(value=Stable)
 @NotNull
default Metric metricTunnelDataOut(@Nullable
                                                                      MetricOptions props)

The bytes sent through the VPN tunnel.

Sum over 5 minutes

Specified by:

metricTunnelDataOut in interface IVpnConnection

Parameters:

props -

metricTunnelState

@Stability(value=Stable)
 @NotNull
default Metric metricTunnelState(@Nullable
                                                                    MetricOptions props)

The state of the tunnel. 0 indicates DOWN and 1 indicates UP.

Average over 5 minutes

Specified by:

metricTunnelState in interface IVpnConnection

Parameters:

props -