Class: MintPress::Aws::EC2::ByoipCidr

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

Properties (Read/Write)

  • #cidr ⇒ [String]
    'The address range, in CIDR notation.'
    Property Attributes
    • source ⇒ "withdraw_byoip_cidr"
    • orig_name ⇒ 'cidr'
    • withdraw_byoip_cidr_prop ⇒ 'cidr'
    • read_only ⇒ false
    

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

property :cidr, description: 'The address range, in CIDR notation.', source: "withdraw_byoip_cidr", orig_name: 'cidr', type: [String], withdraw_byoip_cidr_prop: 'cidr', read_only: false
  • #description ⇒ [String]
    'The description of the address range.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ByoipCidr"
    • orig_name ⇒ 'description'
    

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

property :description, disposition: :attribute, description: 'The description of the address range.', source: "MintPress::Aws::EC2::ByoipCidr", orig_name: 'description', type: [String]
  • #state ⇒ [String]
    'The state of the address pool.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ByoipCidr"
    • orig_name ⇒ 'state'
    

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

property :state, disposition: :attribute, description: 'The state of the address pool.', source: "MintPress::Aws::EC2::ByoipCidr", orig_name: 'state', type: [String]
  • #status_message ⇒ [String]
    'Upon success, contains the ID of the address pool.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ByoipCidr"
    • orig_name ⇒ 'status_message'
    

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

property :status_message, disposition: :attribute, description: 'Upon success, contains the ID of the address pool.', source: "MintPress::Aws::EC2::ByoipCidr", orig_name: 'status_message', 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
    • describe_byoip_cidrs_prop ⇒ 'dry_run'
    • source ⇒ "withdraw_byoip_cidr"
    • withdraw_byoip_cidr_prop ⇒ 'dry_run'
    • read_only ⇒ false
    

23
24
25
26
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/byoip_cidr.rb', line 23

property :dry_run, describe_byoip_cidrs_prop: 'dry_run', type: [TrueClass,FalseClass], source: "withdraw_byoip_cidr", 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.', withdraw_byoip_cidr_prop: 'dry_run', read_only: false
  • #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_byoip_cidrs_prop ⇒ 'max_results'
    • source ⇒ "describe_byoip_cidrs"
    

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

property :max_results, describe_byoip_cidrs_prop: 'max_results', type: [Integer], source: "describe_byoip_cidrs", 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.'
  • #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 
    

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

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
    

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

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

Returns a new instance of ByoipCidr.

Instance Method Details

#describe ⇒ Object

#withdraw ⇒ Object