Class: MintPress::Aws::EC2::PrefixList

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

Properties (Read/Write)

  • #cidrs ⇒ Array of ⇒ [String]
    'The IP address range of the AWS service.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::PrefixList"
    • orig_name ⇒ 'cidrs'
    

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

property :cidrs, disposition: :attribute, description: 'The IP address range of the AWS service.', source: "MintPress::Aws::EC2::PrefixList", orig_name: 'cidrs', type: [String], array: true
  • #prefix_list_name ⇒ [String] (Default Value: Proc.new { self.name })
    'The name of the prefix.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::PrefixList"
    • orig_name ⇒ 'prefix_list_name'
    • default ⇒ Proc.new { self.name }
    

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

property :prefix_list_name, disposition: :attribute, description: 'The name of the prefix.', source: "MintPress::Aws::EC2::PrefixList", orig_name: 'prefix_list_name', type: [String], default: Proc.new { self.name }
  • #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_prefix_lists_prop ⇒ 'dry_run'
    • source ⇒ "describe_prefix_lists"
    

20
21
22
23
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/prefix_list.rb', line 20

property :dry_run, describe_prefix_lists_prop: 'dry_run', type: [TrueClass,FalseClass], source: "describe_prefix_lists", 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.'
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'One or more filters. prefix-list-id: The ID of a prefix list. prefix-list-name: The name of a prefix list.'
    Property Attributes
    • describe_prefix_lists_prop ⇒ 'filters'
    • source ⇒ "describe_prefix_lists"
    

24
25
26
27
28
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/prefix_list.rb', line 24

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


prefix-list-id: The ID of a prefix list.
prefix-list-name: The name of a prefix list.', 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_prefix_lists_prop ⇒ 'max_results'
    • source ⇒ "describe_prefix_lists"
    

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

property :max_results, describe_prefix_lists_prop: 'max_results', type: [Integer], source: "describe_prefix_lists", 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]
    'One or more prefix list IDs.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "describe_prefix_lists"
    • orig_name ⇒ 'prefix_list_id'
    • describe_prefix_lists_prop ⇒ 'prefix_list_ids'
    

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

property :id, disposition: :attribute, description: 'One or more prefix list IDs.', source: "describe_prefix_lists", orig_name: 'prefix_list_id', type: [String], array: false, hash: false, describe_prefix_lists_prop: 'prefix_list_ids'
  • #name ⇒ [String]

    Property Attributes 
    

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

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 
    

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

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
    

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

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

Returns a new instance of PrefixList.

Instance Method Details

#describe ⇒ Object