AWS SDK for C++  1.8.54
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::RDS::Model::StartExportTaskRequest Class Reference

#include <StartExportTaskRequest.h>

+ Inheritance diagram for Aws::RDS::Model::StartExportTaskRequest:

Public Member Functions

 StartExportTaskRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetExportTaskIdentifier () const
 
bool ExportTaskIdentifierHasBeenSet () const
 
void SetExportTaskIdentifier (const Aws::String &value)
 
void SetExportTaskIdentifier (Aws::String &&value)
 
void SetExportTaskIdentifier (const char *value)
 
StartExportTaskRequestWithExportTaskIdentifier (const Aws::String &value)
 
StartExportTaskRequestWithExportTaskIdentifier (Aws::String &&value)
 
StartExportTaskRequestWithExportTaskIdentifier (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)
 
StartExportTaskRequestWithSourceArn (const Aws::String &value)
 
StartExportTaskRequestWithSourceArn (Aws::String &&value)
 
StartExportTaskRequestWithSourceArn (const char *value)
 
const Aws::StringGetS3BucketName () const
 
bool S3BucketNameHasBeenSet () const
 
void SetS3BucketName (const Aws::String &value)
 
void SetS3BucketName (Aws::String &&value)
 
void SetS3BucketName (const char *value)
 
StartExportTaskRequestWithS3BucketName (const Aws::String &value)
 
StartExportTaskRequestWithS3BucketName (Aws::String &&value)
 
StartExportTaskRequestWithS3BucketName (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)
 
StartExportTaskRequestWithIamRoleArn (const Aws::String &value)
 
StartExportTaskRequestWithIamRoleArn (Aws::String &&value)
 
StartExportTaskRequestWithIamRoleArn (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)
 
StartExportTaskRequestWithKmsKeyId (const Aws::String &value)
 
StartExportTaskRequestWithKmsKeyId (Aws::String &&value)
 
StartExportTaskRequestWithKmsKeyId (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)
 
StartExportTaskRequestWithS3Prefix (const Aws::String &value)
 
StartExportTaskRequestWithS3Prefix (Aws::String &&value)
 
StartExportTaskRequestWithS3Prefix (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)
 
StartExportTaskRequestWithExportOnly (const Aws::Vector< Aws::String > &value)
 
StartExportTaskRequestWithExportOnly (Aws::Vector< Aws::String > &&value)
 
StartExportTaskRequestAddExportOnly (const Aws::String &value)
 
StartExportTaskRequestAddExportOnly (Aws::String &&value)
 
StartExportTaskRequestAddExportOnly (const char *value)
 
- Public Member Functions inherited from Aws::RDS::RDSRequest
virtual ~RDSRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::RDS::RDSRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Definition at line 22 of file StartExportTaskRequest.h.

Constructor & Destructor Documentation

◆ StartExportTaskRequest()

Aws::RDS::Model::StartExportTaskRequest::StartExportTaskRequest ( )

Member Function Documentation

◆ AddExportOnly() [1/3]

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

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.

Definition at line 493 of file StartExportTaskRequest.h.

◆ AddExportOnly() [2/3]

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

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.

Definition at line 508 of file StartExportTaskRequest.h.

◆ AddExportOnly() [3/3]

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

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.

Definition at line 523 of file StartExportTaskRequest.h.

◆ DumpBodyToUrl()

void Aws::RDS::Model::StartExportTaskRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ ExportOnlyHasBeenSet()

bool Aws::RDS::Model::StartExportTaskRequest::ExportOnlyHasBeenSet ( ) const
inline

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.

Definition at line 418 of file StartExportTaskRequest.h.

◆ ExportTaskIdentifierHasBeenSet()

bool Aws::RDS::Model::StartExportTaskRequest::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 to be exported to.

Definition at line 50 of file StartExportTaskRequest.h.

◆ GetExportOnly()

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

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.

Definition at line 403 of file StartExportTaskRequest.h.

◆ GetExportTaskIdentifier()

const Aws::String& Aws::RDS::Model::StartExportTaskRequest::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 to be exported to.

Definition at line 44 of file StartExportTaskRequest.h.

◆ GetIamRoleArn()

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

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

Definition at line 175 of file StartExportTaskRequest.h.

◆ GetKmsKeyId()

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

The ID of the AWS KMS key to use to encrypt the snapshot exported to Amazon S3. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key. The caller of this operation must be authorized to execute the following operations. These can be set in the KMS key policy:

  • GrantOperation.Encrypt

  • GrantOperation.Decrypt

  • GrantOperation.GenerateDataKey

  • GrantOperation.GenerateDataKeyWithoutPlaintext

  • GrantOperation.ReEncryptFrom

  • GrantOperation.ReEncryptTo

  • GrantOperation.CreateGrant

  • GrantOperation.DescribeKey

  • GrantOperation.RetireGrant

Definition at line 233 of file StartExportTaskRequest.h.

◆ GetS3BucketName()

const Aws::String& Aws::RDS::Model::StartExportTaskRequest::GetS3BucketName ( ) const
inline

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

Definition at line 133 of file StartExportTaskRequest.h.

◆ GetS3Prefix()

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

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

Definition at line 345 of file StartExportTaskRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::RDS::Model::StartExportTaskRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file StartExportTaskRequest.h.

◆ GetSourceArn()

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

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

Definition at line 92 of file StartExportTaskRequest.h.

◆ IamRoleArnHasBeenSet()

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

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

Definition at line 181 of file StartExportTaskRequest.h.

◆ KmsKeyIdHasBeenSet()

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

The ID of the AWS KMS key to use to encrypt the snapshot exported to Amazon S3. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key. The caller of this operation must be authorized to execute the following operations. These can be set in the KMS key policy:

  • GrantOperation.Encrypt

  • GrantOperation.Decrypt

  • GrantOperation.GenerateDataKey

  • GrantOperation.GenerateDataKeyWithoutPlaintext

  • GrantOperation.ReEncryptFrom

  • GrantOperation.ReEncryptTo

  • GrantOperation.CreateGrant

  • GrantOperation.DescribeKey

  • GrantOperation.RetireGrant

Definition at line 248 of file StartExportTaskRequest.h.

◆ S3BucketNameHasBeenSet()

bool Aws::RDS::Model::StartExportTaskRequest::S3BucketNameHasBeenSet ( ) const
inline

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

Definition at line 138 of file StartExportTaskRequest.h.

◆ S3PrefixHasBeenSet()

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

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

Definition at line 351 of file StartExportTaskRequest.h.

◆ SerializePayload()

Aws::String Aws::RDS::Model::StartExportTaskRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetExportOnly() [1/2]

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

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.

Definition at line 433 of file StartExportTaskRequest.h.

◆ SetExportOnly() [2/2]

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

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.

Definition at line 448 of file StartExportTaskRequest.h.

◆ SetExportTaskIdentifier() [1/3]

void Aws::RDS::Model::StartExportTaskRequest::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 to be exported to.

Definition at line 56 of file StartExportTaskRequest.h.

◆ SetExportTaskIdentifier() [2/3]

void Aws::RDS::Model::StartExportTaskRequest::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 to be exported to.

Definition at line 62 of file StartExportTaskRequest.h.

◆ SetExportTaskIdentifier() [3/3]

void Aws::RDS::Model::StartExportTaskRequest::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 to be exported to.

Definition at line 68 of file StartExportTaskRequest.h.

◆ SetIamRoleArn() [1/3]

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

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

Definition at line 187 of file StartExportTaskRequest.h.

◆ SetIamRoleArn() [2/3]

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

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

Definition at line 193 of file StartExportTaskRequest.h.

◆ SetIamRoleArn() [3/3]

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

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

Definition at line 199 of file StartExportTaskRequest.h.

◆ SetKmsKeyId() [1/3]

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

The ID of the AWS KMS key to use to encrypt the snapshot exported to Amazon S3. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key. The caller of this operation must be authorized to execute the following operations. These can be set in the KMS key policy:

  • GrantOperation.Encrypt

  • GrantOperation.Decrypt

  • GrantOperation.GenerateDataKey

  • GrantOperation.GenerateDataKeyWithoutPlaintext

  • GrantOperation.ReEncryptFrom

  • GrantOperation.ReEncryptTo

  • GrantOperation.CreateGrant

  • GrantOperation.DescribeKey

  • GrantOperation.RetireGrant

Definition at line 263 of file StartExportTaskRequest.h.

◆ SetKmsKeyId() [2/3]

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

The ID of the AWS KMS key to use to encrypt the snapshot exported to Amazon S3. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key. The caller of this operation must be authorized to execute the following operations. These can be set in the KMS key policy:

  • GrantOperation.Encrypt

  • GrantOperation.Decrypt

  • GrantOperation.GenerateDataKey

  • GrantOperation.GenerateDataKeyWithoutPlaintext

  • GrantOperation.ReEncryptFrom

  • GrantOperation.ReEncryptTo

  • GrantOperation.CreateGrant

  • GrantOperation.DescribeKey

  • GrantOperation.RetireGrant

Definition at line 278 of file StartExportTaskRequest.h.

◆ SetKmsKeyId() [3/3]

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

The ID of the AWS KMS key to use to encrypt the snapshot exported to Amazon S3. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key. The caller of this operation must be authorized to execute the following operations. These can be set in the KMS key policy:

  • GrantOperation.Encrypt

  • GrantOperation.Decrypt

  • GrantOperation.GenerateDataKey

  • GrantOperation.GenerateDataKeyWithoutPlaintext

  • GrantOperation.ReEncryptFrom

  • GrantOperation.ReEncryptTo

  • GrantOperation.CreateGrant

  • GrantOperation.DescribeKey

  • GrantOperation.RetireGrant

Definition at line 293 of file StartExportTaskRequest.h.

◆ SetS3BucketName() [1/3]

void Aws::RDS::Model::StartExportTaskRequest::SetS3BucketName ( const Aws::String value)
inline

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

Definition at line 143 of file StartExportTaskRequest.h.

◆ SetS3BucketName() [2/3]

void Aws::RDS::Model::StartExportTaskRequest::SetS3BucketName ( Aws::String &&  value)
inline

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

Definition at line 148 of file StartExportTaskRequest.h.

◆ SetS3BucketName() [3/3]

void Aws::RDS::Model::StartExportTaskRequest::SetS3BucketName ( const char *  value)
inline

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

Definition at line 153 of file StartExportTaskRequest.h.

◆ SetS3Prefix() [1/3]

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

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

Definition at line 357 of file StartExportTaskRequest.h.

◆ SetS3Prefix() [2/3]

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

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

Definition at line 363 of file StartExportTaskRequest.h.

◆ SetS3Prefix() [3/3]

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

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

Definition at line 369 of file StartExportTaskRequest.h.

◆ SetSourceArn() [1/3]

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

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

Definition at line 102 of file StartExportTaskRequest.h.

◆ SetSourceArn() [2/3]

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

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

Definition at line 107 of file StartExportTaskRequest.h.

◆ SetSourceArn() [3/3]

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

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

Definition at line 112 of file StartExportTaskRequest.h.

◆ SourceArnHasBeenSet()

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

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

Definition at line 97 of file StartExportTaskRequest.h.

◆ WithExportOnly() [1/2]

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

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.

Definition at line 463 of file StartExportTaskRequest.h.

◆ WithExportOnly() [2/2]

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

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.

Definition at line 478 of file StartExportTaskRequest.h.

◆ WithExportTaskIdentifier() [1/3]

StartExportTaskRequest& Aws::RDS::Model::StartExportTaskRequest::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 to be exported to.

Definition at line 74 of file StartExportTaskRequest.h.

◆ WithExportTaskIdentifier() [2/3]

StartExportTaskRequest& Aws::RDS::Model::StartExportTaskRequest::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 to be exported to.

Definition at line 80 of file StartExportTaskRequest.h.

◆ WithExportTaskIdentifier() [3/3]

StartExportTaskRequest& Aws::RDS::Model::StartExportTaskRequest::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 to be exported to.

Definition at line 86 of file StartExportTaskRequest.h.

◆ WithIamRoleArn() [1/3]

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

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

Definition at line 205 of file StartExportTaskRequest.h.

◆ WithIamRoleArn() [2/3]

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

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

Definition at line 211 of file StartExportTaskRequest.h.

◆ WithIamRoleArn() [3/3]

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

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

Definition at line 217 of file StartExportTaskRequest.h.

◆ WithKmsKeyId() [1/3]

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

The ID of the AWS KMS key to use to encrypt the snapshot exported to Amazon S3. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key. The caller of this operation must be authorized to execute the following operations. These can be set in the KMS key policy:

  • GrantOperation.Encrypt

  • GrantOperation.Decrypt

  • GrantOperation.GenerateDataKey

  • GrantOperation.GenerateDataKeyWithoutPlaintext

  • GrantOperation.ReEncryptFrom

  • GrantOperation.ReEncryptTo

  • GrantOperation.CreateGrant

  • GrantOperation.DescribeKey

  • GrantOperation.RetireGrant

Definition at line 308 of file StartExportTaskRequest.h.

◆ WithKmsKeyId() [2/3]

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

The ID of the AWS KMS key to use to encrypt the snapshot exported to Amazon S3. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key. The caller of this operation must be authorized to execute the following operations. These can be set in the KMS key policy:

  • GrantOperation.Encrypt

  • GrantOperation.Decrypt

  • GrantOperation.GenerateDataKey

  • GrantOperation.GenerateDataKeyWithoutPlaintext

  • GrantOperation.ReEncryptFrom

  • GrantOperation.ReEncryptTo

  • GrantOperation.CreateGrant

  • GrantOperation.DescribeKey

  • GrantOperation.RetireGrant

Definition at line 323 of file StartExportTaskRequest.h.

◆ WithKmsKeyId() [3/3]

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

The ID of the AWS KMS key to use to encrypt the snapshot exported to Amazon S3. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key. The caller of this operation must be authorized to execute the following operations. These can be set in the KMS key policy:

  • GrantOperation.Encrypt

  • GrantOperation.Decrypt

  • GrantOperation.GenerateDataKey

  • GrantOperation.GenerateDataKeyWithoutPlaintext

  • GrantOperation.ReEncryptFrom

  • GrantOperation.ReEncryptTo

  • GrantOperation.CreateGrant

  • GrantOperation.DescribeKey

  • GrantOperation.RetireGrant

Definition at line 338 of file StartExportTaskRequest.h.

◆ WithS3BucketName() [1/3]

StartExportTaskRequest& Aws::RDS::Model::StartExportTaskRequest::WithS3BucketName ( const Aws::String value)
inline

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

Definition at line 158 of file StartExportTaskRequest.h.

◆ WithS3BucketName() [2/3]

StartExportTaskRequest& Aws::RDS::Model::StartExportTaskRequest::WithS3BucketName ( Aws::String &&  value)
inline

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

Definition at line 163 of file StartExportTaskRequest.h.

◆ WithS3BucketName() [3/3]

StartExportTaskRequest& Aws::RDS::Model::StartExportTaskRequest::WithS3BucketName ( const char *  value)
inline

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

Definition at line 168 of file StartExportTaskRequest.h.

◆ WithS3Prefix() [1/3]

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

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

Definition at line 375 of file StartExportTaskRequest.h.

◆ WithS3Prefix() [2/3]

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

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

Definition at line 381 of file StartExportTaskRequest.h.

◆ WithS3Prefix() [3/3]

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

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

Definition at line 387 of file StartExportTaskRequest.h.

◆ WithSourceArn() [1/3]

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

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

Definition at line 117 of file StartExportTaskRequest.h.

◆ WithSourceArn() [2/3]

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

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

Definition at line 122 of file StartExportTaskRequest.h.

◆ WithSourceArn() [3/3]

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

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

Definition at line 127 of file StartExportTaskRequest.h.


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