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

Class: Aws::RDS::DBClusterSnapshot

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

Defined Under Namespace

Classes: Collection

Actions collapse

Associations collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(cluster_id, snapshot_id, options = {}) ⇒ DBClusterSnapshot #initialize(options = {}) ⇒ DBClusterSnapshot

Returns a new instance of DBClusterSnapshot

Overloads:

  • #initialize(cluster_id, snapshot_id, options = {}) ⇒ DBClusterSnapshot

    Parameters:

    • cluster_id (String)
    • snapshot_id (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ DBClusterSnapshot

    Options Hash (options):

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


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

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

Instance Method Details

#allocated_storageInteger

Specifies the allocated storage size in gigabytes (GB).

Returns:

  • (Integer)


65
66
67
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 65

def allocated_storage
  data[:allocated_storage]
end

#availability_zonesArray<String>

Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.

Returns:

  • (Array<String>)


46
47
48
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 46

def availability_zones
  data[:availability_zones]
end

#clientClient

Returns:



164
165
166
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 164

def client
  @client
end

#clusterDBCluster

Returns:



560
561
562
563
564
565
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 560

def cluster
  DBCluster.new(
    id: @cluster_id,
    client: @client
  )
end

#cluster_create_timeTime

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

Returns:

  • (Time)


91
92
93
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 91

def cluster_create_time
  data[:cluster_create_time]
end

#cluster_idString Also known as: db_cluster_identifier

Returns:

  • (String)


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

def cluster_id
  @cluster_id
end

#copy(options = {}) ⇒ DBClusterSnapshot

Examples:

Request syntax with placeholder values


dbclustersnapshot = db_cluster_snapshot.copy({
  target_db_cluster_snapshot_identifier: "String", # required
  kms_key_id: "String",
  pre_signed_url: "String",
  copy_tags: false,
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  source_region: "String",
})

Parameters:

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

    ({})

Options Hash (options):

  • :target_db_cluster_snapshot_identifier (required, String)

    The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter is not case-sensitive.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens.

    • First character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

    Example: my-cluster-snapshot2

  • :kms_key_id (String)

    The AWS AWS KMS key ID for an encrypted DB cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

    If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, Amazon RDS encrypts the target DB cluster snapshot using the specified KMS encryption key.

    If you copy an encrypted DB cluster snapshot from your AWS account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.

    If you copy an encrypted DB cluster snapshot that is shared from another AWS account, then you must specify a value for KmsKeyId.

    To copy an encrypted DB cluster snapshot to another AWS Region, you must set KmsKeyId to the KMS key ID you want to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.

  • :pre_signed_url (String)

    The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the AWS Region that contains the source DB cluster snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB cluster snapshot from another AWS Region.

    The pre-signed URL must be a valid request for the CopyDBSClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values:

    • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the pre-signed URL.

    • DestinationRegion - The name of the AWS Region that the DB cluster snapshot will be created in.

    • SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.

    To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

  • :copy_tags (Boolean)

    True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot, and otherwise false. The default is false.

  • :tags (Array<Types::Tag>)

    A list of tags. For more information, see Tagging Amazon RDS Resources.

  • :destination_region (String)
  • :source_region (String)

    The source region of the snapshot. This is only needed when the shapshot is encrypted and in a different region.

Returns:



428
429
430
431
432
433
434
435
436
437
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 428

def copy(options = {})
  options = options.merge(source_db_cluster_snapshot_identifier: @snapshot_id)
  resp = @client.copy_db_cluster_snapshot(options)
  DBClusterSnapshot.new(
    cluster_id: resp.data.db_cluster_snapshot.db_cluster_identifier,
    snapshot_id: resp.data.db_cluster_snapshot.db_cluster_snapshot_identifier,
    data: resp.data.db_cluster_snapshot,
    client: @client
  )
end

#create(options = {}) ⇒ DBClusterSnapshot

Examples:

Request syntax with placeholder values


dbclustersnapshot = db_cluster_snapshot.create({
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Parameters:

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

    ({})

Options Hash (options):

  • :tags (Array<Types::Tag>)

    The tags to be assigned to the DB cluster snapshot.

Returns:



307
308
309
310
311
312
313
314
315
316
317
318
319
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 307

def create(options = {})
  options = options.merge(
    db_cluster_identifier: @cluster_id,
    db_cluster_snapshot_identifier: @snapshot_id
  )
  resp = @client.create_db_cluster_snapshot(options)
  DBClusterSnapshot.new(
    cluster_id: resp.data.db_cluster_snapshot.db_cluster_identifier,
    snapshot_id: resp.data.db_cluster_snapshot.db_cluster_snapshot_identifier,
    data: resp.data.db_cluster_snapshot,
    client: @client
  )
end

#dataTypes::DBClusterSnapshot



184
185
186
187
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 184

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.



192
193
194
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 192

def data_loaded?
  !!@data
end

#db_cluster_snapshot_arnString

The Amazon Resource Name (ARN) for the DB cluster snapshot.

Returns:

  • (String)


142
143
144
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 142

def db_cluster_snapshot_arn
  data[:db_cluster_snapshot_arn]
end

#delete(options = {}) ⇒ DBClusterSnapshot

Examples:

Request syntax with placeholder values


db_cluster_snapshot.delete()

Parameters:

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

    ({})

Returns:



444
445
446
447
448
449
450
451
452
453
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 444

def delete(options = {})
  options = options.merge(db_cluster_snapshot_identifier: @snapshot_id)
  resp = @client.delete_db_cluster_snapshot(options)
  DBClusterSnapshot.new(
    cluster_id: resp.data.db_cluster_snapshot.db_cluster_identifier,
    snapshot_id: resp.data.db_cluster_snapshot.db_cluster_snapshot_identifier,
    data: resp.data.db_cluster_snapshot,
    client: @client
  )
end

#engineString

Specifies the name of the database engine.

Returns:

  • (String)


59
60
61
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 59

def engine
  data[:engine]
end

#engine_versionString

Provides the version of the database engine for this DB cluster snapshot.

Returns:

  • (String)


104
105
106
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 104

def engine_version
  data[:engine_version]
end

#events(options = {}) ⇒ Event::Collection

Examples:

Request syntax with placeholder values


events = db_cluster_snapshot.events({
  start_time: Time.now,
  end_time: Time.now,
  duration: 1,
  event_categories: ["String"],
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
})

Parameters:

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

    ({})

Options Hash (options):

  • :start_time (Time, DateTime, Date, Integer, String)

    The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

    Example: 2009-07-08T18:00Z

  • :end_time (Time, DateTime, Date, Integer, String)

    The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

    Example: 2009-07-08T18:00Z

  • :duration (Integer)

    The number of minutes to retrieve events for.

    Default: 60

  • :event_categories (Array<String>)

    A list of event categories that trigger notifications for a event notification subscription.

  • :filters (Array<Types::Filter>)

    This parameter is not currently supported.

Returns:



612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 612

def events(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(
      source_type: "db-cluster-snapshot",
      source_identifier: @snapshot_id
    )
    resp = @client.describe_events(options)
    resp.each_page do |page|
      batch = []
      page.data.events.each do |e|
        batch << Event.new(
          source_id: e.source_identifier,
          date: e.date,
          data: e,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  Event::Collection.new(batches)
end

#iam_database_authentication_enabledBoolean

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

Returns:

  • (Boolean)


157
158
159
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 157

def iam_database_authentication_enabled
  data[:iam_database_authentication_enabled]
end

#kms_key_idString

If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.

Returns:

  • (String)


136
137
138
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 136

def kms_key_id
  data[:kms_key_id]
end

#license_modelString

Provides the license model information for this DB cluster snapshot.

Returns:

  • (String)


110
111
112
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 110

def license_model
  data[:license_model]
end

#loadself Also known as: reload

Loads, or reloads #data for the current Aws::RDS::DBClusterSnapshot. Returns self making it possible to chain methods.

db_cluster_snapshot.reload.data

Returns:

  • (self)


174
175
176
177
178
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 174

def load
  resp = @client.describe_db_cluster_snapshots(db_cluster_snapshot_identifier: @snapshot_id)
  @data = resp.db_cluster_snapshots[0]
  self
end

#master_usernameString

Provides the master username for the DB cluster snapshot.

Returns:

  • (String)


97
98
99
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 97

def master_username
  data[:master_username]
end

#percent_progressInteger

Specifies the percentage of the estimated data that has been transferred.

Returns:

  • (Integer)


123
124
125
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 123

def percent_progress
  data[:percent_progress]
end

#portInteger

Specifies the port that the DB cluster was listening on at the time of the snapshot.

Returns:

  • (Integer)


78
79
80
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 78

def port
  data[:port]
end

#restore(options = {}) ⇒ DBCluster

Examples:

Request syntax with placeholder values


dbcluster = db_cluster_snapshot.restore({
  availability_zones: ["String"],
  db_cluster_identifier: "String", # required
  engine: "String", # required
  engine_version: "String",
  port: 1,
  db_subnet_group_name: "String",
  database_name: "String",
  option_group_name: "String",
  vpc_security_group_ids: ["String"],
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  kms_key_id: "String",
  enable_iam_database_authentication: false,
})

Parameters:

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

    ({})

Options Hash (options):

  • :availability_zones (Array<String>)

    Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.

  • :db_cluster_identifier (required, String)

    The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive.

    Constraints:

    • Must contain from 1 to 255 letters, numbers, or hyphens

    • First character must be a letter

    • Cannot end with a hyphen or contain two consecutive hyphens

    Example: my-snapshot-id

  • :engine (required, String)

    The database engine to use for the new DB cluster.

    Default: The same as source

    Constraint: Must be compatible with the engine of the source

  • :engine_version (String)

    The version of the database engine to use for the new DB cluster.

  • :port (Integer)

    The port number on which the new DB cluster accepts connections.

    Constraints: Value must be 1150-65535

    Default: The same port as the original DB cluster.

  • :db_subnet_group_name (String)

    The name of the DB subnet group to use for the new DB cluster.

    Constraints: If supplied, must match the name of an existing DBSubnetGroup.

    Example: mySubnetgroup

  • :database_name (String)

    The database name for the restored DB cluster.

  • :option_group_name (String)

    The name of the option group to use for the restored DB cluster.

  • :vpc_security_group_ids (Array<String>)

    A list of VPC security groups that the new DB cluster will belong to.

  • :tags (Array<Types::Tag>)

    The tags to be assigned to the restored DB cluster.

  • :kms_key_id (String)

    The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.

    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

    If you do not specify a value for the KmsKeyId parameter, then the following will occur:

    • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.

    • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.

  • :enable_iam_database_authentication (Boolean)

    True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

    Default: false

Returns:



547
548
549
550
551
552
553
554
555
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 547

def restore(options = {})
  options = options.merge(snapshot_identifier: @snapshot_id)
  resp = @client.restore_db_cluster_from_snapshot(options)
  DBCluster.new(
    id: resp.data.db_cluster.db_cluster_identifier,
    data: resp.data.db_cluster,
    client: @client
  )
end

#snapshot_create_timeTime

Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

Returns:

  • (Time)


53
54
55
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 53

def snapshot_create_time
  data[:snapshot_create_time]
end

#snapshot_idString Also known as: db_cluster_snapshot_identifier

Returns:

  • (String)


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

def snapshot_id
  @snapshot_id
end

#snapshot_typeString

Provides the type of the DB cluster snapshot.

Returns:

  • (String)


116
117
118
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 116

def snapshot_type
  data[:snapshot_type]
end

#source_db_cluster_snapshot_arnString

If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.

Returns:

  • (String)


150
151
152
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 150

def source_db_cluster_snapshot_arn
  data[:source_db_cluster_snapshot_arn]
end

#statusString

Specifies the status of this DB cluster snapshot.

Returns:

  • (String)


71
72
73
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 71

def status
  data[:status]
end

#storage_encryptedBoolean

Specifies whether the DB cluster snapshot is encrypted.

Returns:

  • (Boolean)


129
130
131
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 129

def storage_encrypted
  data[:storage_encrypted]
end

#vpc_idString

Provides the VPC ID associated with the DB cluster snapshot.

Returns:

  • (String)


84
85
86
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 84

def vpc_id
  data[:vpc_id]
end

#wait_until(options = {}, &block) ⇒ Resource

Deprecated.

Use [Aws::RDS::Client] #wait_until instead

Note:

The waiting operation is performed on a copy. The original resource remains unchanged

Waiter polls an API operation until a resource enters a desired state.

Basic Usage

Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop until condition is true
resource.wait_until(options) {|resource| condition}

Example

instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to #wait_until:

# poll for ~25 seconds
resource.wait_until(max_attempts:5,delay:5) {|resource|...}

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
# poll for 1 hour, instead of a number of attempts
proc = Proc.new do |attempts, response|
  throw :failure if Time.now - started_at > 3600
end

  # disable max attempts
instance.wait_until(before_wait:proc, max_attempts:nil) {...}

Handling Errors

When a waiter is successful, it returns the Resource. When a waiter fails, it raises an error.

begin
  resource.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

attempts attempt in seconds invoked before each attempt invoked before each wait

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :max_attempts (Integer) — default: 10

    Maximum number of

  • :delay (Integer) — default: 10

    Delay between each

  • :before_attempt (Proc) — default: nil

    Callback

  • :before_wait (Proc) — default: nil

    Callback

Returns:

  • (Resource)

    if the waiter was successful

Raises:

  • (Aws::Waiters::Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

    yet successful.

  • (Aws::Waiters::Errors::UnexpectedError)

    Raised when an error is encountered while polling for a resource that is not expected.

  • (NotImplementedError)

    Raised when the resource does not



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 274

def wait_until(options = {}, &block)
  self_copy = self.dup
  attempts = 0
  options[:max_attempts] = 10 unless options.key?(:max_attempts)
  options[:delay] ||= 10
  options[:poller] = Proc.new do
    attempts += 1
    if block.call(self_copy)
      [:success, self_copy]
    else
      self_copy.reload unless attempts == options[:max_attempts]
      :retry
    end
  end
  Aws::Waiters::Waiter.new(options).wait({})
end