The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

DBSnapshot

Contains the details of an Amazon RDS DB snapshot.

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

AllocatedStorage

Specifies the allocated storage size in gibibytes (GiB).

Type: Integer

Required: No

AvailabilityZone

Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

Type: String

Required: No

DBInstanceIdentifier

Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

Type: String

Required: No

DbiResourceId

The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.

Type: String

Required: No

DBSnapshotArn

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

Type: String

Required: No

DBSnapshotIdentifier

Specifies the identifier for the DB snapshot.

Type: String

Required: No

Encrypted

Specifies whether the DB snapshot is encrypted.

Type: Boolean

Required: No

Engine

Specifies the name of the database engine.

Type: String

Required: No

EngineVersion

Specifies the version of the database engine.

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

InstanceCreateTime

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

Type: Timestamp

Required: No

Iops

Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

Type: Integer

Required: No

KmsKeyId

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

Type: String

Required: No

LicenseModel

License model information for the restored DB instance.

Type: String

Required: No

MasterUsername

Provides the master username for the DB snapshot.

Type: String

Required: No

OptionGroupName

Provides the option group name for the DB snapshot.

Type: String

Required: No

PercentProgress

The percentage of the estimated data that has been transferred.

Type: Integer

Required: No

Port

Specifies the port that the database engine was listening on at the time of the snapshot.

Type: Integer

Required: No

ProcessorFeatures.ProcessorFeature.N

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.

Type: Array of ProcessorFeature objects

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 snapshot.

Type: String

Required: No

SourceDBSnapshotIdentifier

The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has value in case of cross-customer or cross-region copy.

Type: String

Required: No

SourceRegion

The AWS Region that the DB snapshot was created in or copied from.

Type: String

Required: No

Status

Specifies the status of this DB snapshot.

Type: String

Required: No

StorageType

Specifies the storage type associated with DB snapshot.

Type: String

Required: No

TdeCredentialArn

The ARN from the key store with which to associate the instance for TDE encryption.

Type: String

Required: No

Timezone

The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.

Type: String

Required: No

VpcId

Provides the VPC ID associated with the DB snapshot.

Type: String

Required: No

DBSnapshot

Contents

See Also