CreateReplicationTaskRequest (AWS Java SDK :: Services :: AWS Database Migration Service 2.21.12 API)

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateReplicationTaskRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`MigrationTypeValue`	`migrationType()` The migration type.
`String`	`migrationTypeAsString()` The migration type.
`String`	`replicationInstanceArn()` The Amazon Resource Name (ARN) of a replication instance.
`String`	`replicationTaskIdentifier()` An identifier for the replication task.
`String`	`replicationTaskSettings()` Overall settings for the task, in JSON format.
`String`	`resourceIdentifier()` A friendly name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateReplicationTaskRequest.Builder>`	`serializableBuilderClass()`
`String`	`sourceEndpointArn()` An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.
`String`	`tableMappings()` The table mappings for the task, in JSON format.
`List<Tag>`	`tags()` One or more tags to be assigned to the replication task.
`String`	`targetEndpointArn()` An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.
`String`	`taskData()` Supplemental information that the task requires to migrate the data for certain source and target endpoints.
`CreateReplicationTaskRequest.Builder`	`toBuilder()`
`String`	`toString()` 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
  - replicationTaskIdentifier
```
public final String replicationTaskIdentifier()
```
    An identifier for the replication task.
    
    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:
    An identifier for the replication task.
    
    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.
  - sourceEndpointArn
```
public final String sourceEndpointArn()
```
    An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.
    
    Returns:
    
    An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.
  - targetEndpointArn
```
public final String targetEndpointArn()
```
    An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.
    
    Returns:
    
    An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.
  - replicationInstanceArn
```
public final String replicationInstanceArn()
```
    The Amazon Resource Name (ARN) of a replication instance.
    
    Returns:
    
    The Amazon Resource Name (ARN) of a replication instance.
  - migrationType
```
public final MigrationTypeValue migrationType()
```
    The migration type. Valid values: full-load | cdc | full-load-and-cdc
    
    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. 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-cdc
    
    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. Valid values: full-load | cdc | full-load-and-cdc
    
    See Also:
    
    MigrationTypeValue
  - tableMappings
```
public final String tableMappings()
```
    The table mappings for the task, in JSON format. For more information, see Using Table Mapping to Specify Task Settings in the Database Migration Service User Guide.
    
    Returns:
    
    The table mappings for the task, in JSON format. For more information, see Using Table Mapping to Specify Task Settings in the Database Migration Service User Guide.
  - replicationTaskSettings
```
public final String replicationTaskSettings()
```
    Overall settings for the task, in JSON format. For more information, see Specifying Task Settings for Database Migration Service Tasks in the Database Migration Service User Guide.
    
    Returns:
    
    Overall settings for the task, in JSON format. For more information, see Specifying Task Settings for Database Migration Service Tasks in the Database Migration Service User Guide.
  - 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 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 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 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 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“
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final List<Tag> tags()
```
    One or more tags to be assigned to the replication task.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    Returns:
    
    One or more tags to be assigned to the replication task.
  - 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.
  - resourceIdentifier
```
public final String resourceIdentifier()
```
    A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1. For example, this value might result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify a ResourceIdentifier value, DMS generates a default identifier value for the end of EndpointArn.
    
    Returns:
    
    A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1. For example, this value might result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify a ResourceIdentifier value, DMS generates a default identifier value for the end of EndpointArn.
  - toBuilder
```
public CreateReplicationTaskRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateReplicationTaskRequest.Builder,CreateReplicationTaskRequest>
    
    Specified by:
    
    toBuilder in class DatabaseMigrationRequest
  - builder
```
public static CreateReplicationTaskRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateReplicationTaskRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateReplicationTaskRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

replicationTaskIdentifier

sourceEndpointArn

targetEndpointArn

replicationInstanceArn

migrationType

migrationTypeAsString

tableMappings

replicationTaskSettings

cdcStartTime

cdcStartPosition

cdcStopPosition

hasTags

tags

taskData

resourceIdentifier

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields