Class: Aws::RDS::DBSnapshotAttribute

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

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions 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 '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_values ⇒ Array<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 'lib/aws-sdk-rds/db_snapshot_attribute.rb', line 50

def attribute_values
  data.attribute_values
end

#client ⇒ Client

Returns:



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

def client
  @client
end

#data ⇒ Types::DBSnapshotAttribute

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

Returns:

Raises:

  • (NotImplementedError) —

    Raises when #data_loaded? is ‘false`.



72
73
74
75
 
# File '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 'lib/aws-sdk-rds/db_snapshot_attribute.rb', line 80

def data_loaded?
  !!@data
end

#identifiers ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


124
125
126
127
128
129
 
# File 'lib/aws-sdk-rds/db_snapshot_attribute.rb', line 124

def identifiers
  {
    snapshot_id: @snapshot_id,
    name: @name
  }
end

#load ⇒ Object Also known as: reload

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Raises:

  • (NotImplementedError) 


63
64
65
66
 
# File 'lib/aws-sdk-rds/db_snapshot_attribute.rb', line 63

def load
  msg = "#load is not implemented, data only available via enumeration"
  raise NotImplementedError, msg
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 '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

#name ⇒ String Also known as: attribute_name

Returns:

  • (String) 


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

def name
  @name
end

#snapshot_id ⇒ String

Returns:

  • (String) 


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

def snapshot_id
  @snapshot_id
end