Class: Aws::RDS::Types::StartExportTaskMessage
- Inherits:
-
Struct
- Object
- Struct
- Aws::RDS::Types::StartExportTaskMessage
- Defined in:
- gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#export_only ⇒ Array<String>
The data to be exported from the snapshot or cluster.
-
#export_task_identifier ⇒ String
A unique identifier for the export task.
-
#iam_role_arn ⇒ String
The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot or cluster.
-
#kms_key_id ⇒ String
The ID of the Amazon Web Services KMS key to use to encrypt the data exported to Amazon S3.
-
#s3_bucket_name ⇒ String
The name of the Amazon S3 bucket to export the snapshot or cluster data to.
-
#s3_prefix ⇒ String
The Amazon S3 bucket prefix to use as the file name and path of the exported data.
-
#source_arn ⇒ String
The Amazon Resource Name (ARN) of the snapshot or cluster to export to Amazon S3.
Instance Attribute Details
#export_only ⇒ Array<String>
The data to be exported from the snapshot or cluster. If this parameter isn't provided, all of the data is exported.
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.
26315 26316 26317 26318 26319 26320 26321 26322 26323 26324 26325 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 26315 class StartExportTaskMessage < Struct.new( :export_task_identifier, :source_arn, :s3_bucket_name, :iam_role_arn, :kms_key_id, :s3_prefix, :export_only) SENSITIVE = [] include Aws::Structure end |
#export_task_identifier ⇒ String
A unique identifier for the export task. This ID isn't an identifier for the Amazon S3 bucket where the data is to be exported.
26315 26316 26317 26318 26319 26320 26321 26322 26323 26324 26325 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 26315 class StartExportTaskMessage < Struct.new( :export_task_identifier, :source_arn, :s3_bucket_name, :iam_role_arn, :kms_key_id, :s3_prefix, :export_only) SENSITIVE = [] include Aws::Structure end |
#iam_role_arn ⇒ String
The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot or cluster.
In the IAM policy attached to your IAM role, include the following required actions to allow the transfer of files from Amazon RDS or Amazon Aurora to an S3 bucket:
s3:PutObject*
s3:GetObject*
s3:ListBucket
s3:DeleteObject*
s3:GetBucketLocation
In the policy, include the resources to identify the S3 bucket and objects in the bucket. The following list of resources shows the Amazon Resource Name (ARN) format for accessing S3:
arn:aws:s3:::your-s3-bucket
arn:aws:s3:::your-s3-bucket/*
26315 26316 26317 26318 26319 26320 26321 26322 26323 26324 26325 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 26315 class StartExportTaskMessage < Struct.new( :export_task_identifier, :source_arn, :s3_bucket_name, :iam_role_arn, :kms_key_id, :s3_prefix, :export_only) SENSITIVE = [] include Aws::Structure end |
#kms_key_id ⇒ String
The ID of the Amazon Web Services KMS key to use to encrypt the data exported to Amazon S3. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. The caller of this operation must be authorized to run the following operations. These can be set in the Amazon Web Services KMS key policy:
kms:Encrypt
kms:Decrypt
kms:GenerateDataKey
kms:GenerateDataKeyWithoutPlaintext
kms:ReEncryptFrom
kms:ReEncryptTo
kms:CreateGrant
kms:DescribeKey
kms:RetireGrant
26315 26316 26317 26318 26319 26320 26321 26322 26323 26324 26325 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 26315 class StartExportTaskMessage < Struct.new( :export_task_identifier, :source_arn, :s3_bucket_name, :iam_role_arn, :kms_key_id, :s3_prefix, :export_only) SENSITIVE = [] include Aws::Structure end |
#s3_bucket_name ⇒ String
The name of the Amazon S3 bucket to export the snapshot or cluster data to.
26315 26316 26317 26318 26319 26320 26321 26322 26323 26324 26325 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 26315 class StartExportTaskMessage < Struct.new( :export_task_identifier, :source_arn, :s3_bucket_name, :iam_role_arn, :kms_key_id, :s3_prefix, :export_only) SENSITIVE = [] include Aws::Structure end |
#s3_prefix ⇒ String
The Amazon S3 bucket prefix to use as the file name and path of the exported data.
26315 26316 26317 26318 26319 26320 26321 26322 26323 26324 26325 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 26315 class StartExportTaskMessage < Struct.new( :export_task_identifier, :source_arn, :s3_bucket_name, :iam_role_arn, :kms_key_id, :s3_prefix, :export_only) SENSITIVE = [] include Aws::Structure end |
#source_arn ⇒ String
The Amazon Resource Name (ARN) of the snapshot or cluster to export to Amazon S3.
26315 26316 26317 26318 26319 26320 26321 26322 26323 26324 26325 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 26315 class StartExportTaskMessage < Struct.new( :export_task_identifier, :source_arn, :s3_bucket_name, :iam_role_arn, :kms_key_id, :s3_prefix, :export_only) SENSITIVE = [] include Aws::Structure end |