Package software.amazon.awscdk.services.dms

Class CfnDataMigration

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.CfnDataMigration
All Implemented Interfaces:
IInspectable, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-12-17T21:37:29.199Z") @Stability(Stable) public class CfnDataMigration extends CfnResource implements IInspectable, ITaggableV2
This object provides information about a AWS DMS data migration.

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.*;
 CfnDataMigration cfnDataMigration = CfnDataMigration.Builder.create(this, "MyCfnDataMigration")
         .dataMigrationType("dataMigrationType")
         .migrationProjectIdentifier("migrationProjectIdentifier")
         .serviceAccessRoleArn("serviceAccessRoleArn")
         // the properties below are optional
         .dataMigrationIdentifier("dataMigrationIdentifier")
         .dataMigrationName("dataMigrationName")
         .dataMigrationSettings(DataMigrationSettingsProperty.builder()
                 .cloudwatchLogsEnabled(false)
                 .numberOfJobs(123)
                 .selectionRules("selectionRules")
                 .build())
         .sourceDataSettings(List.of(SourceDataSettingsProperty.builder()
                 .cdcStartPosition("cdcStartPosition")
                 .cdcStartTime("cdcStartTime")
                 .cdcStopTime("cdcStopTime")
                 .slotName("slotName")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .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

    • CfnDataMigration

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

    • CfnDataMigration

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

    • CfnDataMigration

      @Stability(Stable) public CfnDataMigration(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDataMigrationProps 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. 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.

    • getAttrDataMigrationArn

      @Stability(Stable) @NotNull public String getAttrDataMigrationArn()
      The Amazon Resource Name (ARN) that identifies this replication.

    • getAttrDataMigrationCreateTime

      @Stability(Stable) @NotNull public String getAttrDataMigrationCreateTime()
      The UTC time when DMS created the data migration.

    • 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

    • getDataMigrationType

      @Stability(Stable) @NotNull public String getDataMigrationType()
      Specifies whether the data migration is full-load only, change data capture (CDC) only, or full-load and CDC.

    • setDataMigrationType

      @Stability(Stable) public void setDataMigrationType(@NotNull String value)
      Specifies whether the data migration is full-load only, change data capture (CDC) only, or full-load and CDC.

    • getMigrationProjectIdentifier

      @Stability(Stable) @NotNull public String getMigrationProjectIdentifier()
      The property describes an identifier for the migration project.

    • setMigrationProjectIdentifier

      @Stability(Stable) public void setMigrationProjectIdentifier(@NotNull String value)
      The property describes an identifier for the migration project.

    • getServiceAccessRoleArn

      @Stability(Stable) @NotNull public String getServiceAccessRoleArn()
      The IAM role that the data migration uses to access AWS resources.

    • setServiceAccessRoleArn

      @Stability(Stable) public void setServiceAccessRoleArn(@NotNull String value)
      The IAM role that the data migration uses to access AWS resources.

    • getDataMigrationIdentifier

      @Stability(Stable) @Nullable public String getDataMigrationIdentifier()
      The property describes an ARN of the data migration.

    • setDataMigrationIdentifier

      @Stability(Stable) public void setDataMigrationIdentifier(@Nullable String value)
      The property describes an ARN of the data migration.

    • getDataMigrationName

      @Stability(Stable) @Nullable public String getDataMigrationName()
      The user-friendly name for the data migration.

    • setDataMigrationName

      @Stability(Stable) public void setDataMigrationName(@Nullable String value)
      The user-friendly name for the data migration.

    • getDataMigrationSettings

      @Stability(Stable) @Nullable public Object getDataMigrationSettings()
      Specifies CloudWatch settings and selection rules for the data migration.

    • setDataMigrationSettings

      @Stability(Stable) public void setDataMigrationSettings(@Nullable IResolvable value)
      Specifies CloudWatch settings and selection rules for the data migration.

    • setDataMigrationSettings

      @Stability(Stable) public void setDataMigrationSettings(@Nullable CfnDataMigration.DataMigrationSettingsProperty value)
      Specifies CloudWatch settings and selection rules for the data migration.

    • getSourceDataSettings

      @Stability(Stable) @Nullable public Object getSourceDataSettings()
      Specifies information about the data migration's source data provider.

    • setSourceDataSettings

      @Stability(Stable) public void setSourceDataSettings(@Nullable IResolvable value)
      Specifies information about the data migration's source data provider.

    • setSourceDataSettings

      @Stability(Stable) public void setSourceDataSettings(@Nullable List<Object> value)
      Specifies information about the data migration's source data provider.

    • 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.