Class: Aws::RDS::Types::ModifyDBClusterSnapshotAttributeMessage

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

Overview

Note:

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

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attribute_nameString

The name of the DB cluster snapshot attribute to modify.

To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this value to `restore`.

<note markdown=“1”> To view the list of attributes available to modify, use the DescribeDBClusterSnapshotAttributes API action.

</note>

Returns:

  • (String)

14126
14127
14128
14129
14130
14131
14132
14133
# File 'lib/aws-sdk-rds/types.rb', line 14126

class ModifyDBClusterSnapshotAttributeMessage < Struct.new(
  :db_cluster_snapshot_identifier,
  :attribute_name,
  :values_to_add,
  :values_to_remove)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_snapshot_identifierString

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

Returns:

  • (String)

14126
14127
14128
14129
14130
14131
14132
14133
# File 'lib/aws-sdk-rds/types.rb', line 14126

class ModifyDBClusterSnapshotAttributeMessage < Struct.new(
  :db_cluster_snapshot_identifier,
  :attribute_name,
  :values_to_add,
  :values_to_remove)
  SENSITIVE = []
  include Aws::Structure
end

#values_to_addArray<String>

A list of DB cluster snapshot attributes to add to the attribute specified by `AttributeName`.

To authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon Web Services account IDs, or `all` to make the manual DB cluster snapshot restorable by any Amazon Web Services account. Do not add the `all` value for any manual DB cluster snapshots that contain private information that you don't want available to all Amazon Web Services accounts.

Returns:

  • (Array<String>)

14126
14127
14128
14129
14130
14131
14132
14133
# File 'lib/aws-sdk-rds/types.rb', line 14126

class ModifyDBClusterSnapshotAttributeMessage < Struct.new(
  :db_cluster_snapshot_identifier,
  :attribute_name,
  :values_to_add,
  :values_to_remove)
  SENSITIVE = []
  include Aws::Structure
end

#values_to_removeArray<String>

A list of DB cluster snapshot attributes to remove from the attribute specified by `AttributeName`.

To remove authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon Web Services account identifiers, or `all` to remove authorization for any Amazon Web Services account to copy or restore the DB cluster snapshot. If you specify `all`, an Amazon Web Services account whose account ID is explicitly added to the `restore` attribute can still copy or restore a manual DB cluster snapshot.

Returns:

  • (Array<String>)

14126
14127
14128
14129
14130
14131
14132
14133
# File 'lib/aws-sdk-rds/types.rb', line 14126

class ModifyDBClusterSnapshotAttributeMessage < Struct.new(
  :db_cluster_snapshot_identifier,
  :attribute_name,
  :values_to_add,
  :values_to_remove)
  SENSITIVE = []
  include Aws::Structure
end