DBClusterSnapshot - Amazon Relational Database Service
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

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

Note

In the following list, the required parameters are described first.

AllocatedStorage

The allocated storage size of the DB cluster snapshot in gibibytes (GiB).

Type: Integer

Required: No

AvailabilityZones.AvailabilityZone.N

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

Type: Array of strings

Required: No

ClusterCreateTime

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

Type: Timestamp

Required: No

DBClusterIdentifier

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

Type: String

Required: No

DbClusterResourceId

The resource ID 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

The identifier for the DB cluster snapshot.

Type: String

Required: No

DBSystemId

Reserved for future use.

Type: String

Required: No

Engine

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

Type: String

Required: No

EngineMode

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

Type: String

Required: No

EngineVersion

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

Type: String

Required: No

IAMDatabaseAuthenticationEnabled

Indicates whether mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled.

Type: Boolean

Required: No

KmsKeyId

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

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

Type: String

Required: No

LicenseModel

The license model information for this DB cluster snapshot.

Type: String

Required: No

MasterUsername

The master username for this DB cluster snapshot.

Type: String

Required: No

PercentProgress

The percentage of the estimated data that has been transferred.

Type: Integer

Required: No

Port

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

Type: Integer

Required: No

SnapshotCreateTime

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

Type: Timestamp

Required: No

SnapshotType

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

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

  • available

  • copying

  • creating

Type: String

Required: No

StorageEncrypted

Indicates whether the DB cluster snapshot is encrypted.

Type: Boolean

Required: No

StorageThroughput

The storage throughput for the DB cluster snapshot. The throughput is automatically set based on the IOPS that you provision, and is not configurable.

This setting is only for non-Aurora Multi-AZ DB clusters.

Type: Integer

Required: No

StorageType

The storage type associated with the DB cluster snapshot.

This setting is only for Aurora DB clusters.

Type: String

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

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 Amazon SDKs, see the following: