Struct aws_sdk_rds::operation::start_export_task::builders::StartExportTaskInputBuilder

#[non_exhaustive]
pub struct StartExportTaskInputBuilder { /* private fields */ }

A builder for StartExportTaskInput.

Implementations

impl StartExportTaskInputBuilder

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

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.

This field is required.

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

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.

pub fn get_export_task_identifier(&self) -> &Option<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.

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

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

This field is required.

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

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

pub fn get_source_arn(&self) -> &Option<String>

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

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

The name of the Amazon S3 bucket to export the snapshot or cluster data to.

This field is required.

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

The name of the Amazon S3 bucket to export the snapshot or cluster data to.

pub fn get_s3_bucket_name(&self) -> &Option<String>

The name of the Amazon S3 bucket to export the snapshot or cluster data to.

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

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/*

This field is required.

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 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/*

pub fn get_iam_role_arn(&self) -> &Option<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/*

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

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

This field is required.

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 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

pub fn get_kms_key_id(&self) -> &Option<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

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

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

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 data.

pub fn get_s3_prefix(&self) -> &Option<String>

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

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

Appends an item to export_only.

To override the contents of this collection use set_export_only.

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.

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

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.

pub fn get_export_only(&self) -> &Option<Vec<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.

pub fn build(self) -> Result<StartExportTaskInput, BuildError>

Consumes the builder and constructs a StartExportTaskInput.

impl StartExportTaskInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<StartExportTaskOutput, SdkError<StartExportTaskError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for StartExportTaskInputBuilder

fn clone(&self) -> StartExportTaskInputBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StartExportTaskInputBuilder

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

Formats the value using the given formatter.

impl Default for StartExportTaskInputBuilder

fn default() -> StartExportTaskInputBuilder

Returns the “default value” for a type.

impl PartialEq for StartExportTaskInputBuilder

fn eq(&self, other: &StartExportTaskInputBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StartExportTaskInputBuilder