Class: Aws::DocDB::Types::ModifyDBClusterSnapshotAttributeMessage

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-docdb/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"],
}

Represents the input to ModifyDBClusterSnapshotAttribute.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attribute_name ⇒ String

The name of the cluster snapshot attribute to modify.

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

Returns:

  • (String) 


4616
4617
4618
4619
4620
4621
4622
4623
 
# File 'lib/aws-sdk-docdb/types.rb', line 4616

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

#db_cluster_snapshot_identifier ⇒ String

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

Returns:

  • (String) 


4616
4617
4618
4619
4620
4621
4622
4623
 
# File 'lib/aws-sdk-docdb/types.rb', line 4616

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

#values_to_add ⇒ Array<String>

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

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

Returns:

  • (Array<String>) 


4616
4617
4618
4619
4620
4621
4622
4623
 
# File 'lib/aws-sdk-docdb/types.rb', line 4616

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

#values_to_remove ⇒ Array<String>

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

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

Returns:

  • (Array<String>) 


4616
4617
4618
4619
4620
4621
4622
4623
 
# File 'lib/aws-sdk-docdb/types.rb', line 4616

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