You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::RDS::Types::ExportTask

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Contains the details of a snapshot export to Amazon S3.

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

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#export_only ⇒ Array<String>

The data exported from the snapshot. Valid values are the following:

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

  • database.table table-name - Export a table of the snapshot. 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. 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.

Returns:

  • (Array<String>) —

    The data exported from the snapshot.

#export_task_identifier ⇒ String

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

Returns:

  • (String) —

    A unique identifier for the snapshot export task.

#failure_cause ⇒ String

The reason the export failed, if it failed.

Returns:

  • (String) —

    The reason the export failed, if it failed.

#iam_role_arn ⇒ String

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

Returns:

  • (String) —

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

#kms_key_id ⇒ String

The ID of the AWS KMS key that is used to encrypt the snapshot when it\'s exported to Amazon S3. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key. The IAM role used for the snapshot export must have encryption and decryption permissions to use this KMS key.

Returns:

  • (String) —

    The ID of the AWS KMS key that is used to encrypt the snapshot when it\'s exported to Amazon S3.

#percent_progress ⇒ Integer

The progress of the snapshot export task as a percentage.

Returns:

  • (Integer) —

    The progress of the snapshot export task as a percentage.

#s3_bucket ⇒ String

The Amazon S3 bucket that the snapshot is exported to.

Returns:

  • (String) —

    The Amazon S3 bucket that the snapshot is exported to.

#s3_prefix ⇒ String

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

Returns:

  • (String) —

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

#snapshot_time ⇒ Time

The time that the snapshot was created.

Returns:

  • (Time) —

    The time that the snapshot was created.

#source_arn ⇒ String

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

Returns:

  • (String) —

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

#status ⇒ String

The progress status of the export task.

Returns:

  • (String) —

    The progress status of the export task.

#task_end_time ⇒ Time

The time that the snapshot export task completed.

Returns:

  • (Time) —

    The time that the snapshot export task completed.

#task_start_time ⇒ Time

The time that the snapshot export task started.

Returns:

  • (Time) —

    The time that the snapshot export task started.

#total_extracted_data_in_gb ⇒ Integer

The total amount of data exported, in gigabytes.

Returns:

  • (Integer) —

    The total amount of data exported, in gigabytes.

#warning_message ⇒ String

A warning about the snapshot export task.

Returns:

  • (String) —

    A warning about the snapshot export task.