rds/aws.sdk.kotlin.services.rds.model/StartExportTaskResponse

StartExportTaskResponse

class StartExportTaskResponse

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.

Types

object Companion

Properties

val exportOnly: List<String>?

The data exported from the snapshot or cluster.

exportTaskIdentifier

val exportTaskIdentifier: String?

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.

val failureCause: String?

The reason the export failed, if it failed.

val iamRoleArn: String?

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

val kmsKeyId: String?

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.

percentProgress

val percentProgress: Int?

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

val s3Bucket: String?

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

val s3Prefix: String?

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

val snapshotTime: Instant?

The time when the snapshot was created.

val sourceArn: String?

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

val sourceType: ExportSourceType?

The type of source for the export.

val status: String?

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

val taskEndTime: Instant?

The time when the snapshot or cluster export task ended.

val taskStartTime: Instant?

The time when the snapshot or cluster export task started.

totalExtractedDataInGb

val totalExtractedDataInGb: Int?

The total amount of data exported, in gigabytes.

val warningMessage: String?

A warning about the snapshot or cluster export task.

Functions

inline fun copy(block: StartExportTaskResponse.Builder.() -> Unit = {}): StartExportTaskResponse

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String