AwsRdsExportTaskPropertiesArgs

data class AwsRdsExportTaskPropertiesArgs(val exportOnly: Output<List<String>>? = null, val exportTaskIdentifier: Output<String>? = null, val failureCause: Output<String>? = null, val iamRoleArn: Output<String>? = null, val kmsKeyId: Output<String>? = null, val percentProgress: Output<Int>? = null, val s3Bucket: Output<String>? = null, val s3Prefix: Output<String>? = null, val snapshotTime: Output<String>? = null, val sourceArn: Output<String>? = null, val sourceType: Output<ExportSourceTypeEnumValueArgs>? = null, val status: Output<String>? = null, val taskEndTime: Output<String>? = null, val taskStartTime: Output<String>? = null, val totalExtractedDataInGB: Output<Int>? = null, val warningMessage: Output<String>? = null) : ConvertibleToJava<AwsRdsExportTaskPropertiesArgs>

Definition of awsRdsExportTask

Constructors

Link copied to clipboard
constructor(exportOnly: Output<List<String>>? = null, exportTaskIdentifier: Output<String>? = null, failureCause: Output<String>? = null, iamRoleArn: Output<String>? = null, kmsKeyId: Output<String>? = null, percentProgress: Output<Int>? = null, s3Bucket: Output<String>? = null, s3Prefix: Output<String>? = null, snapshotTime: Output<String>? = null, sourceArn: Output<String>? = null, sourceType: Output<ExportSourceTypeEnumValueArgs>? = null, status: Output<String>? = null, taskEndTime: Output<String>? = null, taskStartTime: Output<String>? = null, totalExtractedDataInGB: Output<Int>? = null, warningMessage: Output<String>? = null)

Properties

Link copied to clipboard
val exportOnly: Output<List<String>>? = null

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.

Link copied to clipboard
val exportTaskIdentifier: Output<String>? = null

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.

Link copied to clipboard
val failureCause: Output<String>? = null

The reason the export failed, if it failed.

Link copied to clipboard
val iamRoleArn: Output<String>? = null

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

Link copied to clipboard
val kmsKeyId: Output<String>? = null

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.

Link copied to clipboard
val percentProgress: Output<Int>? = null

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

Link copied to clipboard
val s3Bucket: Output<String>? = null

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

Link copied to clipboard
val s3Prefix: Output<String>? = null

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

Link copied to clipboard
val snapshotTime: Output<String>? = null

The time when the snapshot was created.

Link copied to clipboard
val sourceArn: Output<String>? = null

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

Link copied to clipboard

The type of source for the export.

Link copied to clipboard
val status: Output<String>? = null

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

  • CANCELED

  • CANCELING

  • COMPLETE

  • FAILED

  • IN_PROGRESS

  • STARTING

Link copied to clipboard
val taskEndTime: Output<String>? = null

The time when the snapshot or cluster export task ended.

Link copied to clipboard
val taskStartTime: Output<String>? = null

The time when the snapshot or cluster export task started.

Link copied to clipboard
val totalExtractedDataInGB: Output<Int>? = null

The total amount of data exported, in gigabytes.

Link copied to clipboard
val warningMessage: Output<String>? = null

A warning about the snapshot or cluster export task.

Functions

Link copied to clipboard
open override fun toJava(): AwsRdsExportTaskPropertiesArgs