Class: AWSCDK::EC2::VpnConnection

Inherits:
VpnConnectionBase
  • Object
show all
Defined in:
ec2/vpn_connection.rb

Overview

Define a VPN Connection.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ VpnConnection

Returns a new instance of VpnConnection.

Parameters:



11
12
13
14
15
16
17
 
# File 'ec2/vpn_connection.rb', line 11

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::EC2::VpnConnectionProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLlZwbkNvbm5lY3Rpb25Qcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.from_vpn_connection_attributes(scope, id, attrs) ⇒ AWSCDK::EC2::IVpnConnection

Import a VPN connection by supplying all attributes directly.

Parameters:

Returns:



50
51
52
53
54
55
56
 
# File 'ec2/vpn_connection.rb', line 50

def self.from_vpn_connection_attributes(scope, id, attrs)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  attrs = attrs.is_a?(Hash) ? ::AWSCDK::EC2::VpnConnectionAttributes.new(**attrs.transform_keys(&:to_sym)) : attrs
  Jsii::Type.check_type(attrs, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLlZwbkNvbm5lY3Rpb25BdHRyaWJ1dGVzIn0=")), "attrs")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.VpnConnection", "fromVpnConnectionAttributes", [scope, id, attrs])
end

.jsii_overridable_methods ⇒ Object 



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'ec2/vpn_connection.rb', line 19

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :customer_gateway_asn => { kind: :property, name: "customerGatewayAsn", is_optional: false },
    :customer_gateway_id => { kind: :property, name: "customerGatewayId", is_optional: false },
    :customer_gateway_ip => { kind: :property, name: "customerGatewayIp", is_optional: false },
    :vpn_connection_ref => { kind: :property, name: "vpnConnectionRef", is_optional: false },
    :vpn_id => { kind: :property, name: "vpnId", is_optional: false },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
    :metric => { kind: :method, name: "metric", is_optional: false },
    :metric_tunnel_data_in => { kind: :method, name: "metricTunnelDataIn", is_optional: false },
    :metric_tunnel_data_out => { kind: :method, name: "metricTunnelDataOut", is_optional: false },
    :metric_tunnel_state => { kind: :method, name: "metricTunnelState", is_optional: false },
  }
end

.metric_all(metric_name, props = nil) ⇒ AWSCDK::CloudWatch::Metric

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

Parameters:

Returns:



63
64
65
66
67
68
 
# File 'ec2/vpn_connection.rb', line 63

def self.metric_all(metric_name, props = nil)
  Jsii::Type.check_type(metric_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "metricName")
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.VpnConnection", "metricAll", [metric_name, props])
end

.metric_all_tunnel_data_in(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: sum over 5 minutes

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

Parameters:

Returns:



75
76
77
78
79
 
# File 'ec2/vpn_connection.rb', line 75

def self.metric_all_tunnel_data_in(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.VpnConnection", "metricAllTunnelDataIn", [props])
end

.metric_all_tunnel_data_out(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: sum over 5 minutes

Metric for the tunnel data out of all VPN connections.

Parameters:

Returns:



86
87
88
89
90
 
# File 'ec2/vpn_connection.rb', line 86

def self.metric_all_tunnel_data_out(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.VpnConnection", "metricAllTunnelDataOut", [props])
end

.metric_all_tunnel_state(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: average over 5 minutes

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

Parameters:

Returns:



97
98
99
100
101
 
# File 'ec2/vpn_connection.rb', line 97

def self.metric_all_tunnel_state(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.VpnConnection", "metricAllTunnelState", [props])
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


184
185
186
 
# File 'ec2/vpn_connection.rb', line 184

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.VpnConnection", "PROPERTY_INJECTION_ID")
end

Instance Method Details

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

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:



221
222
223
224
 
# File 'ec2/vpn_connection.rb', line 221

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

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).

Parameters:



238
239
240
241
 
# File 'ec2/vpn_connection.rb', line 238

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#customer_gateway_asn ⇒ Numeric

The ASN of the customer gateway.

Returns:

  • (Numeric) 


149
150
151
 
# File 'ec2/vpn_connection.rb', line 149

def customer_gateway_asn()
  jsii_get_property("customerGatewayAsn")
end

#customer_gateway_id ⇒ String

The id of the customer gateway.

Returns:

  • (String) 


156
157
158
 
# File 'ec2/vpn_connection.rb', line 156

def customer_gateway_id()
  jsii_get_property("customerGatewayId")
end

#customer_gateway_ip ⇒ String

The ip address of the customer gateway.

Returns:

  • (String) 


163
164
165
 
# File 'ec2/vpn_connection.rb', line 163

def customer_gateway_ip()
  jsii_get_property("customerGatewayIp")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

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.

Returns:



121
122
123
 
# File 'ec2/vpn_connection.rb', line 121

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


244
245
246
 
# File 'ec2/vpn_connection.rb', line 244

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


258
259
260
261
262
263
 
# File 'ec2/vpn_connection.rb', line 258

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


273
274
275
276
 
# File 'ec2/vpn_connection.rb', line 273

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#metric(metric_name, props = nil) ⇒ AWSCDK::CloudWatch::Metric

Return the given named metric for this VPNConnection.

Parameters:

Returns:



283
284
285
286
287
288
 
# File 'ec2/vpn_connection.rb', line 283

def metric(metric_name, props = nil)
  Jsii::Type.check_type(metric_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "metricName")
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metric", [metric_name, props])
end

#metric_tunnel_data_in(props = nil) ⇒ AWSCDK::CloudWatch::Metric

The bytes received through the VPN tunnel.

Sum over 5 minutes

Parameters:

Returns:



296
297
298
299
300
 
# File 'ec2/vpn_connection.rb', line 296

def metric_tunnel_data_in(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricTunnelDataIn", [props])
end

#metric_tunnel_data_out(props = nil) ⇒ AWSCDK::CloudWatch::Metric

The bytes sent through the VPN tunnel.

Sum over 5 minutes

Parameters:

Returns:



308
309
310
311
312
 
# File 'ec2/vpn_connection.rb', line 308

def metric_tunnel_data_out(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricTunnelDataOut", [props])
end

#metric_tunnel_state(props = nil) ⇒ AWSCDK::CloudWatch::Metric

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

Average over 5 minutes

Parameters:

Returns:



320
321
322
323
324
 
# File 'ec2/vpn_connection.rb', line 320

def metric_tunnel_state(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricTunnelState", [props])
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


106
107
108
 
# File 'ec2/vpn_connection.rb', line 106

def node()
  jsii_get_property("node")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


135
136
137
 
# File 'ec2/vpn_connection.rb', line 135

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



142
143
144
 
# File 'ec2/vpn_connection.rb', line 142

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


191
192
193
 
# File 'ec2/vpn_connection.rb', line 191

def to_string()
  jsii_call_method("toString", [])
end

#vpn_connection_ref ⇒ AWSCDK::Interfaces::AWSEC2::VPNConnectionReference

A reference to a VPNConnection resource.

Returns:



170
171
172
 
# File 'ec2/vpn_connection.rb', line 170

def vpn_connection_ref()
  jsii_get_property("vpnConnectionRef")
end

#vpn_id ⇒ String

The id of the VPN connection.

Returns:

  • (String) 


177
178
179
 
# File 'ec2/vpn_connection.rb', line 177

def vpn_id()
  jsii_get_property("vpnId")
end

#with(*mixins) ⇒ Constructs::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.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


204
205
206
207
208
209
 
# File 'ec2/vpn_connection.rb', line 204

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end