Class: AWSCDK::EC2::VpnConnectionBase

Inherits:
Resource
  • Object
show all
Includes:
IVpnConnection
Defined in:
ec2/vpn_connection_base.rb

Overview

Base class for Vpn connections.

Direct Known Subclasses

VpnConnection

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ VpnConnectionBase

Returns a new instance of VpnConnectionBase.

Parameters:



12
13
14
15
16
17
18
 
# File 'ec2/vpn_connection_base.rb', line 12

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::ResourceProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvdXJjZVByb3BzIn0=")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.jsii_overridable_methods ⇒ Object 



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

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

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:



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

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:



173
174
175
176
 
# File 'ec2/vpn_connection_base.rb', line 173

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) 


91
92
93
 
# File 'ec2/vpn_connection_base.rb', line 91

def customer_gateway_asn()
  jsii_get_property("customerGatewayAsn")
end

#customer_gateway_id ⇒ String

The id of the customer gateway.

Returns:

  • (String) 


98
99
100
 
# File 'ec2/vpn_connection_base.rb', line 98

def customer_gateway_id()
  jsii_get_property("customerGatewayId")
end

#customer_gateway_ip ⇒ String

The ip address of the customer gateway.

Returns:

  • (String) 


105
106
107
 
# File 'ec2/vpn_connection_base.rb', line 105

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:



63
64
65
 
# File 'ec2/vpn_connection_base.rb', line 63

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


179
180
181
 
# File 'ec2/vpn_connection_base.rb', line 179

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) 


193
194
195
196
197
198
 
# File 'ec2/vpn_connection_base.rb', line 193

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) 


208
209
210
211
 
# File 'ec2/vpn_connection_base.rb', line 208

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:



218
219
220
221
222
223
 
# File 'ec2/vpn_connection_base.rb', line 218

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:



231
232
233
234
235
 
# File 'ec2/vpn_connection_base.rb', line 231

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:



243
244
245
246
247
 
# File 'ec2/vpn_connection_base.rb', line 243

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:



255
256
257
258
259
 
# File 'ec2/vpn_connection_base.rb', line 255

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) 


48
49
50
 
# File 'ec2/vpn_connection_base.rb', line 48

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) 


77
78
79
 
# File 'ec2/vpn_connection_base.rb', line 77

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



84
85
86
 
# File 'ec2/vpn_connection_base.rb', line 84

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


126
127
128
 
# File 'ec2/vpn_connection_base.rb', line 126

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

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

A reference to a VPNConnection resource.

Returns:



112
113
114
 
# File 'ec2/vpn_connection_base.rb', line 112

def vpn_connection_ref()
  jsii_get_property("vpnConnectionRef")
end

#vpn_id ⇒ String

The id of the VPN connection.

Returns:

  • (String) 


119
120
121
 
# File 'ec2/vpn_connection_base.rb', line 119

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) 


139
140
141
142
143
144
 
# File 'ec2/vpn_connection_base.rb', line 139

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