Class: MintPress::Aws::EC2::CoipPoolUsage

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

Properties (Read/Write)

  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'The filters. The following are the possible values: coip-address-usage.allocation-id ^ ^ coip-address-usage.aws-account-id ^ ^ coip-address-usage.aws-service ^ ^ coip-address-usage.co-ip ^'
    Property Attributes
    • get_coip_pool_usage_prop ⇒ 'filters'
    • read_only ⇒ false
    • source ⇒ "get_coip_pool_usage"
    

18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/coip_pool_usage.rb', line 18

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


coip-address-usage.allocation-id



^
^


coip-address-usage.aws-account-id



^
^


coip-address-usage.aws-service



^
^


coip-address-usage.co-ip



^', 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
    • get_coip_pool_usage_prop ⇒ 'max_results'
    • read_only ⇒ false
    • source ⇒ "get_coip_pool_usage"
    

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

property :max_results, get_coip_pool_usage_prop: 'max_results', type: [Integer], read_only: false, source: "get_coip_pool_usage", 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
    • get_coip_pool_usage_prop ⇒ 'dry_run'
    • read_only ⇒ false
    • source ⇒ "get_coip_pool_usage"
    

53
54
55
56
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/coip_pool_usage.rb', line 53

property :dry_run, get_coip_pool_usage_prop: 'dry_run', type: [TrueClass,FalseClass], read_only: false, source: "get_coip_pool_usage", 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.'
  • #pool ⇒ [String]
    'The ID of the address pool.'
    Property Attributes
    • get_coip_pool_usage_prop ⇒ 'pool_id'
    • read_only ⇒ false
    • source ⇒ "get_coip_pool_usage"
    

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

property :pool, get_coip_pool_usage_prop: 'pool_id', type: [String], read_only: false, source: "get_coip_pool_usage", description: 'The ID of the address pool.'
  • #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 
    

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

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
    

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

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

Returns a new instance of CoipPoolUsage.

Instance Method Details

#get ⇒ Object