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 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.
-
#export_task_identifier ⇒ String
A unique identifier for the snapshot 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.
-
#kms_key_id ⇒ String
The key identifier of the AWS KMS customer master key (CMK) 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.
-
#s3_bucket ⇒ 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.
-
#snapshot_time ⇒ Time
The time that the snapshot was created.
-
#source_arn ⇒ String
The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
-
#status ⇒ String
The progress status of the export task.
-
#task_end_time ⇒ Time
The time that the snapshot export task completed.
-
#task_start_time ⇒ Time
The time that the snapshot 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 export task.
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.
11923 11924 11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 11939 11940 11941 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11923 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) SENSITIVE = [] include Aws::Structure end |
#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.
11923 11924 11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 11939 11940 11941 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11923 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) SENSITIVE = [] include Aws::Structure end |
#failure_cause ⇒ String
The reason the export failed, if it failed.
11923 11924 11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 11939 11940 11941 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11923 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) 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.
11923 11924 11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 11939 11940 11941 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11923 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) SENSITIVE = [] include Aws::Structure end |
#kms_key_id ⇒ String
The key identifier of the AWS KMS customer master key (CMK) that is used to encrypt the snapshot when it's exported to Amazon S3. The AWS KMS CMK identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the snapshot export must have encryption and decryption permissions to use this AWS KMS CMK.
11923 11924 11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 11939 11940 11941 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11923 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) SENSITIVE = [] include Aws::Structure end |
#percent_progress ⇒ Integer
The progress of the snapshot export task as a percentage.
11923 11924 11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 11939 11940 11941 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11923 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) SENSITIVE = [] include Aws::Structure end |
#s3_bucket ⇒ String
The Amazon S3 bucket that the snapshot is exported to.
11923 11924 11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 11939 11940 11941 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11923 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) SENSITIVE = [] include Aws::Structure end |
#s3_prefix ⇒ String
The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.
11923 11924 11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 11939 11940 11941 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11923 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) SENSITIVE = [] include Aws::Structure end |
#snapshot_time ⇒ Time
The time that the snapshot was created.
11923 11924 11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 11939 11940 11941 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11923 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) SENSITIVE = [] include Aws::Structure end |
#source_arn ⇒ String
The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
11923 11924 11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 11939 11940 11941 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11923 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) SENSITIVE = [] include Aws::Structure end |
#status ⇒ String
The progress status of the export task.
11923 11924 11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 11939 11940 11941 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11923 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) SENSITIVE = [] include Aws::Structure end |
#task_end_time ⇒ Time
The time that the snapshot export task completed.
11923 11924 11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 11939 11940 11941 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11923 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) SENSITIVE = [] include Aws::Structure end |
#task_start_time ⇒ Time
The time that the snapshot export task started.
11923 11924 11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 11939 11940 11941 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11923 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) SENSITIVE = [] include Aws::Structure end |
#total_extracted_data_in_gb ⇒ Integer
The total amount of data exported, in gigabytes.
11923 11924 11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 11939 11940 11941 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11923 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) SENSITIVE = [] include Aws::Structure end |
#warning_message ⇒ String
A warning about the snapshot export task.
11923 11924 11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 11939 11940 11941 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11923 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) SENSITIVE = [] include Aws::Structure end |