Class: MintPress::Aws::EC2::TransitGateway

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

Properties (Read/Write)

  • #creation_time ⇒ [Time]
    'The creation time.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::TransitGateway"
    • orig_name ⇒ 'creation_time'
    

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

property :creation_time, disposition: :attribute, description: 'The creation time.', source: "MintPress::Aws::EC2::TransitGateway", orig_name: 'creation_time', type: [Time]
  • #description ⇒ [String]
    'The description for the transit gateway.'
    Property Attributes
    • source ⇒ "modify_transit_gateway"
    • orig_name ⇒ 'description'
    • create_transit_gateway_prop ⇒ 'description'
    • read_only ⇒ false
    • modify_transit_gateway_prop ⇒ 'description'
    

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

property :description, description: 'The description for the transit gateway.', source: "modify_transit_gateway", orig_name: 'description', type: [String], create_transit_gateway_prop: 'description', read_only: false, modify_transit_gateway_prop: 'description'
  • #options ⇒ [MintPress::Aws::EC2::ModifyTransitGatewayOption] (Default Value: MintPress::Aws::EC2::ModifyTransitGatewayOption.new)
    'The options to modify.'
    Property Attributes
    • source ⇒ "modify_transit_gateway"
    • orig_name ⇒ 'options'
    • default ⇒ MintPress::Aws::EC2::ModifyTransitGatewayOption.new
    • create_transit_gateway_prop ⇒ 'options'
    • read_only ⇒ false
    • modify_transit_gateway_prop ⇒ 'options'
    

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

property :options, description: 'The options to modify.', source: "modify_transit_gateway", orig_name: 'options', type: [MintPress::Aws::EC2::ModifyTransitGatewayOption], default: MintPress::Aws::EC2::ModifyTransitGatewayOption.new, create_transit_gateway_prop: 'options', read_only: false, modify_transit_gateway_prop: 'options'
  • #state ⇒ [String]
    'The state of the transit gateway.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::TransitGateway"
    • orig_name ⇒ 'state'
    

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

property :state, disposition: :attribute, description: 'The state of the transit gateway.', source: "MintPress::Aws::EC2::TransitGateway", orig_name: 'state', type: [String]
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::EC2::Tag]
    'The tags for the transit gateway.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::TransitGateway"
    • orig_name ⇒ 'tags'
    • create_transit_gateway_prop ⇒ 'tag_specifications'
    • read_only ⇒ false
    

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

property :tags, disposition: :attribute, description: 'The tags for the transit gateway.', source: "MintPress::Aws::EC2::TransitGateway", orig_name: 'tags', type: [MintPress::Aws::EC2::Tag], array: false, create_transit_gateway_prop: 'tag_specifications', read_only: false, hash: true
  • #transit_gateway_arn ⇒ [String]
    'The Amazon Resource Name (ARN) of the transit gateway.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::TransitGateway"
    • orig_name ⇒ 'transit_gateway_arn'
    

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

property :transit_gateway_arn, disposition: :attribute, description: 'The Amazon Resource Name (ARN) of the transit gateway.', source: "MintPress::Aws::EC2::TransitGateway", orig_name: 'transit_gateway_arn', type: [String]
  • #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_transit_gateway_prop ⇒ 'dry_run'
    • read_only ⇒ false
    • source ⇒ "modify_transit_gateway"
    • delete_transit_gateway_prop ⇒ 'dry_run'
    • describe_transit_gateways_prop ⇒ 'dry_run'
    • modify_transit_gateway_prop ⇒ 'dry_run'
    

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

property :dry_run, create_transit_gateway_prop: 'dry_run', type: [TrueClass,FalseClass], read_only: false, source: "modify_transit_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_transit_gateway_prop: 'dry_run', describe_transit_gateways_prop: 'dry_run', modify_transit_gateway_prop: 'dry_run'
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'One or more filters. The possible values are: options.propagation-default-route-table-id - The ID of the default propagation route table. options.amazon-side-asn - The private ASN for the Amazon side of a BGP session. options.association-default-route-table-id - The ID of the default association route table. options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable | disable). options.default-route-table-association - Indicates whether resource attachments are automatically associated with the default association route table (enable | disable). options.default-route-table-propagation - Indicates whether resource attachments automatically propagate routes to the default propagation route table (enable | disable). options.dns-support - Indicates whether DNS support is enabled (enable | disable). options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (enable | disable). owner-id - The ID of the AWS account that owns the transit gateway. state - The state of the transit gateway (available | deleted | deleting | modifying | pending). transit-gateway-id - The ID of the transit gateway.'
    Property Attributes
    • describe_transit_gateways_prop ⇒ 'filters'
    • source ⇒ "describe_transit_gateways"
    

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

property :filters, describe_transit_gateways_prop: 'filters', type: [MintPress::Aws::EC2::Filter], array: false, source: "describe_transit_gateways", description: 'One or more filters. The possible values are:


options.propagation-default-route-table-id - The ID of the default
propagation route table.
options.amazon-side-asn - The private ASN for the Amazon side of a
BGP session.
options.association-default-route-table-id - The ID of the default
association route table.
options.auto-accept-shared-attachments - Indicates whether there
is automatic acceptance of attachment requests (enable |
disable).
options.default-route-table-association - Indicates whether
resource attachments are automatically associated with the default
association route table (enable | disable).
options.default-route-table-propagation - Indicates whether
resource attachments automatically propagate routes to the default
propagation route table (enable | disable).
options.dns-support - Indicates whether DNS support is enabled
(enable | disable).
options.vpn-ecmp-support - Indicates whether Equal Cost Multipath
Protocol support is enabled (enable | disable).
owner-id - The ID of the AWS account that owns the transit
gateway.
state - The state of the transit gateway (available | deleted
| deleting | modifying | pending).
transit-gateway-id - The ID of the transit gateway.', 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_transit_gateways_prop ⇒ 'max_results'
    • source ⇒ "describe_transit_gateways"
    

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

property :max_results, describe_transit_gateways_prop: 'max_results', type: [Integer], source: "describe_transit_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.'
  • #owner ⇒ [String]
    'The ID of the AWS account ID that owns the transit gateway.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::TransitGateway"
    • orig_name ⇒ 'owner_id'
    

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

property :owner, disposition: :attribute, description: 'The ID of the AWS account ID that owns the transit gateway.', source: "MintPress::Aws::EC2::TransitGateway", orig_name: 'owner_id', type: [String]
  • #id ⇒ [String] (Default Value: Proc.new { self.name })
    'The IDs of the transit gateways.'
    Property Attributes
    • source ⇒ "describe_transit_gateways"
    • orig_name ⇒ 'transit_gateway_id'
    • delete_transit_gateway_prop ⇒ 'transit_gateway_id'
    • read_only ⇒ false
    • modify_transit_gateway_prop ⇒ 'transit_gateway_id'
    • describe_transit_gateways_prop ⇒ 'transit_gateway_ids'
    • default ⇒ Proc.new { self.name }
    

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

property :id, description: 'The IDs of the transit gateways.', source: "describe_transit_gateways", orig_name: 'transit_gateway_id', type: [String], delete_transit_gateway_prop: 'transit_gateway_id', read_only: false, modify_transit_gateway_prop: 'transit_gateway_id', array: false, hash: false, describe_transit_gateways_prop: 'transit_gateway_ids', default: Proc.new { self.name }
  • #name ⇒ String

    Property Attributes 
    

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

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 
    

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

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
    

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

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

Properties (Read Only)

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

Returns a new instance of TransitGateway.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object

#modify ⇒ Object