Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. dms
  5. DataMigration

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.dms.DataMigration

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource schema for AWS::DMS::DataMigration.

    Create DataMigration Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DataMigration(name: string, args: DataMigrationArgs, opts?: CustomResourceOptions);
    @overload
def DataMigration(resource_name: str,
                  args: DataMigrationArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def DataMigration(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  data_migration_type: Optional[DataMigrationType] = None,
                  migration_project_identifier: Optional[str] = None,
                  service_access_role_arn: Optional[str] = None,
                  data_migration_identifier: Optional[str] = None,
                  data_migration_name: Optional[str] = None,
                  data_migration_settings: Optional[DataMigrationSettingsArgs] = None,
                  source_data_settings: Optional[Sequence[DataMigrationSourceDataSettingsArgs]] = None,
                  tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewDataMigration(ctx *Context, name string, args DataMigrationArgs, opts ...ResourceOption) (*DataMigration, error)
    public DataMigration(string name, DataMigrationArgs args, CustomResourceOptions? opts = null)
    public DataMigration(String name, DataMigrationArgs args)
public DataMigration(String name, DataMigrationArgs args, CustomResourceOptions options)

    type: aws-native:dms:DataMigration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args DataMigrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DataMigrationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DataMigrationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DataMigrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DataMigrationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    DataMigration Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The DataMigration resource accepts the following input properties:

    DataMigrationType Pulumi.AwsNative.Dms.DataMigrationType
    The property describes the type of migration.
    MigrationProjectIdentifier string
    The property describes an identifier for the migration project. It is used for describing/deleting/modifying can be name/arn
    ServiceAccessRoleArn string
    The property describes Amazon Resource Name (ARN) of the service access role.
    DataMigrationIdentifier string
    The property describes an ARN of the data migration.
    DataMigrationName string
    The property describes a name to identify the data migration.
    DataMigrationSettings Pulumi.AwsNative.Dms.Inputs.DataMigrationSettings
    The property describes the settings for the data migration.
    SourceDataSettings List<Pulumi.AwsNative.Dms.Inputs.DataMigrationSourceDataSettings>
    The property describes the settings for the data migration.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this resource.
    DataMigrationType DataMigrationType
    The property describes the type of migration.
    MigrationProjectIdentifier string
    The property describes an identifier for the migration project. It is used for describing/deleting/modifying can be name/arn
    ServiceAccessRoleArn string
    The property describes Amazon Resource Name (ARN) of the service access role.
    DataMigrationIdentifier string
    The property describes an ARN of the data migration.
    DataMigrationName string
    The property describes a name to identify the data migration.
    DataMigrationSettings DataMigrationSettingsArgs
    The property describes the settings for the data migration.
    SourceDataSettings []DataMigrationSourceDataSettingsArgs
    The property describes the settings for the data migration.
    Tags TagArgs
    An array of key-value pairs to apply to this resource.
    dataMigrationType DataMigrationType
    The property describes the type of migration.
    migrationProjectIdentifier String
    The property describes an identifier for the migration project. It is used for describing/deleting/modifying can be name/arn
    serviceAccessRoleArn String
    The property describes Amazon Resource Name (ARN) of the service access role.
    dataMigrationIdentifier String
    The property describes an ARN of the data migration.
    dataMigrationName String
    The property describes a name to identify the data migration.
    dataMigrationSettings DataMigrationSettings
    The property describes the settings for the data migration.
    sourceDataSettings List<DataMigrationSourceDataSettings>
    The property describes the settings for the data migration.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    dataMigrationType DataMigrationType
    The property describes the type of migration.
    migrationProjectIdentifier string
    The property describes an identifier for the migration project. It is used for describing/deleting/modifying can be name/arn
    serviceAccessRoleArn string
    The property describes Amazon Resource Name (ARN) of the service access role.
    dataMigrationIdentifier string
    The property describes an ARN of the data migration.
    dataMigrationName string
    The property describes a name to identify the data migration.
    dataMigrationSettings DataMigrationSettings
    The property describes the settings for the data migration.
    sourceDataSettings DataMigrationSourceDataSettings[]
    The property describes the settings for the data migration.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    data_migration_type DataMigrationType
    The property describes the type of migration.
    migration_project_identifier str
    The property describes an identifier for the migration project. It is used for describing/deleting/modifying can be name/arn
    service_access_role_arn str
    The property describes Amazon Resource Name (ARN) of the service access role.
    data_migration_identifier str
    The property describes an ARN of the data migration.
    data_migration_name str
    The property describes a name to identify the data migration.
    data_migration_settings DataMigrationSettingsArgs
    The property describes the settings for the data migration.
    source_data_settings Sequence[DataMigrationSourceDataSettingsArgs]
    The property describes the settings for the data migration.
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this resource.
    dataMigrationType "full-load" | "cdc" | "full-load-and-cdc"
    The property describes the type of migration.
    migrationProjectIdentifier String
    The property describes an identifier for the migration project. It is used for describing/deleting/modifying can be name/arn
    serviceAccessRoleArn String
    The property describes Amazon Resource Name (ARN) of the service access role.
    dataMigrationIdentifier String
    The property describes an ARN of the data migration.
    dataMigrationName String
    The property describes a name to identify the data migration.
    dataMigrationSettings Property Map
    The property describes the settings for the data migration.
    sourceDataSettings List<Property Map>
    The property describes the settings for the data migration.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DataMigration resource produces the following output properties:

    DataMigrationArn string
    The property describes an ARN of the data migration.
    DataMigrationCreateTime string
    The property describes the create time of the data migration.
    Id string
    The provider-assigned unique ID for this managed resource.
    DataMigrationArn string
    The property describes an ARN of the data migration.
    DataMigrationCreateTime string
    The property describes the create time of the data migration.
    Id string
    The provider-assigned unique ID for this managed resource.
    dataMigrationArn String
    The property describes an ARN of the data migration.
    dataMigrationCreateTime String
    The property describes the create time of the data migration.
    id String
    The provider-assigned unique ID for this managed resource.
    dataMigrationArn string
    The property describes an ARN of the data migration.
    dataMigrationCreateTime string
    The property describes the create time of the data migration.
    id string
    The provider-assigned unique ID for this managed resource.
    data_migration_arn str
    The property describes an ARN of the data migration.
    data_migration_create_time str
    The property describes the create time of the data migration.
    id str
    The provider-assigned unique ID for this managed resource.
    dataMigrationArn String
    The property describes an ARN of the data migration.
    dataMigrationCreateTime String
    The property describes the create time of the data migration.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    DataMigrationSettings, DataMigrationSettingsArgs

    CloudwatchLogsEnabled bool
    The property specifies whether to enable the Cloudwatch log.
    NumberOfJobs int
    The number of parallel jobs that trigger parallel threads to unload the tables from the source, and then load them to the target.
    SelectionRules string
    The property specifies the rules of selecting objects for data migration.
    CloudwatchLogsEnabled bool
    The property specifies whether to enable the Cloudwatch log.
    NumberOfJobs int
    The number of parallel jobs that trigger parallel threads to unload the tables from the source, and then load them to the target.
    SelectionRules string
    The property specifies the rules of selecting objects for data migration.
    cloudwatchLogsEnabled Boolean
    The property specifies whether to enable the Cloudwatch log.
    numberOfJobs Integer
    The number of parallel jobs that trigger parallel threads to unload the tables from the source, and then load them to the target.
    selectionRules String
    The property specifies the rules of selecting objects for data migration.
    cloudwatchLogsEnabled boolean
    The property specifies whether to enable the Cloudwatch log.
    numberOfJobs number
    The number of parallel jobs that trigger parallel threads to unload the tables from the source, and then load them to the target.
    selectionRules string
    The property specifies the rules of selecting objects for data migration.
    cloudwatch_logs_enabled bool
    The property specifies whether to enable the Cloudwatch log.
    number_of_jobs int
    The number of parallel jobs that trigger parallel threads to unload the tables from the source, and then load them to the target.
    selection_rules str
    The property specifies the rules of selecting objects for data migration.
    cloudwatchLogsEnabled Boolean
    The property specifies whether to enable the Cloudwatch log.
    numberOfJobs Number
    The number of parallel jobs that trigger parallel threads to unload the tables from the source, and then load them to the target.
    selectionRules String
    The property specifies the rules of selecting objects for data migration.

    DataMigrationSourceDataSettings, DataMigrationSourceDataSettingsArgs

    CdcStartPosition string
    The property is a point in the database engine's log that defines a time where you can begin CDC.
    CdcStartTime string
    The property indicates the start time for a change data capture (CDC) operation. The value is server time in UTC format.
    CdcStopTime string
    The property indicates the stop time for a change data capture (CDC) operation. The value is server time in UTC format.
    SlotName string
    The property sets the name of a previously created logical replication slot for a change data capture (CDC) load of the source instance.
    CdcStartPosition string
    The property is a point in the database engine's log that defines a time where you can begin CDC.
    CdcStartTime string
    The property indicates the start time for a change data capture (CDC) operation. The value is server time in UTC format.
    CdcStopTime string
    The property indicates the stop time for a change data capture (CDC) operation. The value is server time in UTC format.
    SlotName string
    The property sets the name of a previously created logical replication slot for a change data capture (CDC) load of the source instance.
    cdcStartPosition String
    The property is a point in the database engine's log that defines a time where you can begin CDC.
    cdcStartTime String
    The property indicates the start time for a change data capture (CDC) operation. The value is server time in UTC format.
    cdcStopTime String
    The property indicates the stop time for a change data capture (CDC) operation. The value is server time in UTC format.
    slotName String
    The property sets the name of a previously created logical replication slot for a change data capture (CDC) load of the source instance.
    cdcStartPosition string
    The property is a point in the database engine's log that defines a time where you can begin CDC.
    cdcStartTime string
    The property indicates the start time for a change data capture (CDC) operation. The value is server time in UTC format.
    cdcStopTime string
    The property indicates the stop time for a change data capture (CDC) operation. The value is server time in UTC format.
    slotName string
    The property sets the name of a previously created logical replication slot for a change data capture (CDC) load of the source instance.
    cdc_start_position str
    The property is a point in the database engine's log that defines a time where you can begin CDC.
    cdc_start_time str
    The property indicates the start time for a change data capture (CDC) operation. The value is server time in UTC format.
    cdc_stop_time str
    The property indicates the stop time for a change data capture (CDC) operation. The value is server time in UTC format.
    slot_name str
    The property sets the name of a previously created logical replication slot for a change data capture (CDC) load of the source instance.
    cdcStartPosition String
    The property is a point in the database engine's log that defines a time where you can begin CDC.
    cdcStartTime String
    The property indicates the start time for a change data capture (CDC) operation. The value is server time in UTC format.
    cdcStopTime String
    The property indicates the stop time for a change data capture (CDC) operation. The value is server time in UTC format.
    slotName String
    The property sets the name of a previously created logical replication slot for a change data capture (CDC) load of the source instance.

    DataMigrationType, DataMigrationTypeArgs

    FullLoad
    full-load
    Cdc
    cdc
    FullLoadAndCdc
    full-load-and-cdc
    DataMigrationTypeFullLoad
    full-load
    DataMigrationTypeCdc
    cdc
    DataMigrationTypeFullLoadAndCdc
    full-load-and-cdc
    FullLoad
    full-load
    Cdc
    cdc
    FullLoadAndCdc
    full-load-and-cdc
    FullLoad
    full-load
    Cdc
    cdc
    FullLoadAndCdc
    full-load-and-cdc
    FULL_LOAD
    full-load
    CDC
    cdc
    FULL_LOAD_AND_CDC
    full-load-and-cdc
    "full-load"
    full-load
    "cdc"
    cdc
    "full-load-and-cdc"
    full-load-and-cdc

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native