Package software.amazon.awscdk.services.dms

Class CfnMigrationProject

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.dms.CfnMigrationProject
All Implemented Interfaces:
IInspectable, ITaggableV2, IMigrationProjectRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:36.386Z") @Stability(Stable) public class CfnMigrationProject extends CfnResource implements IInspectable, IMigrationProjectRef, ITaggableV2
Provides information that defines a migration project.

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.*;
 CfnMigrationProject cfnMigrationProject = CfnMigrationProject.Builder.create(this, "MyCfnMigrationProject")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnMigrationProject

      protected CfnMigrationProject(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnMigrationProject

      protected CfnMigrationProject(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnMigrationProject

      @Stability(Stable) public CfnMigrationProject(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnMigrationProjectProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnMigrationProject

      @Stability(Stable) public CfnMigrationProject(@NotNull software.constructs.Construct scope, @NotNull String id)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrMigrationProjectArn

      @Stability(Stable) @NotNull public String getAttrMigrationProjectArn()
      The ARN string that uniquely identifies the migration project.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getMigrationProjectRef

      @Stability(Stable) @NotNull public MigrationProjectReference getMigrationProjectRef()
      A reference to a MigrationProject resource.
      Specified by:
      getMigrationProjectRef in interface IMigrationProjectRef

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A user-friendly description of the migration project.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A user-friendly description of the migration project.

    • getInstanceProfileArn

      @Stability(Stable) @Nullable public String getInstanceProfileArn()
      The Amazon Resource Name (ARN) of the instance profile for your migration project.

    • setInstanceProfileArn

      @Stability(Stable) public void setInstanceProfileArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the instance profile for your migration project.

    • getInstanceProfileIdentifier

      @Stability(Stable) @Nullable public String getInstanceProfileIdentifier()
      The identifier of the instance profile for your migration project.

    • setInstanceProfileIdentifier

      @Stability(Stable) public void setInstanceProfileIdentifier(@Nullable String value)
      The identifier of the instance profile for your migration project.

    • getInstanceProfileName

      @Stability(Stable) @Nullable public String getInstanceProfileName()
      The name of the associated instance profile.

    • setInstanceProfileName

      @Stability(Stable) public void setInstanceProfileName(@Nullable String value)
      The name of the associated instance profile.

    • getMigrationProjectCreationTime

      @Stability(Deprecated) @Deprecated @Nullable public String getMigrationProjectCreationTime()
      Deprecated.
      this property has been deprecated
      (deprecated) The property describes a creating time of the migration project.

    • setMigrationProjectCreationTime

      @Stability(Deprecated) @Deprecated public void setMigrationProjectCreationTime(@Nullable String value)
      Deprecated.
      this property has been deprecated
      (deprecated) The property describes a creating time of the migration project.

    • getMigrationProjectIdentifier

      @Stability(Stable) @Nullable public String getMigrationProjectIdentifier()
      The identifier of the migration project.

    • setMigrationProjectIdentifier

      @Stability(Stable) public void setMigrationProjectIdentifier(@Nullable String value)
      The identifier of the migration project.

    • getMigrationProjectName

      @Stability(Stable) @Nullable public String getMigrationProjectName()
      The name of the migration project.

    • setMigrationProjectName

      @Stability(Stable) public void setMigrationProjectName(@Nullable String value)
      The name of the migration project.

    • getSchemaConversionApplicationAttributes

      @Stability(Stable) @Nullable public Object getSchemaConversionApplicationAttributes()
      The schema conversion application attributes, including the Amazon S3 bucket name and Amazon S3 role ARN.

      Returns union: either IResolvable or CfnMigrationProject.SchemaConversionApplicationAttributesProperty

    • setSchemaConversionApplicationAttributes

      @Stability(Stable) public void setSchemaConversionApplicationAttributes(@Nullable IResolvable value)
      The schema conversion application attributes, including the Amazon S3 bucket name and Amazon S3 role ARN.

    • setSchemaConversionApplicationAttributes

      @Stability(Stable) public void setSchemaConversionApplicationAttributes(@Nullable CfnMigrationProject.SchemaConversionApplicationAttributesProperty value)
      The schema conversion application attributes, including the Amazon S3 bucket name and Amazon S3 role ARN.

    • getSourceDataProviderDescriptors

      @Stability(Stable) @Nullable public Object getSourceDataProviderDescriptors()
      Information about the source data provider, including the name or ARN, and AWS Secrets Manager parameters.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnMigrationProject.DataProviderDescriptorProperty>

    • setSourceDataProviderDescriptors

      @Stability(Stable) public void setSourceDataProviderDescriptors(@Nullable IResolvable value)
      Information about the source data provider, including the name or ARN, and AWS Secrets Manager parameters.

    • setSourceDataProviderDescriptors

      @Stability(Stable) public void setSourceDataProviderDescriptors(@Nullable List<Object> value)
      Information about the source data provider, including the name or ARN, and AWS Secrets Manager parameters.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An array of key-value pairs to apply to this resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.

    • getTargetDataProviderDescriptors

      @Stability(Stable) @Nullable public Object getTargetDataProviderDescriptors()
      Information about the target data provider, including the name or ARN, and AWS Secrets Manager parameters.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnMigrationProject.DataProviderDescriptorProperty>

    • setTargetDataProviderDescriptors

      @Stability(Stable) public void setTargetDataProviderDescriptors(@Nullable IResolvable value)
      Information about the target data provider, including the name or ARN, and AWS Secrets Manager parameters.

    • setTargetDataProviderDescriptors

      @Stability(Stable) public void setTargetDataProviderDescriptors(@Nullable List<Object> value)
      Information about the target data provider, including the name or ARN, and AWS Secrets Manager parameters.

    • getTransformationRules

      @Stability(Stable) @Nullable public String getTransformationRules()
      The settings in JSON format for migration rules.

    • setTransformationRules

      @Stability(Stable) public void setTransformationRules(@Nullable String value)
      The settings in JSON format for migration rules.