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

Class: Aws::RDS::DBSnapshotAttribute

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

Defined Under Namespace

Classes: Collection

Actions collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(snapshot_id, name, options = {}) ⇒ DBSnapshotAttribute #initialize(options = {}) ⇒ DBSnapshotAttribute

Returns a new instance of DBSnapshotAttribute

Overloads:

  • #initialize(snapshot_id, name, options = {}) ⇒ DBSnapshotAttribute

    Parameters:

    • snapshot_id (String)
    • name (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ DBSnapshotAttribute

    Options Hash (options):

    • :snapshot_id (required, String)
    • :name (required, String)
    • :client (Client)


21
22
23
24
25
26
27
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot_attribute.rb', line 21

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @snapshot_id = extract_snapshot_id(args, options)
  @name = extract_name(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
end

Instance Method Details

#attribute_valuesArray<String>

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.

Returns:

  • (Array<String>)


50
51
52
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot_attribute.rb', line 50

def attribute_values
  data.attribute_values
end

#clientClient

Returns:



57
58
59
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot_attribute.rb', line 57

def client
  @client
end

#dataTypes::DBSnapshotAttribute

Returns the data for this Aws::RDS::DBSnapshotAttribute.

Returns:

Raises:



72
73
74
75
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot_attribute.rb', line 72

def data
  load unless @data
  @data
end

#data_loaded?Boolean

Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean)

    Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



80
81
82
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot_attribute.rb', line 80

def data_loaded?
  !!@data
end

#modify(options = {}) ⇒ Types::ModifyDBSnapshotAttributeResult

Examples:

Request syntax with placeholder values


db_snapshot_attribute.modify({
  values_to_add: ["String"],
  values_to_remove: ["String"],
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :values_to_add (Array<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.

  • :values_to_remove (Array<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:



113
114
115
116
117
118
119
120
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot_attribute.rb', line 113

def modify(options = {})
  options = options.merge(
    attribute_name: @name,
    db_snapshot_identifier: @snapshot_id
  )
  resp = @client.modify_db_snapshot_attribute(options)
  resp.data
end

#nameString Also known as: attribute_name

Returns:

  • (String)


37
38
39
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot_attribute.rb', line 37

def name
  @name
end

#snapshot_idString

Returns:

  • (String)


32
33
34
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot_attribute.rb', line 32

def snapshot_id
  @snapshot_id
end