Class: AWSCDK::EC2::CfnVPNConnection

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSEC2::IVPNConnectionRef
Defined in:
ec2/cfn_vpn_connection.rb

Overview

Specifies a VPN connection between a virtual private gateway and a VPN customer gateway or a transit gateway and a VPN customer gateway.

To specify a VPN connection between a transit gateway and customer gateway, use the TransitGatewayId and CustomerGatewayId properties.

To specify a VPN connection between a virtual private gateway and customer gateway, use the VpnGatewayId and CustomerGatewayId properties.

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnVPNConnection

Create a new AWS::EC2::VPNConnection.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::EC2::CfnVPNConnectionProps) —

    Resource properties.



24
25
26
27
28
29
30
 
# File 'ec2/cfn_vpn_connection.rb', line 24

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

Class Method Details

.arn_for_vpn_connection(resource) ⇒ String

Parameters:

Returns:

  • (String) 


95
96
97
98
 
# File 'ec2/cfn_vpn_connection.rb', line 95

def self.arn_for_vpn_connection(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lYzIuSVZQTkNvbm5lY3Rpb25SZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnVPNConnection", "arnForVPNConnection", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


215
216
217
 
# File 'ec2/cfn_vpn_connection.rb', line 215

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

.from_vpn_connection_id(scope, id, vpn_connection_id) ⇒ AWSCDK::Interfaces::AWSEC2::IVPNConnectionRef

Creates a new IVPNConnectionRef from a vpnConnectionId.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • vpn_connection_id (String)

Returns:



106
107
108
109
110
111
 
# File 'ec2/cfn_vpn_connection.rb', line 106

def self.from_vpn_connection_id(scope, id, vpn_connection_id)
  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(vpn_connection_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "vpnConnectionId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnVPNConnection", "fromVpnConnectionId", [scope, id, vpn_connection_id])
end

.is_cfn_vpn_connection(x) ⇒ Boolean

Checks whether the given object is a CfnVPNConnection.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


117
118
119
120
 
# File 'ec2/cfn_vpn_connection.rb', line 117

def self.is_cfn_vpn_connection(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnVPNConnection", "isCfnVPNConnection", [x])
end

.jsii_overridable_methods ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'ec2/cfn_vpn_connection.rb', line 32

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_vpn_connection_id => { kind: :property, name: "attrVpnConnectionId", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :vpn_connection_ref => { kind: :property, name: "vpnConnectionRef", is_optional: false },
    :customer_gateway_id => { kind: :property, name: "customerGatewayId", is_optional: false },
    :type => { kind: :property, name: "type", is_optional: false },
    :enable_acceleration => { kind: :property, name: "enableAcceleration", is_optional: true },
    :local_ipv4_network_cidr => { kind: :property, name: "localIpv4NetworkCidr", is_optional: true },
    :local_ipv6_network_cidr => { kind: :property, name: "localIpv6NetworkCidr", is_optional: true },
    :outside_ip_address_type => { kind: :property, name: "outsideIpAddressType", is_optional: true },
    :pre_shared_key_storage => { kind: :property, name: "preSharedKeyStorage", is_optional: true },
    :remote_ipv4_network_cidr => { kind: :property, name: "remoteIpv4NetworkCidr", is_optional: true },
    :remote_ipv6_network_cidr => { kind: :property, name: "remoteIpv6NetworkCidr", is_optional: true },
    :static_routes_only => { kind: :property, name: "staticRoutesOnly", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :transit_gateway_id => { kind: :property, name: "transitGatewayId", is_optional: true },
    :transport_transit_gateway_attachment_id => { kind: :property, name: "transportTransitGatewayAttachmentId", is_optional: true },
    :tunnel_bandwidth => { kind: :property, name: "tunnelBandwidth", is_optional: true },
    :tunnel_inside_ip_version => { kind: :property, name: "tunnelInsideIpVersion", is_optional: true },
    :vpn_concentrator_id => { kind: :property, name: "vpnConcentratorId", is_optional: true },
    :vpn_gateway_id => { kind: :property, name: "vpnGatewayId", is_optional: true },
    :vpn_tunnel_options_specifications => { kind: :property, name: "vpnTunnelOptionsSpecifications", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", 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 },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



493
494
495
496
 
# File 'ec2/cfn_vpn_connection.rb', line 493

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



505
506
507
508
 
# File 'ec2/cfn_vpn_connection.rb', line 505

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



515
516
517
518
 
# File 'ec2/cfn_vpn_connection.rb', line 515

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



526
527
528
529
530
 
# File 'ec2/cfn_vpn_connection.rb', line 526

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


583
584
585
586
587
 
# File 'ec2/cfn_vpn_connection.rb', line 583

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



593
594
595
596
 
# File 'ec2/cfn_vpn_connection.rb', line 593

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



605
606
607
608
609
 
# File 'ec2/cfn_vpn_connection.rb', line 605

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



618
619
620
621
 
# File 'ec2/cfn_vpn_connection.rb', line 618

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 = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



640
641
642
643
644
645
 
# File 'ec2/cfn_vpn_connection.rb', line 640

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_vpn_connection_id ⇒ String

The ID of the VPN connection.

Returns:

  • (String) 


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

def attr_vpn_connection_id()
  jsii_get_property("attrVpnConnectionId")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



168
169
170
 
# File 'ec2/cfn_vpn_connection.rb', line 168

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


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

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


649
650
651
652
 
# File 'ec2/cfn_vpn_connection.rb', line 649

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


178
179
180
 
# File 'ec2/cfn_vpn_connection.rb', line 178

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


185
186
187
 
# File 'ec2/cfn_vpn_connection.rb', line 185

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


130
131
132
 
# File 'ec2/cfn_vpn_connection.rb', line 130

def creation_stack()
  jsii_get_property("creationStack")
end

#customer_gateway_id ⇒ String

The ID of the customer gateway at your end of the VPN connection.

Returns:

  • (String) 


243
244
245
 
# File 'ec2/cfn_vpn_connection.rb', line 243

def customer_gateway_id()
  jsii_get_property("customerGatewayId")
end

#customer_gateway_id=(value) ⇒ Object 



247
248
249
250
 
# File 'ec2/cfn_vpn_connection.rb', line 247

def customer_gateway_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "customerGatewayId")
  jsii_set_property("customerGatewayId", value)
end

#enable_acceleration ⇒ Boolean, ...

Indicate whether to enable acceleration for the VPN connection.

Returns:



267
268
269
 
# File 'ec2/cfn_vpn_connection.rb', line 267

def enable_acceleration()
  jsii_get_property("enableAcceleration")
end

#enable_acceleration=(value) ⇒ Object 



271
272
273
274
 
# File 'ec2/cfn_vpn_connection.rb', line 271

def enable_acceleration=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enableAcceleration") unless value.nil?
  jsii_set_property("enableAcceleration", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



190
191
192
 
# File 'ec2/cfn_vpn_connection.rb', line 190

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



662
663
664
665
666
 
# File 'ec2/cfn_vpn_connection.rb', line 662

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



673
674
675
676
 
# File 'ec2/cfn_vpn_connection.rb', line 673

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



743
744
745
746
 
# File 'ec2/cfn_vpn_connection.rb', line 743

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#local_ipv4_network_cidr ⇒ String?

The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.

Returns:

  • (String, nil) 


279
280
281
 
# File 'ec2/cfn_vpn_connection.rb', line 279

def local_ipv4_network_cidr()
  jsii_get_property("localIpv4NetworkCidr")
end

#local_ipv4_network_cidr=(value) ⇒ Object 



283
284
285
286
 
# File 'ec2/cfn_vpn_connection.rb', line 283

def local_ipv4_network_cidr=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "localIpv4NetworkCidr") unless value.nil?
  jsii_set_property("localIpv4NetworkCidr", value)
end

#local_ipv6_network_cidr ⇒ String?

The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.

Returns:

  • (String, nil) 


291
292
293
 
# File 'ec2/cfn_vpn_connection.rb', line 291

def local_ipv6_network_cidr()
  jsii_get_property("localIpv6NetworkCidr")
end

#local_ipv6_network_cidr=(value) ⇒ Object 



295
296
297
298
 
# File 'ec2/cfn_vpn_connection.rb', line 295

def local_ipv6_network_cidr=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "localIpv6NetworkCidr") unless value.nil?
  jsii_set_property("localIpv6NetworkCidr", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


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

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


125
126
127
 
# File 'ec2/cfn_vpn_connection.rb', line 125

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



684
685
686
 
# File 'ec2/cfn_vpn_connection.rb', line 684

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



691
692
693
 
# File 'ec2/cfn_vpn_connection.rb', line 691

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#outside_ip_address_type ⇒ String?

The type of IP address assigned to the outside interface of the customer gateway device.

Returns:

  • (String, nil) 


303
304
305
 
# File 'ec2/cfn_vpn_connection.rb', line 303

def outside_ip_address_type()
  jsii_get_property("outsideIpAddressType")
end

#outside_ip_address_type=(value) ⇒ Object 



307
308
309
310
 
# File 'ec2/cfn_vpn_connection.rb', line 307

def outside_ip_address_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "outsideIpAddressType") unless value.nil?
  jsii_set_property("outsideIpAddressType", value)
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



484
485
486
487
 
# File 'ec2/cfn_vpn_connection.rb', line 484

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#pre_shared_key_storage ⇒ String?

Describes the storage location for an instance store-backed AMI.

Returns:

  • (String, nil) 


315
316
317
 
# File 'ec2/cfn_vpn_connection.rb', line 315

def pre_shared_key_storage()
  jsii_get_property("preSharedKeyStorage")
end

#pre_shared_key_storage=(value) ⇒ Object 



319
320
321
322
 
# File 'ec2/cfn_vpn_connection.rb', line 319

def pre_shared_key_storage=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "preSharedKeyStorage") unless value.nil?
  jsii_set_property("preSharedKeyStorage", value)
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


161
162
163
 
# File 'ec2/cfn_vpn_connection.rb', line 161

def ref()
  jsii_get_property("ref")
end

#remote_ipv4_network_cidr ⇒ String?

The IPv4 CIDR on the AWS side of the VPN connection.

Returns:

  • (String, nil) 


327
328
329
 
# File 'ec2/cfn_vpn_connection.rb', line 327

def remote_ipv4_network_cidr()
  jsii_get_property("remoteIpv4NetworkCidr")
end

#remote_ipv4_network_cidr=(value) ⇒ Object 



331
332
333
334
 
# File 'ec2/cfn_vpn_connection.rb', line 331

def remote_ipv4_network_cidr=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "remoteIpv4NetworkCidr") unless value.nil?
  jsii_set_property("remoteIpv4NetworkCidr", value)
end

#remote_ipv6_network_cidr ⇒ String?

The IPv6 CIDR on the AWS side of the VPN connection.

Returns:

  • (String, nil) 


339
340
341
 
# File 'ec2/cfn_vpn_connection.rb', line 339

def remote_ipv6_network_cidr()
  jsii_get_property("remoteIpv6NetworkCidr")
end

#remote_ipv6_network_cidr=(value) ⇒ Object 



343
344
345
346
 
# File 'ec2/cfn_vpn_connection.rb', line 343

def remote_ipv6_network_cidr=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "remoteIpv6NetworkCidr") unless value.nil?
  jsii_set_property("remoteIpv6NetworkCidr", value)
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



702
703
704
705
 
# File 'ec2/cfn_vpn_connection.rb', line 702

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


709
710
711
712
 
# File 'ec2/cfn_vpn_connection.rb', line 709

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



719
720
721
722
723
 
# File 'ec2/cfn_vpn_connection.rb', line 719

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



728
729
730
 
# File 'ec2/cfn_vpn_connection.rb', line 728

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



151
152
153
 
# File 'ec2/cfn_vpn_connection.rb', line 151

def stack()
  jsii_get_property("stack")
end

#static_routes_only ⇒ Boolean, ...

Indicates whether the VPN connection uses static routes only.

Returns:



351
352
353
 
# File 'ec2/cfn_vpn_connection.rb', line 351

def static_routes_only()
  jsii_get_property("staticRoutesOnly")
end

#static_routes_only=(value) ⇒ Object 



355
356
357
358
 
# File 'ec2/cfn_vpn_connection.rb', line 355

def static_routes_only=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "staticRoutesOnly") unless value.nil?
  jsii_set_property("staticRoutesOnly", value)
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



229
230
231
 
# File 'ec2/cfn_vpn_connection.rb', line 229

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

Any tags assigned to the VPN connection.

Returns:



363
364
365
 
# File 'ec2/cfn_vpn_connection.rb', line 363

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



367
368
369
370
371
 
# File 'ec2/cfn_vpn_connection.rb', line 367

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



460
461
462
 
# File 'ec2/cfn_vpn_connection.rb', line 460

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

#transit_gateway_id ⇒ String?

The ID of the transit gateway associated with the VPN connection.

Returns:

  • (String, nil) 


376
377
378
 
# File 'ec2/cfn_vpn_connection.rb', line 376

def transit_gateway_id()
  jsii_get_property("transitGatewayId")
end

#transit_gateway_id=(value) ⇒ Object 



380
381
382
383
 
# File 'ec2/cfn_vpn_connection.rb', line 380

def transit_gateway_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "transitGatewayId") unless value.nil?
  jsii_set_property("transitGatewayId", value)
end

#transport_transit_gateway_attachment_id ⇒ String?

The transit gateway attachment ID to use for the VPN tunnel.

Returns:

  • (String, nil) 


388
389
390
 
# File 'ec2/cfn_vpn_connection.rb', line 388

def transport_transit_gateway_attachment_id()
  jsii_get_property("transportTransitGatewayAttachmentId")
end

#transport_transit_gateway_attachment_id=(value) ⇒ Object 



392
393
394
395
 
# File 'ec2/cfn_vpn_connection.rb', line 392

def transport_transit_gateway_attachment_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "transportTransitGatewayAttachmentId") unless value.nil?
  jsii_set_property("transportTransitGatewayAttachmentId", value)
end

#tunnel_bandwidth ⇒ String?

The desired bandwidth specification for the VPN tunnel, used when creating or modifying VPN connection options to set the tunnel's throughput capacity.

Returns:

  • (String, nil) 


400
401
402
 
# File 'ec2/cfn_vpn_connection.rb', line 400

def tunnel_bandwidth()
  jsii_get_property("tunnelBandwidth")
end

#tunnel_bandwidth=(value) ⇒ Object 



404
405
406
407
 
# File 'ec2/cfn_vpn_connection.rb', line 404

def tunnel_bandwidth=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "tunnelBandwidth") unless value.nil?
  jsii_set_property("tunnelBandwidth", value)
end

#tunnel_inside_ip_version ⇒ String?

Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.

Returns:

  • (String, nil) 


412
413
414
 
# File 'ec2/cfn_vpn_connection.rb', line 412

def tunnel_inside_ip_version()
  jsii_get_property("tunnelInsideIpVersion")
end

#tunnel_inside_ip_version=(value) ⇒ Object 



416
417
418
419
 
# File 'ec2/cfn_vpn_connection.rb', line 416

def tunnel_inside_ip_version=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "tunnelInsideIpVersion") unless value.nil?
  jsii_set_property("tunnelInsideIpVersion", value)
end

#type ⇒ String

The type of VPN connection.

Returns:

  • (String) 


255
256
257
 
# File 'ec2/cfn_vpn_connection.rb', line 255

def type()
  jsii_get_property("type")
end

#type=(value) ⇒ Object 



259
260
261
262
 
# File 'ec2/cfn_vpn_connection.rb', line 259

def type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  jsii_set_property("type", value)
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


198
199
200
 
# File 'ec2/cfn_vpn_connection.rb', line 198

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


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

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


734
735
736
737
 
# File 'ec2/cfn_vpn_connection.rb', line 734

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#vpn_concentrator_id ⇒ String?

The ID of the VPN concentrator to associate with the VPN connection.

Returns:

  • (String, nil) 


424
425
426
 
# File 'ec2/cfn_vpn_connection.rb', line 424

def vpn_concentrator_id()
  jsii_get_property("vpnConcentratorId")
end

#vpn_concentrator_id=(value) ⇒ Object 



428
429
430
431
 
# File 'ec2/cfn_vpn_connection.rb', line 428

def vpn_concentrator_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "vpnConcentratorId") unless value.nil?
  jsii_set_property("vpnConcentratorId", value)
end

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

A reference to a VPNConnection resource.

Returns:



236
237
238
 
# File 'ec2/cfn_vpn_connection.rb', line 236

def vpn_connection_ref()
  jsii_get_property("vpnConnectionRef")
end

#vpn_gateway_id ⇒ String?

The ID of the virtual private gateway at the AWS side of the VPN connection.

Returns:

  • (String, nil) 


436
437
438
 
# File 'ec2/cfn_vpn_connection.rb', line 436

def vpn_gateway_id()
  jsii_get_property("vpnGatewayId")
end

#vpn_gateway_id=(value) ⇒ Object 



440
441
442
443
 
# File 'ec2/cfn_vpn_connection.rb', line 440

def vpn_gateway_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "vpnGatewayId") unless value.nil?
  jsii_set_property("vpnGatewayId", value)
end

#vpn_tunnel_options_specifications ⇒ AWSCDK::IResolvable, ...

The tunnel options for the VPN connection.

Returns:



448
449
450
 
# File 'ec2/cfn_vpn_connection.rb', line 448

def vpn_tunnel_options_specifications()
  jsii_get_property("vpnTunnelOptionsSpecifications")
end

#vpn_tunnel_options_specifications=(value) ⇒ Object 



452
453
454
455
 
# File 'ec2/cfn_vpn_connection.rb', line 452

def vpn_tunnel_options_specifications=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkNmblZQTkNvbm5lY3Rpb24uVnBuVHVubmVsT3B0aW9uc1NwZWNpZmljYXRpb25Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "vpnTunnelOptionsSpecifications") unless value.nil?
  jsii_set_property("vpnTunnelOptionsSpecifications", value)
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) 


473
474
475
476
477
478
 
# File 'ec2/cfn_vpn_connection.rb', line 473

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