Snapshot
A snapshot object that contains databases.
Contents
- accountsWithProvisionedRestoreAccess
-
All of the AWS accounts that have access to restore a snapshot to a provisioned cluster.
Type: Array of strings
Required: No
- accountsWithRestoreAccess
-
All of the AWS accounts that have access to restore a snapshot to a namespace.
Type: Array of strings
Required: No
- actualIncrementalBackupSizeInMegaBytes
-
The size of the incremental backup in megabytes.
Type: Double
Required: No
- adminPasswordSecretArn
-
The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.
Type: String
Required: No
- adminPasswordSecretKmsKeyId
-
The ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
Type: String
Required: No
- adminUsername
-
The username of the database within a snapshot.
Type: String
Required: No
- backupProgressInMegaBytes
-
The size in megabytes of the data that has been backed up to a snapshot.
Type: Double
Required: No
- currentBackupRateInMegaBytesPerSecond
-
The rate at which data is backed up into a snapshot in megabytes per second.
Type: Double
Required: No
- elapsedTimeInSeconds
-
The amount of time it took to back up data into a snapshot.
Type: Long
Required: No
- estimatedSecondsToCompletion
-
The estimated amount of seconds until the snapshot completes backup.
Type: Long
Required: No
- kmsKeyId
-
The unique identifier of the KMS key used to encrypt the snapshot.
Type: String
Required: No
- namespaceArn
-
The Amazon Resource Name (ARN) of the namespace the snapshot was created from.
Type: String
Required: No
- namespaceName
-
The name of the namepsace.
Type: String
Required: No
- ownerAccount
-
The owner AWS; account of the snapshot.
Type: String
Required: No
- snapshotArn
-
The Amazon Resource Name (ARN) of the snapshot.
Type: String
Required: No
- snapshotCreateTime
-
The timestamp of when the snapshot was created.
Type: Timestamp
Required: No
- snapshotName
-
The name of the snapshot.
Type: String
Required: No
- snapshotRemainingDays
-
The amount of days until the snapshot is deleted.
Type: Integer
Required: No
- snapshotRetentionPeriod
-
The period of time, in days, of how long the snapshot is retained.
Type: Integer
Required: No
- snapshotRetentionStartTime
-
The timestamp of when data within the snapshot started getting retained.
Type: Timestamp
Required: No
- status
-
The status of the snapshot.
Type: String
Valid Values:
AVAILABLE | CREATING | DELETED | CANCELLED | FAILED | COPYINGRequired: No
- totalBackupSizeInMegaBytes
-
The total size, in megabytes, of how big the snapshot is.
Type: Double
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
