AWS SDK for C++  1.9.130
AWS SDK for C++
Public Member Functions | List of all members
Aws::RDS::Model::StartExportTaskResult Class Reference

#include <StartExportTaskResult.h>

Public Member Functions

 StartExportTaskResult ()
 
 StartExportTaskResult (const Aws::AmazonWebServiceResult< Aws::Utils::Xml::XmlDocument > &result)
 
StartExportTaskResultoperator= (const Aws::AmazonWebServiceResult< Aws::Utils::Xml::XmlDocument > &result)
 
const Aws::StringGetExportTaskIdentifier () const
 
void SetExportTaskIdentifier (const Aws::String &value)
 
void SetExportTaskIdentifier (Aws::String &&value)
 
void SetExportTaskIdentifier (const char *value)
 
StartExportTaskResultWithExportTaskIdentifier (const Aws::String &value)
 
StartExportTaskResultWithExportTaskIdentifier (Aws::String &&value)
 
StartExportTaskResultWithExportTaskIdentifier (const char *value)
 
const Aws::StringGetSourceArn () const
 
void SetSourceArn (const Aws::String &value)
 
void SetSourceArn (Aws::String &&value)
 
void SetSourceArn (const char *value)
 
StartExportTaskResultWithSourceArn (const Aws::String &value)
 
StartExportTaskResultWithSourceArn (Aws::String &&value)
 
StartExportTaskResultWithSourceArn (const char *value)
 
const Aws::Vector< Aws::String > & GetExportOnly () const
 
void SetExportOnly (const Aws::Vector< Aws::String > &value)
 
void SetExportOnly (Aws::Vector< Aws::String > &&value)
 
StartExportTaskResultWithExportOnly (const Aws::Vector< Aws::String > &value)
 
StartExportTaskResultWithExportOnly (Aws::Vector< Aws::String > &&value)
 
StartExportTaskResultAddExportOnly (const Aws::String &value)
 
StartExportTaskResultAddExportOnly (Aws::String &&value)
 
StartExportTaskResultAddExportOnly (const char *value)
 
const Aws::Utils::DateTimeGetSnapshotTime () const
 
void SetSnapshotTime (const Aws::Utils::DateTime &value)
 
void SetSnapshotTime (Aws::Utils::DateTime &&value)
 
StartExportTaskResultWithSnapshotTime (const Aws::Utils::DateTime &value)
 
StartExportTaskResultWithSnapshotTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetTaskStartTime () const
 
void SetTaskStartTime (const Aws::Utils::DateTime &value)
 
void SetTaskStartTime (Aws::Utils::DateTime &&value)
 
StartExportTaskResultWithTaskStartTime (const Aws::Utils::DateTime &value)
 
StartExportTaskResultWithTaskStartTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetTaskEndTime () const
 
void SetTaskEndTime (const Aws::Utils::DateTime &value)
 
void SetTaskEndTime (Aws::Utils::DateTime &&value)
 
StartExportTaskResultWithTaskEndTime (const Aws::Utils::DateTime &value)
 
StartExportTaskResultWithTaskEndTime (Aws::Utils::DateTime &&value)
 
const Aws::StringGetS3Bucket () const
 
void SetS3Bucket (const Aws::String &value)
 
void SetS3Bucket (Aws::String &&value)
 
void SetS3Bucket (const char *value)
 
StartExportTaskResultWithS3Bucket (const Aws::String &value)
 
StartExportTaskResultWithS3Bucket (Aws::String &&value)
 
StartExportTaskResultWithS3Bucket (const char *value)
 
const Aws::StringGetS3Prefix () const
 
void SetS3Prefix (const Aws::String &value)
 
void SetS3Prefix (Aws::String &&value)
 
void SetS3Prefix (const char *value)
 
StartExportTaskResultWithS3Prefix (const Aws::String &value)
 
StartExportTaskResultWithS3Prefix (Aws::String &&value)
 
StartExportTaskResultWithS3Prefix (const char *value)
 
const Aws::StringGetIamRoleArn () const
 
void SetIamRoleArn (const Aws::String &value)
 
void SetIamRoleArn (Aws::String &&value)
 
void SetIamRoleArn (const char *value)
 
StartExportTaskResultWithIamRoleArn (const Aws::String &value)
 
StartExportTaskResultWithIamRoleArn (Aws::String &&value)
 
StartExportTaskResultWithIamRoleArn (const char *value)
 
const Aws::StringGetKmsKeyId () const
 
void SetKmsKeyId (const Aws::String &value)
 
void SetKmsKeyId (Aws::String &&value)
 
void SetKmsKeyId (const char *value)
 
StartExportTaskResultWithKmsKeyId (const Aws::String &value)
 
StartExportTaskResultWithKmsKeyId (Aws::String &&value)
 
StartExportTaskResultWithKmsKeyId (const char *value)
 
const Aws::StringGetStatus () const
 
void SetStatus (const Aws::String &value)
 
void SetStatus (Aws::String &&value)
 
void SetStatus (const char *value)
 
StartExportTaskResultWithStatus (const Aws::String &value)
 
StartExportTaskResultWithStatus (Aws::String &&value)
 
StartExportTaskResultWithStatus (const char *value)
 
int GetPercentProgress () const
 
void SetPercentProgress (int value)
 
StartExportTaskResultWithPercentProgress (int value)
 
int GetTotalExtractedDataInGB () const
 
void SetTotalExtractedDataInGB (int value)
 
StartExportTaskResultWithTotalExtractedDataInGB (int value)
 
const Aws::StringGetFailureCause () const
 
void SetFailureCause (const Aws::String &value)
 
void SetFailureCause (Aws::String &&value)
 
void SetFailureCause (const char *value)
 
StartExportTaskResultWithFailureCause (const Aws::String &value)
 
StartExportTaskResultWithFailureCause (Aws::String &&value)
 
StartExportTaskResultWithFailureCause (const char *value)
 
const Aws::StringGetWarningMessage () const
 
void SetWarningMessage (const Aws::String &value)
 
void SetWarningMessage (Aws::String &&value)
 
void SetWarningMessage (const char *value)
 
StartExportTaskResultWithWarningMessage (const Aws::String &value)
 
StartExportTaskResultWithWarningMessage (Aws::String &&value)
 
StartExportTaskResultWithWarningMessage (const char *value)
 
const ResponseMetadataGetResponseMetadata () const
 
void SetResponseMetadata (const ResponseMetadata &value)
 
void SetResponseMetadata (ResponseMetadata &&value)
 
StartExportTaskResultWithResponseMetadata (const ResponseMetadata &value)
 
StartExportTaskResultWithResponseMetadata (ResponseMetadata &&value)
 

Detailed Description

Contains the details of a snapshot export to Amazon S3.

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

See Also:

AWS API Reference

Definition at line 37 of file StartExportTaskResult.h.

Constructor & Destructor Documentation

◆ StartExportTaskResult() [1/2]

Aws::RDS::Model::StartExportTaskResult::StartExportTaskResult ( )

◆ StartExportTaskResult() [2/2]

Aws::RDS::Model::StartExportTaskResult::StartExportTaskResult ( const Aws::AmazonWebServiceResult< Aws::Utils::Xml::XmlDocument > &  result)

Member Function Documentation

◆ AddExportOnly() [1/3]

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::AddExportOnly ( Aws::String &&  value)
inline

The data exported from the snapshot. 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.

Definition at line 220 of file StartExportTaskResult.h.

◆ AddExportOnly() [2/3]

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::AddExportOnly ( const Aws::String value)
inline

The data exported from the snapshot. 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.

Definition at line 206 of file StartExportTaskResult.h.

◆ AddExportOnly() [3/3]

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::AddExportOnly ( const char *  value)
inline

The data exported from the snapshot. 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.

Definition at line 234 of file StartExportTaskResult.h.

◆ GetExportOnly()

const Aws::Vector<Aws::String>& Aws::RDS::Model::StartExportTaskResult::GetExportOnly ( ) const
inline

The data exported from the snapshot. 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.

Definition at line 136 of file StartExportTaskResult.h.

◆ GetExportTaskIdentifier()

const Aws::String& Aws::RDS::Model::StartExportTaskResult::GetExportTaskIdentifier ( ) const
inline

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

Definition at line 49 of file StartExportTaskResult.h.

◆ GetFailureCause()

const Aws::String& Aws::RDS::Model::StartExportTaskResult::GetFailureCause ( ) const
inline

The reason the export failed, if it failed.

Definition at line 565 of file StartExportTaskResult.h.

◆ GetIamRoleArn()

const Aws::String& Aws::RDS::Model::StartExportTaskResult::GetIamRoleArn ( ) const
inline

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

Definition at line 398 of file StartExportTaskResult.h.

◆ GetKmsKeyId()

const Aws::String& Aws::RDS::Model::StartExportTaskResult::GetKmsKeyId ( ) const
inline

The key identifier of the Amazon Web Services KMS key that is used to encrypt the snapshot 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 snapshot export must have encryption and decryption permissions to use this KMS key.

Definition at line 443 of file StartExportTaskResult.h.

◆ GetPercentProgress()

int Aws::RDS::Model::StartExportTaskResult::GetPercentProgress ( ) const
inline

The progress of the snapshot export task as a percentage.

Definition at line 533 of file StartExportTaskResult.h.

◆ GetResponseMetadata()

const ResponseMetadata& Aws::RDS::Model::StartExportTaskResult::GetResponseMetadata ( ) const
inline

Definition at line 635 of file StartExportTaskResult.h.

◆ GetS3Bucket()

const Aws::String& Aws::RDS::Model::StartExportTaskResult::GetS3Bucket ( ) const
inline

The Amazon S3 bucket that the snapshot is exported to.

Definition at line 318 of file StartExportTaskResult.h.

◆ GetS3Prefix()

const Aws::String& Aws::RDS::Model::StartExportTaskResult::GetS3Prefix ( ) const
inline

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

Definition at line 355 of file StartExportTaskResult.h.

◆ GetSnapshotTime()

const Aws::Utils::DateTime& Aws::RDS::Model::StartExportTaskResult::GetSnapshotTime ( ) const
inline

The time that the snapshot was created.

Definition at line 240 of file StartExportTaskResult.h.

◆ GetSourceArn()

const Aws::String& Aws::RDS::Model::StartExportTaskResult::GetSourceArn ( ) const
inline

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

Definition at line 91 of file StartExportTaskResult.h.

◆ GetStatus()

const Aws::String& Aws::RDS::Model::StartExportTaskResult::GetStatus ( ) const
inline

The progress status of the export task.

Definition at line 497 of file StartExportTaskResult.h.

◆ GetTaskEndTime()

const Aws::Utils::DateTime& Aws::RDS::Model::StartExportTaskResult::GetTaskEndTime ( ) const
inline

The time that the snapshot export task completed.

Definition at line 292 of file StartExportTaskResult.h.

◆ GetTaskStartTime()

const Aws::Utils::DateTime& Aws::RDS::Model::StartExportTaskResult::GetTaskStartTime ( ) const
inline

The time that the snapshot export task started.

Definition at line 266 of file StartExportTaskResult.h.

◆ GetTotalExtractedDataInGB()

int Aws::RDS::Model::StartExportTaskResult::GetTotalExtractedDataInGB ( ) const
inline

The total amount of data exported, in gigabytes.

Definition at line 549 of file StartExportTaskResult.h.

◆ GetWarningMessage()

const Aws::String& Aws::RDS::Model::StartExportTaskResult::GetWarningMessage ( ) const
inline

A warning about the snapshot export task.

Definition at line 601 of file StartExportTaskResult.h.

◆ operator=()

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::operator= ( const Aws::AmazonWebServiceResult< Aws::Utils::Xml::XmlDocument > &  result)

◆ SetExportOnly() [1/2]

void Aws::RDS::Model::StartExportTaskResult::SetExportOnly ( Aws::Vector< Aws::String > &&  value)
inline

The data exported from the snapshot. 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.

Definition at line 164 of file StartExportTaskResult.h.

◆ SetExportOnly() [2/2]

void Aws::RDS::Model::StartExportTaskResult::SetExportOnly ( const Aws::Vector< Aws::String > &  value)
inline

The data exported from the snapshot. 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.

Definition at line 150 of file StartExportTaskResult.h.

◆ SetExportTaskIdentifier() [1/3]

void Aws::RDS::Model::StartExportTaskResult::SetExportTaskIdentifier ( Aws::String &&  value)
inline

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

Definition at line 61 of file StartExportTaskResult.h.

◆ SetExportTaskIdentifier() [2/3]

void Aws::RDS::Model::StartExportTaskResult::SetExportTaskIdentifier ( const Aws::String value)
inline

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

Definition at line 55 of file StartExportTaskResult.h.

◆ SetExportTaskIdentifier() [3/3]

void Aws::RDS::Model::StartExportTaskResult::SetExportTaskIdentifier ( const char *  value)
inline

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

Definition at line 67 of file StartExportTaskResult.h.

◆ SetFailureCause() [1/3]

void Aws::RDS::Model::StartExportTaskResult::SetFailureCause ( Aws::String &&  value)
inline

The reason the export failed, if it failed.

Definition at line 575 of file StartExportTaskResult.h.

◆ SetFailureCause() [2/3]

void Aws::RDS::Model::StartExportTaskResult::SetFailureCause ( const Aws::String value)
inline

The reason the export failed, if it failed.

Definition at line 570 of file StartExportTaskResult.h.

◆ SetFailureCause() [3/3]

void Aws::RDS::Model::StartExportTaskResult::SetFailureCause ( const char *  value)
inline

The reason the export failed, if it failed.

Definition at line 580 of file StartExportTaskResult.h.

◆ SetIamRoleArn() [1/3]

void Aws::RDS::Model::StartExportTaskResult::SetIamRoleArn ( Aws::String &&  value)
inline

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

Definition at line 410 of file StartExportTaskResult.h.

◆ SetIamRoleArn() [2/3]

void Aws::RDS::Model::StartExportTaskResult::SetIamRoleArn ( const Aws::String value)
inline

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

Definition at line 404 of file StartExportTaskResult.h.

◆ SetIamRoleArn() [3/3]

void Aws::RDS::Model::StartExportTaskResult::SetIamRoleArn ( const char *  value)
inline

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

Definition at line 416 of file StartExportTaskResult.h.

◆ SetKmsKeyId() [1/3]

void Aws::RDS::Model::StartExportTaskResult::SetKmsKeyId ( Aws::String &&  value)
inline

The key identifier of the Amazon Web Services KMS key that is used to encrypt the snapshot 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 snapshot export must have encryption and decryption permissions to use this KMS key.

Definition at line 459 of file StartExportTaskResult.h.

◆ SetKmsKeyId() [2/3]

void Aws::RDS::Model::StartExportTaskResult::SetKmsKeyId ( const Aws::String value)
inline

The key identifier of the Amazon Web Services KMS key that is used to encrypt the snapshot 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 snapshot export must have encryption and decryption permissions to use this KMS key.

Definition at line 451 of file StartExportTaskResult.h.

◆ SetKmsKeyId() [3/3]

void Aws::RDS::Model::StartExportTaskResult::SetKmsKeyId ( const char *  value)
inline

The key identifier of the Amazon Web Services KMS key that is used to encrypt the snapshot 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 snapshot export must have encryption and decryption permissions to use this KMS key.

Definition at line 467 of file StartExportTaskResult.h.

◆ SetPercentProgress()

void Aws::RDS::Model::StartExportTaskResult::SetPercentProgress ( int  value)
inline

The progress of the snapshot export task as a percentage.

Definition at line 538 of file StartExportTaskResult.h.

◆ SetResponseMetadata() [1/2]

void Aws::RDS::Model::StartExportTaskResult::SetResponseMetadata ( const ResponseMetadata value)
inline

Definition at line 638 of file StartExportTaskResult.h.

◆ SetResponseMetadata() [2/2]

void Aws::RDS::Model::StartExportTaskResult::SetResponseMetadata ( ResponseMetadata &&  value)
inline

Definition at line 641 of file StartExportTaskResult.h.

◆ SetS3Bucket() [1/3]

void Aws::RDS::Model::StartExportTaskResult::SetS3Bucket ( Aws::String &&  value)
inline

The Amazon S3 bucket that the snapshot is exported to.

Definition at line 328 of file StartExportTaskResult.h.

◆ SetS3Bucket() [2/3]

void Aws::RDS::Model::StartExportTaskResult::SetS3Bucket ( const Aws::String value)
inline

The Amazon S3 bucket that the snapshot is exported to.

Definition at line 323 of file StartExportTaskResult.h.

◆ SetS3Bucket() [3/3]

void Aws::RDS::Model::StartExportTaskResult::SetS3Bucket ( const char *  value)
inline

The Amazon S3 bucket that the snapshot is exported to.

Definition at line 333 of file StartExportTaskResult.h.

◆ SetS3Prefix() [1/3]

void Aws::RDS::Model::StartExportTaskResult::SetS3Prefix ( Aws::String &&  value)
inline

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

Definition at line 367 of file StartExportTaskResult.h.

◆ SetS3Prefix() [2/3]

void Aws::RDS::Model::StartExportTaskResult::SetS3Prefix ( const Aws::String value)
inline

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

Definition at line 361 of file StartExportTaskResult.h.

◆ SetS3Prefix() [3/3]

void Aws::RDS::Model::StartExportTaskResult::SetS3Prefix ( const char *  value)
inline

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

Definition at line 373 of file StartExportTaskResult.h.

◆ SetSnapshotTime() [1/2]

void Aws::RDS::Model::StartExportTaskResult::SetSnapshotTime ( Aws::Utils::DateTime &&  value)
inline

The time that the snapshot was created.

Definition at line 250 of file StartExportTaskResult.h.

◆ SetSnapshotTime() [2/2]

void Aws::RDS::Model::StartExportTaskResult::SetSnapshotTime ( const Aws::Utils::DateTime value)
inline

The time that the snapshot was created.

Definition at line 245 of file StartExportTaskResult.h.

◆ SetSourceArn() [1/3]

void Aws::RDS::Model::StartExportTaskResult::SetSourceArn ( Aws::String &&  value)
inline

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

Definition at line 101 of file StartExportTaskResult.h.

◆ SetSourceArn() [2/3]

void Aws::RDS::Model::StartExportTaskResult::SetSourceArn ( const Aws::String value)
inline

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

Definition at line 96 of file StartExportTaskResult.h.

◆ SetSourceArn() [3/3]

void Aws::RDS::Model::StartExportTaskResult::SetSourceArn ( const char *  value)
inline

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

Definition at line 106 of file StartExportTaskResult.h.

◆ SetStatus() [1/3]

void Aws::RDS::Model::StartExportTaskResult::SetStatus ( Aws::String &&  value)
inline

The progress status of the export task.

Definition at line 507 of file StartExportTaskResult.h.

◆ SetStatus() [2/3]

void Aws::RDS::Model::StartExportTaskResult::SetStatus ( const Aws::String value)
inline

The progress status of the export task.

Definition at line 502 of file StartExportTaskResult.h.

◆ SetStatus() [3/3]

void Aws::RDS::Model::StartExportTaskResult::SetStatus ( const char *  value)
inline

The progress status of the export task.

Definition at line 512 of file StartExportTaskResult.h.

◆ SetTaskEndTime() [1/2]

void Aws::RDS::Model::StartExportTaskResult::SetTaskEndTime ( Aws::Utils::DateTime &&  value)
inline

The time that the snapshot export task completed.

Definition at line 302 of file StartExportTaskResult.h.

◆ SetTaskEndTime() [2/2]

void Aws::RDS::Model::StartExportTaskResult::SetTaskEndTime ( const Aws::Utils::DateTime value)
inline

The time that the snapshot export task completed.

Definition at line 297 of file StartExportTaskResult.h.

◆ SetTaskStartTime() [1/2]

void Aws::RDS::Model::StartExportTaskResult::SetTaskStartTime ( Aws::Utils::DateTime &&  value)
inline

The time that the snapshot export task started.

Definition at line 276 of file StartExportTaskResult.h.

◆ SetTaskStartTime() [2/2]

void Aws::RDS::Model::StartExportTaskResult::SetTaskStartTime ( const Aws::Utils::DateTime value)
inline

The time that the snapshot export task started.

Definition at line 271 of file StartExportTaskResult.h.

◆ SetTotalExtractedDataInGB()

void Aws::RDS::Model::StartExportTaskResult::SetTotalExtractedDataInGB ( int  value)
inline

The total amount of data exported, in gigabytes.

Definition at line 554 of file StartExportTaskResult.h.

◆ SetWarningMessage() [1/3]

void Aws::RDS::Model::StartExportTaskResult::SetWarningMessage ( Aws::String &&  value)
inline

A warning about the snapshot export task.

Definition at line 611 of file StartExportTaskResult.h.

◆ SetWarningMessage() [2/3]

void Aws::RDS::Model::StartExportTaskResult::SetWarningMessage ( const Aws::String value)
inline

A warning about the snapshot export task.

Definition at line 606 of file StartExportTaskResult.h.

◆ SetWarningMessage() [3/3]

void Aws::RDS::Model::StartExportTaskResult::SetWarningMessage ( const char *  value)
inline

A warning about the snapshot export task.

Definition at line 616 of file StartExportTaskResult.h.

◆ WithExportOnly() [1/2]

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::WithExportOnly ( Aws::Vector< Aws::String > &&  value)
inline

The data exported from the snapshot. 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.

Definition at line 192 of file StartExportTaskResult.h.

◆ WithExportOnly() [2/2]

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::WithExportOnly ( const Aws::Vector< Aws::String > &  value)
inline

The data exported from the snapshot. 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.

Definition at line 178 of file StartExportTaskResult.h.

◆ WithExportTaskIdentifier() [1/3]

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::WithExportTaskIdentifier ( Aws::String &&  value)
inline

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

Definition at line 79 of file StartExportTaskResult.h.

◆ WithExportTaskIdentifier() [2/3]

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::WithExportTaskIdentifier ( const Aws::String value)
inline

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

Definition at line 73 of file StartExportTaskResult.h.

◆ WithExportTaskIdentifier() [3/3]

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::WithExportTaskIdentifier ( const char *  value)
inline

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

Definition at line 85 of file StartExportTaskResult.h.

◆ WithFailureCause() [1/3]

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::WithFailureCause ( Aws::String &&  value)
inline

The reason the export failed, if it failed.

Definition at line 590 of file StartExportTaskResult.h.

◆ WithFailureCause() [2/3]

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::WithFailureCause ( const Aws::String value)
inline

The reason the export failed, if it failed.

Definition at line 585 of file StartExportTaskResult.h.

◆ WithFailureCause() [3/3]

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::WithFailureCause ( const char *  value)
inline

The reason the export failed, if it failed.

Definition at line 595 of file StartExportTaskResult.h.

◆ WithIamRoleArn() [1/3]

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::WithIamRoleArn ( Aws::String &&  value)
inline

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

Definition at line 428 of file StartExportTaskResult.h.

◆ WithIamRoleArn() [2/3]

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::WithIamRoleArn ( const Aws::String value)
inline

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

Definition at line 422 of file StartExportTaskResult.h.

◆ WithIamRoleArn() [3/3]

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::WithIamRoleArn ( const char *  value)
inline

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

Definition at line 434 of file StartExportTaskResult.h.

◆ WithKmsKeyId() [1/3]

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::WithKmsKeyId ( Aws::String &&  value)
inline

The key identifier of the Amazon Web Services KMS key that is used to encrypt the snapshot 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 snapshot export must have encryption and decryption permissions to use this KMS key.

Definition at line 483 of file StartExportTaskResult.h.

◆ WithKmsKeyId() [2/3]

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::WithKmsKeyId ( const Aws::String value)
inline

The key identifier of the Amazon Web Services KMS key that is used to encrypt the snapshot 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 snapshot export must have encryption and decryption permissions to use this KMS key.

Definition at line 475 of file StartExportTaskResult.h.

◆ WithKmsKeyId() [3/3]

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::WithKmsKeyId ( const char *  value)
inline

The key identifier of the Amazon Web Services KMS key that is used to encrypt the snapshot 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 snapshot export must have encryption and decryption permissions to use this KMS key.

Definition at line 491 of file StartExportTaskResult.h.

◆ WithPercentProgress()

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::WithPercentProgress ( int  value)
inline

The progress of the snapshot export task as a percentage.

Definition at line 543 of file StartExportTaskResult.h.

◆ WithResponseMetadata() [1/2]

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::WithResponseMetadata ( const ResponseMetadata value)
inline

Definition at line 644 of file StartExportTaskResult.h.

◆ WithResponseMetadata() [2/2]

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::WithResponseMetadata ( ResponseMetadata &&  value)
inline

Definition at line 647 of file StartExportTaskResult.h.

◆ WithS3Bucket() [1/3]

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::WithS3Bucket ( Aws::String &&  value)
inline

The Amazon S3 bucket that the snapshot is exported to.

Definition at line 343 of file StartExportTaskResult.h.

◆ WithS3Bucket() [2/3]

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::WithS3Bucket ( const Aws::String value)
inline

The Amazon S3 bucket that the snapshot is exported to.

Definition at line 338 of file StartExportTaskResult.h.

◆ WithS3Bucket() [3/3]

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::WithS3Bucket ( const char *  value)
inline

The Amazon S3 bucket that the snapshot is exported to.

Definition at line 348 of file StartExportTaskResult.h.

◆ WithS3Prefix() [1/3]

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::WithS3Prefix ( Aws::String &&  value)
inline

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

Definition at line 385 of file StartExportTaskResult.h.

◆ WithS3Prefix() [2/3]

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::WithS3Prefix ( const Aws::String value)
inline

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

Definition at line 379 of file StartExportTaskResult.h.

◆ WithS3Prefix() [3/3]

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::WithS3Prefix ( const char *  value)
inline

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

Definition at line 391 of file StartExportTaskResult.h.

◆ WithSnapshotTime() [1/2]

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::WithSnapshotTime ( Aws::Utils::DateTime &&  value)
inline

The time that the snapshot was created.

Definition at line 260 of file StartExportTaskResult.h.

◆ WithSnapshotTime() [2/2]

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::WithSnapshotTime ( const Aws::Utils::DateTime value)
inline

The time that the snapshot was created.

Definition at line 255 of file StartExportTaskResult.h.

◆ WithSourceArn() [1/3]

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::WithSourceArn ( Aws::String &&  value)
inline

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

Definition at line 116 of file StartExportTaskResult.h.

◆ WithSourceArn() [2/3]

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::WithSourceArn ( const Aws::String value)
inline

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

Definition at line 111 of file StartExportTaskResult.h.

◆ WithSourceArn() [3/3]

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::WithSourceArn ( const char *  value)
inline

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

Definition at line 121 of file StartExportTaskResult.h.

◆ WithStatus() [1/3]

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::WithStatus ( Aws::String &&  value)
inline

The progress status of the export task.

Definition at line 522 of file StartExportTaskResult.h.

◆ WithStatus() [2/3]

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::WithStatus ( const Aws::String value)
inline

The progress status of the export task.

Definition at line 517 of file StartExportTaskResult.h.

◆ WithStatus() [3/3]

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::WithStatus ( const char *  value)
inline

The progress status of the export task.

Definition at line 527 of file StartExportTaskResult.h.

◆ WithTaskEndTime() [1/2]

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::WithTaskEndTime ( Aws::Utils::DateTime &&  value)
inline

The time that the snapshot export task completed.

Definition at line 312 of file StartExportTaskResult.h.

◆ WithTaskEndTime() [2/2]

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::WithTaskEndTime ( const Aws::Utils::DateTime value)
inline

The time that the snapshot export task completed.

Definition at line 307 of file StartExportTaskResult.h.

◆ WithTaskStartTime() [1/2]

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::WithTaskStartTime ( Aws::Utils::DateTime &&  value)
inline

The time that the snapshot export task started.

Definition at line 286 of file StartExportTaskResult.h.

◆ WithTaskStartTime() [2/2]

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::WithTaskStartTime ( const Aws::Utils::DateTime value)
inline

The time that the snapshot export task started.

Definition at line 281 of file StartExportTaskResult.h.

◆ WithTotalExtractedDataInGB()

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::WithTotalExtractedDataInGB ( int  value)
inline

The total amount of data exported, in gigabytes.

Definition at line 559 of file StartExportTaskResult.h.

◆ WithWarningMessage() [1/3]

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::WithWarningMessage ( Aws::String &&  value)
inline

A warning about the snapshot export task.

Definition at line 626 of file StartExportTaskResult.h.

◆ WithWarningMessage() [2/3]

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::WithWarningMessage ( const Aws::String value)
inline

A warning about the snapshot export task.

Definition at line 621 of file StartExportTaskResult.h.

◆ WithWarningMessage() [3/3]

StartExportTaskResult& Aws::RDS::Model::StartExportTaskResult::WithWarningMessage ( const char *  value)
inline

A warning about the snapshot export task.

Definition at line 631 of file StartExportTaskResult.h.


The documentation for this class was generated from the following file: