VpnConnection¶

class aws_cdk.aws_ec2.VpnConnection(scope, id, *, vpc, ip, asn=None, static_routes=None, tunnel_options=None)¶

Bases: aws_cdk.core.Resource

Define a VPN Connection.

resource: :resource:: AWS::EC2::VPNConnection

__init__(scope, id, *, vpc, ip, asn=None, static_routes=None, tunnel_options=None)¶

Parameters

scope (Construct) –
id (str) –
vpc (IVpc) – The VPC to connect to.
ip (str) – The ip address of the customer gateway.
asn (Union[int, float, None]) – The ASN of the customer gateway. Default: 65000
static_routes (Optional[List[str]]) – The static routes to be routed from the VPN gateway to the customer gateway. Default: Dynamic routing (BGP)
tunnel_options (Optional[List[VpnTunnelOption]]) – The tunnel options for the VPN connection. At most two elements (one per tunnel). Duplicates not allowed. Default: Amazon generated tunnel options

Return type

None

Methods

metric(metric_name, *, account=None, color=None, dimensions=None, label=None, period=None, region=None, statistic=None, unit=None)¶

Return the given named metric for this VPNConnection.

Parameters

metric_name (str) –
account (Optional[str]) – Account which this metric comes from. Default: Deployment account.
color (Optional[str]) – Color for this metric when added to a Graph in a Dashboard.
dimensions (Optional[Mapping[str, Any]]) – Dimensions of the metric. Default: - No dimensions.
label (Optional[str]) – Label for this metric when added to a Graph in a Dashboard.
period (Optional[Duration]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)
region (Optional[str]) – Region which this metric comes from. Default: Deployment region.
statistic (Optional[str]) – What function to use for aggregating. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” Default: Average
unit (Optional[Unit]) – Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: All metric datums in the given metric stream

Return type

Metric

metric_tunnel_data_in(*, account=None, color=None, dimensions=None, label=None, period=None, region=None, statistic=None, unit=None)¶

The bytes received through the VPN tunnel.

Sum over 5 minutes

Parameters

account (Optional[str]) – Account which this metric comes from. Default: Deployment account.
color (Optional[str]) – Color for this metric when added to a Graph in a Dashboard.
dimensions (Optional[Mapping[str, Any]]) – Dimensions of the metric. Default: - No dimensions.
label (Optional[str]) – Label for this metric when added to a Graph in a Dashboard.
period (Optional[Duration]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)
region (Optional[str]) – Region which this metric comes from. Default: Deployment region.
statistic (Optional[str]) – What function to use for aggregating. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” Default: Average
unit (Optional[Unit]) – Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: All metric datums in the given metric stream

Return type

Metric

metric_tunnel_data_out(*, account=None, color=None, dimensions=None, label=None, period=None, region=None, statistic=None, unit=None)¶

The bytes sent through the VPN tunnel.

Sum over 5 minutes

Parameters

account (Optional[str]) – Account which this metric comes from. Default: Deployment account.
color (Optional[str]) – Color for this metric when added to a Graph in a Dashboard.
dimensions (Optional[Mapping[str, Any]]) – Dimensions of the metric. Default: - No dimensions.
label (Optional[str]) – Label for this metric when added to a Graph in a Dashboard.
period (Optional[Duration]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)
region (Optional[str]) – Region which this metric comes from. Default: Deployment region.
statistic (Optional[str]) – What function to use for aggregating. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” Default: Average
unit (Optional[Unit]) – Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: All metric datums in the given metric stream

Return type

Metric

metric_tunnel_state(*, account=None, color=None, dimensions=None, label=None, period=None, region=None, statistic=None, unit=None)¶

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

Average over 5 minutes

Parameters

account (Optional[str]) – Account which this metric comes from. Default: Deployment account.
color (Optional[str]) – Color for this metric when added to a Graph in a Dashboard.
dimensions (Optional[Mapping[str, Any]]) – Dimensions of the metric. Default: - No dimensions.
label (Optional[str]) – Label for this metric when added to a Graph in a Dashboard.
period (Optional[Duration]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)
region (Optional[str]) – Region which this metric comes from. Default: Deployment region.
statistic (Optional[str]) – What function to use for aggregating. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” Default: Average
unit (Optional[Unit]) – Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: All metric datums in the given metric stream

Return type

Metric

to_string()¶

Returns a string representation of this construct.

Return type: str

Attributes

customer_gateway_asn¶

The ASN of the customer gateway.

Return type: Union[int, float]

customer_gateway_id¶

The id of the customer gateway.

Return type: str

customer_gateway_ip¶

The ip address of the customer gateway.

Return type: str

node¶

Construct tree node which offers APIs for interacting with the construct tree.

Return type: ConstructNode

stack¶

The stack in which this resource is defined.

Return type: Stack

vpn_id¶

The id of the VPN connection.

Return type: str

Static Methods

classmethod is_construct(x)¶

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

classmethod metric_all(metric_name, *, account=None, color=None, dimensions=None, label=None, period=None, region=None, statistic=None, unit=None)¶

Return the given named metric for all VPN connections in the account/region.

Parameters

metric_name (str) –
account (Optional[str]) – Account which this metric comes from. Default: Deployment account.
color (Optional[str]) – Color for this metric when added to a Graph in a Dashboard.
dimensions (Optional[Mapping[str, Any]]) – Dimensions of the metric. Default: - No dimensions.
label (Optional[str]) – Label for this metric when added to a Graph in a Dashboard.
period (Optional[Duration]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)
region (Optional[str]) – Region which this metric comes from. Default: Deployment region.
statistic (Optional[str]) – What function to use for aggregating. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” Default: Average
unit (Optional[Unit]) – Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: All metric datums in the given metric stream

Return type

Metric

classmethod metric_all_tunnel_data_in(*, account=None, color=None, dimensions=None, label=None, period=None, region=None, statistic=None, unit=None)¶

Metric for the tunnel data in of all VPN connections in the account/region.

Parameters

account (Optional[str]) – Account which this metric comes from. Default: Deployment account.
color (Optional[str]) – Color for this metric when added to a Graph in a Dashboard.
dimensions (Optional[Mapping[str, Any]]) – Dimensions of the metric. Default: - No dimensions.
label (Optional[str]) – Label for this metric when added to a Graph in a Dashboard.
period (Optional[Duration]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)
region (Optional[str]) – Region which this metric comes from. Default: Deployment region.
statistic (Optional[str]) – What function to use for aggregating. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” Default: Average
unit (Optional[Unit]) – Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: All metric datums in the given metric stream

default :default: sum over 5 minutes

Return type: Metric

classmethod metric_all_tunnel_data_out(*, account=None, color=None, dimensions=None, label=None, period=None, region=None, statistic=None, unit=None)¶

Metric for the tunnel data out of all VPN connections.

Parameters

account (Optional[str]) – Account which this metric comes from. Default: Deployment account.
color (Optional[str]) – Color for this metric when added to a Graph in a Dashboard.
dimensions (Optional[Mapping[str, Any]]) – Dimensions of the metric. Default: - No dimensions.
label (Optional[str]) – Label for this metric when added to a Graph in a Dashboard.
period (Optional[Duration]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)
region (Optional[str]) – Region which this metric comes from. Default: Deployment region.
statistic (Optional[str]) – What function to use for aggregating. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” Default: Average
unit (Optional[Unit]) – Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: All metric datums in the given metric stream

default :default: sum over 5 minutes

Return type: Metric

classmethod metric_all_tunnel_state(*, account=None, color=None, dimensions=None, label=None, period=None, region=None, statistic=None, unit=None)¶

Metric for the tunnel state of all VPN connections in the account/region.

Parameters

account (Optional[str]) – Account which this metric comes from. Default: Deployment account.
color (Optional[str]) – Color for this metric when added to a Graph in a Dashboard.
dimensions (Optional[Mapping[str, Any]]) – Dimensions of the metric. Default: - No dimensions.
label (Optional[str]) – Label for this metric when added to a Graph in a Dashboard.
period (Optional[Duration]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)
region (Optional[str]) – Region which this metric comes from. Default: Deployment region.
statistic (Optional[str]) – What function to use for aggregating. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” Default: Average
unit (Optional[Unit]) – Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: All metric datums in the given metric stream

default :default: average over 5 minutes

Return type: Metric