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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-docdb/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.

Instance Attribute Summary collapse

Instance Attribute Details

#attribute_nameString

The name of the DB cluster snapshot attribute to modify.

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

Returns:

  • (String)


3614
3615
3616
3617
3618
3619
3620
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 3614

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

#db_cluster_snapshot_identifierString

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

Returns:

  • (String)


3614
3615
3616
3617
3618
3619
3620
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 3614

class ModifyDBClusterSnapshotAttributeMessage < Struct.new(
  :db_cluster_snapshot_identifier,
  :attribute_name,
  :values_to_add,
  :values_to_remove)
  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 AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account IDs. To make the manual DB cluster snapshot restorable by any AWS account, set it to all. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want to be available to all AWS accounts.

Returns:

  • (Array<String>)


3614
3615
3616
3617
3618
3619
3620
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 3614

class ModifyDBClusterSnapshotAttributeMessage < Struct.new(
  :db_cluster_snapshot_identifier,
  :attribute_name,
  :values_to_add,
  :values_to_remove)
  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 AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account identifiers. To remove authorization for any AWS account to copy or restore the DB cluster snapshot, set it to all . If you specify all, an AWS account whose account ID is explicitly added to the restore attribute can still copy or restore a manual DB cluster snapshot.

Returns:

  • (Array<String>)


3614
3615
3616
3617
3618
3619
3620
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 3614

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