aws_sdk_rds/client/

start_export_task.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`StartExportTask`](crate::operation::start_export_task::builders::StartExportTaskFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`export_task_identifier(impl Into<String>)`](crate::operation::start_export_task::builders::StartExportTaskFluentBuilder::export_task_identifier) / [`set_export_task_identifier(Option<String>)`](crate::operation::start_export_task::builders::StartExportTaskFluentBuilder::set_export_task_identifier):<br>required: **true**<br><p>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.</p><br>
    ///   - [`source_arn(impl Into<String>)`](crate::operation::start_export_task::builders::StartExportTaskFluentBuilder::source_arn) / [`set_source_arn(Option<String>)`](crate::operation::start_export_task::builders::StartExportTaskFluentBuilder::set_source_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the snapshot or cluster to export to Amazon S3.</p><br>
    ///   - [`s3_bucket_name(impl Into<String>)`](crate::operation::start_export_task::builders::StartExportTaskFluentBuilder::s3_bucket_name) / [`set_s3_bucket_name(Option<String>)`](crate::operation::start_export_task::builders::StartExportTaskFluentBuilder::set_s3_bucket_name):<br>required: **true**<br><p>The name of the Amazon S3 bucket to export the snapshot or cluster data to.</p><br>
    ///   - [`iam_role_arn(impl Into<String>)`](crate::operation::start_export_task::builders::StartExportTaskFluentBuilder::iam_role_arn) / [`set_iam_role_arn(Option<String>)`](crate::operation::start_export_task::builders::StartExportTaskFluentBuilder::set_iam_role_arn):<br>required: **true**<br><p>The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot or cluster.</p> <p>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:</p> <ul>  <li>   <p>s3:PutObject*</p></li>  <li>   <p>s3:GetObject*</p></li>  <li>   <p>s3:ListBucket</p></li>  <li>   <p>s3:DeleteObject*</p></li>  <li>   <p>s3:GetBucketLocation</p></li> </ul> <p>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:</p> <ul>  <li>   <p><code>arn:aws:s3:::<i>your-s3-bucket</i> </code></p></li>  <li>   <p><code>arn:aws:s3:::<i>your-s3-bucket</i>/*</code></p></li> </ul><br>
    ///   - [`kms_key_id(impl Into<String>)`](crate::operation::start_export_task::builders::StartExportTaskFluentBuilder::kms_key_id) / [`set_kms_key_id(Option<String>)`](crate::operation::start_export_task::builders::StartExportTaskFluentBuilder::set_kms_key_id):<br>required: **true**<br><p>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:</p> <ul>  <li>   <p>kms:CreateGrant</p></li>  <li>   <p>kms:DescribeKey</p></li> </ul><br>
    ///   - [`s3_prefix(impl Into<String>)`](crate::operation::start_export_task::builders::StartExportTaskFluentBuilder::s3_prefix) / [`set_s3_prefix(Option<String>)`](crate::operation::start_export_task::builders::StartExportTaskFluentBuilder::set_s3_prefix):<br>required: **false**<br><p>The Amazon S3 bucket prefix to use as the file name and path of the exported data.</p><br>
    ///   - [`export_only(impl Into<String>)`](crate::operation::start_export_task::builders::StartExportTaskFluentBuilder::export_only) / [`set_export_only(Option<Vec::<String>>)`](crate::operation::start_export_task::builders::StartExportTaskFluentBuilder::set_export_only):<br>required: **false**<br><p>The data to be exported from the snapshot or cluster. If this parameter isn't provided, all of the data is exported.</p> <p>Valid Values:</p> <ul>  <li>   <p><code>database</code> - Export all the data from a specified database.</p></li>  <li>   <p><code>database.table</code> <i>table-name</i> - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.</p></li>  <li>   <p><code>database.schema</code> <i>schema-name</i> - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.</p></li>  <li>   <p><code>database.schema.table</code> <i>table-name</i> - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.</p></li> </ul><br>
    /// - On success, responds with [`StartExportTaskOutput`](crate::operation::start_export_task::StartExportTaskOutput) with field(s):
    ///   - [`export_task_identifier(Option<String>)`](crate::operation::start_export_task::StartExportTaskOutput::export_task_identifier): <p>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.</p>
    ///   - [`source_arn(Option<String>)`](crate::operation::start_export_task::StartExportTaskOutput::source_arn): <p>The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.</p>
    ///   - [`export_only(Option<Vec::<String>>)`](crate::operation::start_export_task::StartExportTaskOutput::export_only): <p>The data exported from the snapshot or cluster.</p> <p>Valid Values:</p> <ul>  <li>   <p><code>database</code> - Export all the data from a specified database.</p></li>  <li>   <p><code>database.table</code> <i>table-name</i> - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.</p></li>  <li>   <p><code>database.schema</code> <i>schema-name</i> - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.</p></li>  <li>   <p><code>database.schema.table</code> <i>table-name</i> - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.</p></li> </ul>
    ///   - [`snapshot_time(Option<DateTime>)`](crate::operation::start_export_task::StartExportTaskOutput::snapshot_time): <p>The time when the snapshot was created.</p>
    ///   - [`task_start_time(Option<DateTime>)`](crate::operation::start_export_task::StartExportTaskOutput::task_start_time): <p>The time when the snapshot or cluster export task started.</p>
    ///   - [`task_end_time(Option<DateTime>)`](crate::operation::start_export_task::StartExportTaskOutput::task_end_time): <p>The time when the snapshot or cluster export task ended.</p>
    ///   - [`s3_bucket(Option<String>)`](crate::operation::start_export_task::StartExportTaskOutput::s3_bucket): <p>The Amazon S3 bucket where the snapshot or cluster is exported to.</p>
    ///   - [`s3_prefix(Option<String>)`](crate::operation::start_export_task::StartExportTaskOutput::s3_prefix): <p>The Amazon S3 bucket prefix that is the file name and path of the exported data.</p>
    ///   - [`iam_role_arn(Option<String>)`](crate::operation::start_export_task::StartExportTaskOutput::iam_role_arn): <p>The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.</p>
    ///   - [`kms_key_id(Option<String>)`](crate::operation::start_export_task::StartExportTaskOutput::kms_key_id): <p>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.</p>
    ///   - [`status(Option<String>)`](crate::operation::start_export_task::StartExportTaskOutput::status): <p>The progress status of the export task. The status can be one of the following:</p> <ul>  <li>   <p><code>CANCELED</code></p></li>  <li>   <p><code>CANCELING</code></p></li>  <li>   <p><code>COMPLETE</code></p></li>  <li>   <p><code>FAILED</code></p></li>  <li>   <p><code>IN_PROGRESS</code></p></li>  <li>   <p><code>STARTING</code></p></li> </ul>
    ///   - [`percent_progress(Option<i32>)`](crate::operation::start_export_task::StartExportTaskOutput::percent_progress): <p>The progress of the snapshot or cluster export task as a percentage.</p>
    ///   - [`total_extracted_data_in_gb(Option<i32>)`](crate::operation::start_export_task::StartExportTaskOutput::total_extracted_data_in_gb): <p>The total amount of data exported, in gigabytes.</p>
    ///   - [`failure_cause(Option<String>)`](crate::operation::start_export_task::StartExportTaskOutput::failure_cause): <p>The reason the export failed, if it failed.</p>
    ///   - [`warning_message(Option<String>)`](crate::operation::start_export_task::StartExportTaskOutput::warning_message): <p>A warning about the snapshot or cluster export task.</p>
    ///   - [`source_type(Option<ExportSourceType>)`](crate::operation::start_export_task::StartExportTaskOutput::source_type): <p>The type of source for the export.</p>
    /// - On failure, responds with [`SdkError<StartExportTaskError>`](crate::operation::start_export_task::StartExportTaskError)
    pub fn start_export_task(&self) -> crate::operation::start_export_task::builders::StartExportTaskFluentBuilder {
        crate::operation::start_export_task::builders::StartExportTaskFluentBuilder::new(self.handle.clone())
    }
}