DBClusterSnapshot - Amazon Relational Database Service

DBClusterSnapshot

Contains the details for an Amazon RDS DB cluster snapshot

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

Contents

AllocatedStorage

Specifies the allocated storage size in gibibytes (GiB).

Type: Integer

Required: No

AvailabilityZones.AvailabilityZone.N

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

Type: Array of strings

Required: No

ClusterCreateTime

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

Type: Timestamp

Required: No

DBClusterIdentifier

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

Type: String

Required: No

DBClusterSnapshotArn

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

Type: String

Required: No

DBClusterSnapshotIdentifier

Specifies the identifier for the DB cluster snapshot.

Type: String

Required: No

Engine

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

Type: String

Required: No

EngineMode

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

Type: String

Required: No

EngineVersion

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

Type: String

Required: No

IAMDatabaseAuthenticationEnabled

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

Type: Boolean

Required: No

KmsKeyId

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

The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).

Type: String

Required: No

LicenseModel

Provides the license model information for this DB cluster snapshot.

Type: String

Required: No

MasterUsername

Provides the master username for this DB cluster snapshot.

Type: String

Required: No

PercentProgress

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

Type: Integer

Required: No

Port

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

Type: Integer

Required: No

SnapshotCreateTime

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

Type: Timestamp

Required: No

SnapshotType

Provides the type of the DB cluster snapshot.

Type: String

Required: No

SourceDBClusterSnapshotArn

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.

Type: String

Required: No

Status

Specifies the status of this DB cluster snapshot.

Type: String

Required: No

StorageEncrypted

Specifies whether the DB cluster snapshot is encrypted.

Type: Boolean

Required: No

TagList.Tag.N

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

Type: Array of Tag objects

Required: No

VpcId

Provides the VPC ID associated with the DB cluster snapshot.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: