Class: MintPress::Aws::RDS::DbSnapshotAttribute

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

Properties (Read/Write)

  • #db_snapshot_identifier ⇒ [String]
    'The identifier for the DB snapshot to modify the attributes for.'
    Property Attributes
    • describe_db_snapshot_attributes_prop ⇒ 'db_snapshot_identifier'
    • source ⇒ "modify_db_snapshot_attribute"
    • modify_db_snapshot_attribute_prop ⇒ 'db_snapshot_identifier'
    • read_only ⇒ false
    

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

property :db_snapshot_identifier, describe_db_snapshot_attributes_prop: 'db_snapshot_identifier', type: [String], source: "modify_db_snapshot_attribute", description: 'The identifier for the DB snapshot to modify the attributes for.', modify_db_snapshot_attribute_prop: 'db_snapshot_identifier', read_only: false
  • #attribute_name ⇒ [String] (Default Value: Proc.new { self.name })
    'The name of the DB snapshot attribute to modify. To manage authorization for other AWS accounts to copy or restore a manual DB snapshot, set this value to restore. To view the list of attributes available to modify, use the DescribeDBSnapshotAttributes API action.'
    Property Attributes
    • modify_db_snapshot_attribute_prop ⇒ 'attribute_name'
    • read_only ⇒ false
    • source ⇒ "modify_db_snapshot_attribute"
    • default ⇒ Proc.new { self.name }
    

20
21
22
23
24
25
26
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_snapshot_attribute.rb', line 20

property :attribute_name, modify_db_snapshot_attribute_prop: 'attribute_name', type: [String], read_only: false, source: "modify_db_snapshot_attribute", description: 'The name of the DB snapshot attribute to modify.

To manage authorization for other AWS accounts to copy or restore a
manual DB snapshot, set this value to restore.

 To view the list of attributes available to modify, use the
DescribeDBSnapshotAttributes API action.', default: Proc.new { self.name }
  • #values_to_add ⇒ Array of ⇒ [String]
    'A list of DB snapshot attributes to add to the attribute specified by AttributeName. To authorize other AWS accounts to copy or restore a manual snapshot, set this list to include one or more AWS account IDs, or all to make the manual DB snapshot restorable by any AWS account. Do not add the all value for any manual DB snapshots that contain private information that you don"t want available to all AWS accounts.'
    Property Attributes
    • modify_db_snapshot_attribute_prop ⇒ 'values_to_add'
    • read_only ⇒ false
    • source ⇒ "modify_db_snapshot_attribute"
    

27
28
29
30
31
32
33
34
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_snapshot_attribute.rb', line 27

property :values_to_add, modify_db_snapshot_attribute_prop: 'values_to_add', type: [String], array: true, read_only: false, source: "modify_db_snapshot_attribute", description: 'A list of DB snapshot attributes to add to the attribute specified by
AttributeName.

To authorize other AWS accounts to copy or restore a manual snapshot,
set this list to include one or more AWS account IDs, or all to make
the manual DB snapshot restorable by any AWS account. Do not add the
all value for any manual DB snapshots that contain private
information that you don"t want available to all AWS accounts.'
  • #values_to_remove ⇒ Array of ⇒ [String]
    'A list of DB snapshot attributes to remove from the attribute specified by AttributeName. To remove authorization for other AWS accounts to copy or restore a manual snapshot, set this list to include one or more AWS account identifiers, or all to remove authorization for any AWS account to copy or restore the DB snapshot. If you specify all, an AWS account whose account ID is explicitly added to the restore attribute can still copy or restore the manual DB snapshot.'
    Property Attributes
    • modify_db_snapshot_attribute_prop ⇒ 'values_to_remove'
    • read_only ⇒ false
    • source ⇒ "modify_db_snapshot_attribute"
    

35
36
37
38
39
40
41
42
43
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_snapshot_attribute.rb', line 35

property :values_to_remove, modify_db_snapshot_attribute_prop: 'values_to_remove', type: [String], array: true, read_only: false, source: "modify_db_snapshot_attribute", description: 'A list of DB snapshot attributes to remove from the attribute
specified by AttributeName.

To remove authorization for other AWS accounts to copy or restore a
manual snapshot, set this list to include one or more AWS account
identifiers, or all to remove authorization for any AWS account to
copy or restore the DB snapshot. If you specify all, an AWS account
whose account ID is explicitly added to the restore attribute can
still copy or restore the manual DB snapshot.'
  • #name ⇒ [String]

    Property Attributes 
    

44
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_snapshot_attribute.rb', line 44

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 
    

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

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
    

51
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_snapshot_attribute.rb', line 51

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

Returns a new instance of DbSnapshotAttribute.

Instance Method Details

#describe ⇒ Object

#modify ⇒ Object