Class: AWSCDK::EC2::NatInstanceProvider Deprecated

Inherits:
NatProvider
  • Object
show all
Includes:
IConnectable
Defined in:
ec2/nat_instance_provider.rb

Overview

Deprecated.

use NatInstanceProviderV2. NatInstanceProvider is deprecated since the instance image used has reached EOL on Dec 31 2023

NAT provider which uses NAT Instances.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(props) ⇒ NatInstanceProvider

Returns a new instance of NatInstanceProvider.

Parameters:



12
13
14
15
16
 
# File 'ec2/nat_instance_provider.rb', line 12

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

Class Method Details

.jsii_overridable_methods ⇒ Object 



18
19
20
21
22
23
24
25
26
 
# File 'ec2/nat_instance_provider.rb', line 18

def self.jsii_overridable_methods
  {
    :configured_gateways => { kind: :property, name: "configuredGateways", is_optional: false },
    :connections => { kind: :property, name: "connections", is_optional: false },
    :security_group => { kind: :property, name: "securityGroup", is_optional: false },
    :configure_nat => { kind: :method, name: "configureNat", is_optional: false },
    :configure_subnet => { kind: :method, name: "configureSubnet", is_optional: false },
  }
end

Instance Method Details

#configure_nat(options) ⇒ void

This method returns an undefined value.

Called by the VPC to configure NAT.

Don't call this directly, the VPC will call it automatically.

Parameters:



55
56
57
58
59
 
# File 'ec2/nat_instance_provider.rb', line 55

def configure_nat(options)
  options = options.is_a?(Hash) ? ::AWSCDK::EC2::ConfigureNatOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkNvbmZpZ3VyZU5hdE9wdGlvbnMifQ==")), "options")
  jsii_call_method("configureNat", [options])
end

#configure_subnet(subnet) ⇒ void

This method returns an undefined value.

Configures subnet with the gateway.

Don't call this directly, the VPC will call it automatically.

Parameters:



67
68
69
70
 
# File 'ec2/nat_instance_provider.rb', line 67

def configure_subnet(subnet)
  Jsii::Type.check_type(subnet, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLlByaXZhdGVTdWJuZXQifQ==")), "subnet")
  jsii_call_method("configureSubnet", [subnet])
end

#configured_gateways ⇒ Array<AWSCDK::EC2::GatewayConfig>

Return list of gateways spawned by the provider.

Returns:



31
32
33
 
# File 'ec2/nat_instance_provider.rb', line 31

def configured_gateways()
  jsii_get_property("configuredGateways")
end

#connections ⇒ AWSCDK::EC2::Connections

Manage the Security Groups associated with the NAT instances.

Returns:



38
39
40
 
# File 'ec2/nat_instance_provider.rb', line 38

def connections()
  jsii_get_property("connections")
end

#security_group ⇒ AWSCDK::EC2::ISecurityGroup

The Security Group associated with the NAT instances.

Returns:



45
46
47
 
# File 'ec2/nat_instance_provider.rb', line 45

def security_group()
  jsii_get_property("securityGroup")
end