You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::RDS::Types::ModifyDBSnapshotAttributeMessage

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb

Overview

Note:

When making an API call, you may pass ModifyDBSnapshotAttributeMessage data as a hash:

{
  db_snapshot_identifier: "String", # required
  attribute_name: "String", # required
  values_to_add: ["String"],
  values_to_remove: ["String"],
}

Instance Attribute Summary collapse

Instance Attribute Details

#attribute_nameString

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.

Returns:

  • (String)


9223
9224
9225
9226
9227
9228
9229
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 9223

class ModifyDBSnapshotAttributeMessage < Struct.new(
  :db_snapshot_identifier,
  :attribute_name,
  :values_to_add,
  :values_to_remove)
  include Aws::Structure
end

#db_snapshot_identifierString

The identifier for the DB snapshot to modify the attributes for.

Returns:

  • (String)


9223
9224
9225
9226
9227
9228
9229
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 9223

class ModifyDBSnapshotAttributeMessage < Struct.new(
  :db_snapshot_identifier,
  :attribute_name,
  :values_to_add,
  :values_to_remove)
  include Aws::Structure
end

#values_to_addArray<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.

Returns:

  • (Array<String>)


9223
9224
9225
9226
9227
9228
9229
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 9223

class ModifyDBSnapshotAttributeMessage < Struct.new(
  :db_snapshot_identifier,
  :attribute_name,
  :values_to_add,
  :values_to_remove)
  include Aws::Structure
end

#values_to_removeArray<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.

Returns:

  • (Array<String>)


9223
9224
9225
9226
9227
9228
9229
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 9223

class ModifyDBSnapshotAttributeMessage < Struct.new(
  :db_snapshot_identifier,
  :attribute_name,
  :values_to_add,
  :values_to_remove)
  include Aws::Structure
end