Struct aws_sdk_rds::client::fluent_builders::StartExportTask

pub struct StartExportTask<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to StartExportTask.

Starts an export of a snapshot to Amazon S3. The provided IAM role must have access to the S3 bucket.

This command doesn't apply to RDS Custom.

Implementations

impl<C, M, R> StartExportTask<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<StartExportTaskOutput, SdkError<StartExportTaskError>> where
    R::Policy: SmithyRetryPolicy<StartExportTaskInputOperationOutputAlias, StartExportTaskOutput, StartExportTaskError, StartExportTaskInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn export_task_identifier(self, inp: impl Into<String>) -> Self

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

pub fn set_export_task_identifier(self, input: Option<String>) -> Self

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

pub fn source_arn(self, inp: impl Into<String>) -> Self

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

pub fn set_source_arn(self, input: Option<String>) -> Self

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

pub fn s3_bucket_name(self, inp: impl Into<String>) -> Self

The name of the Amazon S3 bucket to export the snapshot to.

pub fn set_s3_bucket_name(self, input: Option<String>) -> Self

The name of the Amazon S3 bucket to export the snapshot to.

pub fn iam_role_arn(self, inp: impl Into<String>) -> Self

The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot.

pub fn set_iam_role_arn(self, input: Option<String>) -> Self

The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot.

pub fn kms_key_id(self, inp: impl Into<String>) -> Self

The ID of the Amazon Web Services KMS key to use to encrypt the snapshot 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 execute the following operations. These can be set in the Amazon Web Services KMS key policy:

• GrantOperation.Encrypt

• GrantOperation.Decrypt

• GrantOperation.GenerateDataKey

• GrantOperation.GenerateDataKeyWithoutPlaintext

• GrantOperation.ReEncryptFrom

• GrantOperation.ReEncryptTo

• GrantOperation.CreateGrant

• GrantOperation.DescribeKey

• GrantOperation.RetireGrant

pub fn set_kms_key_id(self, input: Option<String>) -> Self

The ID of the Amazon Web Services KMS key to use to encrypt the snapshot 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 execute the following operations. These can be set in the Amazon Web Services KMS key policy:

• GrantOperation.Encrypt

• GrantOperation.Decrypt

• GrantOperation.GenerateDataKey

• GrantOperation.GenerateDataKeyWithoutPlaintext

• GrantOperation.ReEncryptFrom

• GrantOperation.ReEncryptTo

• GrantOperation.CreateGrant

• GrantOperation.DescribeKey

• GrantOperation.RetireGrant

pub fn s3_prefix(self, inp: impl Into<String>) -> Self

The Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.

pub fn set_s3_prefix(self, input: Option<String>) -> Self

The Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.

pub fn export_only(self, inp: impl Into<String>) -> Self

Appends an item to ExportOnly.

To override the contents of this collection use set_export_only.

The data to be exported from the snapshot. If this parameter is not provided, all the snapshot data is exported. 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.

pub fn set_export_only(self, input: Option<Vec<String>>) -> Self

The data to be exported from the snapshot. If this parameter is not provided, all the snapshot data is exported. 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.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for StartExportTask<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.