Class: AWSCDK::EC2::CfnNatGateway

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

Overview

Specifies a network address translation (NAT) gateway in the specified subnet.

You can create either a public NAT gateway or a private NAT gateway. The default is a public NAT gateway. If you create a public NAT gateway, you must specify an elastic IP address.

With a NAT gateway, instances in a private subnet can connect to the internet, other AWS services, or an on-premises network using the IP address of the NAT gateway. For more information, see NAT gateways in the Amazon VPC User Guide .

If you add a default route ( AWS::EC2::Route resource) that points to a NAT gateway, specify the NAT gateway ID for the route's NatGatewayId property.

When you associate an Elastic IP address or secondary Elastic IP address with a public NAT gateway, the network border group of the Elastic IP address must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. Otherwise, the NAT gateway fails to launch. You can see the network border group for the AZ by viewing the details of the subnet. Similarly, you can view the network border group for the Elastic IP address by viewing its details. For more information, see Allocate an Elastic IP address in the Amazon VPC User Guide .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Create a new AWS::EC2::NatGateway.

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::CfnNatGatewayProps, nil) (defaults to: nil) —

    Resource properties.



26
27
28
29
30
31
32
 
# File 'ec2/cfn_nat_gateway.rb', line 26

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

Class Method Details

.arn_for_nat_gateway(resource) ⇒ String

Parameters:

Returns:

  • (String) 


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

def self.arn_for_nat_gateway(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lYzIuSU5hdEdhdGV3YXlSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnNatGateway", "arnForNatGateway", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


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

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

.from_nat_gateway_id(scope, id, nat_gateway_id) ⇒ AWSCDK::Interfaces::AWSEC2::INatGatewayRef

Creates a new INatGatewayRef from a natGatewayId.

Parameters:

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

Returns:



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

def self.from_nat_gateway_id(scope, id, nat_gateway_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(nat_gateway_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "natGatewayId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnNatGateway", "fromNatGatewayId", [scope, id, nat_gateway_id])
end

.is_cfn_nat_gateway(x) ⇒ Boolean

Checks whether the given object is a CfnNatGateway.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


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

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

.jsii_overridable_methods ⇒ Object 



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_nat_gateway.rb', line 34

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_auto_provision_zones => { kind: :property, name: "attrAutoProvisionZones", is_optional: false },
    :attr_auto_scaling_ips => { kind: :property, name: "attrAutoScalingIps", is_optional: false },
    :attr_eni_id => { kind: :property, name: "attrEniId", is_optional: false },
    :attr_nat_gateway_id => { kind: :property, name: "attrNatGatewayId", is_optional: false },
    :attr_route_table_id => { kind: :property, name: "attrRouteTableId", is_optional: false },
    :nat_gateway_ref => { kind: :property, name: "natGatewayRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :allocation_id => { kind: :property, name: "allocationId", is_optional: true },
    :availability_mode => { kind: :property, name: "availabilityMode", is_optional: true },
    :availability_zone_addresses => { kind: :property, name: "availabilityZoneAddresses", is_optional: true },
    :connectivity_type => { kind: :property, name: "connectivityType", is_optional: true },
    :max_drain_duration_seconds => { kind: :property, name: "maxDrainDurationSeconds", is_optional: true },
    :private_ip_address => { kind: :property, name: "privateIpAddress", is_optional: true },
    :secondary_allocation_ids => { kind: :property, name: "secondaryAllocationIds", is_optional: true },
    :secondary_private_ip_address_count => { kind: :property, name: "secondaryPrivateIpAddressCount", is_optional: true },
    :secondary_private_ip_addresses => { kind: :property, name: "secondaryPrivateIpAddresses", is_optional: true },
    :subnet_id => { kind: :property, name: "subnetId", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :vpc_id => { kind: :property, name: "vpcId", 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.



457
458
459
460
 
# File 'ec2/cfn_nat_gateway.rb', line 457

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:



469
470
471
472
 
# File 'ec2/cfn_nat_gateway.rb', line 469

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:



479
480
481
482
 
# File 'ec2/cfn_nat_gateway.rb', line 479

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:



490
491
492
493
494
 
# File 'ec2/cfn_nat_gateway.rb', line 490

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.


547
548
549
550
551
 
# File 'ec2/cfn_nat_gateway.rb', line 547

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.



557
558
559
560
 
# File 'ec2/cfn_nat_gateway.rb', line 557

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.



569
570
571
572
573
 
# File 'ec2/cfn_nat_gateway.rb', line 569

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

#allocation_id ⇒ String?

[Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway.

Returns:

  • (String, nil) 


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

def allocation_id()
  jsii_get_property("allocationId")
end

#allocation_id=(value) ⇒ Object 



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

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



582
583
584
585
 
# File 'ec2/cfn_nat_gateway.rb', line 582

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:



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

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_auto_provision_zones ⇒ String

For regional NAT gateways only: Indicates whether AWS automatically manages AZ coverage.

When enabled, the NAT gateway associates EIPs in all AZs where your VPC has subnets to handle outbound NAT traffic, expands to new AZs when you create subnets there, and retracts from AZs where you've removed all subnets. When disabled, you must manually manage which AZs the NAT gateway supports and their corresponding EIPs.

A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide .

Returns:

  • (String) 


228
229
230
 
# File 'ec2/cfn_nat_gateway.rb', line 228

def attr_auto_provision_zones()
  jsii_get_property("attrAutoProvisionZones")
end

#attr_auto_scaling_ips ⇒ String

For regional NAT gateways only: Indicates whether AWS automatically allocates additional Elastic IP addresses (EIPs) in an AZ when the NAT gateway needs more ports due to increased concurrent connections to a single destination from that AZ.

For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide .

Returns:

  • (String) 


237
238
239
 
# File 'ec2/cfn_nat_gateway.rb', line 237

def attr_auto_scaling_ips()
  jsii_get_property("attrAutoScalingIps")
end

#attr_eni_id ⇒ String

The ID of the network interface.

Returns:

  • (String) 


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

def attr_eni_id()
  jsii_get_property("attrEniId")
end

#attr_nat_gateway_id ⇒ String

The ID of the NAT gateway.

Returns:

  • (String) 


251
252
253
 
# File 'ec2/cfn_nat_gateway.rb', line 251

def attr_nat_gateway_id()
  jsii_get_property("attrNatGatewayId")
end

#attr_route_table_id ⇒ String

For regional NAT gateways only, this is the ID of the NAT gateway.

Returns:

  • (String) 


258
259
260
 
# File 'ec2/cfn_nat_gateway.rb', line 258

def attr_route_table_id()
  jsii_get_property("attrRouteTableId")
end

#availability_mode ⇒ String?

Indicates whether this is a zonal (single-AZ) or regional (multi-AZ) NAT gateway.

Returns:

  • (String, nil) 


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

def availability_mode()
  jsii_get_property("availabilityMode")
end

#availability_mode=(value) ⇒ Object 



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

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

#availability_zone_addresses ⇒ AWSCDK::IResolvable, ...

For regional NAT gateways only: Specifies which Availability Zones you want the NAT gateway to support and the Elastic IP addresses (EIPs) to use in each AZ.

Returns:



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

def availability_zone_addresses()
  jsii_get_property("availabilityZoneAddresses")
end

#availability_zone_addresses=(value) ⇒ Object 



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

def availability_zone_addresses=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkNmbk5hdEdhdGV3YXkuQXZhaWxhYmlsaXR5Wm9uZUFkZHJlc3NQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "availabilityZoneAddresses") unless value.nil?
  jsii_set_property("availabilityZoneAddresses", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



168
169
170
 
# File 'ec2/cfn_nat_gateway.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_nat_gateway.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) 


613
614
615
616
 
# File 'ec2/cfn_nat_gateway.rb', line 613

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_nat_gateway.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_nat_gateway.rb', line 185

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#connectivity_type ⇒ String?

Indicates whether the NAT gateway supports public or private connectivity.

Returns:

  • (String, nil) 


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

def connectivity_type()
  jsii_get_property("connectivityType")
end

#connectivity_type=(value) ⇒ Object 



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

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

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


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

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



190
191
192
 
# File 'ec2/cfn_nat_gateway.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:



626
627
628
629
630
 
# File 'ec2/cfn_nat_gateway.rb', line 626

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:



637
638
639
640
 
# File 'ec2/cfn_nat_gateway.rb', line 637

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:



707
708
709
710
 
# File 'ec2/cfn_nat_gateway.rb', line 707

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
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_nat_gateway.rb', line 142

def logical_id()
  jsii_get_property("logicalId")
end

#max_drain_duration_seconds ⇒ Numeric?

The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress.

Returns:

  • (Numeric, nil) 


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

def max_drain_duration_seconds()
  jsii_get_property("maxDrainDurationSeconds")
end

#max_drain_duration_seconds=(value) ⇒ Object 



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

def max_drain_duration_seconds=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxDrainDurationSeconds") unless value.nil?
  jsii_set_property("maxDrainDurationSeconds", value)
end

#nat_gateway_ref ⇒ AWSCDK::Interfaces::AWSEC2::NatGatewayReference

A reference to a NatGateway resource.

Returns:



265
266
267
 
# File 'ec2/cfn_nat_gateway.rb', line 265

def nat_gateway_ref()
  jsii_get_property("natGatewayRef")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


125
126
127
 
# File 'ec2/cfn_nat_gateway.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:



648
649
650
 
# File 'ec2/cfn_nat_gateway.rb', line 648

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:



655
656
657
 
# File 'ec2/cfn_nat_gateway.rb', line 655

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
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.



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

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

#private_ip_address ⇒ String?

The private IPv4 address to assign to the NAT gateway.

Returns:

  • (String, nil) 


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

def private_ip_address()
  jsii_get_property("privateIpAddress")
end

#private_ip_address=(value) ⇒ Object 



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

def private_ip_address=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "privateIpAddress") unless value.nil?
  jsii_set_property("privateIpAddress", 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_nat_gateway.rb', line 161

def ref()
  jsii_get_property("ref")
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:



666
667
668
669
 
# File 'ec2/cfn_nat_gateway.rb', line 666

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


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

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:



683
684
685
686
687
 
# File 'ec2/cfn_nat_gateway.rb', line 683

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

#secondary_allocation_ids ⇒ Array<String>?

Secondary EIP allocation IDs.

Returns:

  • (Array<String>, nil) 


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

def secondary_allocation_ids()
  jsii_get_property("secondaryAllocationIds")
end

#secondary_allocation_ids=(value) ⇒ Object 



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

def secondary_allocation_ids=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "secondaryAllocationIds") unless value.nil?
  jsii_set_property("secondaryAllocationIds", value)
end

#secondary_private_ip_address_count ⇒ Numeric?

[Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway.

Returns:

  • (Numeric, nil) 


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

def secondary_private_ip_address_count()
  jsii_get_property("secondaryPrivateIpAddressCount")
end

#secondary_private_ip_address_count=(value) ⇒ Object 



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

def secondary_private_ip_address_count=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "secondaryPrivateIpAddressCount") unless value.nil?
  jsii_set_property("secondaryPrivateIpAddressCount", value)
end

#secondary_private_ip_addresses ⇒ Array<String>?

Secondary private IPv4 addresses.

Returns:

  • (Array<String>, nil) 


375
376
377
 
# File 'ec2/cfn_nat_gateway.rb', line 375

def secondary_private_ip_addresses()
  jsii_get_property("secondaryPrivateIpAddresses")
end

#secondary_private_ip_addresses=(value) ⇒ Object 



379
380
381
382
 
# File 'ec2/cfn_nat_gateway.rb', line 379

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



692
693
694
 
# File 'ec2/cfn_nat_gateway.rb', line 692

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_nat_gateway.rb', line 151

def stack()
  jsii_get_property("stack")
end

#subnet_id ⇒ String?

The ID of the subnet in which the NAT gateway is located.

Returns:

  • (String, nil) 


387
388
389
 
# File 'ec2/cfn_nat_gateway.rb', line 387

def subnet_id()
  jsii_get_property("subnetId")
end

#subnet_id=(value) ⇒ Object 



391
392
393
394
 
# File 'ec2/cfn_nat_gateway.rb', line 391

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

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



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

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

The tags for the NAT gateway.

Returns:



399
400
401
 
# File 'ec2/cfn_nat_gateway.rb', line 399

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



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

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



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

def to_string()
  jsii_call_method("toString", [])
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_nat_gateway.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_nat_gateway.rb', line 208

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


698
699
700
701
 
# File 'ec2/cfn_nat_gateway.rb', line 698

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

#vpc_id ⇒ String?

The ID of the VPC in which the NAT gateway is located.

Returns:

  • (String, nil) 


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

def vpc_id()
  jsii_get_property("vpcId")
end

#vpc_id=(value) ⇒ Object 



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

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


437
438
439
440
441
442
 
# File 'ec2/cfn_nat_gateway.rb', line 437

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