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.

Detailed information about a cluster snapshot.

Inheritance Hierarchy

System.Object
  Amazon.DocDB.Model.DBClusterSnapshot

Namespace: Amazon.DocDB.Model
Assembly: AWSSDK.DocDB.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 AvailabilityZones System.Collections.Generic.List<System.String>

Gets and sets the property AvailabilityZones.

Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.

Public Property ClusterCreateTime System.DateTime

Gets and sets the property ClusterCreateTime.

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

Public Property DBClusterIdentifier System.String

Gets and sets the property DBClusterIdentifier.

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

Public Property DBClusterSnapshotArn System.String

Gets and sets the property DBClusterSnapshotArn.

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

Public Property DBClusterSnapshotIdentifier System.String

Gets and sets the property DBClusterSnapshotIdentifier.

Specifies the identifier for the cluster snapshot.

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.

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

Public Property KmsKeyId System.String

Gets and sets the property KmsKeyId.

If StorageEncrypted is true, the KMS key identifier for the encrypted cluster snapshot.

Public Property MasterUsername System.String

Gets and sets the property MasterUsername.

Provides the master user name for the cluster snapshot.

Public Property PercentProgress System.Int32

Gets and sets the property PercentProgress.

Specifies 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 cluster was listening on at the time of the snapshot.

Public Property SnapshotCreateTime System.DateTime

Gets and sets the property SnapshotCreateTime.

Provides the time when the snapshot was taken, in UTC.

Public Property SnapshotType System.String

Gets and sets the property SnapshotType.

Provides the type of the cluster snapshot.

Public Property SourceDBClusterSnapshotArn System.String

Gets and sets the property SourceDBClusterSnapshotArn.

If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.

Public Property Status System.String

Gets and sets the property Status.

Specifies the status of this cluster snapshot.

Public Property StorageEncrypted System.Boolean

Gets and sets the property StorageEncrypted.

Specifies whether the cluster snapshot is encrypted.

Public Property StorageType System.String

Gets and sets the property StorageType.

Storage type associated with your cluster snapshot

For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

Valid values for storage type - standard | iopt1

Default value is standard

Public Property VpcId System.String

Gets and sets the property VpcId.

Provides the virtual private cloud (VPC) ID that is associated with the cluster 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