Class: Aws::RDS::DBClusterSnapshot

Inherits:

Object

Object
Aws::RDS::DBClusterSnapshot

show all

Extended by:: Deprecations

Defined in:: lib/aws-sdk-rds/db_cluster_snapshot.rb

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

#allocated_storage ⇒ Integer

Specifies the allocated storage size in gibibytes (GiB).
#availability_zones ⇒ Array<String>

Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
#cluster_create_time ⇒ Time

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
#cluster_id ⇒ String (also: #db_cluster_identifier)
#db_cluster_snapshot_arn ⇒ String

The Amazon Resource Name (ARN) for the DB cluster snapshot.
#db_system_id ⇒ String

Reserved for future use.
#engine ⇒ String

Specifies the name of the database engine for this DB cluster snapshot.
#engine_mode ⇒ String

Provides the engine mode of the database engine for this DB cluster snapshot.
#engine_version ⇒ String

Provides the version of the database engine for this DB cluster snapshot.
#iam_database_authentication_enabled ⇒ Boolean

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
#kms_key_id ⇒ String

If `StorageEncrypted` is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.
#license_model ⇒ String

Provides the license model information for this DB cluster snapshot.
#master_username ⇒ String

Provides the master username for this DB cluster snapshot.
#percent_progress ⇒ Integer

Specifies the percentage of the estimated data that has been transferred.
#port ⇒ Integer

Specifies the port that the DB cluster was listening on at the time of the snapshot.
#snapshot_create_time ⇒ Time

Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
#snapshot_id ⇒ String (also: #db_cluster_snapshot_identifier)
#snapshot_type ⇒ String

Provides the type of the DB cluster snapshot.
#source_db_cluster_snapshot_arn ⇒ String

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.
#status ⇒ String

Specifies the status of this DB cluster snapshot.
#storage_encrypted ⇒ Boolean

Specifies whether the DB cluster snapshot is encrypted.
#tag_list ⇒ Array<Types::Tag>

A list of tags.
#vpc_id ⇒ String

Provides the VPC ID associated with the DB cluster snapshot.

Actions collapse

Associations collapse

#cluster ⇒ DBCluster
#events(options = {}) ⇒ Event::Collection
#identifiers ⇒ Object deprecated private Deprecated.

Instance Method Summary collapse

#client ⇒ Client
#data ⇒ Types::DBClusterSnapshot

Returns the data for this DBClusterSnapshot.
#data_loaded? ⇒ Boolean

Returns `true` if this resource is loaded.
#initialize(*args) ⇒ DBClusterSnapshot constructor

A new instance of DBClusterSnapshot.
#load ⇒ self (also: #reload)

Loads, or reloads #data for the current DBClusterSnapshot.
#wait_until(options = {}) {|resource| ... } ⇒ Resource deprecated Deprecated.

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

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):
- :client (Client)
#initialize(options = {}) ⇒ DBClusterSnapshot
Options Hash (options):
- :cluster_id (required, String)
- :snapshot_id (required, String)
- :client (Client)

# File 'lib/aws-sdk-rds/db_cluster_snapshot.rb', line 24

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)
  @waiter_block_warned = false
end

Instance Method Details

#allocated_storage ⇒ `Integer`

Specifies the allocated storage size in gibibytes (GiB).

Returns:

(Integer)


77
78
79

# File 'lib/aws-sdk-rds/db_cluster_snapshot.rb', line 77

def allocated_storage
  data[:allocated_storage]
end

#availability_zones ⇒ `Array<String>`

Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.

Returns:

(Array<String>)


50
51
52

# File 'lib/aws-sdk-rds/db_cluster_snapshot.rb', line 50

def availability_zones
  data[:availability_zones]
end

#client ⇒ `Client`

Returns:

(Client)


203
204
205

# File 'lib/aws-sdk-rds/db_cluster_snapshot.rb', line 203

def client
  @client
end

#cluster ⇒ `DBCluster`

Returns:

(DBCluster)

# File 'lib/aws-sdk-rds/db_cluster_snapshot.rb', line 950

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

#cluster_create_time ⇒ `Time`

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

Returns:

(Time)


110
111
112

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

def cluster_create_time
  data[:cluster_create_time]
end

#cluster_id ⇒ `String` Also known as: db_cluster_identifier

Returns:

(String)


36
37
38

# File 'lib/aws-sdk-rds/db_cluster_snapshot.rb', line 36

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 isn't case-sensitive.

Constraints:
- Must contain from 1 to 63 letters, numbers, or hyphens.
- First character must be a letter.
- Can't end with a hyphen or contain two consecutive hyphens.
Example: `my-cluster-snapshot2`
:kms_key_id (String) —

The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS key.

If you copy an encrypted DB cluster snapshot from your Amazon Web Services account, you can specify a value for `KmsKeyId` to encrypt the copy with a new KMS 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 Amazon Web Services account, then you must specify a value for `KmsKeyId`.

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

If you copy an unencrypted DB cluster snapshot and specify a value for the `KmsKeyId` parameter, an error is returned.
:pre_signed_url (String) —
When you are copying a DB cluster snapshot from one Amazon Web Services GovCloud (US) Region to another, the URL that contains a Signature Version 4 signed request for the `CopyDBClusterSnapshot` API operation in the Amazon Web Services Region that contains the source DB cluster snapshot to copy. Use the `PreSignedUrl` parameter when copying an encrypted DB cluster snapshot from another Amazon Web Services Region. Don't specify `PreSignedUrl` when copying an encrypted DB cluster snapshot in the same Amazon Web Services Region.

This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other Amazon Web Services Regions.

The presigned URL must be a valid request for the `CopyDBClusterSnapshot` API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request must contain the following parameter values:
- `KmsKeyId` - The KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the `CopyDBClusterSnapshot` operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.
- `DestinationRegion` - The name of the Amazon Web Services Region that the DB cluster snapshot is to 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 Amazon Web Services Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services 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 (Amazon Web Services Signature Version 4)] and [ Signature Version 4 Signing Process].

<note markdown=“1”> If you are using an Amazon Web Services SDK tool or the CLI, you can specify `SourceRegion` (or `–source-region` for the CLI) instead of specifying `PreSignedUrl` manually. Specifying `SourceRegion` autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.
```
</note>
```
[1]: docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html [2]: docs.aws.amazon.com/general/latest/gr/signature-version-4.html
:copy_tags (Boolean) —

A value that indicates whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. By default, tags are not copied.
:tags (Array<Types::Tag>) —

A list of tags. For more information, see [Tagging Amazon RDS Resources] in the *Amazon RDS User Guide.*

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
:source_region (String) —

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

Returns:

(DBClusterSnapshot)

# File 'lib/aws-sdk-rds/db_cluster_snapshot.rb', line 486

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:

(DBClusterSnapshot)

# File 'lib/aws-sdk-rds/db_cluster_snapshot.rb', line 348

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

#data ⇒ `Types::DBClusterSnapshot`

Returns the data for this Aws::RDS::DBClusterSnapshot. Calls Client#describe_db_cluster_snapshots if #data_loaded? is `false`.

Returns:

(Types::DBClusterSnapshot) —

Returns the data for this Aws::RDS::DBClusterSnapshot. Calls Client#describe_db_cluster_snapshots if #data_loaded? is `false`.

# File 'lib/aws-sdk-rds/db_cluster_snapshot.rb', line 223

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.


231
232
233

# File 'lib/aws-sdk-rds/db_cluster_snapshot.rb', line 231

def data_loaded?
  !!@data
end

#db_cluster_snapshot_arn ⇒ `String`

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

Returns:

(String)


164
165
166

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

def db_cluster_snapshot_arn
  data[:db_cluster_snapshot_arn]
end

#db_system_id ⇒ `String`

Reserved for future use.

Returns:

(String)


196
197
198

# File 'lib/aws-sdk-rds/db_cluster_snapshot.rb', line 196

def db_system_id
  data[:db_system_id]
end

#delete(options = {}) ⇒ `DBClusterSnapshot`

Examples:

Request syntax with placeholder values


db_cluster_snapshot.delete()

Parameters:

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

({})

Returns:

(DBClusterSnapshot)

# File 'lib/aws-sdk-rds/db_cluster_snapshot.rb', line 502

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

#engine ⇒ `String`

Specifies the name of the database engine for this DB cluster snapshot.

Returns:

(String)


64
65
66

# File 'lib/aws-sdk-rds/db_cluster_snapshot.rb', line 64

def engine
  data[:engine]
end

#engine_mode ⇒ `String`

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

Returns:

(String)


71
72
73

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

def engine_mode
  data[:engine_mode]
end

#engine_version ⇒ `String`

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

Returns:

(String)


123
124
125

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

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.][1

Example: 2009-07-08T18:00Z

[1]: en.wikipedia.org/wiki/ISO_8601
: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.][1

Example: 2009-07-08T18:00Z

[1]: en.wikipedia.org/wiki/ISO_8601
: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 isn't currently supported.

Returns:

(Event::Collection)

# File 'lib/aws-sdk-rds/db_cluster_snapshot.rb', line 1002

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_enabled ⇒ `Boolean`

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

Returns:

(Boolean)


179
180
181

# File 'lib/aws-sdk-rds/db_cluster_snapshot.rb', line 179

def iam_database_authentication_enabled
  data[:iam_database_authentication_enabled]
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.

# File 'lib/aws-sdk-rds/db_cluster_snapshot.rb', line 1027

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

#kms_key_id ⇒ `String`

If `StorageEncrypted` is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

Returns:

(String)


158
159
160

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

def kms_key_id
  data[:kms_key_id]
end

#license_model ⇒ `String`

Provides the license model information for this DB cluster snapshot.

Returns:

(String)


129
130
131

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

def license_model
  data[:license_model]
end

#load ⇒ `self` 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)

# File 'lib/aws-sdk-rds/db_cluster_snapshot.rb', line 213

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

#master_username ⇒ `String`

Provides the master username for this DB cluster snapshot.

Returns:

(String)


116
117
118

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

def master_username
  data[:master_username]
end

#percent_progress ⇒ `Integer`

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

Returns:

(Integer)


142
143
144

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

def percent_progress
  data[:percent_progress]
end

#port ⇒ `Integer`

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

Returns:

(Integer)


97
98
99

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

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,
  backtrack_window: 1,
  enable_cloudwatch_logs_exports: ["String"],
  engine_mode: "String",
  scaling_configuration: {
    min_capacity: 1,
    max_capacity: 1,
    auto_pause: false,
    seconds_until_auto_pause: 1,
    timeout_action: "String",
    seconds_before_timeout: 1,
  },
  db_cluster_parameter_group_name: "String",
  deletion_protection: false,
  copy_tags_to_snapshot: false,
  domain: "String",
  domain_iam_role_name: "String",
  db_cluster_instance_class: "String",
  storage_type: "String",
  iops: 1,
  publicly_accessible: false,
  serverless_v2_scaling_configuration: {
    min_capacity: 1.0,
    max_capacity: 1.0,
  },
  network_type: "String",
})

Parameters:

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

({})

Options Hash (options):

:availability_zones (Array<String>) —

Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.

Valid for: Aurora DB clusters only
: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 63 letters, numbers, or hyphens
- First character must be a letter
- Can't end with a hyphen or contain two consecutive hyphens
Example: `my-snapshot-id`

Valid for: Aurora DB clusters and Multi-AZ DB clusters
: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

Valid for: Aurora DB clusters and Multi-AZ DB clusters
:engine_version (String) —

The version of the database engine to use for the new DB cluster. If you don't specify an engine version, the default version for the database engine in the Amazon Web Services Region is used.

To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:

`aws rds describe-db-engine-versions –engine aurora-mysql –query “DBEngineVersions[].EngineVersion”`

To list all of the available engine versions for Aurora PostgreSQL, use the following command:

`aws rds describe-db-engine-versions –engine aurora-postgresql –query “DBEngineVersions[].EngineVersion”`

To list all of the available engine versions for RDS for MySQL, use the following command:

`aws rds describe-db-engine-versions –engine mysql –query “DBEngineVersions[].EngineVersion”`

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

`aws rds describe-db-engine-versions –engine postgres –query “DBEngineVersions[].EngineVersion”`

**Aurora MySQL**

See [Database engine updates for Amazon Aurora MySQL] in the *Amazon Aurora User Guide*.

**Aurora PostgreSQL**

See [Amazon Aurora PostgreSQL releases and engine versions] in the *Amazon Aurora User Guide*.

MySQL

See [Amazon RDS for MySQL] in the *Amazon RDS User Guide.*

PostgreSQL

See [Amazon RDS for PostgreSQL versions and extensions] in the *Amazon RDS User Guide.*

Valid for: Aurora DB clusters and Multi-AZ DB clusters

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html [2]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html [3]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt [4]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts
:port (Integer) —

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

Constraints: This value must be `1150-65535`

Default: The same port as the original DB cluster.

Valid for: Aurora DB clusters and Multi-AZ DB clusters
: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 DB subnet group.

Example: `mydbsubnetgroup`

Valid for: Aurora DB clusters and Multi-AZ DB clusters
:database_name (String) —

The database name for the restored DB cluster.

Valid for: Aurora DB clusters and Multi-AZ DB clusters
:option_group_name (String) —

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

DB clusters are associated with a default option group that can't be modified.
:vpc_security_group_ids (Array<String>) —

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

Valid for: Aurora DB clusters and Multi-AZ DB clusters
:tags (Array<Types::Tag>) —

The tags to be assigned to the restored DB cluster.

Valid for: Aurora DB clusters and Multi-AZ DB clusters
:kms_key_id (String) —
The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

When you don't specify a value for the `KmsKeyId` parameter, then the following occurs:
- 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` isn't encrypted, then the restored DB cluster isn't encrypted.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
:enable_iam_database_authentication (Boolean) —

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.

For more information, see [ IAM Database Authentication] in the *Amazon Aurora User Guide*.

Valid for: Aurora DB clusters only

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html
:backtrack_window (Integer) —
The target backtrack window, in seconds. To disable backtracking, set this value to 0.

<note markdown=“1”> Currently, Backtrack is only supported for Aurora MySQL DB clusters.
```
</note>
```
Default: 0

Constraints:
- If specified, this value must be set to a number from 0 to 259,200 (72 hours).
^

Valid for: Aurora DB clusters only
:enable_cloudwatch_logs_exports (Array<String>) —

The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used.

**RDS for MySQL**

Possible values are `error`, `general`, and `slowquery`.

**RDS for PostgreSQL**

Possible values are `postgresql` and `upgrade`.

**Aurora MySQL**

Possible values are `audit`, `error`, `general`, and `slowquery`.

**Aurora PostgreSQL**

Possible value is `postgresql`.

For more information about exporting CloudWatch Logs for Amazon RDS, see [Publishing Database Logs to Amazon CloudWatch Logs] in the *Amazon RDS User Guide*.

For more information about exporting CloudWatch Logs for Amazon Aurora, see [Publishing Database Logs to Amazon CloudWatch Logs] in the *Amazon Aurora User Guide*.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch [2]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
:engine_mode (String) —

The DB engine mode of the DB cluster, either `provisioned`, `serverless`, `parallelquery`, `global`, or `multimaster`.

For more information, see [ CreateDBCluster].

Valid for: Aurora DB clusters only

[1]: docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html
:scaling_configuration (Types::ScalingConfiguration) —

For DB clusters in `serverless` DB engine mode, the scaling properties of the DB cluster.

Valid for: Aurora DB clusters only
:db_cluster_parameter_group_name (String) —
The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.

Constraints:
- If supplied, must match the name of an existing default DB cluster parameter group.
- Must be 1 to 255 letters, numbers, or hyphens.
- First character must be a letter.
- Can't end with a hyphen or contain two consecutive hyphens.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
:deletion_protection (Boolean) —

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.

Valid for: Aurora DB clusters and Multi-AZ DB clusters
:copy_tags_to_snapshot (Boolean) —

A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

Valid for: Aurora DB clusters and Multi-AZ DB clusters
:domain (String) —

Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

For more information, see [ Kerberos Authentication] in the *Amazon RDS User Guide*.

Valid for: Aurora DB clusters only

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
:domain_iam_role_name (String) —

Specify the name of the IAM role to be used when making API calls to the Directory Service.

Valid for: Aurora DB clusters only
:db_cluster_instance_class (String) —

The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

For the full list of DB instance classes, and availability for your engine, see [DB Instance Class] in the *Amazon RDS User Guide.*

Valid for: Multi-AZ DB clusters only

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
:storage_type (String) —

Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.

Valid values: `io1`

When specified, a value for the `Iops` parameter is required.

Default: `io1`

Valid for: Aurora DB clusters and Multi-AZ DB clusters
:iops (Integer) —

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.

For information about valid IOPS values, see [Amazon RDS Provisioned IOPS storage] in the *Amazon RDS User Guide*.

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
:publicly_accessible (Boolean) —
A value that indicates whether the DB cluster is publicly accessible.

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether `DBSubnetGroupName` is specified.

If `DBSubnetGroupName` isn't specified, and `PubliclyAccessible` isn't specified, the following applies:
- If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
- If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
If `DBSubnetGroupName` is specified, and `PubliclyAccessible` isn't specified, the following applies:
- If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
- If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
:serverless_v2_scaling_configuration (Types::ServerlessV2ScalingConfiguration) —

Contains the scaling configuration of an Aurora Serverless v2 DB cluster.

For more information, see [Using Amazon Aurora Serverless v2] in the *Amazon Aurora User Guide*.

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html
:network_type (String) —
The network type of the DB cluster.

Valid values:
- `IPV4`
- `DUAL`
The network type is determined by the `DBSubnetGroup` specified for the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (`DUAL`).

For more information, see [ Working with a DB instance in a VPC] in the *Amazon Aurora User Guide.*

Valid for: Aurora DB clusters only

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html

Returns:

(DBCluster)

# File 'lib/aws-sdk-rds/db_cluster_snapshot.rb', line 937

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_time ⇒ `Time`

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

Returns:

(Time)


57
58
59

# File 'lib/aws-sdk-rds/db_cluster_snapshot.rb', line 57

def snapshot_create_time
  data[:snapshot_create_time]
end

#snapshot_id ⇒ `String` Also known as: db_cluster_snapshot_identifier

Returns:

(String)


42
43
44

# File 'lib/aws-sdk-rds/db_cluster_snapshot.rb', line 42

def snapshot_id
  @snapshot_id
end

#snapshot_type ⇒ `String`

Provides the type of the DB cluster snapshot.

Returns:

(String)


135
136
137

# File 'lib/aws-sdk-rds/db_cluster_snapshot.rb', line 135

def snapshot_type
  data[:snapshot_type]
end

#source_db_cluster_snapshot_arn ⇒ `String`

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)


172
173
174

# File 'lib/aws-sdk-rds/db_cluster_snapshot.rb', line 172

def source_db_cluster_snapshot_arn
  data[:source_db_cluster_snapshot_arn]
end

#status ⇒ `String`

Specifies the status of this DB cluster snapshot. Valid statuses are the following:

`available`
`copying`
`creating`

Returns:

(String)


90
91
92

# File 'lib/aws-sdk-rds/db_cluster_snapshot.rb', line 90

def status
  data[:status]
end

#storage_encrypted ⇒ `Boolean`

Specifies whether the DB cluster snapshot is encrypted.

Returns:

(Boolean)


148
149
150

# File 'lib/aws-sdk-rds/db_cluster_snapshot.rb', line 148

def storage_encrypted
  data[:storage_encrypted]
end

A list of tags. For more information, see [Tagging Amazon RDS Resources] in the *Amazon RDS User Guide.*

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html

Returns:

(Array<Types::Tag>)


190
191
192

# File 'lib/aws-sdk-rds/db_cluster_snapshot.rb', line 190

def tag_list
  data[:tag_list]
end

#vpc_id ⇒ `String`

Provides the VPC ID associated with the DB cluster snapshot.

Returns:

(String)


103
104
105

# File 'lib/aws-sdk-rds/db_cluster_snapshot.rb', line 103

def vpc_id
  data[:vpc_id]
end

#wait_until(options = {}) {|resource| ... } ⇒ `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) do |instance|
  instance.state.name == 'running'
end

## 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

Yield Parameters:

resource (Resource) —

to be used in the waiting condition.

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

# File 'lib/aws-sdk-rds/db_cluster_snapshot.rb', line 315

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

Class: Aws::RDS::DBClusterSnapshot

Defined Under Namespace

Read-Only Attributes collapse

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

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

Instance Method Details

#allocated_storage ⇒ Integer

#availability_zones ⇒ Array<String>

#client ⇒ Client

#cluster ⇒ DBCluster

#cluster_create_time ⇒ Time

#cluster_id ⇒ String Also known as: db_cluster_identifier

#copy(options = {}) ⇒ DBClusterSnapshot

#create(options = {}) ⇒ DBClusterSnapshot

#data ⇒ Types::DBClusterSnapshot

#data_loaded? ⇒ Boolean

#db_cluster_snapshot_arn ⇒ String

#db_system_id ⇒ String

#delete(options = {}) ⇒ DBClusterSnapshot

#engine ⇒ String

#engine_mode ⇒ String

#engine_version ⇒ String

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

#iam_database_authentication_enabled ⇒ Boolean

#identifiers ⇒ Object

#kms_key_id ⇒ String

#license_model ⇒ String

#load ⇒ self Also known as: reload

#master_username ⇒ String

#percent_progress ⇒ Integer

#port ⇒ Integer

#restore(options = {}) ⇒ DBCluster

#snapshot_create_time ⇒ Time

#snapshot_id ⇒ String Also known as: db_cluster_snapshot_identifier

#snapshot_type ⇒ String

#source_db_cluster_snapshot_arn ⇒ String

#status ⇒ String

#storage_encrypted ⇒ Boolean

#tag_list ⇒ Array<Types::Tag>

#vpc_id ⇒ String

#wait_until(options = {}) {|resource| ... } ⇒ Resource

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

#allocated_storage ⇒ `Integer`

#availability_zones ⇒ `Array<String>`

#client ⇒ `Client`

#cluster ⇒ `DBCluster`

#cluster_create_time ⇒ `Time`

#cluster_id ⇒ `String` Also known as: db_cluster_identifier

#copy(options = {}) ⇒ `DBClusterSnapshot`

#create(options = {}) ⇒ `DBClusterSnapshot`

#data ⇒ `Types::DBClusterSnapshot`

#data_loaded? ⇒ `Boolean`

#db_cluster_snapshot_arn ⇒ `String`

#db_system_id ⇒ `String`

#delete(options = {}) ⇒ `DBClusterSnapshot`

#engine ⇒ `String`

#engine_mode ⇒ `String`

#engine_version ⇒ `String`

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

#iam_database_authentication_enabled ⇒ `Boolean`

#identifiers ⇒ `Object`

#kms_key_id ⇒ `String`

#license_model ⇒ `String`

#load ⇒ `self` Also known as: reload

#master_username ⇒ `String`

#percent_progress ⇒ `Integer`

#port ⇒ `Integer`

#restore(options = {}) ⇒ `DBCluster`

#snapshot_create_time ⇒ `Time`

#snapshot_id ⇒ `String` Also known as: db_cluster_snapshot_identifier

#snapshot_type ⇒ `String`

#source_db_cluster_snapshot_arn ⇒ `String`

#status ⇒ `String`

#storage_encrypted ⇒ `Boolean`

#tag_list ⇒ `Array<Types::Tag>`

#vpc_id ⇒ `String`

#wait_until(options = {}) {|resource| ... } ⇒ `Resource`