You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::RDS::DBSnapshotAttribute
- Inherits:
-
Aws::Resources::Resource
- Object
- Aws::Resources::Resource
- Aws::RDS::DBSnapshotAttribute
- Defined in:
- (unknown)
Instance Attribute Summary collapse
-
#attribute_name ⇒ String
readonly
The name of the manual DB snapshot attribute.
-
#attribute_values ⇒ Array<String>
readonly
The value or values for the manual DB snapshot attribute.
-
#name ⇒ String
readonly
-
#snapshot_id ⇒ String
readonly
Attributes inherited from Aws::Resources::Resource
Instance Method Summary collapse
-
#initialize ⇒ Object
constructor
-
#modify(options = {}) ⇒ Types::ModifyDBSnapshotAttributeResult
Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.
To share a manual DB snapshot with other AWS accounts, specify
restore
as theAttributeName
and use theValuesToAdd
parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB snapshot.
Methods inherited from Aws::Resources::Resource
add_data_attribute, add_identifier, #data, data_attributes, #data_loaded?, identifiers, #load, #wait_until
Methods included from Aws::Resources::OperationMethods
#add_batch_operation, #add_operation, #batch_operation, #batch_operation_names, #batch_operations, #operation, #operation_names, #operations
Constructor Details
#initialize(snapshot_id, name, options = {}) ⇒ Object #initialize(options = {}) ⇒ Object
Instance Attribute Details
#attribute_name ⇒ String (readonly)
The name of the manual DB snapshot attribute.
The attribute named restore
refers to the list of AWS accounts that
have permission to copy or restore the manual DB cluster snapshot. For
more information, see the ModifyDBSnapshotAttribute
API action.
#attribute_values ⇒ Array<String> (readonly)
The value or values for the manual DB snapshot attribute.
If the AttributeName
field is set to restore
, then this element
returns a list of IDs of the AWS accounts that are authorized to copy or
restore the manual DB snapshot. If a value of all
is in the list, then
the manual DB snapshot is public and available for any AWS account to
copy or restore.
#name ⇒ String (readonly)
#snapshot_id ⇒ String (readonly)
Instance Method Details
#modify(options = {}) ⇒ Types::ModifyDBSnapshotAttributeResult
Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.
To share a manual DB snapshot with other AWS accounts, specify restore
as the AttributeName
and use the ValuesToAdd
parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB snapshot. Uses the value all
to make the manual DB snapshot public, which means it can be copied or restored by all AWS accounts.
Don't add the all
value for any manual DB snapshots that contain private information that you don't want available to all AWS accounts.
If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd
parameter. You can't use all
as a value for that parameter in this case.
To view which AWS accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API action. The accounts are returned as values for the restore
attribute.