Class: MintPress::Aws::EC2::NatGateway

Inherits:
Object
  • Object
show all
Includes:
MintLogger, AwsCommon, Mixins::Properties
Defined in:
src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/nat_gateway.rb

Properties (Read/Write)

  • #tags ⇒ Hash of ⇒ [MintPress::Aws::EC2::Tag]
    'The tags to assign to the NAT gateway.'
    Property Attributes
    • source ⇒ "create_nat_gateway"
    • orig_name ⇒ 'tags'
    • create_nat_gateway_prop ⇒ 'tag_specifications'
    • read_only ⇒ false
    

36
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/nat_gateway.rb', line 36

property :tags, description: 'The tags to assign to the NAT gateway.', source: "create_nat_gateway", orig_name: 'tags', type: [MintPress::Aws::EC2::Tag], array: false, create_nat_gateway_prop: 'tag_specifications', read_only: false, hash: true
  • #client_token ⇒ [String]
    'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency. Constraint: Maximum 64 ASCII characters.'
    Property Attributes
    • create_nat_gateway_prop ⇒ 'client_token'
    • read_only ⇒ false
    • source ⇒ "create_nat_gateway"
    

37
38
39
40
41
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/nat_gateway.rb', line 37

property :client_token, create_nat_gateway_prop: 'client_token', type: [String], read_only: false, source: "create_nat_gateway", description: 'Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see How to Ensure
Idempotency.

Constraint: Maximum 64 ASCII characters.'
  • #dry_run ⇒ [TrueClass,FalseClass]
    'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
    Property Attributes
    • create_nat_gateway_prop ⇒ 'dry_run'
    • read_only ⇒ false
    • source ⇒ "create_nat_gateway"
    • delete_nat_gateway_prop ⇒ 'dry_run'
    • describe_nat_gateways_prop ⇒ 'dry_run'
    

42
43
44
45
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/nat_gateway.rb', line 42

property :dry_run, create_nat_gateway_prop: 'dry_run', type: [TrueClass,FalseClass], read_only: false, source: "create_nat_gateway", description: 'Checks whether you have the required permissions for the action,
without actually making the request, and provides an error response.
If you have the required permissions, the error response is
DryRunOperation. Otherwise, it is UnauthorizedOperation.', delete_nat_gateway_prop: 'dry_run', describe_nat_gateways_prop: 'dry_run'
  • #filter ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'One or more filters. nat-gateway-id - The ID of the NAT gateway. state - The state of the NAT gateway (pending | failed | available | deleting | deleted). subnet-id - The ID of the subnet in which the NAT gateway resides. tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. vpc-id - The ID of the VPC in which the NAT gateway resides.'
    Property Attributes
    • describe_nat_gateways_prop ⇒ 'filter'
    • source ⇒ "describe_nat_gateways"
    

46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/nat_gateway.rb', line 46

property :filter, describe_nat_gateways_prop: 'filter', type: [MintPress::Aws::EC2::Filter], array: false, source: "describe_nat_gateways", description: 'One or more filters.


nat-gateway-id - The ID of the NAT gateway.
state - The state of the NAT gateway (pending | failed |
available | deleting | deleted).
subnet-id - The ID of the subnet in which the NAT gateway resides.
tag:<key> - The key/value combination of a tag assigned to
the resource. Use the tag key in the filter name and the tag value
as the filter value. For example, to find all resources that have a
tag with the key Owner and the value TeamA, specify tag:Owner
for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this
filter to find all resources assigned a tag with a specific key,
regardless of the tag value.
vpc-id - The ID of the VPC in which the NAT gateway resides.', hash: true
  • #max_results ⇒ [Integer]
    'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
    Property Attributes
    • describe_nat_gateways_prop ⇒ 'max_results'
    • source ⇒ "describe_nat_gateways"
    

62
63
64
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/nat_gateway.rb', line 62

property :max_results, describe_nat_gateways_prop: 'max_results', type: [Integer], source: "describe_nat_gateways", description: 'The maximum number of results to return with a single call. To
retrieve the remaining results, make another call with the returned
nextToken value.'
  • #id ⇒ [String] (Default Value: Proc.new { self.name })
    'One or more NAT gateway IDs.'
    Property Attributes
    • read_only ⇒ false
    • disposition ⇒ :attribute
    • source ⇒ "describe_nat_gateways"
    • orig_name ⇒ 'nat_gateway_id'
    • delete_nat_gateway_prop ⇒ 'nat_gateway_id'
    • describe_nat_gateways_prop ⇒ 'nat_gateway_ids'
    • default ⇒ Proc.new { self.name }
    

65
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/nat_gateway.rb', line 65

property :id, read_only: false, disposition: :attribute, description: 'One or more NAT gateway IDs.', source: "describe_nat_gateways", orig_name: 'nat_gateway_id', type: [String], delete_nat_gateway_prop: 'nat_gateway_id', array: false, hash: false, describe_nat_gateways_prop: 'nat_gateway_ids', default: Proc.new { self.name }
  • #address ⇒ [MintPress::Aws::EC2::VpcAddress] (Default Value: MintPress::Aws::EC2::VpcAddress.new)

    Property Attributes
    • disposition ⇒ :association
    • source ⇒ "NatGateway"
    • orig_name ⇒ 'address'
    • default ⇒ MintPress::Aws::EC2::VpcAddress.new
    

66
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/nat_gateway.rb', line 66

property :address, disposition: :association, source: "NatGateway", orig_name: 'address', type: [MintPress::Aws::EC2::VpcAddress], default: MintPress::Aws::EC2::VpcAddress.new
  • #subnet ⇒ [MintPress::Aws::EC2::Subnet] (Default Value: MintPress::Aws::EC2::Subnet.new)
    'The subnet in which to create the NAT gateway.'
    Property Attributes
    • disposition ⇒ :association
    • source ⇒ "NatGateway"
    • orig_name ⇒ 'subnet'
    • create_nat_gateway_prop ⇒ 'subnet_id'
    • read_only ⇒ false
    • default ⇒ MintPress::Aws::EC2::Subnet.new
    • from ⇒ String
    

67
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/nat_gateway.rb', line 67

property :subnet, disposition: :association, description: 'The subnet in which to create the NAT gateway.', source: "NatGateway", orig_name: 'subnet', type: [MintPress::Aws::EC2::Subnet], create_nat_gateway_prop: 'subnet_id', read_only: false, default: MintPress::Aws::EC2::Subnet.new, from: String
  • #allocation ⇒ [String]
    'The allocation ID of an Elastic IP address to associate with the NAT gateway. If the Elastic IP address is associated with another resource, you must first disassociate it.'
    Property Attributes
    • create_nat_gateway_prop ⇒ 'allocation_id'
    • read_only ⇒ false
    • source ⇒ "create_nat_gateway"
    

69
70
71
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/nat_gateway.rb', line 69

property :allocation, create_nat_gateway_prop: 'allocation_id', type: [String], read_only: false, source: "create_nat_gateway", description: 'The allocation ID of an Elastic IP address to associate with the NAT
gateway. If the Elastic IP address is associated with another
resource, you must first disassociate it.'
  • #name ⇒ String

    Property Attributes 
    

72
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/nat_gateway.rb', line 72

property :name, type: String
  • #region ⇒ String
    Region _specifically for this object_. If you're not doing different objects in different regions, you should not set this, but rather set the region on your AwsPlatformProvider instead
    Property Attributes 
    

76
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/nat_gateway.rb', line 76

property :region, type: String
  • #platform ⇒ MintPress::InfrastructureAws::AwsPlatform (Default Value: MintPress::InfrastructureAws::AwsPlatform.new)
    The platform details, including credentials - normally this will come via AwsPlatformProvider (see the Infrastructure Providers section of the documentation)
    Property Attributes
    • default ⇒ MintPress::InfrastructureAws::AwsPlatform.new
    

79
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/nat_gateway.rb', line 79

property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new

Properties (Read Only)

  • #create_time ⇒ [Time]
    'The date and time the NAT gateway was created.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "NatGateway"
    • orig_name ⇒ 'create_time'
    • read_only ⇒ true
    

29
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/nat_gateway.rb', line 29

property :create_time, disposition: :read_only_attribute, description: 'The date and time the NAT gateway was created.', source: "NatGateway", orig_name: 'create_time', type: [Time], read_only: true
  • #delete_time ⇒ [Time]
    'The date and time the NAT gateway was deleted, if applicable.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "NatGateway"
    • orig_name ⇒ 'delete_time'
    • read_only ⇒ true
    

30
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/nat_gateway.rb', line 30

property :delete_time, disposition: :read_only_attribute, description: 'The date and time the NAT gateway was deleted, if applicable.', source: "NatGateway", orig_name: 'delete_time', type: [Time], read_only: true
  • #failure_code ⇒ [String]
    'If the NAT gateway could not be created, specifies the error code for the failure.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "NatGateway"
    • orig_name ⇒ 'failure_code'
    • read_only ⇒ true
    

31
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/nat_gateway.rb', line 31

property :failure_code, disposition: :read_only_attribute, description: 'If the NAT gateway could not be created, specifies the error code for the failure.', source: "NatGateway", orig_name: 'failure_code', type: [String], read_only: true
  • #failure_message ⇒ [String]
    'If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "NatGateway"
    • orig_name ⇒ 'failure_message'
    • read_only ⇒ true
    

32
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/nat_gateway.rb', line 32

property :failure_message, disposition: :read_only_attribute, description: 'If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.', source: "NatGateway", orig_name: 'failure_message', type: [String], read_only: true
  • #nat_gateway_addresses ⇒ Array of ⇒ [MintPress::Aws::EC2::NatGatewayAddress]
    'Information about the IP addresses and network interface associated with the NAT gateway.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "NatGateway"
    • orig_name ⇒ 'nat_gateway_addresses'
    • read_only ⇒ true
    

33
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/nat_gateway.rb', line 33

property :nat_gateway_addresses, disposition: :read_only_attribute, description: 'Information about the IP addresses and network interface associated with the NAT gateway.', source: "NatGateway", orig_name: 'nat_gateway_addresses', type: [MintPress::Aws::EC2::NatGatewayAddress], array: true, read_only: true
  • #provisioned_bandwidth ⇒ [MintPress::Aws::EC2::ProvisionedBandwidth] (Default Value: MintPress::Aws::EC2::ProvisionedBandwidth.new)
    'Reserved.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "NatGateway"
    • orig_name ⇒ 'provisioned_bandwidth'
    • default ⇒ MintPress::Aws::EC2::ProvisionedBandwidth.new
    • read_only ⇒ true
    

34
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/nat_gateway.rb', line 34

property :provisioned_bandwidth, disposition: :read_only_attribute, description: 'Reserved.', source: "NatGateway", orig_name: 'provisioned_bandwidth', type: [MintPress::Aws::EC2::ProvisionedBandwidth], default: MintPress::Aws::EC2::ProvisionedBandwidth.new, read_only: true
  • #state ⇒ [String]
    'The state of the NAT gateway.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "NatGateway"
    • orig_name ⇒ 'state'
    • read_only ⇒ true
    

35
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/nat_gateway.rb', line 35

property :state, disposition: :read_only_attribute, description: 'The state of the NAT gateway.', source: "NatGateway", orig_name: 'state', type: [String], read_only: true
  • #vpc ⇒ [MintPress::Aws::EC2::Vpc]
    'The ID of the VPC in which the NAT gateway is located.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "NatGateway"
    • orig_name ⇒ 'vpc_id'
    • read_only ⇒ true
    • from ⇒ String
    

68
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/nat_gateway.rb', line 68

property :vpc, disposition: :read_only_attribute, description: 'The ID of the VPC in which the NAT gateway is located.', source: "NatGateway", orig_name: 'vpc_id', type: [MintPress::Aws::EC2::Vpc], read_only: true, from: String

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary collapse

Methods included from AwsCommon

#alive?, all, #attach_generic, #attached?, #available?, #build_create_hash, #by_id, #by_name, #create_generic, #delete_cascade_generic, #delete_generic, #detach_generic, #exists?, #fill_in_details, #find_by_details, #find_global_object, #get_aws_region, #get_state, #handle_singleton_object, #harvest, #perform_operation, #prop_to_hash, #register_aws_object, #resource_api, #running?, #start_generic, #started?, #stop_generic, #terminate_generic

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Constructor Details

#initialize(opts = {}) ⇒ NatGateway

Returns a new instance of NatGateway.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object