Package software.amazon.awscdk.services.dms

Interface CfnMigrationProjectProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnMigrationProjectProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.109.0 (build c221850)",
           date="2025-03-14T03:24:56.458Z")
@Stability(Stable)
public interface CfnMigrationProjectProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnMigrationProject.

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.*;
 CfnMigrationProjectProps cfnMigrationProjectProps = CfnMigrationProjectProps.builder()
         .description("description")
         .instanceProfileArn("instanceProfileArn")
         .instanceProfileIdentifier("instanceProfileIdentifier")
         .instanceProfileName("instanceProfileName")
         .migrationProjectCreationTime("migrationProjectCreationTime")
         .migrationProjectIdentifier("migrationProjectIdentifier")
         .migrationProjectName("migrationProjectName")
         .schemaConversionApplicationAttributes(SchemaConversionApplicationAttributesProperty.builder()
                 .s3BucketPath("s3BucketPath")
                 .s3BucketRoleArn("s3BucketRoleArn")
                 .build())
         .sourceDataProviderDescriptors(List.of(DataProviderDescriptorProperty.builder()
                 .dataProviderArn("dataProviderArn")
                 .dataProviderIdentifier("dataProviderIdentifier")
                 .dataProviderName("dataProviderName")
                 .secretsManagerAccessRoleArn("secretsManagerAccessRoleArn")
                 .secretsManagerSecretId("secretsManagerSecretId")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .targetDataProviderDescriptors(List.of(DataProviderDescriptorProperty.builder()
                 .dataProviderArn("dataProviderArn")
                 .dataProviderIdentifier("dataProviderIdentifier")
                 .dataProviderName("dataProviderName")
                 .secretsManagerAccessRoleArn("secretsManagerAccessRoleArn")
                 .secretsManagerSecretId("secretsManagerSecretId")
                 .build()))
         .transformationRules("transformationRules")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnMigrationProjectProps.Builder	builder()
default String	getDescription()	A user-friendly description of the migration project.
default String	getInstanceProfileArn()	The Amazon Resource Name (ARN) of the instance profile for your migration project.
default String	getInstanceProfileIdentifier()	The identifier of the instance profile for your migration project.
default String	getInstanceProfileName()	The name of the associated instance profile.
default String	getMigrationProjectCreationTime()	Deprecated. this property has been deprecated
default String	getMigrationProjectIdentifier()	The identifier of the migration project.
default String	getMigrationProjectName()	The name of the migration project.
default Object	getSchemaConversionApplicationAttributes()	The schema conversion application attributes, including the Amazon S3 bucket name and Amazon S3 role ARN.
default Object	getSourceDataProviderDescriptors()	Information about the source data provider, including the name or ARN, and AWS Secrets Manager parameters.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.
default Object	getTargetDataProviderDescriptors()	Information about the target data provider, including the name or ARN, and AWS Secrets Manager parameters.
default String	getTransformationRules()	The settings in JSON format for migration rules.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDescription

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

A user-friendly description of the migration project.

See Also:

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

getInstanceProfileArn

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

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

See Also:

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

getInstanceProfileIdentifier

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

The identifier of the instance profile for your migration project.

See Also:

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

getInstanceProfileName

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

The name of the associated instance profile.

See Also:

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

getMigrationProjectCreationTime

@Stability(Deprecated)
@Deprecated
@Nullable
default String getMigrationProjectCreationTime()

Deprecated.

this property has been deprecated

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

See Also:

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

getMigrationProjectIdentifier

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

The identifier of the migration project.

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 Also:

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

getMigrationProjectName

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

The name of the migration project.

See Also:

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

getSchemaConversionApplicationAttributes

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

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

See Also:

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

getSourceDataProviderDescriptors

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

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

See Also:

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

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-migrationproject.html#cfn-dms-migrationproject-tags

getTargetDataProviderDescriptors

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

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

See Also:

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

getTransformationRules

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

The settings in JSON format for migration rules.

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 Also:

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

builder

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

Returns:

a CfnMigrationProjectProps.Builder of CfnMigrationProjectProps