Interface ICfnMigrationProjectProps

Properties for defining a CfnMigrationProject.

Namespace: Amazon.CDK.AWS.DMS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnMigrationProjectProps

Syntax (vb)

Public Interface ICfnMigrationProjectProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.DMS;

             var cfnMigrationProjectProps = new CfnMigrationProjectProps {
                 Description = "description",
                 InstanceProfileArn = "instanceProfileArn",
                 InstanceProfileIdentifier = "instanceProfileIdentifier",
                 InstanceProfileName = "instanceProfileName",
                 MigrationProjectCreationTime = "migrationProjectCreationTime",
                 MigrationProjectIdentifier = "migrationProjectIdentifier",
                 MigrationProjectName = "migrationProjectName",
                 SchemaConversionApplicationAttributes = new SchemaConversionApplicationAttributesProperty {
                     S3BucketPath = "s3BucketPath",
                     S3BucketRoleArn = "s3BucketRoleArn"
                 },
                 SourceDataProviderDescriptors = new [] { new DataProviderDescriptorProperty {
                     DataProviderArn = "dataProviderArn",
                     DataProviderIdentifier = "dataProviderIdentifier",
                     DataProviderName = "dataProviderName",
                     SecretsManagerAccessRoleArn = "secretsManagerAccessRoleArn",
                     SecretsManagerSecretId = "secretsManagerSecretId"
                 } },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TargetDataProviderDescriptors = new [] { new DataProviderDescriptorProperty {
                     DataProviderArn = "dataProviderArn",
                     DataProviderIdentifier = "dataProviderIdentifier",
                     DataProviderName = "dataProviderName",
                     SecretsManagerAccessRoleArn = "secretsManagerAccessRoleArn",
                     SecretsManagerSecretId = "secretsManagerSecretId"
                 } },
                 TransformationRules = "transformationRules"
             };

Synopsis

Properties

Description	A user-friendly description of the migration project.
InstanceProfileArn	The Amazon Resource Name (ARN) of the instance profile for your migration project.
InstanceProfileIdentifier	The identifier of the instance profile for your migration project.
InstanceProfileName	The name of the associated instance profile.
MigrationProjectCreationTime	(deprecated) The property describes a creating time of the migration project.
MigrationProjectIdentifier	The identifier of the migration project.
MigrationProjectName	The name of the migration project.
SchemaConversionApplicationAttributes	The schema conversion application attributes, including the Amazon S3 bucket name and Amazon S3 role ARN.
SourceDataProviderDescriptors	Information about the source data provider, including the name or ARN, and AWS Secrets Manager parameters.
Tags	An array of key-value pairs to apply to this resource.
TargetDataProviderDescriptors	Information about the target data provider, including the name or ARN, and AWS Secrets Manager parameters.
TransformationRules	The settings in JSON format for migration rules.

Properties

Description

A user-friendly description of the migration project.

string? Description { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-migrationproject.html#cfn-dms-migrationproject-description

InstanceProfileArn

The Amazon Resource Name (ARN) of the instance profile for your migration project.

string? InstanceProfileArn { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-migrationproject.html#cfn-dms-migrationproject-instanceprofilearn

InstanceProfileIdentifier

The identifier of the instance profile for your migration project.

string? InstanceProfileIdentifier { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-migrationproject.html#cfn-dms-migrationproject-instanceprofileidentifier

InstanceProfileName

The name of the associated instance profile.

string? InstanceProfileName { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-migrationproject.html#cfn-dms-migrationproject-instanceprofilename

MigrationProjectCreationTime

(deprecated) The property describes a creating time of the migration project.

[Obsolete("this property has been deprecated")]
string? MigrationProjectCreationTime { get; }

Property Value

string

Remarks

Stability: Deprecated

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-migrationproject.html#cfn-dms-migrationproject-migrationprojectcreationtime

MigrationProjectIdentifier

The identifier of the migration project.

string? MigrationProjectIdentifier { get; }

Property Value

string

Remarks

Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen, or contain two consecutive hyphens.

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

MigrationProjectName

The name of the migration project.

string? MigrationProjectName { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-migrationproject.html#cfn-dms-migrationproject-migrationprojectname

SchemaConversionApplicationAttributes

The schema conversion application attributes, including the Amazon S3 bucket name and Amazon S3 role ARN.

object? SchemaConversionApplicationAttributes { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-migrationproject.html#cfn-dms-migrationproject-schemaconversionapplicationattributes

Type union: either IResolvable or CfnMigrationProject.ISchemaConversionApplicationAttributesProperty

SourceDataProviderDescriptors

Information about the source data provider, including the name or ARN, and AWS Secrets Manager parameters.

object? SourceDataProviderDescriptors { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-migrationproject.html#cfn-dms-migrationproject-sourcedataproviderdescriptors

Type union: either IResolvable or (either IResolvable or CfnMigrationProject.IDataProviderDescriptorProperty)[]

TargetDataProviderDescriptors

Information about the target data provider, including the name or ARN, and AWS Secrets Manager parameters.

object? TargetDataProviderDescriptors { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-migrationproject.html#cfn-dms-migrationproject-targetdataproviderdescriptors

Type union: either IResolvable or (either IResolvable or CfnMigrationProject.IDataProviderDescriptorProperty)[]

TransformationRules

The settings in JSON format for migration rules.

string? TransformationRules { get; }

Property Value

string

Remarks

Migration rules make it possible for you to change the object names according to the rules that you specify. For example, you can change an object name to lowercase or uppercase, add or remove a prefix or suffix, or rename objects.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-migrationproject.html#cfn-dms-migrationproject-transformationrules