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 for an Amazon RDS DB cluster snapshot

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

Inheritance Hierarchy

System.Object
  Amazon.RDS.Model.DBClusterSnapshot

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

Syntax

C#
public class DBClusterSnapshot

The DBClusterSnapshot type exposes the following members

Constructors

NameDescription
Public Method DBClusterSnapshot()

Properties

NameTypeDescription
Public Property AllocatedStorage System.Int32

Gets and sets the property AllocatedStorage.

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

Public Property AvailabilityZones System.Collections.Generic.List<System.String>

Gets and sets the property AvailabilityZones.

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

Public Property ClusterCreateTime System.DateTime

Gets and sets the property ClusterCreateTime.

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

Public Property DBClusterIdentifier System.String

Gets and sets the property DBClusterIdentifier.

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

Public Property DbClusterResourceId System.String

Gets and sets the property DbClusterResourceId.

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

Public Property DBClusterSnapshotArn System.String

Gets and sets the property DBClusterSnapshotArn.

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

Public Property DBClusterSnapshotIdentifier System.String

Gets and sets the property DBClusterSnapshotIdentifier.

The identifier for the DB cluster snapshot.

Public Property DBSystemId System.String

Gets and sets the property DBSystemId.

Reserved for future use.

Public Property Engine System.String

Gets and sets the property Engine.

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

Public Property EngineMode System.String

Gets and sets the property EngineMode.

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

Public Property EngineVersion System.String

Gets and sets the property EngineVersion.

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

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 KmsKeyId System.String

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

Public Property LicenseModel System.String

Gets and sets the property LicenseModel.

The license model information for this DB cluster snapshot.

Public Property MasterUsername System.String

Gets and sets the property MasterUsername.

The master username for this DB cluster snapshot.

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.

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

Public Property SnapshotCreateTime System.DateTime

Gets and sets the property SnapshotCreateTime.

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

Public Property SnapshotType System.String

Gets and sets the property SnapshotType.

The type of the DB cluster snapshot.

Public Property SourceDBClusterSnapshotArn System.String

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

Public Property Status System.String

Gets and sets the property Status.

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

  • available

  • copying

  • creating

Public Property StorageEncrypted System.Boolean

Gets and sets the property StorageEncrypted.

Indicates whether the DB cluster snapshot is encrypted.

Public Property StorageThroughput System.Int32

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

Public Property StorageType System.String

Gets and sets the property StorageType.

The storage type associated with the DB cluster snapshot.

This setting is only for Aurora DB clusters.

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

Gets and sets the property TagList.

Public Property VpcId System.String

Gets and sets the property VpcId.

The VPC ID associated with the DB cluster snapshot.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5