Struct aws_sdk_rds::operation::start_export_task::StartExportTaskOutput

#[non_exhaustive]
pub struct StartExportTaskOutput {

    pub export_task_identifier: Option<String>,
    pub source_arn: Option<String>,
    pub export_only: Option<Vec<String>>,
    pub snapshot_time: Option<DateTime>,
    pub task_start_time: Option<DateTime>,
    pub task_end_time: Option<DateTime>,
    pub s3_bucket: Option<String>,
    pub s3_prefix: Option<String>,
    pub iam_role_arn: Option<String>,
    pub kms_key_id: Option<String>,
    pub status: Option<String>,
    pub percent_progress: Option<i32>,
    pub total_extracted_data_in_gb: Option<i32>,
    pub failure_cause: Option<String>,
    pub warning_message: Option<String>,
    pub source_type: Option<ExportSourceType>,
    /* private fields */
}

Contains the details of a snapshot or cluster export to Amazon S3.

This data type is used as a response element in the DescribeExportTasks operation.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

export_task_identifier: Option<String>

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.

source_arn: Option<String>

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

export_only: Option<Vec<String>>

The data exported from the snapshot or cluster.

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.

snapshot_time: Option<DateTime>

The time when the snapshot was created.

task_start_time: Option<DateTime>

The time when the snapshot or cluster export task started.

task_end_time: Option<DateTime>

The time when the snapshot or cluster export task ended.

s3_bucket: Option<String>

The Amazon S3 bucket where the snapshot or cluster is exported to.

s3_prefix: Option<String>

The Amazon S3 bucket prefix that is the file name and path of the exported data.

iam_role_arn: Option<String>

The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.

kms_key_id: Option<String>

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.

status: Option<String>

The progress status of the export task. The status can be one of the following:

• CANCELED

• CANCELING

• COMPLETE

• FAILED

• IN_PROGRESS

• STARTING

percent_progress: Option<i32>

The progress of the snapshot or cluster export task as a percentage.

total_extracted_data_in_gb: Option<i32>

The total amount of data exported, in gigabytes.

failure_cause: Option<String>

The reason the export failed, if it failed.

warning_message: Option<String>

A warning about the snapshot or cluster export task.

source_type: Option<ExportSourceType>

The type of source for the export.

Implementations

impl StartExportTaskOutput

pub fn export_task_identifier(&self) -> Option<&str>

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.

pub fn source_arn(&self) -> Option<&str>

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

pub fn export_only(&self) -> &[String]

The data exported from the snapshot or cluster.

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .export_only.is_none().

pub fn snapshot_time(&self) -> Option<&DateTime>

The time when the snapshot was created.

pub fn task_start_time(&self) -> Option<&DateTime>

The time when the snapshot or cluster export task started.

pub fn task_end_time(&self) -> Option<&DateTime>

The time when the snapshot or cluster export task ended.

pub fn s3_bucket(&self) -> Option<&str>

The Amazon S3 bucket where the snapshot or cluster is exported to.

pub fn s3_prefix(&self) -> Option<&str>

The Amazon S3 bucket prefix that is the file name and path of the exported data.

pub fn iam_role_arn(&self) -> Option<&str>

The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.

pub fn kms_key_id(&self) -> Option<&str>

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.

pub fn status(&self) -> Option<&str>

The progress status of the export task. The status can be one of the following:

• CANCELED

• CANCELING

• COMPLETE

• FAILED

• IN_PROGRESS

• STARTING

pub fn percent_progress(&self) -> Option<i32>

The progress of the snapshot or cluster export task as a percentage.

pub fn total_extracted_data_in_gb(&self) -> Option<i32>

The total amount of data exported, in gigabytes.

pub fn failure_cause(&self) -> Option<&str>

The reason the export failed, if it failed.

pub fn warning_message(&self) -> Option<&str>

A warning about the snapshot or cluster export task.

pub fn source_type(&self) -> Option<&ExportSourceType>

The type of source for the export.

impl StartExportTaskOutput

pub fn builder() -> StartExportTaskOutputBuilder

Creates a new builder-style object to manufacture StartExportTaskOutput.

Trait Implementations

impl Clone for StartExportTaskOutput

fn clone(&self) -> StartExportTaskOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartExportTaskOutput

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

Formats the value using the given formatter.

impl PartialEq for StartExportTaskOutput

fn eq(&self, other: &StartExportTaskOutput) -> 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 RequestId for StartExportTaskOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for StartExportTaskOutput