interface CfnDataMigrationProps

Language	Type name
.NET	Amazon.CDK.AWS.DMS.CfnDataMigrationProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsdms#CfnDataMigrationProps
Java	software.amazon.awscdk.services.dms.CfnDataMigrationProps
Python	aws_cdk.aws_dms.CfnDataMigrationProps
TypeScript	aws-cdk-lib » aws_dms » CfnDataMigrationProps

Properties for defining a CfnDataMigration.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_dms as dms } from 'aws-cdk-lib';
const cfnDataMigrationProps: dms.CfnDataMigrationProps = {
  dataMigrationType: 'dataMigrationType',
  migrationProjectIdentifier: 'migrationProjectIdentifier',
  serviceAccessRoleArn: 'serviceAccessRoleArn',

  // the properties below are optional
  dataMigrationIdentifier: 'dataMigrationIdentifier',
  dataMigrationName: 'dataMigrationName',
  dataMigrationSettings: {
    cloudwatchLogsEnabled: false,
    numberOfJobs: 123,
    selectionRules: 'selectionRules',
  },
  sourceDataSettings: [{
    cdcStartPosition: 'cdcStartPosition',
    cdcStartTime: 'cdcStartTime',
    cdcStopTime: 'cdcStopTime',
    slotName: 'slotName',
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
dataMigrationType	string	Specifies whether the data migration is full-load only, change data capture (CDC) only, or full-load and CDC.
migrationProjectIdentifier	string	The property describes an identifier for the migration project.
serviceAccessRoleArn	string	The IAM role that the data migration uses to access AWS resources.
dataMigrationIdentifier?	string	The property describes an ARN of the data migration.
dataMigrationName?	string	The user-friendly name for the data migration.
dataMigrationSettings?	IResolvable | DataMigrationSettingsProperty	Specifies CloudWatch settings and selection rules for the data migration.
sourceDataSettings?	IResolvable | IResolvable | SourceDataSettingsProperty[]	Specifies information about the data migration's source data provider.
tags?	CfnTag[]	An array of key-value pairs to apply to this resource.

---

dataMigrationType

Type: string

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

---

migrationProjectIdentifier

Type: string

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

---

serviceAccessRoleArn

Type: string

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

---

dataMigrationIdentifier?

Type: string (optional)

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

---

dataMigrationName?

Type: string (optional)

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

---

dataMigrationSettings?

Type: IResolvable | DataMigrationSettingsProperty (optional)

Specifies CloudWatch settings and selection rules for the data migration.

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

---

sourceDataSettings?

Type: IResolvable | IResolvable | SourceDataSettingsProperty[] (optional)

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

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

---

tags?

Type: CfnTag[] (optional)

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