Class: MintPress::Aws::EC2::RouteTable

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

Properties (Read/Write)

  • #associations ⇒ Hash of ⇒ [MintPress::Aws::EC2::RouteTableAssociation]
    'The associations between the route table and one or more subnets or a gateway.'
    Property Attributes
    • disposition ⇒ :association
    • source ⇒ "RouteTable"
    • orig_name ⇒ 'associations'
    

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

property :associations, disposition: :association, description: 'The associations between the route table and one or more subnets or a gateway.', source: "RouteTable", orig_name: 'associations', type: [MintPress::Aws::EC2::RouteTableAssociation], array: false, hash: true
  • #routes ⇒ Array of ⇒ [MintPress::Aws::EC2::Route]
    'The routes in the route table.'
    Property Attributes
    • disposition ⇒ :association
    • source ⇒ "RouteTable"
    • orig_name ⇒ 'routes'
    

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

property :routes, disposition: :association, description: 'The routes in the route table.', source: "RouteTable", orig_name: 'routes', type: [MintPress::Aws::EC2::Route], array: true
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::EC2::Tag]
    'The tags to assign to the route table.'
    Property Attributes
    • source ⇒ "create_route_table"
    • orig_name ⇒ 'tags'
    • create_route_table_prop ⇒ 'tag_specifications'
    • read_only ⇒ false
    

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

property :tags, description: 'The tags to assign to the route table.', source: "create_route_table", orig_name: 'tags', type: [MintPress::Aws::EC2::Tag], array: false, create_route_table_prop: 'tag_specifications', read_only: false, hash: true
  • #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_route_table_prop ⇒ 'dry_run'
    • read_only ⇒ false
    • source ⇒ "create_route_table"
    • delete_route_table_prop ⇒ 'dry_run'
    • describe_route_tables_prop ⇒ 'dry_run'
    

32
33
34
35
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/route_table.rb', line 32

property :dry_run, create_route_table_prop: 'dry_run', type: [TrueClass,FalseClass], read_only: false, source: "create_route_table", 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_route_table_prop: 'dry_run', describe_route_tables_prop: 'dry_run'
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'One or more filters. association.route-table-association-id - The ID of an association ID for the route table. association.route-table-id - The ID of the route table involved in the association. association.subnet-id - The ID of the subnet involved in the association. association.main - Indicates whether the route table is the main route table for the VPC (true | false). Route tables that do not have an association ID are not returned in the response. owner-id - The ID of the AWS account that owns the route table. route-table-id - The ID of the route table. route.destination-cidr-block - The IPv4 CIDR range specified in a route in the table. route.destination-ipv6-cidr-block - The IPv6 CIDR range specified in a route in the route table. route.destination-prefix-list-id - The ID (prefix) of the AWS service specified in a route in the table. route.egress-only-internet-gateway-id - The ID of an egress-only Internet gateway specified in a route in the route table. route.gateway-id - The ID of a gateway specified in a route in the table. route.instance-id - The ID of an instance specified in a route in the table. route.nat-gateway-id - The ID of a NAT gateway. route.transit-gateway-id - The ID of a transit gateway. route.origin - Describes how the route was created. CreateRouteTable indicates that the route was automatically created when the route table was created; CreateRoute indicates that the route was manually added to the route table; EnableVgwRoutePropagation indicates that the route was propagated by route propagation. route.state - The state of a route in the route table (active | blackhole). The blackhole state indicates that the route"s target isn"t available (for example, the specified gateway isn"t attached to the VPC, the specified NAT instance has been terminated, and so on). route.vpc-peering-connection-id - The ID of a VPC peering connection specified in a route in the table. 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 for the route table.'
    Property Attributes
    • describe_route_tables_prop ⇒ 'filters'
    • source ⇒ "describe_route_tables"
    

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
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/route_table.rb', line 36

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


association.route-table-association-id - The ID of an association
ID for the route table.
association.route-table-id - The ID of the route table involved in
the association.
association.subnet-id - The ID of the subnet involved in the
association.
association.main - Indicates whether the route table is the main
route table for the VPC (true | false). Route tables that do
not have an association ID are not returned in the response.
owner-id - The ID of the AWS account that owns the route table.
route-table-id - The ID of the route table.
route.destination-cidr-block - The IPv4 CIDR range specified in a
route in the table.
route.destination-ipv6-cidr-block - The IPv6 CIDR range specified
in a route in the route table.
route.destination-prefix-list-id - The ID (prefix) of the AWS
service specified in a route in the table.
route.egress-only-internet-gateway-id - The ID of an egress-only
Internet gateway specified in a route in the route table.
route.gateway-id - The ID of a gateway specified in a route in the
table.
route.instance-id - The ID of an instance specified in a route in
the table.
route.nat-gateway-id - The ID of a NAT gateway.
route.transit-gateway-id - The ID of a transit gateway.
route.origin - Describes how the route was created.
CreateRouteTable indicates that the route was automatically
created when the route table was created; CreateRoute indicates
that the route was manually added to the route table;
EnableVgwRoutePropagation indicates that the route was propagated
by route propagation.
route.state - The state of a route in the route table (active |
blackhole). The blackhole state indicates that the route"s target
isn"t available (for example, the specified gateway isn"t attached
to the VPC, the specified NAT instance has been terminated, and so
on).
route.vpc-peering-connection-id - The ID of a VPC peering
connection specified in a route in the table.
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 for the route table.', 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_route_tables_prop ⇒ 'max_results'
    • source ⇒ "describe_route_tables"
    

86
87
88
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/route_table.rb', line 86

property :max_results, describe_route_tables_prop: 'max_results', type: [Integer], source: "describe_route_tables", 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 route table IDs. Default: Describes all your route tables.'
    Property Attributes
    • read_only ⇒ false
    • disposition ⇒ :attribute
    • source ⇒ "describe_route_tables"
    • orig_name ⇒ 'route_table_id'
    • delete_route_table_prop ⇒ 'route_table_id'
    • describe_route_tables_prop ⇒ 'route_table_ids'
    • default ⇒ Proc.new { self.name }
    

89
90
91
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/route_table.rb', line 89

property :id, read_only: false, disposition: :attribute, description: 'One or more route table IDs.

Default: Describes all your route tables.', source: "describe_route_tables", orig_name: 'route_table_id', type: [String], delete_route_table_prop: 'route_table_id', array: false, hash: false, describe_route_tables_prop: 'route_table_ids', default: Proc.new { self.name }
  • #vpc ⇒ [MintPress::Aws::EC2::Vpc] (Default Value: MintPress::Aws::EC2::Vpc.new)
    'The ID of the VPC.'
    Property Attributes
    • disposition ⇒ :association
    • source ⇒ "RouteTable"
    • orig_name ⇒ 'vpc'
    • create_route_table_prop ⇒ 'vpc_id'
    • read_only ⇒ false
    • default ⇒ MintPress::Aws::EC2::Vpc.new
    • from ⇒ String
    

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

property :vpc, disposition: :association, description: 'The ID of the VPC.', source: "RouteTable", orig_name: 'vpc', type: [MintPress::Aws::EC2::Vpc], create_route_table_prop: 'vpc_id', read_only: false, default: MintPress::Aws::EC2::Vpc.new, from: String
  • #name ⇒ String

    Property Attributes 
    

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

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 
    

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

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
    

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

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

Properties (Read Only)

  • #propagating_vgws ⇒ Array of ⇒ [MintPress::Aws::EC2::PropagatingVgw]
    'Any virtual private gateway (VGW) propagating routes.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "RouteTable"
    • orig_name ⇒ 'propagating_vgws'
    • read_only ⇒ true
    

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

property :propagating_vgws, disposition: :read_only_attribute, description: 'Any virtual private gateway (VGW) propagating routes.', source: "RouteTable", orig_name: 'propagating_vgws', type: [MintPress::Aws::EC2::PropagatingVgw], array: true, read_only: true
  • #owner ⇒ [String]
    'The ID of the AWS account that owns the route table.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "RouteTable"
    • orig_name ⇒ 'owner_id'
    • read_only ⇒ true
    

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

property :owner, disposition: :read_only_attribute, description: 'The ID of the AWS account that owns the route table.', source: "RouteTable", orig_name: 'owner_id', type: [String], read_only: true

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 = {}) ⇒ RouteTable

Returns a new instance of RouteTable.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object