Class ModifyReplicationTaskRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.databasemigration.model.DatabaseMigrationRequest
-
- software.amazon.awssdk.services.databasemigration.model.ModifyReplicationTaskRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<ModifyReplicationTaskRequest.Builder,ModifyReplicationTaskRequest>
@Generated("software.amazon.awssdk:codegen") public final class ModifyReplicationTaskRequest extends DatabaseMigrationRequest implements ToCopyableBuilder<ModifyReplicationTaskRequest.Builder,ModifyReplicationTaskRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceModifyReplicationTaskRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ModifyReplicationTaskRequest.Builderbuilder()StringcdcStartPosition()Indicates when you want a change data capture (CDC) operation to start.InstantcdcStartTime()Indicates the start time for a change data capture (CDC) operation.StringcdcStopPosition()Indicates when you want a change data capture (CDC) operation to stop.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()MigrationTypeValuemigrationType()The migration type.StringmigrationTypeAsString()The migration type.StringreplicationTaskArn()The Amazon Resource Name (ARN) of the replication task.StringreplicationTaskIdentifier()The replication task identifier.StringreplicationTaskSettings()JSON file that contains settings for the task, such as task metadata settings.List<SdkField<?>>sdkFields()static Class<? extends ModifyReplicationTaskRequest.Builder>serializableBuilderClass()StringtableMappings()When using the CLI or boto3, provide the path of the JSON file that contains the table mappings.StringtaskData()Supplemental information that the task requires to migrate the data for certain source and target endpoints.ModifyReplicationTaskRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
replicationTaskArn
public final String replicationTaskArn()
The Amazon Resource Name (ARN) of the replication task.
- Returns:
- The Amazon Resource Name (ARN) of the replication task.
-
replicationTaskIdentifier
public final String replicationTaskIdentifier()
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.
- Returns:
- 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.
-
-
-
migrationType
public final MigrationTypeValue migrationType()
The migration type. Valid values:
full-load|cdc|full-load-and-cdcIf the service returns an enum value that is not available in the current SDK version,
migrationTypewill returnMigrationTypeValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frommigrationTypeAsString().- Returns:
- The migration type. Valid values:
full-load|cdc|full-load-and-cdc - See Also:
MigrationTypeValue
-
migrationTypeAsString
public final String migrationTypeAsString()
The migration type. Valid values:
full-load|cdc|full-load-and-cdcIf the service returns an enum value that is not available in the current SDK version,
migrationTypewill returnMigrationTypeValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frommigrationTypeAsString().- Returns:
- The migration type. Valid values:
full-load|cdc|full-load-and-cdc - See Also:
MigrationTypeValue
-
tableMappings
public final String tableMappings()
When using the CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with
file://. For example,--table-mappings file://mappingfile.json. When working with the DMS API, provide the JSON as the parameter value.- Returns:
- When using the CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede
the path with
file://. For example,--table-mappings file://mappingfile.json. When working with the DMS API, provide the JSON as the parameter value.
-
replicationTaskSettings
public final String replicationTaskSettings()
JSON file that contains settings for the task, such as task metadata settings.
- Returns:
- JSON file that contains settings for the task, such as task metadata settings.
-
cdcStartTime
public final Instant cdcStartTime()
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”
- Returns:
- 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”
-
cdcStartPosition
public final String cdcStartPosition()
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
slotNameextra connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for DMS.- Returns:
- 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
slotNameextra connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for DMS.
-
cdcStopPosition
public final String cdcStopPosition()
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“
- Returns:
- 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“
-
taskData
public final String taskData()
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 Database Migration Service User Guide.
- Returns:
- 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 Database Migration Service User Guide.
-
toBuilder
public ModifyReplicationTaskRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ModifyReplicationTaskRequest.Builder,ModifyReplicationTaskRequest>- Specified by:
toBuilderin classDatabaseMigrationRequest
-
builder
public static ModifyReplicationTaskRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends ModifyReplicationTaskRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-