Class: Aws::RDS::Types::DBClusterSnapshot

Inherits:

Struct

• Object
• Struct
• Aws::RDS::Types::DBClusterSnapshot

Defined in:

(unknown)

Overview

Contains the details for an Amazon RDS DB cluster snapshot

This data type is used as a response element in the DescribeDBClusterSnapshots action.

Returned by:

• CopyDBClusterSnapshotResult#db_cluster_snapshot
• CreateDBClusterSnapshotResult#db_cluster_snapshot
• Aws::RDS::Types::DeleteDBClusterSnapshotResult#db_cluster_snapshot

See Also:

• AWS API Documentation

Instance Attribute Summary

• #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).

• #db_cluster_identifier ⇒ String

  Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

• #db_cluster_snapshot_arn ⇒ String

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

• #db_cluster_snapshot_identifier ⇒ String

  Specifies the identifier for the DB cluster snapshot.

• #engine ⇒ String

  Specifies the name of the database engine.

• #engine_version ⇒ String

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

• #iam_database_authentication_enabled ⇒ Boolean

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

• #kms_key_id ⇒ String

  If StorageEncrypted is true, the AWS 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 the 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_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.

Instance Attribute Details

#allocated_storage ⇒ Integer

Specifies the allocated storage size in gibibytes (GiB).

Returns:

• (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.

Returns:

• (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).

Returns:

• (Time) —

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

#db_cluster_identifier ⇒ String

Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

Returns:

• (String) —

  Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

#db_cluster_snapshot_arn ⇒ String

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

Returns:

• (String) —

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

#db_cluster_snapshot_identifier ⇒ String

Specifies the identifier for the DB cluster snapshot.

Returns:

• (String) —

  Specifies the identifier for the DB cluster snapshot.

#engine ⇒ String

Specifies the name of the database engine.

Returns:

• (String) —

  Specifies the name of the database engine.

#engine_version ⇒ String

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

Returns:

• (String) —

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

#iam_database_authentication_enabled ⇒ Boolean

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

Returns:

• (Boolean) —

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

#kms_key_id ⇒ String

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

Returns:

• (String) —

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

#license_model ⇒ String

Provides the license model information for this DB cluster snapshot.

Returns:

• (String) —

  Provides the license model information for this DB cluster snapshot.

#master_username ⇒ String

Provides the master username for the DB cluster snapshot.

Returns:

• (String) —

  Provides the master username for the DB cluster snapshot.

#percent_progress ⇒ Integer

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

Returns:

• (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.

Returns:

• (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).

Returns:

• (Time) —

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

#snapshot_type ⇒ String

Provides the type of the DB cluster snapshot.

Returns:

• (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.

Returns:

• (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.

Returns:

• (String) —

  Specifies the status of this DB cluster snapshot.

#storage_encrypted ⇒ Boolean

Specifies whether the DB cluster snapshot is encrypted.

Returns:

• (Boolean) —

  Specifies whether the DB cluster snapshot is encrypted.

#tag_list ⇒ Array<Types::Tag>

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

Returns:

• (Array<Types::Tag>) —

  A list of tags.

#vpc_id ⇒ String

Provides the VPC ID associated with the DB cluster snapshot.

Returns:

• (String) —

  Provides the VPC ID associated with the DB cluster snapshot.