Class: MintPress::Aws::EC2::CoipPool

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

Properties (Read/Write)

  • #pool_arn ⇒ [String]
    'The ARN of the address pool.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::CoipPool"
    • orig_name ⇒ 'pool_arn'
    

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

property :pool_arn, disposition: :attribute, description: 'The ARN of the address pool.', source: "MintPress::Aws::EC2::CoipPool", orig_name: 'pool_arn', type: [String]
  • #pool_cidrs ⇒ Array of ⇒ [String]
    'The address ranges of the address pool.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::CoipPool"
    • orig_name ⇒ 'pool_cidrs'
    

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

property :pool_cidrs, disposition: :attribute, description: 'The address ranges of the address pool.', source: "MintPress::Aws::EC2::CoipPool", orig_name: 'pool_cidrs', type: [String], array: true
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::EC2::Tag]
    'The tags.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::CoipPool"
    • orig_name ⇒ 'tags'
    

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

property :tags, disposition: :attribute, description: 'The tags.', source: "MintPress::Aws::EC2::CoipPool", orig_name: 'tags', type: [MintPress::Aws::EC2::Tag], array: false, hash: true
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'The filters. The following are the possible values: coip-pool.pool-id ^ ^ coip-pool.local-gateway-route-table-id ^'
    Property Attributes
    • describe_coip_pools_prop ⇒ 'filters'
    • source ⇒ "describe_coip_pools"
    

23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/coip_pool.rb', line 23

property :filters, describe_coip_pools_prop: 'filters', type: [MintPress::Aws::EC2::Filter], array: false, source: "describe_coip_pools", description: 'The filters. The following are the possible values:


coip-pool.pool-id



^
^


coip-pool.local-gateway-route-table-id



^', 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_coip_pools_prop ⇒ 'max_results'
    • source ⇒ "describe_coip_pools"
    

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

property :max_results, describe_coip_pools_prop: 'max_results', type: [Integer], source: "describe_coip_pools", 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.'
  • #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
    • describe_coip_pools_prop ⇒ 'dry_run'
    • source ⇒ "describe_coip_pools"
    

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

property :dry_run, describe_coip_pools_prop: 'dry_run', type: [TrueClass,FalseClass], source: "describe_coip_pools", 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.'
  • #local_gateway_route_table ⇒ [MintPress::Aws::EC2::LocalGatewayRouteTable]
    'The ID of the local gateway route table.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::CoipPool"
    • orig_name ⇒ 'local_gateway_route_table_id'
    • from ⇒ String
    

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

property :local_gateway_route_table, disposition: :attribute, description: 'The ID of the local gateway route table.', source: "MintPress::Aws::EC2::CoipPool", orig_name: 'local_gateway_route_table_id', type: [MintPress::Aws::EC2::LocalGatewayRouteTable], from: String
  • #id ⇒ [String] (Default Value: Proc.new { self.name })
    'The IDs of the address pools.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "describe_coip_pools"
    • orig_name ⇒ 'pool_id'
    • describe_coip_pools_prop ⇒ 'pool_ids'
    • default ⇒ Proc.new { self.name }
    

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

property :id, disposition: :attribute, description: 'The IDs of the address pools.', source: "describe_coip_pools", orig_name: 'pool_id', type: [String], array: false, hash: false, describe_coip_pools_prop: 'pool_ids', default: Proc.new { self.name }
  • #name ⇒ String

    Property Attributes 
    

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

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 
    

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

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
    

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

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

Returns a new instance of CoipPool.

Instance Method Details

#describe ⇒ Object