Class: Aws::RDS::Types::DBClusterSnapshot
- Inherits:
-
Struct
- Object
- Struct
- Aws::RDS::Types::DBClusterSnapshot
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-rds/types.rb
Overview
Contains the details for an Amazon RDS DB cluster snapshot
This data type is used as a response element in the `DescribeDBClusterSnapshots` action.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary 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).
-
#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 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_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).
6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 |
# File 'lib/aws-sdk-rds/types.rb', line 6859 class DBClusterSnapshot < Struct.new( :availability_zones, :db_cluster_snapshot_identifier, :db_cluster_identifier, :snapshot_create_time, :engine, :engine_mode, :allocated_storage, :status, :port, :vpc_id, :cluster_create_time, :master_username, :engine_version, :license_model, :snapshot_type, :percent_progress, :storage_encrypted, :kms_key_id, :db_cluster_snapshot_arn, :source_db_cluster_snapshot_arn, :iam_database_authentication_enabled, :tag_list) SENSITIVE = [] include Aws::Structure end |
#availability_zones ⇒ Array<String>
Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 |
# File 'lib/aws-sdk-rds/types.rb', line 6859 class DBClusterSnapshot < Struct.new( :availability_zones, :db_cluster_snapshot_identifier, :db_cluster_identifier, :snapshot_create_time, :engine, :engine_mode, :allocated_storage, :status, :port, :vpc_id, :cluster_create_time, :master_username, :engine_version, :license_model, :snapshot_type, :percent_progress, :storage_encrypted, :kms_key_id, :db_cluster_snapshot_arn, :source_db_cluster_snapshot_arn, :iam_database_authentication_enabled, :tag_list) SENSITIVE = [] include Aws::Structure end |
#cluster_create_time ⇒ Time
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 |
# File 'lib/aws-sdk-rds/types.rb', line 6859 class DBClusterSnapshot < Struct.new( :availability_zones, :db_cluster_snapshot_identifier, :db_cluster_identifier, :snapshot_create_time, :engine, :engine_mode, :allocated_storage, :status, :port, :vpc_id, :cluster_create_time, :master_username, :engine_version, :license_model, :snapshot_type, :percent_progress, :storage_encrypted, :kms_key_id, :db_cluster_snapshot_arn, :source_db_cluster_snapshot_arn, :iam_database_authentication_enabled, :tag_list) SENSITIVE = [] include Aws::Structure end |
#db_cluster_identifier ⇒ String
Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 |
# File 'lib/aws-sdk-rds/types.rb', line 6859 class DBClusterSnapshot < Struct.new( :availability_zones, :db_cluster_snapshot_identifier, :db_cluster_identifier, :snapshot_create_time, :engine, :engine_mode, :allocated_storage, :status, :port, :vpc_id, :cluster_create_time, :master_username, :engine_version, :license_model, :snapshot_type, :percent_progress, :storage_encrypted, :kms_key_id, :db_cluster_snapshot_arn, :source_db_cluster_snapshot_arn, :iam_database_authentication_enabled, :tag_list) SENSITIVE = [] include Aws::Structure end |
#db_cluster_snapshot_arn ⇒ String
The Amazon Resource Name (ARN) for the DB cluster snapshot.
6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 |
# File 'lib/aws-sdk-rds/types.rb', line 6859 class DBClusterSnapshot < Struct.new( :availability_zones, :db_cluster_snapshot_identifier, :db_cluster_identifier, :snapshot_create_time, :engine, :engine_mode, :allocated_storage, :status, :port, :vpc_id, :cluster_create_time, :master_username, :engine_version, :license_model, :snapshot_type, :percent_progress, :storage_encrypted, :kms_key_id, :db_cluster_snapshot_arn, :source_db_cluster_snapshot_arn, :iam_database_authentication_enabled, :tag_list) SENSITIVE = [] include Aws::Structure end |
#db_cluster_snapshot_identifier ⇒ String
Specifies the identifier for the DB cluster snapshot.
6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 |
# File 'lib/aws-sdk-rds/types.rb', line 6859 class DBClusterSnapshot < Struct.new( :availability_zones, :db_cluster_snapshot_identifier, :db_cluster_identifier, :snapshot_create_time, :engine, :engine_mode, :allocated_storage, :status, :port, :vpc_id, :cluster_create_time, :master_username, :engine_version, :license_model, :snapshot_type, :percent_progress, :storage_encrypted, :kms_key_id, :db_cluster_snapshot_arn, :source_db_cluster_snapshot_arn, :iam_database_authentication_enabled, :tag_list) SENSITIVE = [] include Aws::Structure end |
#engine ⇒ String
Specifies the name of the database engine for this DB cluster snapshot.
6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 |
# File 'lib/aws-sdk-rds/types.rb', line 6859 class DBClusterSnapshot < Struct.new( :availability_zones, :db_cluster_snapshot_identifier, :db_cluster_identifier, :snapshot_create_time, :engine, :engine_mode, :allocated_storage, :status, :port, :vpc_id, :cluster_create_time, :master_username, :engine_version, :license_model, :snapshot_type, :percent_progress, :storage_encrypted, :kms_key_id, :db_cluster_snapshot_arn, :source_db_cluster_snapshot_arn, :iam_database_authentication_enabled, :tag_list) SENSITIVE = [] include Aws::Structure end |
#engine_mode ⇒ String
Provides the engine mode of the database engine for this DB cluster snapshot.
6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 |
# File 'lib/aws-sdk-rds/types.rb', line 6859 class DBClusterSnapshot < Struct.new( :availability_zones, :db_cluster_snapshot_identifier, :db_cluster_identifier, :snapshot_create_time, :engine, :engine_mode, :allocated_storage, :status, :port, :vpc_id, :cluster_create_time, :master_username, :engine_version, :license_model, :snapshot_type, :percent_progress, :storage_encrypted, :kms_key_id, :db_cluster_snapshot_arn, :source_db_cluster_snapshot_arn, :iam_database_authentication_enabled, :tag_list) SENSITIVE = [] include Aws::Structure end |
#engine_version ⇒ String
Provides the version of the database engine for this DB cluster snapshot.
6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 |
# File 'lib/aws-sdk-rds/types.rb', line 6859 class DBClusterSnapshot < Struct.new( :availability_zones, :db_cluster_snapshot_identifier, :db_cluster_identifier, :snapshot_create_time, :engine, :engine_mode, :allocated_storage, :status, :port, :vpc_id, :cluster_create_time, :master_username, :engine_version, :license_model, :snapshot_type, :percent_progress, :storage_encrypted, :kms_key_id, :db_cluster_snapshot_arn, :source_db_cluster_snapshot_arn, :iam_database_authentication_enabled, :tag_list) SENSITIVE = [] include Aws::Structure 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.
6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 |
# File 'lib/aws-sdk-rds/types.rb', line 6859 class DBClusterSnapshot < Struct.new( :availability_zones, :db_cluster_snapshot_identifier, :db_cluster_identifier, :snapshot_create_time, :engine, :engine_mode, :allocated_storage, :status, :port, :vpc_id, :cluster_create_time, :master_username, :engine_version, :license_model, :snapshot_type, :percent_progress, :storage_encrypted, :kms_key_id, :db_cluster_snapshot_arn, :source_db_cluster_snapshot_arn, :iam_database_authentication_enabled, :tag_list) SENSITIVE = [] include Aws::Structure 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.
6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 |
# File 'lib/aws-sdk-rds/types.rb', line 6859 class DBClusterSnapshot < Struct.new( :availability_zones, :db_cluster_snapshot_identifier, :db_cluster_identifier, :snapshot_create_time, :engine, :engine_mode, :allocated_storage, :status, :port, :vpc_id, :cluster_create_time, :master_username, :engine_version, :license_model, :snapshot_type, :percent_progress, :storage_encrypted, :kms_key_id, :db_cluster_snapshot_arn, :source_db_cluster_snapshot_arn, :iam_database_authentication_enabled, :tag_list) SENSITIVE = [] include Aws::Structure end |
#license_model ⇒ String
Provides the license model information for this DB cluster snapshot.
6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 |
# File 'lib/aws-sdk-rds/types.rb', line 6859 class DBClusterSnapshot < Struct.new( :availability_zones, :db_cluster_snapshot_identifier, :db_cluster_identifier, :snapshot_create_time, :engine, :engine_mode, :allocated_storage, :status, :port, :vpc_id, :cluster_create_time, :master_username, :engine_version, :license_model, :snapshot_type, :percent_progress, :storage_encrypted, :kms_key_id, :db_cluster_snapshot_arn, :source_db_cluster_snapshot_arn, :iam_database_authentication_enabled, :tag_list) SENSITIVE = [] include Aws::Structure end |
#master_username ⇒ String
Provides the master username for this DB cluster snapshot.
6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 |
# File 'lib/aws-sdk-rds/types.rb', line 6859 class DBClusterSnapshot < Struct.new( :availability_zones, :db_cluster_snapshot_identifier, :db_cluster_identifier, :snapshot_create_time, :engine, :engine_mode, :allocated_storage, :status, :port, :vpc_id, :cluster_create_time, :master_username, :engine_version, :license_model, :snapshot_type, :percent_progress, :storage_encrypted, :kms_key_id, :db_cluster_snapshot_arn, :source_db_cluster_snapshot_arn, :iam_database_authentication_enabled, :tag_list) SENSITIVE = [] include Aws::Structure end |
#percent_progress ⇒ Integer
Specifies the percentage of the estimated data that has been transferred.
6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 |
# File 'lib/aws-sdk-rds/types.rb', line 6859 class DBClusterSnapshot < Struct.new( :availability_zones, :db_cluster_snapshot_identifier, :db_cluster_identifier, :snapshot_create_time, :engine, :engine_mode, :allocated_storage, :status, :port, :vpc_id, :cluster_create_time, :master_username, :engine_version, :license_model, :snapshot_type, :percent_progress, :storage_encrypted, :kms_key_id, :db_cluster_snapshot_arn, :source_db_cluster_snapshot_arn, :iam_database_authentication_enabled, :tag_list) SENSITIVE = [] include Aws::Structure end |
#port ⇒ Integer
Specifies the port that the DB cluster was listening on at the time of the snapshot.
6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 |
# File 'lib/aws-sdk-rds/types.rb', line 6859 class DBClusterSnapshot < Struct.new( :availability_zones, :db_cluster_snapshot_identifier, :db_cluster_identifier, :snapshot_create_time, :engine, :engine_mode, :allocated_storage, :status, :port, :vpc_id, :cluster_create_time, :master_username, :engine_version, :license_model, :snapshot_type, :percent_progress, :storage_encrypted, :kms_key_id, :db_cluster_snapshot_arn, :source_db_cluster_snapshot_arn, :iam_database_authentication_enabled, :tag_list) SENSITIVE = [] include Aws::Structure end |
#snapshot_create_time ⇒ Time
Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 |
# File 'lib/aws-sdk-rds/types.rb', line 6859 class DBClusterSnapshot < Struct.new( :availability_zones, :db_cluster_snapshot_identifier, :db_cluster_identifier, :snapshot_create_time, :engine, :engine_mode, :allocated_storage, :status, :port, :vpc_id, :cluster_create_time, :master_username, :engine_version, :license_model, :snapshot_type, :percent_progress, :storage_encrypted, :kms_key_id, :db_cluster_snapshot_arn, :source_db_cluster_snapshot_arn, :iam_database_authentication_enabled, :tag_list) SENSITIVE = [] include Aws::Structure end |
#snapshot_type ⇒ String
Provides the type of the DB cluster snapshot.
6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 |
# File 'lib/aws-sdk-rds/types.rb', line 6859 class DBClusterSnapshot < Struct.new( :availability_zones, :db_cluster_snapshot_identifier, :db_cluster_identifier, :snapshot_create_time, :engine, :engine_mode, :allocated_storage, :status, :port, :vpc_id, :cluster_create_time, :master_username, :engine_version, :license_model, :snapshot_type, :percent_progress, :storage_encrypted, :kms_key_id, :db_cluster_snapshot_arn, :source_db_cluster_snapshot_arn, :iam_database_authentication_enabled, :tag_list) SENSITIVE = [] include Aws::Structure 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.
6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 |
# File 'lib/aws-sdk-rds/types.rb', line 6859 class DBClusterSnapshot < Struct.new( :availability_zones, :db_cluster_snapshot_identifier, :db_cluster_identifier, :snapshot_create_time, :engine, :engine_mode, :allocated_storage, :status, :port, :vpc_id, :cluster_create_time, :master_username, :engine_version, :license_model, :snapshot_type, :percent_progress, :storage_encrypted, :kms_key_id, :db_cluster_snapshot_arn, :source_db_cluster_snapshot_arn, :iam_database_authentication_enabled, :tag_list) SENSITIVE = [] include Aws::Structure end |
#status ⇒ String
Specifies the status of this DB cluster snapshot. Valid statuses are the following:
-
`available`
-
`copying`
-
`creating`
6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 |
# File 'lib/aws-sdk-rds/types.rb', line 6859 class DBClusterSnapshot < Struct.new( :availability_zones, :db_cluster_snapshot_identifier, :db_cluster_identifier, :snapshot_create_time, :engine, :engine_mode, :allocated_storage, :status, :port, :vpc_id, :cluster_create_time, :master_username, :engine_version, :license_model, :snapshot_type, :percent_progress, :storage_encrypted, :kms_key_id, :db_cluster_snapshot_arn, :source_db_cluster_snapshot_arn, :iam_database_authentication_enabled, :tag_list) SENSITIVE = [] include Aws::Structure end |
#storage_encrypted ⇒ Boolean
Specifies whether the DB cluster snapshot is encrypted.
6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 |
# File 'lib/aws-sdk-rds/types.rb', line 6859 class DBClusterSnapshot < Struct.new( :availability_zones, :db_cluster_snapshot_identifier, :db_cluster_identifier, :snapshot_create_time, :engine, :engine_mode, :allocated_storage, :status, :port, :vpc_id, :cluster_create_time, :master_username, :engine_version, :license_model, :snapshot_type, :percent_progress, :storage_encrypted, :kms_key_id, :db_cluster_snapshot_arn, :source_db_cluster_snapshot_arn, :iam_database_authentication_enabled, :tag_list) SENSITIVE = [] include Aws::Structure end |
#tag_list ⇒ 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
6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 |
# File 'lib/aws-sdk-rds/types.rb', line 6859 class DBClusterSnapshot < Struct.new( :availability_zones, :db_cluster_snapshot_identifier, :db_cluster_identifier, :snapshot_create_time, :engine, :engine_mode, :allocated_storage, :status, :port, :vpc_id, :cluster_create_time, :master_username, :engine_version, :license_model, :snapshot_type, :percent_progress, :storage_encrypted, :kms_key_id, :db_cluster_snapshot_arn, :source_db_cluster_snapshot_arn, :iam_database_authentication_enabled, :tag_list) SENSITIVE = [] include Aws::Structure end |
#vpc_id ⇒ String
Provides the VPC ID associated with the DB cluster snapshot.
6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 |
# File 'lib/aws-sdk-rds/types.rb', line 6859 class DBClusterSnapshot < Struct.new( :availability_zones, :db_cluster_snapshot_identifier, :db_cluster_identifier, :snapshot_create_time, :engine, :engine_mode, :allocated_storage, :status, :port, :vpc_id, :cluster_create_time, :master_username, :engine_version, :license_model, :snapshot_type, :percent_progress, :storage_encrypted, :kms_key_id, :db_cluster_snapshot_arn, :source_db_cluster_snapshot_arn, :iam_database_authentication_enabled, :tag_list) SENSITIVE = [] include Aws::Structure end |