Documentation

Contains the details for an Amazon RDS DB cluster snapshot

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

See: newDBClusterSnapshot smart constructor.

Create a value of DBClusterSnapshot with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:allocatedStorage:DBClusterSnapshot', dbClusterSnapshot_allocatedStorage - Specifies the allocated storage size in gibibytes (GiB).

$sel:availabilityZones:DBClusterSnapshot', dbClusterSnapshot_availabilityZones - Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.

$sel:clusterCreateTime:DBClusterSnapshot', dbClusterSnapshot_clusterCreateTime - Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

$sel:dbClusterIdentifier:DBClusterSnapshot', dbClusterSnapshot_dbClusterIdentifier - Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

$sel:dbClusterSnapshotArn:DBClusterSnapshot', dbClusterSnapshot_dbClusterSnapshotArn - The Amazon Resource Name (ARN) for the DB cluster snapshot.

$sel:dbClusterSnapshotIdentifier:DBClusterSnapshot', dbClusterSnapshot_dbClusterSnapshotIdentifier - Specifies the identifier for the DB cluster snapshot.

$sel:dbSystemId:DBClusterSnapshot', dbClusterSnapshot_dbSystemId - Reserved for future use.

$sel:engine:DBClusterSnapshot', dbClusterSnapshot_engine - Specifies the name of the database engine for this DB cluster snapshot.

$sel:engineMode:DBClusterSnapshot', dbClusterSnapshot_engineMode - Provides the engine mode of the database engine for this DB cluster snapshot.

$sel:engineVersion:DBClusterSnapshot', dbClusterSnapshot_engineVersion - Provides the version of the database engine for this DB cluster snapshot.

$sel:iAMDatabaseAuthenticationEnabled:DBClusterSnapshot', dbClusterSnapshot_iAMDatabaseAuthenticationEnabled - True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

$sel:kmsKeyId:DBClusterSnapshot', dbClusterSnapshot_kmsKeyId - 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.

$sel:licenseModel:DBClusterSnapshot', dbClusterSnapshot_licenseModel - Provides the license model information for this DB cluster snapshot.

$sel:masterUsername:DBClusterSnapshot', dbClusterSnapshot_masterUsername - Provides the master username for this DB cluster snapshot.

$sel:percentProgress:DBClusterSnapshot', dbClusterSnapshot_percentProgress - Specifies the percentage of the estimated data that has been transferred.

$sel:port:DBClusterSnapshot', dbClusterSnapshot_port - Specifies the port that the DB cluster was listening on at the time of the snapshot.

$sel:snapshotCreateTime:DBClusterSnapshot', dbClusterSnapshot_snapshotCreateTime - Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

$sel:snapshotType:DBClusterSnapshot', dbClusterSnapshot_snapshotType - Provides the type of the DB cluster snapshot.

$sel:sourceDBClusterSnapshotArn:DBClusterSnapshot', dbClusterSnapshot_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.

$sel:status:DBClusterSnapshot', dbClusterSnapshot_status - Specifies the status of this DB cluster snapshot. Valid statuses are the following:

• available

• copying

• creating

$sel:storageEncrypted:DBClusterSnapshot', dbClusterSnapshot_storageEncrypted - Specifies whether the DB cluster snapshot is encrypted.

$sel:tagList:DBClusterSnapshot', dbClusterSnapshot_tagList - Undocumented member.

$sel:vpcId:DBClusterSnapshot', dbClusterSnapshot_vpcId - Provides the VPC ID associated with the DB cluster snapshot.

Specifies the allocated storage size in gibibytes (GiB).

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

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

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

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

Specifies the identifier for the DB cluster snapshot.

Reserved for future use.

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

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

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

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

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.

Provides the license model information for this DB cluster snapshot.

Provides the master username for this DB cluster snapshot.

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

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

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

Provides the type of the DB cluster snapshot.

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.

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

• available

• copying

• creating

Specifies whether the DB cluster snapshot is encrypted.

Undocumented member.

Provides the VPC ID associated with the DB cluster snapshot.