Package software.amazon.awscdk.services.dms

Interface CfnDataMigrationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataMigrationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:08.288Z")
@Stability(Stable)
public interface CfnDataMigrationProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDataMigration.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.dms.*;
 CfnDataMigrationProps cfnDataMigrationProps = CfnDataMigrationProps.builder()
         .dataMigrationType("dataMigrationType")
         .migrationProjectIdentifier("migrationProjectIdentifier")
         .serviceAccessRoleArn("serviceAccessRoleArn")
         // the properties below are optional
         .dataMigrationIdentifier("dataMigrationIdentifier")
         .dataMigrationName("dataMigrationName")
         .dataMigrationSettings(DataMigrationSettingsProperty.builder()
                 .cloudwatchLogsEnabled(false)
                 .numberOfJobs(123)
                 .selectionRules("selectionRules")
                 .build())
         .sourceDataSettings(List.of(SourceDataSettingsProperty.builder()
                 .cdcStartPosition("cdcStartPosition")
                 .cdcStartTime("cdcStartTime")
                 .cdcStopTime("cdcStopTime")
                 .slotName("slotName")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-datamigration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDataMigrationProps.Builder	A builder for CfnDataMigrationProps
static final class	CfnDataMigrationProps.Jsii$Proxy	An implementation for CfnDataMigrationProps

Method Summary

Modifier and Type	Method	Description
static CfnDataMigrationProps.Builder	builder()
default String	getDataMigrationIdentifier()	The property describes an ARN of the data migration.
default String	getDataMigrationName()	The user-friendly name for the data migration.
default Object	getDataMigrationSettings()	Specifies CloudWatch settings and selection rules for the data migration.
String	getDataMigrationType()	Specifies whether the data migration is full-load only, change data capture (CDC) only, or full-load and CDC.
String	getMigrationProjectIdentifier()	The property describes an identifier for the migration project.
String	getServiceAccessRoleArn()	The IAM role that the data migration uses to access AWS resources.
default Object	getSourceDataSettings()	Specifies information about the data migration's source data provider.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDataMigrationType

@Stability(Stable)
@NotNull
String getDataMigrationType()

Specifies whether the data migration is full-load only, change data capture (CDC) only, or full-load and CDC.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-datamigration.html#cfn-dms-datamigration-datamigrationtype

getMigrationProjectIdentifier

@Stability(Stable)
@NotNull
String getMigrationProjectIdentifier()

The property describes an identifier for the migration project.

It is used for describing/deleting/modifying can be name/arn

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-datamigration.html#cfn-dms-datamigration-migrationprojectidentifier

getServiceAccessRoleArn

@Stability(Stable)
@NotNull
String getServiceAccessRoleArn()

The IAM role that the data migration uses to access AWS resources.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-datamigration.html#cfn-dms-datamigration-serviceaccessrolearn

getDataMigrationIdentifier

@Stability(Stable)
@Nullable
default String getDataMigrationIdentifier()

The property describes an ARN of the data migration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-datamigration.html#cfn-dms-datamigration-datamigrationidentifier

getDataMigrationName

@Stability(Stable)
@Nullable
default String getDataMigrationName()

The user-friendly name for the data migration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-datamigration.html#cfn-dms-datamigration-datamigrationname

getDataMigrationSettings

@Stability(Stable)
@Nullable
default Object getDataMigrationSettings()

Specifies CloudWatch settings and selection rules for the data migration.

Returns union: either IResolvable or CfnDataMigration.DataMigrationSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-datamigration.html#cfn-dms-datamigration-datamigrationsettings

getSourceDataSettings

@Stability(Stable)
@Nullable
default Object getSourceDataSettings()

Specifies information about the data migration's source data provider.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDataMigration.SourceDataSettingsProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-datamigration.html#cfn-dms-datamigration-sourcedatasettings

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

An array of key-value pairs to apply to this resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-datamigration.html#cfn-dms-datamigration-tags

builder

@Stability(Stable)
static CfnDataMigrationProps.Builder builder()

Returns:

a CfnDataMigrationProps.Builder of CfnDataMigrationProps