Class: Aws::RDS::Types::ExportTask
- Inherits:
-
Struct
- Object
- Struct
- Aws::RDS::Types::ExportTask
- Defined in:
- gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb
Overview
Contains the details of a snapshot or cluster export to Amazon S3.
This data type is used as a response element in the
DescribeExportTasks
action.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#export_only ⇒ Array<String>
The data exported from the snapshot or cluster.
-
#export_task_identifier ⇒ String
A unique identifier for the snapshot or cluster export task.
-
#failure_cause ⇒ 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 or cluster.
-
#kms_key_id ⇒ 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.
-
#percent_progress ⇒ Integer
The progress of the snapshot or cluster export task as a percentage.
-
#s3_bucket ⇒ String
The Amazon S3 bucket that the snapshot or cluster is exported to.
-
#s3_prefix ⇒ String
The Amazon S3 bucket prefix that is the file name and path of the exported data.
-
#snapshot_time ⇒ Time
The time that the snapshot was created.
-
#source_arn ⇒ String
The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
-
#source_type ⇒ String
The type of source for the export.
-
#status ⇒ String
The progress status of the export task.
-
#task_end_time ⇒ Time
The time that the snapshot or cluster export task ended.
-
#task_start_time ⇒ Time
The time that the snapshot or cluster export task started.
-
#total_extracted_data_in_gb ⇒ Integer
The total amount of data exported, in gigabytes.
-
#warning_message ⇒ String
A warning about the snapshot or cluster export task.
Instance Attribute Details
#export_only ⇒ Array<String>
The data exported from the snapshot or cluster. Valid values are the following:
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.
13851 13852 13853 13854 13855 13856 13857 13858 13859 13860 13861 13862 13863 13864 13865 13866 13867 13868 13869 13870 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 13851 class ExportTask < Struct.new( :export_task_identifier, :source_arn, :export_only, :snapshot_time, :task_start_time, :task_end_time, :s3_bucket, :s3_prefix, :iam_role_arn, :kms_key_id, :status, :percent_progress, :total_extracted_data_in_gb, :failure_cause, :warning_message, :source_type) SENSITIVE = [] include Aws::Structure end |
#export_task_identifier ⇒ 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.
13851 13852 13853 13854 13855 13856 13857 13858 13859 13860 13861 13862 13863 13864 13865 13866 13867 13868 13869 13870 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 13851 class ExportTask < Struct.new( :export_task_identifier, :source_arn, :export_only, :snapshot_time, :task_start_time, :task_end_time, :s3_bucket, :s3_prefix, :iam_role_arn, :kms_key_id, :status, :percent_progress, :total_extracted_data_in_gb, :failure_cause, :warning_message, :source_type) SENSITIVE = [] include Aws::Structure end |
#failure_cause ⇒ String
The reason the export failed, if it failed.
13851 13852 13853 13854 13855 13856 13857 13858 13859 13860 13861 13862 13863 13864 13865 13866 13867 13868 13869 13870 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 13851 class ExportTask < Struct.new( :export_task_identifier, :source_arn, :export_only, :snapshot_time, :task_start_time, :task_end_time, :s3_bucket, :s3_prefix, :iam_role_arn, :kms_key_id, :status, :percent_progress, :total_extracted_data_in_gb, :failure_cause, :warning_message, :source_type) SENSITIVE = [] include Aws::Structure end |
#iam_role_arn ⇒ String
The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.
13851 13852 13853 13854 13855 13856 13857 13858 13859 13860 13861 13862 13863 13864 13865 13866 13867 13868 13869 13870 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 13851 class ExportTask < Struct.new( :export_task_identifier, :source_arn, :export_only, :snapshot_time, :task_start_time, :task_end_time, :s3_bucket, :s3_prefix, :iam_role_arn, :kms_key_id, :status, :percent_progress, :total_extracted_data_in_gb, :failure_cause, :warning_message, :source_type) SENSITIVE = [] include Aws::Structure end |
#kms_key_id ⇒ 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.
13851 13852 13853 13854 13855 13856 13857 13858 13859 13860 13861 13862 13863 13864 13865 13866 13867 13868 13869 13870 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 13851 class ExportTask < Struct.new( :export_task_identifier, :source_arn, :export_only, :snapshot_time, :task_start_time, :task_end_time, :s3_bucket, :s3_prefix, :iam_role_arn, :kms_key_id, :status, :percent_progress, :total_extracted_data_in_gb, :failure_cause, :warning_message, :source_type) SENSITIVE = [] include Aws::Structure end |
#percent_progress ⇒ Integer
The progress of the snapshot or cluster export task as a percentage.
13851 13852 13853 13854 13855 13856 13857 13858 13859 13860 13861 13862 13863 13864 13865 13866 13867 13868 13869 13870 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 13851 class ExportTask < Struct.new( :export_task_identifier, :source_arn, :export_only, :snapshot_time, :task_start_time, :task_end_time, :s3_bucket, :s3_prefix, :iam_role_arn, :kms_key_id, :status, :percent_progress, :total_extracted_data_in_gb, :failure_cause, :warning_message, :source_type) SENSITIVE = [] include Aws::Structure end |
#s3_bucket ⇒ String
The Amazon S3 bucket that the snapshot or cluster is exported to.
13851 13852 13853 13854 13855 13856 13857 13858 13859 13860 13861 13862 13863 13864 13865 13866 13867 13868 13869 13870 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 13851 class ExportTask < Struct.new( :export_task_identifier, :source_arn, :export_only, :snapshot_time, :task_start_time, :task_end_time, :s3_bucket, :s3_prefix, :iam_role_arn, :kms_key_id, :status, :percent_progress, :total_extracted_data_in_gb, :failure_cause, :warning_message, :source_type) SENSITIVE = [] include Aws::Structure end |
#s3_prefix ⇒ String
The Amazon S3 bucket prefix that is the file name and path of the exported data.
13851 13852 13853 13854 13855 13856 13857 13858 13859 13860 13861 13862 13863 13864 13865 13866 13867 13868 13869 13870 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 13851 class ExportTask < Struct.new( :export_task_identifier, :source_arn, :export_only, :snapshot_time, :task_start_time, :task_end_time, :s3_bucket, :s3_prefix, :iam_role_arn, :kms_key_id, :status, :percent_progress, :total_extracted_data_in_gb, :failure_cause, :warning_message, :source_type) SENSITIVE = [] include Aws::Structure end |
#snapshot_time ⇒ Time
The time that the snapshot was created.
13851 13852 13853 13854 13855 13856 13857 13858 13859 13860 13861 13862 13863 13864 13865 13866 13867 13868 13869 13870 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 13851 class ExportTask < Struct.new( :export_task_identifier, :source_arn, :export_only, :snapshot_time, :task_start_time, :task_end_time, :s3_bucket, :s3_prefix, :iam_role_arn, :kms_key_id, :status, :percent_progress, :total_extracted_data_in_gb, :failure_cause, :warning_message, :source_type) SENSITIVE = [] include Aws::Structure end |
#source_arn ⇒ String
The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
13851 13852 13853 13854 13855 13856 13857 13858 13859 13860 13861 13862 13863 13864 13865 13866 13867 13868 13869 13870 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 13851 class ExportTask < Struct.new( :export_task_identifier, :source_arn, :export_only, :snapshot_time, :task_start_time, :task_end_time, :s3_bucket, :s3_prefix, :iam_role_arn, :kms_key_id, :status, :percent_progress, :total_extracted_data_in_gb, :failure_cause, :warning_message, :source_type) SENSITIVE = [] include Aws::Structure end |
#source_type ⇒ String
The type of source for the export.
13851 13852 13853 13854 13855 13856 13857 13858 13859 13860 13861 13862 13863 13864 13865 13866 13867 13868 13869 13870 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 13851 class ExportTask < Struct.new( :export_task_identifier, :source_arn, :export_only, :snapshot_time, :task_start_time, :task_end_time, :s3_bucket, :s3_prefix, :iam_role_arn, :kms_key_id, :status, :percent_progress, :total_extracted_data_in_gb, :failure_cause, :warning_message, :source_type) SENSITIVE = [] include Aws::Structure end |
#status ⇒ String
The progress status of the export task. The status can be one of the following:
CANCELED
CANCELING
COMPLETE
FAILED
IN_PROGRESS
STARTING
13851 13852 13853 13854 13855 13856 13857 13858 13859 13860 13861 13862 13863 13864 13865 13866 13867 13868 13869 13870 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 13851 class ExportTask < Struct.new( :export_task_identifier, :source_arn, :export_only, :snapshot_time, :task_start_time, :task_end_time, :s3_bucket, :s3_prefix, :iam_role_arn, :kms_key_id, :status, :percent_progress, :total_extracted_data_in_gb, :failure_cause, :warning_message, :source_type) SENSITIVE = [] include Aws::Structure end |
#task_end_time ⇒ Time
The time that the snapshot or cluster export task ended.
13851 13852 13853 13854 13855 13856 13857 13858 13859 13860 13861 13862 13863 13864 13865 13866 13867 13868 13869 13870 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 13851 class ExportTask < Struct.new( :export_task_identifier, :source_arn, :export_only, :snapshot_time, :task_start_time, :task_end_time, :s3_bucket, :s3_prefix, :iam_role_arn, :kms_key_id, :status, :percent_progress, :total_extracted_data_in_gb, :failure_cause, :warning_message, :source_type) SENSITIVE = [] include Aws::Structure end |
#task_start_time ⇒ Time
The time that the snapshot or cluster export task started.
13851 13852 13853 13854 13855 13856 13857 13858 13859 13860 13861 13862 13863 13864 13865 13866 13867 13868 13869 13870 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 13851 class ExportTask < Struct.new( :export_task_identifier, :source_arn, :export_only, :snapshot_time, :task_start_time, :task_end_time, :s3_bucket, :s3_prefix, :iam_role_arn, :kms_key_id, :status, :percent_progress, :total_extracted_data_in_gb, :failure_cause, :warning_message, :source_type) SENSITIVE = [] include Aws::Structure end |
#total_extracted_data_in_gb ⇒ Integer
The total amount of data exported, in gigabytes.
13851 13852 13853 13854 13855 13856 13857 13858 13859 13860 13861 13862 13863 13864 13865 13866 13867 13868 13869 13870 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 13851 class ExportTask < Struct.new( :export_task_identifier, :source_arn, :export_only, :snapshot_time, :task_start_time, :task_end_time, :s3_bucket, :s3_prefix, :iam_role_arn, :kms_key_id, :status, :percent_progress, :total_extracted_data_in_gb, :failure_cause, :warning_message, :source_type) SENSITIVE = [] include Aws::Structure end |
#warning_message ⇒ String
A warning about the snapshot or cluster export task.
13851 13852 13853 13854 13855 13856 13857 13858 13859 13860 13861 13862 13863 13864 13865 13866 13867 13868 13869 13870 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 13851 class ExportTask < Struct.new( :export_task_identifier, :source_arn, :export_only, :snapshot_time, :task_start_time, :task_end_time, :s3_bucket, :s3_prefix, :iam_role_arn, :kms_key_id, :status, :percent_progress, :total_extracted_data_in_gb, :failure_cause, :warning_message, :source_type) SENSITIVE = [] include Aws::Structure end |