Class: MintPress::Aws::EC2::ManagedPrefixList

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

Properties (Read/Write)

  • #address_family ⇒ [String]
    'The IP address version.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ManagedPrefixList"
    • orig_name ⇒ 'address_family'
    • create_managed_prefix_list_prop ⇒ 'address_family'
    • read_only ⇒ false
    

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

property :address_family, disposition: :attribute, description: 'The IP address version.', source: "MintPress::Aws::EC2::ManagedPrefixList", orig_name: 'address_family', type: [String], create_managed_prefix_list_prop: 'address_family', read_only: false
  • #max_entries ⇒ [Integer]
    'The maximum number of entries for the prefix list.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ManagedPrefixList"
    • orig_name ⇒ 'max_entries'
    • create_managed_prefix_list_prop ⇒ 'max_entries'
    • read_only ⇒ false
    

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

property :max_entries, disposition: :attribute, description: 'The maximum number of entries for the prefix list.', source: "MintPress::Aws::EC2::ManagedPrefixList", orig_name: 'max_entries', type: [Integer], create_managed_prefix_list_prop: 'max_entries', read_only: false
  • #prefix_list_arn ⇒ [String]
    'The Amazon Resource Name (ARN) for the prefix list.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ManagedPrefixList"
    • orig_name ⇒ 'prefix_list_arn'
    

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

property :prefix_list_arn, disposition: :attribute, description: 'The Amazon Resource Name (ARN) for the prefix list.', source: "MintPress::Aws::EC2::ManagedPrefixList", orig_name: 'prefix_list_arn', type: [String]
  • #prefix_list_name ⇒ [String] (Default Value: Proc.new { self.name })
    'A name for the prefix list.'
    Property Attributes
    • source ⇒ "modify_managed_prefix_list"
    • orig_name ⇒ 'prefix_list_name'
    • create_managed_prefix_list_prop ⇒ 'prefix_list_name'
    • read_only ⇒ false
    • modify_managed_prefix_list_prop ⇒ 'prefix_list_name'
    • default ⇒ Proc.new { self.name }
    

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

property :prefix_list_name, description: 'A name for the prefix list.', source: "modify_managed_prefix_list", orig_name: 'prefix_list_name', type: [String], create_managed_prefix_list_prop: 'prefix_list_name', read_only: false, modify_managed_prefix_list_prop: 'prefix_list_name', default: Proc.new { self.name }
  • #state ⇒ [String]
    'The state of the prefix list.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ManagedPrefixList"
    • orig_name ⇒ 'state'
    

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

property :state, disposition: :attribute, description: 'The state of the prefix list.', source: "MintPress::Aws::EC2::ManagedPrefixList", orig_name: 'state', type: [String]
  • #state_message ⇒ [String]
    'The state message.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ManagedPrefixList"
    • orig_name ⇒ 'state_message'
    

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

property :state_message, disposition: :attribute, description: 'The state message.', source: "MintPress::Aws::EC2::ManagedPrefixList", orig_name: 'state_message', type: [String]
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::EC2::Tag]
    'The tags for the prefix list.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ManagedPrefixList"
    • orig_name ⇒ 'tags'
    • create_managed_prefix_list_prop ⇒ 'tag_specifications'
    • read_only ⇒ false
    

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

property :tags, disposition: :attribute, description: 'The tags for the prefix list.', source: "MintPress::Aws::EC2::ManagedPrefixList", orig_name: 'tags', type: [MintPress::Aws::EC2::Tag], array: false, create_managed_prefix_list_prop: 'tag_specifications', read_only: false, hash: true
  • #version ⇒ [Integer]
    'The version of the prefix list.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ManagedPrefixList"
    • orig_name ⇒ 'version'
    

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

property :version, disposition: :attribute, description: 'The version of the prefix list.', source: "MintPress::Aws::EC2::ManagedPrefixList", orig_name: 'version', type: [Integer]
  • #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_managed_prefix_list_prop ⇒ 'dry_run'
    • read_only ⇒ false
    • source ⇒ "modify_managed_prefix_list"
    • delete_managed_prefix_list_prop ⇒ 'dry_run'
    • describe_managed_prefix_lists_prop ⇒ 'dry_run'
    • modify_managed_prefix_list_prop ⇒ 'dry_run'
    

37
38
39
40
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/managed_prefix_list.rb', line 37

property :dry_run, create_managed_prefix_list_prop: 'dry_run', type: [TrueClass,FalseClass], read_only: false, source: "modify_managed_prefix_list", 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_managed_prefix_list_prop: 'dry_run', describe_managed_prefix_lists_prop: 'dry_run', modify_managed_prefix_list_prop: 'dry_run'
  • #entries ⇒ Array of ⇒ [MintPress::Aws::EC2::AddPrefixListEntry]
    'One or more entries for the prefix list.'
    Property Attributes
    • create_managed_prefix_list_prop ⇒ 'entries'
    • read_only ⇒ false
    • source ⇒ "create_managed_prefix_list"
    

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

property :entries, create_managed_prefix_list_prop: 'entries', type: [MintPress::Aws::EC2::AddPrefixListEntry], array: true, read_only: false, source: "create_managed_prefix_list", description: 'One or more entries for the prefix list.'
  • #client_token ⇒ [String]
    'Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency. Constraints: Up to 255 UTF-8 characters in length. A suitable default value is auto-generated. You should normally not need to pass this option.**'
    Property Attributes
    • create_managed_prefix_list_prop ⇒ 'client_token'
    • read_only ⇒ false
    • source ⇒ "create_managed_prefix_list"
    

42
43
44
45
46
47
48
49
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/managed_prefix_list.rb', line 42

property :client_token, create_managed_prefix_list_prop: 'client_token', type: [String], read_only: false, source: "create_managed_prefix_list", description: 'Unique, case-sensitive identifier you provide to ensure the
idempotency of the request. For more information, see Ensuring
Idempotency.

Constraints: Up to 255 UTF-8 characters in length.

A suitable default value is auto-generated. You should normally
not need to pass this option.**'
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'One or more filters. owner-id - The ID of the prefix list owner. prefix-list-id - The ID of the prefix list. prefix-list-name - The name of the prefix list.'
    Property Attributes
    • describe_managed_prefix_lists_prop ⇒ 'filters'
    • source ⇒ "describe_managed_prefix_lists"
    

50
51
52
53
54
55
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/managed_prefix_list.rb', line 50

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


owner-id - The ID of the prefix list owner.
prefix-list-id - The ID of the prefix list.
prefix-list-name - The name of the 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_managed_prefix_lists_prop ⇒ 'max_results'
    • source ⇒ "describe_managed_prefix_lists"
    

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

property :max_results, describe_managed_prefix_lists_prop: 'max_results', type: [Integer], source: "describe_managed_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.'
  • #current_version ⇒ [Integer]
    'The current version of the prefix list.'
    Property Attributes
    • modify_managed_prefix_list_prop ⇒ 'current_version'
    • read_only ⇒ false
    • source ⇒ "modify_managed_prefix_list"
    

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

property :current_version, modify_managed_prefix_list_prop: 'current_version', type: [Integer], read_only: false, source: "modify_managed_prefix_list", description: 'The current version of the prefix list.'
  • #add_entries ⇒ Array of ⇒ [MintPress::Aws::EC2::AddPrefixListEntry]
    'One or more entries to add to the prefix list.'
    Property Attributes
    • modify_managed_prefix_list_prop ⇒ 'add_entries'
    • read_only ⇒ false
    • source ⇒ "modify_managed_prefix_list"
    

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

property :add_entries, modify_managed_prefix_list_prop: 'add_entries', type: [MintPress::Aws::EC2::AddPrefixListEntry], array: true, read_only: false, source: "modify_managed_prefix_list", description: 'One or more entries to add to the prefix list.'
  • #remove_entries ⇒ Array of ⇒ [String]
    'One or more entries to remove from the prefix list.'
    Property Attributes
    • modify_managed_prefix_list_prop ⇒ "remove_entries.cidr"
    • read_only ⇒ false
    • source ⇒ "modify_managed_prefix_list"
    

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

property :remove_entries, modify_managed_prefix_list_prop: "remove_entries.cidr", type: [String], array: true, read_only: false, source: "modify_managed_prefix_list", description: 'One or more entries to remove from the prefix list.'
  • #owner ⇒ [String]
    'The ID of the owner of the prefix list.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ManagedPrefixList"
    • orig_name ⇒ 'owner_id'
    

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

property :owner, disposition: :attribute, description: 'The ID of the owner of the prefix list.', source: "MintPress::Aws::EC2::ManagedPrefixList", orig_name: 'owner_id', type: [String]
  • #prefix_list ⇒ [MintPress::Aws::EC2::PrefixList]
    'The ID of the prefix list.'
    Property Attributes
    • source ⇒ "modify_managed_prefix_list"
    • orig_name ⇒ 'prefix_list_id'
    • delete_managed_prefix_list_prop ⇒ 'prefix_list_id'
    • read_only ⇒ false
    • modify_managed_prefix_list_prop ⇒ 'prefix_list_id'
    • from ⇒ String
    

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

property :prefix_list, description: 'The ID of the prefix list.', source: "modify_managed_prefix_list", orig_name: 'prefix_list_id', type: [MintPress::Aws::EC2::PrefixList], delete_managed_prefix_list_prop: 'prefix_list_id', read_only: false, modify_managed_prefix_list_prop: 'prefix_list_id', from: String
  • #prefix_lists ⇒ Hash of ⇒ [MintPress::Aws::EC2::PrefixList]
    'One or more prefix list IDs.'
    Property Attributes
    • describe_managed_prefix_lists_prop ⇒ 'prefix_list_ids'
    • source ⇒ "describe_managed_prefix_lists"
    • from ⇒ String
    

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

property :prefix_lists, describe_managed_prefix_lists_prop: 'prefix_list_ids', type: [MintPress::Aws::EC2::PrefixList], array: false, source: "describe_managed_prefix_lists", description: 'One or more prefix list IDs.', from: String, hash: true
  • #name ⇒ [String]

    Property Attributes 
    

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

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 
    

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

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
    

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

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

Returns a new instance of ManagedPrefixList.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object

#modify ⇒ Object