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 a snapshot or cluster export to Amazon S3.

This data type is used as a response element in the DescribeExportTasks operation.

Inheritance Hierarchy

System.Object
  Amazon.RDS.Model.ExportTask

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

Syntax

C# 
public class ExportTask

The ExportTask type exposes the following members

Constructors

NameDescription
Public Method ExportTask()

Properties

NameTypeDescription
Public Property ExportOnly System.Collections.Generic.List<System.String>

Gets and sets the property ExportOnly.

The data exported from the snapshot or cluster.

Valid Values:

  • database - Export all the data from a specified database.

  • database.table table-name - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.

  • database.schema schema-name - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

  • database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

Public Property ExportTaskIdentifier System.String

Gets and sets the property ExportTaskIdentifier.

A unique identifier for the snapshot or cluster export task. This ID isn't an identifier for the Amazon S3 bucket where the data is exported.

Public Property FailureCause System.String

Gets and sets the property FailureCause.

The reason the export failed, if it failed.

Public Property IamRoleArn System.String

Gets and sets the property IamRoleArn.

The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.

Public Property KmsKeyId System.String

Gets and sets the property KmsKeyId.

The key identifier of the Amazon Web Services KMS key that is used to encrypt the data when it's exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the export must have encryption and decryption permissions to use this KMS key.

Public Property PercentProgress System.Int32

Gets and sets the property PercentProgress.

The progress of the snapshot or cluster export task as a percentage.

Public Property S3Bucket System.String

Gets and sets the property S3Bucket.

The Amazon S3 bucket where the snapshot or cluster is exported to.

Public Property S3Prefix System.String

Gets and sets the property S3Prefix.

The Amazon S3 bucket prefix that is the file name and path of the exported data.

Public Property SnapshotTime System.DateTime

Gets and sets the property SnapshotTime.

The time when the snapshot was created.

Public Property SourceArn System.String

Gets and sets the property SourceArn.

The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.

Public Property SourceType Amazon.RDS.ExportSourceType

Gets and sets the property SourceType.

The type of source for the export.

Public Property Status System.String

Gets and sets the property Status.

The progress status of the export task. The status can be one of the following:

  • CANCELED

  • CANCELING

  • COMPLETE

  • FAILED

  • IN_PROGRESS

  • STARTING

Public Property TaskEndTime System.DateTime

Gets and sets the property TaskEndTime.

The time when the snapshot or cluster export task ended.

Public Property TaskStartTime System.DateTime

Gets and sets the property TaskStartTime.

The time when the snapshot or cluster export task started.

Public Property TotalExtractedDataInGB System.Int32

Gets and sets the property TotalExtractedDataInGB.

The total amount of data exported, in gigabytes.

Public Property WarningMessage System.String

Gets and sets the property WarningMessage.

A warning about the snapshot or cluster export task.

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