AWS SDK for C++  1.8.54
AWS SDK for C++
Public Member Functions | List of all members
Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest Class Reference

#include <ModifyReplicationTaskRequest.h>

+ Inheritance diagram for Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest:

Public Member Functions

 ModifyReplicationTaskRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetReplicationTaskArn () const
 
bool ReplicationTaskArnHasBeenSet () const
 
void SetReplicationTaskArn (const Aws::String &value)
 
void SetReplicationTaskArn (Aws::String &&value)
 
void SetReplicationTaskArn (const char *value)
 
ModifyReplicationTaskRequestWithReplicationTaskArn (const Aws::String &value)
 
ModifyReplicationTaskRequestWithReplicationTaskArn (Aws::String &&value)
 
ModifyReplicationTaskRequestWithReplicationTaskArn (const char *value)
 
const Aws::StringGetReplicationTaskIdentifier () const
 
bool ReplicationTaskIdentifierHasBeenSet () const
 
void SetReplicationTaskIdentifier (const Aws::String &value)
 
void SetReplicationTaskIdentifier (Aws::String &&value)
 
void SetReplicationTaskIdentifier (const char *value)
 
ModifyReplicationTaskRequestWithReplicationTaskIdentifier (const Aws::String &value)
 
ModifyReplicationTaskRequestWithReplicationTaskIdentifier (Aws::String &&value)
 
ModifyReplicationTaskRequestWithReplicationTaskIdentifier (const char *value)
 
const MigrationTypeValueGetMigrationType () const
 
bool MigrationTypeHasBeenSet () const
 
void SetMigrationType (const MigrationTypeValue &value)
 
void SetMigrationType (MigrationTypeValue &&value)
 
ModifyReplicationTaskRequestWithMigrationType (const MigrationTypeValue &value)
 
ModifyReplicationTaskRequestWithMigrationType (MigrationTypeValue &&value)
 
const Aws::StringGetTableMappings () const
 
bool TableMappingsHasBeenSet () const
 
void SetTableMappings (const Aws::String &value)
 
void SetTableMappings (Aws::String &&value)
 
void SetTableMappings (const char *value)
 
ModifyReplicationTaskRequestWithTableMappings (const Aws::String &value)
 
ModifyReplicationTaskRequestWithTableMappings (Aws::String &&value)
 
ModifyReplicationTaskRequestWithTableMappings (const char *value)
 
const Aws::StringGetReplicationTaskSettings () const
 
bool ReplicationTaskSettingsHasBeenSet () const
 
void SetReplicationTaskSettings (const Aws::String &value)
 
void SetReplicationTaskSettings (Aws::String &&value)
 
void SetReplicationTaskSettings (const char *value)
 
ModifyReplicationTaskRequestWithReplicationTaskSettings (const Aws::String &value)
 
ModifyReplicationTaskRequestWithReplicationTaskSettings (Aws::String &&value)
 
ModifyReplicationTaskRequestWithReplicationTaskSettings (const char *value)
 
const Aws::Utils::DateTimeGetCdcStartTime () const
 
bool CdcStartTimeHasBeenSet () const
 
void SetCdcStartTime (const Aws::Utils::DateTime &value)
 
void SetCdcStartTime (Aws::Utils::DateTime &&value)
 
ModifyReplicationTaskRequestWithCdcStartTime (const Aws::Utils::DateTime &value)
 
ModifyReplicationTaskRequestWithCdcStartTime (Aws::Utils::DateTime &&value)
 
const Aws::StringGetCdcStartPosition () const
 
bool CdcStartPositionHasBeenSet () const
 
void SetCdcStartPosition (const Aws::String &value)
 
void SetCdcStartPosition (Aws::String &&value)
 
void SetCdcStartPosition (const char *value)
 
ModifyReplicationTaskRequestWithCdcStartPosition (const Aws::String &value)
 
ModifyReplicationTaskRequestWithCdcStartPosition (Aws::String &&value)
 
ModifyReplicationTaskRequestWithCdcStartPosition (const char *value)
 
const Aws::StringGetCdcStopPosition () const
 
bool CdcStopPositionHasBeenSet () const
 
void SetCdcStopPosition (const Aws::String &value)
 
void SetCdcStopPosition (Aws::String &&value)
 
void SetCdcStopPosition (const char *value)
 
ModifyReplicationTaskRequestWithCdcStopPosition (const Aws::String &value)
 
ModifyReplicationTaskRequestWithCdcStopPosition (Aws::String &&value)
 
ModifyReplicationTaskRequestWithCdcStopPosition (const char *value)
 
const Aws::StringGetTaskData () const
 
bool TaskDataHasBeenSet () const
 
void SetTaskData (const Aws::String &value)
 
void SetTaskData (Aws::String &&value)
 
void SetTaskData (const char *value)
 
ModifyReplicationTaskRequestWithTaskData (const Aws::String &value)
 
ModifyReplicationTaskRequestWithTaskData (Aws::String &&value)
 
ModifyReplicationTaskRequestWithTaskData (const char *value)
 
- Public Member Functions inherited from Aws::DatabaseMigrationService::DatabaseMigrationServiceRequest
virtual ~DatabaseMigrationServiceRequest ()
 
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
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

See Also:

AWS API Reference

Definition at line 26 of file ModifyReplicationTaskRequest.h.

Constructor & Destructor Documentation

◆ ModifyReplicationTaskRequest()

Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::ModifyReplicationTaskRequest ( )

Member Function Documentation

◆ CdcStartPositionHasBeenSet()

bool Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::CdcStartPositionHasBeenSet ( ) const
inline

Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.

The value can be in date, checkpoint, or LSN/SCN format.

Date Example: –cdc-start-position “2018-03-08T12:12:12”

Checkpoint Example: –cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"

LSN Example: –cdc-start-position “mysql-bin-changelog.000024:373”

When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the slotName extra connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for AWS DMS.

Definition at line 386 of file ModifyReplicationTaskRequest.h.

◆ CdcStartTimeHasBeenSet()

bool Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::CdcStartTimeHasBeenSet ( ) const
inline

Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.

Timestamp Example: –cdc-start-time “2018-03-08T12:12:12”

Definition at line 313 of file ModifyReplicationTaskRequest.h.

◆ CdcStopPositionHasBeenSet()

bool Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::CdcStopPositionHasBeenSet ( ) const
inline

Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

Server time example: –cdc-stop-position “server_time:2018-02-09T12:12:12”

Commit time example: –cdc-stop-position “commit_time: 2018-02-09T12:12:12 “

Definition at line 523 of file ModifyReplicationTaskRequest.h.

◆ GetCdcStartPosition()

const Aws::String& Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::GetCdcStartPosition ( ) const
inline

Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.

The value can be in date, checkpoint, or LSN/SCN format.

Date Example: –cdc-start-position “2018-03-08T12:12:12”

Checkpoint Example: –cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"

LSN Example: –cdc-start-position “mysql-bin-changelog.000024:373”

When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the slotName extra connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for AWS DMS.

Definition at line 366 of file ModifyReplicationTaskRequest.h.

◆ GetCdcStartTime()

const Aws::Utils::DateTime& Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::GetCdcStartTime ( ) const
inline

Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.

Timestamp Example: –cdc-start-time “2018-03-08T12:12:12”

Definition at line 305 of file ModifyReplicationTaskRequest.h.

◆ GetCdcStopPosition()

const Aws::String& Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::GetCdcStopPosition ( ) const
inline

Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

Server time example: –cdc-stop-position “server_time:2018-02-09T12:12:12”

Commit time example: –cdc-stop-position “commit_time: 2018-02-09T12:12:12 “

Definition at line 515 of file ModifyReplicationTaskRequest.h.

◆ GetMigrationType()

const MigrationTypeValue& Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::GetMigrationType ( ) const
inline

The migration type. Valid values: full-load | cdc | full-load-and-cdc

Definition at line 152 of file ModifyReplicationTaskRequest.h.

◆ GetReplicationTaskArn()

const Aws::String& Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::GetReplicationTaskArn ( ) const
inline

The Amazon Resource Name (ARN) of the replication task.

Definition at line 45 of file ModifyReplicationTaskRequest.h.

◆ GetReplicationTaskIdentifier()

const Aws::String& Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::GetReplicationTaskIdentifier ( ) const
inline

The replication task identifier.

Constraints:

  • Must contain 1-255 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 89 of file ModifyReplicationTaskRequest.h.

◆ GetReplicationTaskSettings()

const Aws::String& Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::GetReplicationTaskSettings ( ) const
inline

JSON file that contains settings for the task, such as task metadata settings.

Definition at line 254 of file ModifyReplicationTaskRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file ModifyReplicationTaskRequest.h.

◆ GetTableMappings()

const Aws::String& Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::GetTableMappings ( ) const
inline

When using the AWS CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with file://. When working with the DMS API, provide the JSON as the parameter value, for example: –table-mappings file://mappingfile.json

Definition at line 191 of file ModifyReplicationTaskRequest.h.

◆ GetTaskData()

const Aws::String& Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::GetTaskData ( ) const
inline

Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the AWS Database Migration Service User Guide.

Definition at line 581 of file ModifyReplicationTaskRequest.h.

◆ MigrationTypeHasBeenSet()

bool Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::MigrationTypeHasBeenSet ( ) const
inline

The migration type. Valid values: full-load | cdc | full-load-and-cdc

Definition at line 158 of file ModifyReplicationTaskRequest.h.

◆ ReplicationTaskArnHasBeenSet()

bool Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::ReplicationTaskArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the replication task.

Definition at line 50 of file ModifyReplicationTaskRequest.h.

◆ ReplicationTaskIdentifierHasBeenSet()

bool Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::ReplicationTaskIdentifierHasBeenSet ( ) const
inline

The replication task identifier.

Constraints:

  • Must contain 1-255 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 97 of file ModifyReplicationTaskRequest.h.

◆ ReplicationTaskSettingsHasBeenSet()

bool Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::ReplicationTaskSettingsHasBeenSet ( ) const
inline

JSON file that contains settings for the task, such as task metadata settings.

Definition at line 260 of file ModifyReplicationTaskRequest.h.

◆ SerializePayload()

Aws::String Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCdcStartPosition() [1/3]

void Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::SetCdcStartPosition ( const Aws::String value)
inline

Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.

The value can be in date, checkpoint, or LSN/SCN format.

Date Example: –cdc-start-position “2018-03-08T12:12:12”

Checkpoint Example: –cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"

LSN Example: –cdc-start-position “mysql-bin-changelog.000024:373”

When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the slotName extra connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for AWS DMS.

Definition at line 406 of file ModifyReplicationTaskRequest.h.

◆ SetCdcStartPosition() [2/3]

void Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::SetCdcStartPosition ( Aws::String &&  value)
inline

Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.

The value can be in date, checkpoint, or LSN/SCN format.

Date Example: –cdc-start-position “2018-03-08T12:12:12”

Checkpoint Example: –cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"

LSN Example: –cdc-start-position “mysql-bin-changelog.000024:373”

When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the slotName extra connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for AWS DMS.

Definition at line 426 of file ModifyReplicationTaskRequest.h.

◆ SetCdcStartPosition() [3/3]

void Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::SetCdcStartPosition ( const char *  value)
inline

Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.

The value can be in date, checkpoint, or LSN/SCN format.

Date Example: –cdc-start-position “2018-03-08T12:12:12”

Checkpoint Example: –cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"

LSN Example: –cdc-start-position “mysql-bin-changelog.000024:373”

When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the slotName extra connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for AWS DMS.

Definition at line 446 of file ModifyReplicationTaskRequest.h.

◆ SetCdcStartTime() [1/2]

void Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::SetCdcStartTime ( const Aws::Utils::DateTime value)
inline

Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.

Timestamp Example: –cdc-start-time “2018-03-08T12:12:12”

Definition at line 321 of file ModifyReplicationTaskRequest.h.

◆ SetCdcStartTime() [2/2]

void Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::SetCdcStartTime ( Aws::Utils::DateTime &&  value)
inline

Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.

Timestamp Example: –cdc-start-time “2018-03-08T12:12:12”

Definition at line 329 of file ModifyReplicationTaskRequest.h.

◆ SetCdcStopPosition() [1/3]

void Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::SetCdcStopPosition ( const Aws::String value)
inline

Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

Server time example: –cdc-stop-position “server_time:2018-02-09T12:12:12”

Commit time example: –cdc-stop-position “commit_time: 2018-02-09T12:12:12 “

Definition at line 531 of file ModifyReplicationTaskRequest.h.

◆ SetCdcStopPosition() [2/3]

void Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::SetCdcStopPosition ( Aws::String &&  value)
inline

Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

Server time example: –cdc-stop-position “server_time:2018-02-09T12:12:12”

Commit time example: –cdc-stop-position “commit_time: 2018-02-09T12:12:12 “

Definition at line 539 of file ModifyReplicationTaskRequest.h.

◆ SetCdcStopPosition() [3/3]

void Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::SetCdcStopPosition ( const char *  value)
inline

Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

Server time example: –cdc-stop-position “server_time:2018-02-09T12:12:12”

Commit time example: –cdc-stop-position “commit_time: 2018-02-09T12:12:12 “

Definition at line 547 of file ModifyReplicationTaskRequest.h.

◆ SetMigrationType() [1/2]

void Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::SetMigrationType ( const MigrationTypeValue value)
inline

The migration type. Valid values: full-load | cdc | full-load-and-cdc

Definition at line 164 of file ModifyReplicationTaskRequest.h.

◆ SetMigrationType() [2/2]

void Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::SetMigrationType ( MigrationTypeValue &&  value)
inline

The migration type. Valid values: full-load | cdc | full-load-and-cdc

Definition at line 170 of file ModifyReplicationTaskRequest.h.

◆ SetReplicationTaskArn() [1/3]

void Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::SetReplicationTaskArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the replication task.

Definition at line 55 of file ModifyReplicationTaskRequest.h.

◆ SetReplicationTaskArn() [2/3]

void Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::SetReplicationTaskArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the replication task.

Definition at line 60 of file ModifyReplicationTaskRequest.h.

◆ SetReplicationTaskArn() [3/3]

void Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::SetReplicationTaskArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the replication task.

Definition at line 65 of file ModifyReplicationTaskRequest.h.

◆ SetReplicationTaskIdentifier() [1/3]

void Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::SetReplicationTaskIdentifier ( const Aws::String value)
inline

The replication task identifier.

Constraints:

  • Must contain 1-255 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 105 of file ModifyReplicationTaskRequest.h.

◆ SetReplicationTaskIdentifier() [2/3]

void Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::SetReplicationTaskIdentifier ( Aws::String &&  value)
inline

The replication task identifier.

Constraints:

  • Must contain 1-255 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 113 of file ModifyReplicationTaskRequest.h.

◆ SetReplicationTaskIdentifier() [3/3]

void Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::SetReplicationTaskIdentifier ( const char *  value)
inline

The replication task identifier.

Constraints:

  • Must contain 1-255 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 121 of file ModifyReplicationTaskRequest.h.

◆ SetReplicationTaskSettings() [1/3]

void Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::SetReplicationTaskSettings ( const Aws::String value)
inline

JSON file that contains settings for the task, such as task metadata settings.

Definition at line 266 of file ModifyReplicationTaskRequest.h.

◆ SetReplicationTaskSettings() [2/3]

void Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::SetReplicationTaskSettings ( Aws::String &&  value)
inline

JSON file that contains settings for the task, such as task metadata settings.

Definition at line 272 of file ModifyReplicationTaskRequest.h.

◆ SetReplicationTaskSettings() [3/3]

void Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::SetReplicationTaskSettings ( const char *  value)
inline

JSON file that contains settings for the task, such as task metadata settings.

Definition at line 278 of file ModifyReplicationTaskRequest.h.

◆ SetTableMappings() [1/3]

void Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::SetTableMappings ( const Aws::String value)
inline

When using the AWS CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with file://. When working with the DMS API, provide the JSON as the parameter value, for example: –table-mappings file://mappingfile.json

Definition at line 207 of file ModifyReplicationTaskRequest.h.

◆ SetTableMappings() [2/3]

void Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::SetTableMappings ( Aws::String &&  value)
inline

When using the AWS CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with file://. When working with the DMS API, provide the JSON as the parameter value, for example: –table-mappings file://mappingfile.json

Definition at line 215 of file ModifyReplicationTaskRequest.h.

◆ SetTableMappings() [3/3]

void Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::SetTableMappings ( const char *  value)
inline

When using the AWS CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with file://. When working with the DMS API, provide the JSON as the parameter value, for example: –table-mappings file://mappingfile.json

Definition at line 223 of file ModifyReplicationTaskRequest.h.

◆ SetTaskData() [1/3]

void Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::SetTaskData ( const Aws::String value)
inline

Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the AWS Database Migration Service User Guide.

Definition at line 599 of file ModifyReplicationTaskRequest.h.

◆ SetTaskData() [2/3]

void Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::SetTaskData ( Aws::String &&  value)
inline

Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the AWS Database Migration Service User Guide.

Definition at line 608 of file ModifyReplicationTaskRequest.h.

◆ SetTaskData() [3/3]

void Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::SetTaskData ( const char *  value)
inline

Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the AWS Database Migration Service User Guide.

Definition at line 617 of file ModifyReplicationTaskRequest.h.

◆ TableMappingsHasBeenSet()

bool Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::TableMappingsHasBeenSet ( ) const
inline

When using the AWS CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with file://. When working with the DMS API, provide the JSON as the parameter value, for example: –table-mappings file://mappingfile.json

Definition at line 199 of file ModifyReplicationTaskRequest.h.

◆ TaskDataHasBeenSet()

bool Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::TaskDataHasBeenSet ( ) const
inline

Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the AWS Database Migration Service User Guide.

Definition at line 590 of file ModifyReplicationTaskRequest.h.

◆ WithCdcStartPosition() [1/3]

ModifyReplicationTaskRequest& Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::WithCdcStartPosition ( const Aws::String value)
inline

Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.

The value can be in date, checkpoint, or LSN/SCN format.

Date Example: –cdc-start-position “2018-03-08T12:12:12”

Checkpoint Example: –cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"

LSN Example: –cdc-start-position “mysql-bin-changelog.000024:373”

When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the slotName extra connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for AWS DMS.

Definition at line 466 of file ModifyReplicationTaskRequest.h.

◆ WithCdcStartPosition() [2/3]

ModifyReplicationTaskRequest& Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::WithCdcStartPosition ( Aws::String &&  value)
inline

Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.

The value can be in date, checkpoint, or LSN/SCN format.

Date Example: –cdc-start-position “2018-03-08T12:12:12”

Checkpoint Example: –cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"

LSN Example: –cdc-start-position “mysql-bin-changelog.000024:373”

When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the slotName extra connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for AWS DMS.

Definition at line 486 of file ModifyReplicationTaskRequest.h.

◆ WithCdcStartPosition() [3/3]

ModifyReplicationTaskRequest& Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::WithCdcStartPosition ( const char *  value)
inline

Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.

The value can be in date, checkpoint, or LSN/SCN format.

Date Example: –cdc-start-position “2018-03-08T12:12:12”

Checkpoint Example: –cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"

LSN Example: –cdc-start-position “mysql-bin-changelog.000024:373”

When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the slotName extra connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for AWS DMS.

Definition at line 506 of file ModifyReplicationTaskRequest.h.

◆ WithCdcStartTime() [1/2]

ModifyReplicationTaskRequest& Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::WithCdcStartTime ( const Aws::Utils::DateTime value)
inline

Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.

Timestamp Example: –cdc-start-time “2018-03-08T12:12:12”

Definition at line 337 of file ModifyReplicationTaskRequest.h.

◆ WithCdcStartTime() [2/2]

ModifyReplicationTaskRequest& Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::WithCdcStartTime ( Aws::Utils::DateTime &&  value)
inline

Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.

Timestamp Example: –cdc-start-time “2018-03-08T12:12:12”

Definition at line 345 of file ModifyReplicationTaskRequest.h.

◆ WithCdcStopPosition() [1/3]

ModifyReplicationTaskRequest& Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::WithCdcStopPosition ( const Aws::String value)
inline

Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

Server time example: –cdc-stop-position “server_time:2018-02-09T12:12:12”

Commit time example: –cdc-stop-position “commit_time: 2018-02-09T12:12:12 “

Definition at line 555 of file ModifyReplicationTaskRequest.h.

◆ WithCdcStopPosition() [2/3]

ModifyReplicationTaskRequest& Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::WithCdcStopPosition ( Aws::String &&  value)
inline

Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

Server time example: –cdc-stop-position “server_time:2018-02-09T12:12:12”

Commit time example: –cdc-stop-position “commit_time: 2018-02-09T12:12:12 “

Definition at line 563 of file ModifyReplicationTaskRequest.h.

◆ WithCdcStopPosition() [3/3]

ModifyReplicationTaskRequest& Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::WithCdcStopPosition ( const char *  value)
inline

Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

Server time example: –cdc-stop-position “server_time:2018-02-09T12:12:12”

Commit time example: –cdc-stop-position “commit_time: 2018-02-09T12:12:12 “

Definition at line 571 of file ModifyReplicationTaskRequest.h.

◆ WithMigrationType() [1/2]

ModifyReplicationTaskRequest& Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::WithMigrationType ( const MigrationTypeValue value)
inline

The migration type. Valid values: full-load | cdc | full-load-and-cdc

Definition at line 176 of file ModifyReplicationTaskRequest.h.

◆ WithMigrationType() [2/2]

ModifyReplicationTaskRequest& Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::WithMigrationType ( MigrationTypeValue &&  value)
inline

The migration type. Valid values: full-load | cdc | full-load-and-cdc

Definition at line 182 of file ModifyReplicationTaskRequest.h.

◆ WithReplicationTaskArn() [1/3]

ModifyReplicationTaskRequest& Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::WithReplicationTaskArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the replication task.

Definition at line 70 of file ModifyReplicationTaskRequest.h.

◆ WithReplicationTaskArn() [2/3]

ModifyReplicationTaskRequest& Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::WithReplicationTaskArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the replication task.

Definition at line 75 of file ModifyReplicationTaskRequest.h.

◆ WithReplicationTaskArn() [3/3]

ModifyReplicationTaskRequest& Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::WithReplicationTaskArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the replication task.

Definition at line 80 of file ModifyReplicationTaskRequest.h.

◆ WithReplicationTaskIdentifier() [1/3]

ModifyReplicationTaskRequest& Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::WithReplicationTaskIdentifier ( const Aws::String value)
inline

The replication task identifier.

Constraints:

  • Must contain 1-255 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 129 of file ModifyReplicationTaskRequest.h.

◆ WithReplicationTaskIdentifier() [2/3]

ModifyReplicationTaskRequest& Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::WithReplicationTaskIdentifier ( Aws::String &&  value)
inline

The replication task identifier.

Constraints:

  • Must contain 1-255 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 137 of file ModifyReplicationTaskRequest.h.

◆ WithReplicationTaskIdentifier() [3/3]

ModifyReplicationTaskRequest& Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::WithReplicationTaskIdentifier ( const char *  value)
inline

The replication task identifier.

Constraints:

  • Must contain 1-255 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 145 of file ModifyReplicationTaskRequest.h.

◆ WithReplicationTaskSettings() [1/3]

ModifyReplicationTaskRequest& Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::WithReplicationTaskSettings ( const Aws::String value)
inline

JSON file that contains settings for the task, such as task metadata settings.

Definition at line 284 of file ModifyReplicationTaskRequest.h.

◆ WithReplicationTaskSettings() [2/3]

ModifyReplicationTaskRequest& Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::WithReplicationTaskSettings ( Aws::String &&  value)
inline

JSON file that contains settings for the task, such as task metadata settings.

Definition at line 290 of file ModifyReplicationTaskRequest.h.

◆ WithReplicationTaskSettings() [3/3]

ModifyReplicationTaskRequest& Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::WithReplicationTaskSettings ( const char *  value)
inline

JSON file that contains settings for the task, such as task metadata settings.

Definition at line 296 of file ModifyReplicationTaskRequest.h.

◆ WithTableMappings() [1/3]

ModifyReplicationTaskRequest& Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::WithTableMappings ( const Aws::String value)
inline

When using the AWS CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with file://. When working with the DMS API, provide the JSON as the parameter value, for example: –table-mappings file://mappingfile.json

Definition at line 231 of file ModifyReplicationTaskRequest.h.

◆ WithTableMappings() [2/3]

ModifyReplicationTaskRequest& Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::WithTableMappings ( Aws::String &&  value)
inline

When using the AWS CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with file://. When working with the DMS API, provide the JSON as the parameter value, for example: –table-mappings file://mappingfile.json

Definition at line 239 of file ModifyReplicationTaskRequest.h.

◆ WithTableMappings() [3/3]

ModifyReplicationTaskRequest& Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::WithTableMappings ( const char *  value)
inline

When using the AWS CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with file://. When working with the DMS API, provide the JSON as the parameter value, for example: –table-mappings file://mappingfile.json

Definition at line 247 of file ModifyReplicationTaskRequest.h.

◆ WithTaskData() [1/3]

ModifyReplicationTaskRequest& Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::WithTaskData ( const Aws::String value)
inline

Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the AWS Database Migration Service User Guide.

Definition at line 626 of file ModifyReplicationTaskRequest.h.

◆ WithTaskData() [2/3]

ModifyReplicationTaskRequest& Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::WithTaskData ( Aws::String &&  value)
inline

Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the AWS Database Migration Service User Guide.

Definition at line 635 of file ModifyReplicationTaskRequest.h.

◆ WithTaskData() [3/3]

ModifyReplicationTaskRequest& Aws::DatabaseMigrationService::Model::ModifyReplicationTaskRequest::WithTaskData ( const char *  value)
inline

Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the AWS Database Migration Service User Guide.

Definition at line 644 of file ModifyReplicationTaskRequest.h.


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