software.amazon.awssdk.services.databasemigration.model

Class CreateReplicationTaskRequest

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.CreateReplicationTaskRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateReplicationTaskRequest.Builder,CreateReplicationTaskRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateReplicationTaskRequest
extends DatabaseMigrationRequest
implements ToCopyableBuilder<CreateReplicationTaskRequest.Builder,CreateReplicationTaskRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateReplicationTaskRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateReplicationTaskRequest.Builder	builder()
String	cdcStartPosition() Indicates when you want a change data capture (CDC) operation to start.
Instant	cdcStartTime() Indicates the start time for a change data capture (CDC) operation.
String	cdcStopPosition() Indicates when you want a change data capture (CDC) operation to stop.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
MigrationTypeValue	migrationType() The migration type.
String	migrationTypeAsString() The migration type.
String	replicationInstanceArn() The Amazon Resource Name (ARN) of the replication instance.
String	replicationTaskIdentifier() The replication task identifier.
String	replicationTaskSettings() Settings for the task, such as target metadata settings.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateReplicationTaskRequest.Builder>	serializableBuilderClass()
String	sourceEndpointArn() The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
String	tableMappings() When using the AWS CLI or boto3, provide the path of the JSON file that contains the table mappings.
List<Tag>	tags() Tags to be added to the replication instance.
String	targetEndpointArn() The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
CreateReplicationTaskRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

replicationTaskIdentifier

public String replicationTaskIdentifier()

The replication task identifier.

Constraints:

• Must contain from 1 to 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 from 1 to 255 alphanumeric characters or hyphens.

• First character must be a letter.

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

sourceEndpointArn

public String sourceEndpointArn()

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

Returns:

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

targetEndpointArn

public String targetEndpointArn()

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

Returns:

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

replicationInstanceArn

public String replicationInstanceArn()

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

Returns:

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

migrationType

public MigrationTypeValue migrationType()

The migration type.

If the service returns an enum value that is not available in the current SDK version, migrationType will return MigrationTypeValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from migrationTypeAsString().

Returns:

The migration type.

See Also:

MigrationTypeValue

migrationTypeAsString

public String migrationTypeAsString()

The migration type.

If the service returns an enum value that is not available in the current SDK version, migrationType will return MigrationTypeValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from migrationTypeAsString().

Returns:

The migration type.

See Also:

MigrationTypeValue

tableMappings

public String tableMappings()

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

Returns:

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

replicationTaskSettings

public String replicationTaskSettings()

Settings for the task, such as target metadata settings. For a complete list of task settings, see Task Settings for AWS Database Migration Service Tasks in the AWS Database Migration User Guide.

Returns:

Settings for the task, such as target metadata settings. For a complete list of task settings, see Task Settings for AWS Database Migration Service Tasks in the AWS Database Migration User Guide.

cdcStartTime

public 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 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”

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”

cdcStopPosition

public 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:3018-02-09T12:12:12”

Commit time example: --cdc-stop-position “commit_time: 3018-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:3018-02-09T12:12:12”

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

tags

public List<Tag> tags()

Tags to be added to the replication instance.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Tags to be added to the replication instance.

toBuilder

public CreateReplicationTaskRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateReplicationTaskRequest.Builder,CreateReplicationTaskRequest>

Specified by:

toBuilder in class DatabaseMigrationRequest

Returns:

a builder for type T

builder

public static CreateReplicationTaskRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateReplicationTaskRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.