Class CfnMigrationProject

Provides information that defines a migration project.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnMigrationProject
Inherited Members
Namespace: Amazon.CDK.AWS.DMS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnMigrationProject : CfnResource, IInspectable, IMigrationProjectRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2
Syntax (vb)
Public Class CfnMigrationProject Inherits CfnResource Implements IInspectable, IMigrationProjectRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2
Remarks

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

CloudformationResource: AWS::DMS::MigrationProject

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 cfnMigrationProject = new CfnMigrationProject(this, "MyCfnMigrationProject", 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

Constructors

CfnMigrationProject(Construct, string, ICfnMigrationProjectProps?)

Provides information that defines a migration project.

Properties

AttrMigrationProjectArn

The ARN string that uniquely identifies the migration project.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CdkTagManager

Tag Manager which manages the tags for this resource.
CfnProperties

Provides information that defines a migration project.
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.
MigrationProjectRef

A reference to a MigrationProject resource.
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.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)

Provides information that defines a migration project.

Constructors

CfnMigrationProject(Construct, string, ICfnMigrationProjectProps?)

Provides information that defines a migration project.

public CfnMigrationProject(Construct scope, string id, ICfnMigrationProjectProps? props = null)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnMigrationProjectProps

Resource properties.

Remarks

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

CloudformationResource: AWS::DMS::MigrationProject

ExampleMetadata: fixture=_generated

Properties

AttrMigrationProjectArn

The ARN string that uniquely identifies the migration project.

public virtual string AttrMigrationProjectArn { get; }
Property Value

string

Remarks

CloudformationAttribute: MigrationProjectArn

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

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

CloudformationResource: AWS::DMS::MigrationProject

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }
Property Value

TagManager

Remarks

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

CloudformationResource: AWS::DMS::MigrationProject

ExampleMetadata: fixture=_generated

CfnProperties

Provides information that defines a migration project.

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
Remarks

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

CloudformationResource: AWS::DMS::MigrationProject

ExampleMetadata: fixture=_generated

Description

A user-friendly description of the migration project.

public virtual string? Description { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::DMS::MigrationProject

ExampleMetadata: fixture=_generated

InstanceProfileArn

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

public virtual string? InstanceProfileArn { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::DMS::MigrationProject

ExampleMetadata: fixture=_generated

InstanceProfileIdentifier

The identifier of the instance profile for your migration project.

public virtual string? InstanceProfileIdentifier { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::DMS::MigrationProject

ExampleMetadata: fixture=_generated

InstanceProfileName

The name of the associated instance profile.

public virtual string? InstanceProfileName { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::DMS::MigrationProject

ExampleMetadata: fixture=_generated

MigrationProjectCreationTime

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

[Obsolete("this property has been deprecated")]
public virtual string? MigrationProjectCreationTime { get; set; }
Property Value

string

Remarks

Stability: Deprecated

MigrationProjectIdentifier

The identifier of the migration project.

public virtual string? MigrationProjectIdentifier { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::DMS::MigrationProject

ExampleMetadata: fixture=_generated

MigrationProjectName

The name of the migration project.

public virtual string? MigrationProjectName { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::DMS::MigrationProject

ExampleMetadata: fixture=_generated

MigrationProjectRef

A reference to a MigrationProject resource.

public virtual IMigrationProjectReference MigrationProjectRef { get; }
Property Value

IMigrationProjectReference

Remarks

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

CloudformationResource: AWS::DMS::MigrationProject

ExampleMetadata: fixture=_generated

SchemaConversionApplicationAttributes

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

public virtual object? SchemaConversionApplicationAttributes { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnMigrationProject.ISchemaConversionApplicationAttributesProperty

SourceDataProviderDescriptors

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

public virtual object? SourceDataProviderDescriptors { get; set; }
Property Value

object

Remarks

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

Tags

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

public virtual ICfnTag[]? Tags { get; set; }
Property Value

ICfnTag[]

Remarks

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

CloudformationResource: AWS::DMS::MigrationProject

ExampleMetadata: fixture=_generated

TargetDataProviderDescriptors

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

public virtual object? TargetDataProviderDescriptors { get; set; }
Property Value

object

Remarks

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

TransformationRules

The settings in JSON format for migration rules.

public virtual string? TransformationRules { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::DMS::MigrationProject

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

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

CloudformationResource: AWS::DMS::MigrationProject

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Provides information that defines a migration project.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
Remarks

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

CloudformationResource: AWS::DMS::MigrationProject

ExampleMetadata: fixture=_generated

Implements

Constructs.IConstruct
Constructs.IDependable