AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Contains the details of an Amazon RDS DB snapshot.

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

Inheritance Hierarchy

System.Object
  Amazon.RDS.Model.DBSnapshot

Namespace: Amazon.RDS.Model
Assembly: AWSSDK.RDS.dll
Version: 3.x.y.z

Syntax

C#
public class DBSnapshot

The DBSnapshot type exposes the following members

Constructors

NameDescription
Public Method DBSnapshot()

Properties

NameTypeDescription
Public Property AllocatedStorage System.Int32

Gets and sets the property AllocatedStorage.

Specifies the allocated storage size in gibibytes (GiB).

Public Property AvailabilityZone System.String

Gets and sets the property AvailabilityZone.

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

Public Property DBInstanceIdentifier System.String

Gets and sets the property DBInstanceIdentifier.

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

Public Property DbiResourceId System.String

Gets and sets the property DbiResourceId.

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

Public Property DBSnapshotArn System.String

Gets and sets the property DBSnapshotArn.

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

Public Property DBSnapshotIdentifier System.String

Gets and sets the property DBSnapshotIdentifier.

Specifies the identifier for the DB snapshot.

Public Property DBSystemId System.String

Gets and sets the property DBSystemId.

The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. The Oracle SID is also the name of your CDB.

Public Property DedicatedLogVolume System.Boolean

Gets and sets the property DedicatedLogVolume.

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

Public Property Encrypted System.Boolean

Gets and sets the property Encrypted.

Indicates whether the DB snapshot is encrypted.

Public Property Engine System.String

Gets and sets the property Engine.

Specifies the name of the database engine.

Public Property EngineVersion System.String

Gets and sets the property EngineVersion.

Specifies the version of the database engine.

Public Property IAMDatabaseAuthenticationEnabled System.Boolean

Gets and sets the property IAMDatabaseAuthenticationEnabled.

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

Public Property InstanceCreateTime System.DateTime

Gets and sets the property InstanceCreateTime.

Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.

Public Property Iops System.Int32

Gets and sets the property Iops.

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

Public Property KmsKeyId System.String

Gets and sets the property KmsKeyId.

If Encrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.

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

Public Property LicenseModel System.String

Gets and sets the property LicenseModel.

License model information for the restored DB instance.

Public Property MasterUsername System.String

Gets and sets the property MasterUsername.

Provides the master username for the DB snapshot.

Public Property MultiTenant System.Boolean

Gets and sets the property MultiTenant.

Indicates whether the snapshot is of a DB instance using the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).

Public Property OptionGroupName System.String

Gets and sets the property OptionGroupName.

Provides the option group name for the DB snapshot.

Public Property OriginalSnapshotCreateTime System.DateTime

Gets and sets the property OriginalSnapshotCreateTime.

Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.

Public Property PercentProgress System.Int32

Gets and sets the property PercentProgress.

The percentage of the estimated data that has been transferred.

Public Property Port System.Int32

Gets and sets the property Port.

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

Public Property ProcessorFeatures System.Collections.Generic.List<Amazon.RDS.Model.ProcessorFeature>

Gets and sets the property ProcessorFeatures.

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.

Public Property SnapshotAvailabilityZone System.String

Gets and sets the property SnapshotAvailabilityZone.

Specifies the name of the Availability Zone where RDS stores the DB snapshot. This value is valid only for snapshots that RDS stores on a Dedicated Local Zone.

Public Property SnapshotCreateTime System.DateTime

Gets and sets the property SnapshotCreateTime.

Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.

Public Property SnapshotDatabaseTime System.DateTime

Gets and sets the property SnapshotDatabaseTime.

The timestamp of the most recent transaction applied to the database that you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.

If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then the replica lag is two hours.

Public Property SnapshotTarget System.String

Gets and sets the property SnapshotTarget.

Specifies where manual snapshots are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region.

Public Property SnapshotType System.String

Gets and sets the property SnapshotType.

Provides the type of the DB snapshot.

Public Property SourceDBSnapshotIdentifier System.String

Gets and sets the property SourceDBSnapshotIdentifier.

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

Public Property SourceRegion System.String

Gets and sets the property SourceRegion.

The Amazon Web Services Region that the DB snapshot was created in or copied from.

Public Property Status System.String

Gets and sets the property Status.

Specifies the status of this DB snapshot.

Public Property StorageThroughput System.Int32

Gets and sets the property StorageThroughput.

Specifies the storage throughput for the DB snapshot.

Public Property StorageType System.String

Gets and sets the property StorageType.

Specifies the storage type associated with DB snapshot.

Public Property TagList System.Collections.Generic.List<Amazon.RDS.Model.Tag>

Gets and sets the property TagList.

Public Property TdeCredentialArn System.String

Gets and sets the property TdeCredentialArn.

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

Public Property Timezone System.String

Gets and sets the property 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.

Public Property VpcId System.String

Gets and sets the property VpcId.

Provides the VPC ID associated with the DB snapshot.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5