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

#include <ExportTask.h>

Public Member Functions

 ExportTask ()
 
 ExportTask (const Aws::Utils::Xml::XmlNode &xmlNode)
 
ExportTaskoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void OutputToStream (Aws::OStream &ostream, const char *location, unsigned index, const char *locationValue) const
 
void OutputToStream (Aws::OStream &oStream, const char *location) const
 
const Aws::StringGetExportTaskIdentifier () const
 
bool ExportTaskIdentifierHasBeenSet () const
 
void SetExportTaskIdentifier (const Aws::String &value)
 
void SetExportTaskIdentifier (Aws::String &&value)
 
void SetExportTaskIdentifier (const char *value)
 
ExportTaskWithExportTaskIdentifier (const Aws::String &value)
 
ExportTaskWithExportTaskIdentifier (Aws::String &&value)
 
ExportTaskWithExportTaskIdentifier (const char *value)
 
const Aws::StringGetSourceArn () const
 
bool SourceArnHasBeenSet () const
 
void SetSourceArn (const Aws::String &value)
 
void SetSourceArn (Aws::String &&value)
 
void SetSourceArn (const char *value)
 
ExportTaskWithSourceArn (const Aws::String &value)
 
ExportTaskWithSourceArn (Aws::String &&value)
 
ExportTaskWithSourceArn (const char *value)
 
const Aws::Vector< Aws::String > & GetExportOnly () const
 
bool ExportOnlyHasBeenSet () const
 
void SetExportOnly (const Aws::Vector< Aws::String > &value)
 
void SetExportOnly (Aws::Vector< Aws::String > &&value)
 
ExportTaskWithExportOnly (const Aws::Vector< Aws::String > &value)
 
ExportTaskWithExportOnly (Aws::Vector< Aws::String > &&value)
 
ExportTaskAddExportOnly (const Aws::String &value)
 
ExportTaskAddExportOnly (Aws::String &&value)
 
ExportTaskAddExportOnly (const char *value)
 
const Aws::Utils::DateTimeGetSnapshotTime () const
 
bool SnapshotTimeHasBeenSet () const
 
void SetSnapshotTime (const Aws::Utils::DateTime &value)
 
void SetSnapshotTime (Aws::Utils::DateTime &&value)
 
ExportTaskWithSnapshotTime (const Aws::Utils::DateTime &value)
 
ExportTaskWithSnapshotTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetTaskStartTime () const
 
bool TaskStartTimeHasBeenSet () const
 
void SetTaskStartTime (const Aws::Utils::DateTime &value)
 
void SetTaskStartTime (Aws::Utils::DateTime &&value)
 
ExportTaskWithTaskStartTime (const Aws::Utils::DateTime &value)
 
ExportTaskWithTaskStartTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetTaskEndTime () const
 
bool TaskEndTimeHasBeenSet () const
 
void SetTaskEndTime (const Aws::Utils::DateTime &value)
 
void SetTaskEndTime (Aws::Utils::DateTime &&value)
 
ExportTaskWithTaskEndTime (const Aws::Utils::DateTime &value)
 
ExportTaskWithTaskEndTime (Aws::Utils::DateTime &&value)
 
const Aws::StringGetS3Bucket () const
 
bool S3BucketHasBeenSet () const
 
void SetS3Bucket (const Aws::String &value)
 
void SetS3Bucket (Aws::String &&value)
 
void SetS3Bucket (const char *value)
 
ExportTaskWithS3Bucket (const Aws::String &value)
 
ExportTaskWithS3Bucket (Aws::String &&value)
 
ExportTaskWithS3Bucket (const char *value)
 
const Aws::StringGetS3Prefix () const
 
bool S3PrefixHasBeenSet () const
 
void SetS3Prefix (const Aws::String &value)
 
void SetS3Prefix (Aws::String &&value)
 
void SetS3Prefix (const char *value)
 
ExportTaskWithS3Prefix (const Aws::String &value)
 
ExportTaskWithS3Prefix (Aws::String &&value)
 
ExportTaskWithS3Prefix (const char *value)
 
const Aws::StringGetIamRoleArn () const
 
bool IamRoleArnHasBeenSet () const
 
void SetIamRoleArn (const Aws::String &value)
 
void SetIamRoleArn (Aws::String &&value)
 
void SetIamRoleArn (const char *value)
 
ExportTaskWithIamRoleArn (const Aws::String &value)
 
ExportTaskWithIamRoleArn (Aws::String &&value)
 
ExportTaskWithIamRoleArn (const char *value)
 
const Aws::StringGetKmsKeyId () const
 
bool KmsKeyIdHasBeenSet () const
 
void SetKmsKeyId (const Aws::String &value)
 
void SetKmsKeyId (Aws::String &&value)
 
void SetKmsKeyId (const char *value)
 
ExportTaskWithKmsKeyId (const Aws::String &value)
 
ExportTaskWithKmsKeyId (Aws::String &&value)
 
ExportTaskWithKmsKeyId (const char *value)
 
const Aws::StringGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const Aws::String &value)
 
void SetStatus (Aws::String &&value)
 
void SetStatus (const char *value)
 
ExportTaskWithStatus (const Aws::String &value)
 
ExportTaskWithStatus (Aws::String &&value)
 
ExportTaskWithStatus (const char *value)
 
int GetPercentProgress () const
 
bool PercentProgressHasBeenSet () const
 
void SetPercentProgress (int value)
 
ExportTaskWithPercentProgress (int value)
 
int GetTotalExtractedDataInGB () const
 
bool TotalExtractedDataInGBHasBeenSet () const
 
void SetTotalExtractedDataInGB (int value)
 
ExportTaskWithTotalExtractedDataInGB (int value)
 
const Aws::StringGetFailureCause () const
 
bool FailureCauseHasBeenSet () const
 
void SetFailureCause (const Aws::String &value)
 
void SetFailureCause (Aws::String &&value)
 
void SetFailureCause (const char *value)
 
ExportTaskWithFailureCause (const Aws::String &value)
 
ExportTaskWithFailureCause (Aws::String &&value)
 
ExportTaskWithFailureCause (const char *value)
 
const Aws::StringGetWarningMessage () const
 
bool WarningMessageHasBeenSet () const
 
void SetWarningMessage (const Aws::String &value)
 
void SetWarningMessage (Aws::String &&value)
 
void SetWarningMessage (const char *value)
 
ExportTaskWithWarningMessage (const Aws::String &value)
 
ExportTaskWithWarningMessage (Aws::String &&value)
 
ExportTaskWithWarningMessage (const char *value)
 
const ResponseMetadataGetResponseMetadata () const
 
bool ResponseMetadataHasBeenSet () const
 
void SetResponseMetadata (const ResponseMetadata &value)
 
void SetResponseMetadata (ResponseMetadata &&value)
 
ExportTaskWithResponseMetadata (const ResponseMetadata &value)
 
ExportTaskWithResponseMetadata (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 36 of file ExportTask.h.

Constructor & Destructor Documentation

◆ ExportTask() [1/2]

Aws::RDS::Model::ExportTask::ExportTask ( )

◆ ExportTask() [2/2]

Aws::RDS::Model::ExportTask::ExportTask ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ AddExportOnly() [1/3]

ExportTask& Aws::RDS::Model::ExportTask::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 247 of file ExportTask.h.

◆ AddExportOnly() [2/3]

ExportTask& Aws::RDS::Model::ExportTask::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 233 of file ExportTask.h.

◆ AddExportOnly() [3/3]

ExportTask& Aws::RDS::Model::ExportTask::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 261 of file ExportTask.h.

◆ ExportOnlyHasBeenSet()

bool Aws::RDS::Model::ExportTask::ExportOnlyHasBeenSet ( ) 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 163 of file ExportTask.h.

◆ ExportTaskIdentifierHasBeenSet()

bool Aws::RDS::Model::ExportTask::ExportTaskIdentifierHasBeenSet ( ) 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 57 of file ExportTask.h.

◆ FailureCauseHasBeenSet()

bool Aws::RDS::Model::ExportTask::FailureCauseHasBeenSet ( ) const
inline

The reason the export failed, if it failed.

Definition at line 660 of file ExportTask.h.

◆ GetExportOnly()

const Aws::Vector<Aws::String>& Aws::RDS::Model::ExportTask::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 149 of file ExportTask.h.

◆ GetExportTaskIdentifier()

const Aws::String& Aws::RDS::Model::ExportTask::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 51 of file ExportTask.h.

◆ GetFailureCause()

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

The reason the export failed, if it failed.

Definition at line 655 of file ExportTask.h.

◆ GetIamRoleArn()

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

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

Definition at line 451 of file ExportTask.h.

◆ GetKmsKeyId()

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

The key identifier of the AWS KMS customer master key (CMK) that is used to encrypt the snapshot when it's exported to Amazon S3. The AWS KMS CMK 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 AWS KMS CMK.

Definition at line 503 of file ExportTask.h.

◆ GetPercentProgress()

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

The progress of the snapshot export task as a percentage.

Definition at line 613 of file ExportTask.h.

◆ GetResponseMetadata()

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

Definition at line 735 of file ExportTask.h.

◆ GetS3Bucket()

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

The Amazon S3 bucket that the snapshot is exported to.

Definition at line 360 of file ExportTask.h.

◆ GetS3Prefix()

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

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

Definition at line 402 of file ExportTask.h.

◆ GetSnapshotTime()

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

The time that the snapshot was created.

Definition at line 267 of file ExportTask.h.

◆ GetSourceArn()

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

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

Definition at line 99 of file ExportTask.h.

◆ GetStatus()

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

The progress status of the export task.

Definition at line 572 of file ExportTask.h.

◆ GetTaskEndTime()

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

The time that the snapshot export task completed.

Definition at line 329 of file ExportTask.h.

◆ GetTaskStartTime()

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

The time that the snapshot export task started.

Definition at line 298 of file ExportTask.h.

◆ GetTotalExtractedDataInGB()

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

The total amount of data exported, in gigabytes.

Definition at line 634 of file ExportTask.h.

◆ GetWarningMessage()

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

A warning about the snapshot export task.

Definition at line 696 of file ExportTask.h.

◆ IamRoleArnHasBeenSet()

bool Aws::RDS::Model::ExportTask::IamRoleArnHasBeenSet ( ) const
inline

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

Definition at line 457 of file ExportTask.h.

◆ KmsKeyIdHasBeenSet()

bool Aws::RDS::Model::ExportTask::KmsKeyIdHasBeenSet ( ) const
inline

The key identifier of the AWS KMS customer master key (CMK) that is used to encrypt the snapshot when it's exported to Amazon S3. The AWS KMS CMK 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 AWS KMS CMK.

Definition at line 512 of file ExportTask.h.

◆ operator=()

ExportTask& Aws::RDS::Model::ExportTask::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OutputToStream() [1/2]

void Aws::RDS::Model::ExportTask::OutputToStream ( Aws::OStream oStream,
const char *  location 
) const

◆ OutputToStream() [2/2]

void Aws::RDS::Model::ExportTask::OutputToStream ( Aws::OStream ostream,
const char *  location,
unsigned  index,
const char *  locationValue 
) const

◆ PercentProgressHasBeenSet()

bool Aws::RDS::Model::ExportTask::PercentProgressHasBeenSet ( ) const
inline

The progress of the snapshot export task as a percentage.

Definition at line 618 of file ExportTask.h.

◆ ResponseMetadataHasBeenSet()

bool Aws::RDS::Model::ExportTask::ResponseMetadataHasBeenSet ( ) const
inline

Definition at line 738 of file ExportTask.h.

◆ S3BucketHasBeenSet()

bool Aws::RDS::Model::ExportTask::S3BucketHasBeenSet ( ) const
inline

The Amazon S3 bucket that the snapshot is exported to.

Definition at line 365 of file ExportTask.h.

◆ S3PrefixHasBeenSet()

bool Aws::RDS::Model::ExportTask::S3PrefixHasBeenSet ( ) const
inline

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

Definition at line 408 of file ExportTask.h.

◆ SetExportOnly() [1/2]

void Aws::RDS::Model::ExportTask::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 191 of file ExportTask.h.

◆ SetExportOnly() [2/2]

void Aws::RDS::Model::ExportTask::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 177 of file ExportTask.h.

◆ SetExportTaskIdentifier() [1/3]

void Aws::RDS::Model::ExportTask::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 69 of file ExportTask.h.

◆ SetExportTaskIdentifier() [2/3]

void Aws::RDS::Model::ExportTask::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 63 of file ExportTask.h.

◆ SetExportTaskIdentifier() [3/3]

void Aws::RDS::Model::ExportTask::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 75 of file ExportTask.h.

◆ SetFailureCause() [1/3]

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

The reason the export failed, if it failed.

Definition at line 670 of file ExportTask.h.

◆ SetFailureCause() [2/3]

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

The reason the export failed, if it failed.

Definition at line 665 of file ExportTask.h.

◆ SetFailureCause() [3/3]

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

The reason the export failed, if it failed.

Definition at line 675 of file ExportTask.h.

◆ SetIamRoleArn() [1/3]

void Aws::RDS::Model::ExportTask::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 469 of file ExportTask.h.

◆ SetIamRoleArn() [2/3]

void Aws::RDS::Model::ExportTask::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 463 of file ExportTask.h.

◆ SetIamRoleArn() [3/3]

void Aws::RDS::Model::ExportTask::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 475 of file ExportTask.h.

◆ SetKmsKeyId() [1/3]

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

The key identifier of the AWS KMS customer master key (CMK) that is used to encrypt the snapshot when it's exported to Amazon S3. The AWS KMS CMK 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 AWS KMS CMK.

Definition at line 530 of file ExportTask.h.

◆ SetKmsKeyId() [2/3]

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

The key identifier of the AWS KMS customer master key (CMK) that is used to encrypt the snapshot when it's exported to Amazon S3. The AWS KMS CMK 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 AWS KMS CMK.

Definition at line 521 of file ExportTask.h.

◆ SetKmsKeyId() [3/3]

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

The key identifier of the AWS KMS customer master key (CMK) that is used to encrypt the snapshot when it's exported to Amazon S3. The AWS KMS CMK 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 AWS KMS CMK.

Definition at line 539 of file ExportTask.h.

◆ SetPercentProgress()

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

The progress of the snapshot export task as a percentage.

Definition at line 623 of file ExportTask.h.

◆ SetResponseMetadata() [1/2]

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

Definition at line 741 of file ExportTask.h.

◆ SetResponseMetadata() [2/2]

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

Definition at line 744 of file ExportTask.h.

◆ SetS3Bucket() [1/3]

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

The Amazon S3 bucket that the snapshot is exported to.

Definition at line 375 of file ExportTask.h.

◆ SetS3Bucket() [2/3]

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

The Amazon S3 bucket that the snapshot is exported to.

Definition at line 370 of file ExportTask.h.

◆ SetS3Bucket() [3/3]

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

The Amazon S3 bucket that the snapshot is exported to.

Definition at line 380 of file ExportTask.h.

◆ SetS3Prefix() [1/3]

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

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

Definition at line 420 of file ExportTask.h.

◆ SetS3Prefix() [2/3]

void Aws::RDS::Model::ExportTask::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 414 of file ExportTask.h.

◆ SetS3Prefix() [3/3]

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

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

Definition at line 426 of file ExportTask.h.

◆ SetSnapshotTime() [1/2]

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

The time that the snapshot was created.

Definition at line 282 of file ExportTask.h.

◆ SetSnapshotTime() [2/2]

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

The time that the snapshot was created.

Definition at line 277 of file ExportTask.h.

◆ SetSourceArn() [1/3]

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

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

Definition at line 114 of file ExportTask.h.

◆ SetSourceArn() [2/3]

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

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

Definition at line 109 of file ExportTask.h.

◆ SetSourceArn() [3/3]

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

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

Definition at line 119 of file ExportTask.h.

◆ SetStatus() [1/3]

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

The progress status of the export task.

Definition at line 587 of file ExportTask.h.

◆ SetStatus() [2/3]

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

The progress status of the export task.

Definition at line 582 of file ExportTask.h.

◆ SetStatus() [3/3]

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

The progress status of the export task.

Definition at line 592 of file ExportTask.h.

◆ SetTaskEndTime() [1/2]

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

The time that the snapshot export task completed.

Definition at line 344 of file ExportTask.h.

◆ SetTaskEndTime() [2/2]

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

The time that the snapshot export task completed.

Definition at line 339 of file ExportTask.h.

◆ SetTaskStartTime() [1/2]

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

The time that the snapshot export task started.

Definition at line 313 of file ExportTask.h.

◆ SetTaskStartTime() [2/2]

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

The time that the snapshot export task started.

Definition at line 308 of file ExportTask.h.

◆ SetTotalExtractedDataInGB()

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

The total amount of data exported, in gigabytes.

Definition at line 644 of file ExportTask.h.

◆ SetWarningMessage() [1/3]

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

A warning about the snapshot export task.

Definition at line 711 of file ExportTask.h.

◆ SetWarningMessage() [2/3]

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

A warning about the snapshot export task.

Definition at line 706 of file ExportTask.h.

◆ SetWarningMessage() [3/3]

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

A warning about the snapshot export task.

Definition at line 716 of file ExportTask.h.

◆ SnapshotTimeHasBeenSet()

bool Aws::RDS::Model::ExportTask::SnapshotTimeHasBeenSet ( ) const
inline

The time that the snapshot was created.

Definition at line 272 of file ExportTask.h.

◆ SourceArnHasBeenSet()

bool Aws::RDS::Model::ExportTask::SourceArnHasBeenSet ( ) const
inline

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

Definition at line 104 of file ExportTask.h.

◆ StatusHasBeenSet()

bool Aws::RDS::Model::ExportTask::StatusHasBeenSet ( ) const
inline

The progress status of the export task.

Definition at line 577 of file ExportTask.h.

◆ TaskEndTimeHasBeenSet()

bool Aws::RDS::Model::ExportTask::TaskEndTimeHasBeenSet ( ) const
inline

The time that the snapshot export task completed.

Definition at line 334 of file ExportTask.h.

◆ TaskStartTimeHasBeenSet()

bool Aws::RDS::Model::ExportTask::TaskStartTimeHasBeenSet ( ) const
inline

The time that the snapshot export task started.

Definition at line 303 of file ExportTask.h.

◆ TotalExtractedDataInGBHasBeenSet()

bool Aws::RDS::Model::ExportTask::TotalExtractedDataInGBHasBeenSet ( ) const
inline

The total amount of data exported, in gigabytes.

Definition at line 639 of file ExportTask.h.

◆ WarningMessageHasBeenSet()

bool Aws::RDS::Model::ExportTask::WarningMessageHasBeenSet ( ) const
inline

A warning about the snapshot export task.

Definition at line 701 of file ExportTask.h.

◆ WithExportOnly() [1/2]

ExportTask& Aws::RDS::Model::ExportTask::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 219 of file ExportTask.h.

◆ WithExportOnly() [2/2]

ExportTask& Aws::RDS::Model::ExportTask::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 205 of file ExportTask.h.

◆ WithExportTaskIdentifier() [1/3]

ExportTask& Aws::RDS::Model::ExportTask::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 87 of file ExportTask.h.

◆ WithExportTaskIdentifier() [2/3]

ExportTask& Aws::RDS::Model::ExportTask::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 81 of file ExportTask.h.

◆ WithExportTaskIdentifier() [3/3]

ExportTask& Aws::RDS::Model::ExportTask::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 93 of file ExportTask.h.

◆ WithFailureCause() [1/3]

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

The reason the export failed, if it failed.

Definition at line 685 of file ExportTask.h.

◆ WithFailureCause() [2/3]

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

The reason the export failed, if it failed.

Definition at line 680 of file ExportTask.h.

◆ WithFailureCause() [3/3]

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

The reason the export failed, if it failed.

Definition at line 690 of file ExportTask.h.

◆ WithIamRoleArn() [1/3]

ExportTask& Aws::RDS::Model::ExportTask::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 487 of file ExportTask.h.

◆ WithIamRoleArn() [2/3]

ExportTask& Aws::RDS::Model::ExportTask::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 481 of file ExportTask.h.

◆ WithIamRoleArn() [3/3]

ExportTask& Aws::RDS::Model::ExportTask::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 493 of file ExportTask.h.

◆ WithKmsKeyId() [1/3]

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

The key identifier of the AWS KMS customer master key (CMK) that is used to encrypt the snapshot when it's exported to Amazon S3. The AWS KMS CMK 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 AWS KMS CMK.

Definition at line 557 of file ExportTask.h.

◆ WithKmsKeyId() [2/3]

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

The key identifier of the AWS KMS customer master key (CMK) that is used to encrypt the snapshot when it's exported to Amazon S3. The AWS KMS CMK 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 AWS KMS CMK.

Definition at line 548 of file ExportTask.h.

◆ WithKmsKeyId() [3/3]

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

The key identifier of the AWS KMS customer master key (CMK) that is used to encrypt the snapshot when it's exported to Amazon S3. The AWS KMS CMK 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 AWS KMS CMK.

Definition at line 566 of file ExportTask.h.

◆ WithPercentProgress()

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

The progress of the snapshot export task as a percentage.

Definition at line 628 of file ExportTask.h.

◆ WithResponseMetadata() [1/2]

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

Definition at line 747 of file ExportTask.h.

◆ WithResponseMetadata() [2/2]

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

Definition at line 750 of file ExportTask.h.

◆ WithS3Bucket() [1/3]

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

The Amazon S3 bucket that the snapshot is exported to.

Definition at line 390 of file ExportTask.h.

◆ WithS3Bucket() [2/3]

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

The Amazon S3 bucket that the snapshot is exported to.

Definition at line 385 of file ExportTask.h.

◆ WithS3Bucket() [3/3]

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

The Amazon S3 bucket that the snapshot is exported to.

Definition at line 395 of file ExportTask.h.

◆ WithS3Prefix() [1/3]

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

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

Definition at line 438 of file ExportTask.h.

◆ WithS3Prefix() [2/3]

ExportTask& Aws::RDS::Model::ExportTask::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 432 of file ExportTask.h.

◆ WithS3Prefix() [3/3]

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

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

Definition at line 444 of file ExportTask.h.

◆ WithSnapshotTime() [1/2]

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

The time that the snapshot was created.

Definition at line 292 of file ExportTask.h.

◆ WithSnapshotTime() [2/2]

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

The time that the snapshot was created.

Definition at line 287 of file ExportTask.h.

◆ WithSourceArn() [1/3]

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

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

Definition at line 129 of file ExportTask.h.

◆ WithSourceArn() [2/3]

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

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

Definition at line 124 of file ExportTask.h.

◆ WithSourceArn() [3/3]

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

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

Definition at line 134 of file ExportTask.h.

◆ WithStatus() [1/3]

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

The progress status of the export task.

Definition at line 602 of file ExportTask.h.

◆ WithStatus() [2/3]

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

The progress status of the export task.

Definition at line 597 of file ExportTask.h.

◆ WithStatus() [3/3]

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

The progress status of the export task.

Definition at line 607 of file ExportTask.h.

◆ WithTaskEndTime() [1/2]

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

The time that the snapshot export task completed.

Definition at line 354 of file ExportTask.h.

◆ WithTaskEndTime() [2/2]

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

The time that the snapshot export task completed.

Definition at line 349 of file ExportTask.h.

◆ WithTaskStartTime() [1/2]

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

The time that the snapshot export task started.

Definition at line 323 of file ExportTask.h.

◆ WithTaskStartTime() [2/2]

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

The time that the snapshot export task started.

Definition at line 318 of file ExportTask.h.

◆ WithTotalExtractedDataInGB()

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

The total amount of data exported, in gigabytes.

Definition at line 649 of file ExportTask.h.

◆ WithWarningMessage() [1/3]

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

A warning about the snapshot export task.

Definition at line 726 of file ExportTask.h.

◆ WithWarningMessage() [2/3]

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

A warning about the snapshot export task.

Definition at line 721 of file ExportTask.h.

◆ WithWarningMessage() [3/3]

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

A warning about the snapshot export task.

Definition at line 731 of file ExportTask.h.


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