Package software.amazon.awscdk.services.entityresolution

Class CfnIdMappingWorkflow

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.entityresolution.CfnIdMappingWorkflow
All Implemented Interfaces:
IInspectable, ITaggableV2, IIdMappingWorkflowRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:40.128Z") @Stability(Stable) public class CfnIdMappingWorkflow extends CfnResource implements IInspectable, IIdMappingWorkflowRef, ITaggableV2
Creates an IdMappingWorkflow object which stores the configuration of the data processing job to be run.

Each IdMappingWorkflow must have a unique workflow name. To modify an existing workflow, use the UpdateIdMappingWorkflow API.

Incremental processing is not supported for ID mapping workflows.

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.entityresolution.*;
 CfnIdMappingWorkflow cfnIdMappingWorkflow = CfnIdMappingWorkflow.Builder.create(this, "MyCfnIdMappingWorkflow")
         .idMappingTechniques(IdMappingTechniquesProperty.builder()
                 .idMappingType("idMappingType")
                 .normalizationVersion("normalizationVersion")
                 .providerProperties(ProviderPropertiesProperty.builder()
                         .providerServiceArn("providerServiceArn")
                         // the properties below are optional
                         .intermediateSourceConfiguration(IntermediateSourceConfigurationProperty.builder()
                                 .intermediateS3Path("intermediateS3Path")
                                 .build())
                         .providerConfiguration(Map.of(
                                 "providerConfigurationKey", "providerConfiguration"))
                         .build())
                 .ruleBasedProperties(IdMappingRuleBasedPropertiesProperty.builder()
                         .attributeMatchingModel("attributeMatchingModel")
                         .recordMatchingModel("recordMatchingModel")
                         // the properties below are optional
                         .ruleDefinitionType("ruleDefinitionType")
                         .rules(List.of(RuleProperty.builder()
                                 .matchingKeys(List.of("matchingKeys"))
                                 .ruleName("ruleName")
                                 .build()))
                         .build())
                 .build())
         .inputSourceConfig(List.of(IdMappingWorkflowInputSourceProperty.builder()
                 .inputSourceArn("inputSourceArn")
                 // the properties below are optional
                 .schemaArn("schemaArn")
                 .type("type")
                 .build()))
         .roleArn("roleArn")
         .workflowName("workflowName")
         // the properties below are optional
         .description("description")
         .idMappingIncrementalRunConfig(IdMappingIncrementalRunConfigProperty.builder()
                 .incrementalRunType("incrementalRunType")
                 .build())
         .outputSourceConfig(List.of(IdMappingWorkflowOutputSourceProperty.builder()
                 .outputS3Path("outputS3Path")
                 // the properties below are optional
                 .kmsArn("kmsArn")
                 .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

    • CfnIdMappingWorkflow

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

    • CfnIdMappingWorkflow

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

    • CfnIdMappingWorkflow

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

    • fromWorkflowName

      @Stability(Stable) @NotNull public static IIdMappingWorkflowRef fromWorkflowName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String workflowName)
      Creates a new IIdMappingWorkflowRef from a workflowName.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      workflowName - This parameter is required.

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

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The time of this IdMappingWorkflow got created.

    • getAttrUpdatedAt

      @Stability(Stable) @NotNull public String getAttrUpdatedAt()
      The time of this IdMappingWorkflow got last updated at.

    • getAttrWorkflowArn

      @Stability(Stable) @NotNull public String getAttrWorkflowArn()
      The default IdMappingWorkflow arn.

    • 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

    • getIdMappingWorkflowRef

      @Stability(Stable) @NotNull public IdMappingWorkflowReference getIdMappingWorkflowRef()
      A reference to a IdMappingWorkflow resource.
      Specified by:
      getIdMappingWorkflowRef in interface IIdMappingWorkflowRef

    • getIdMappingTechniques

      @Stability(Stable) @NotNull public Object getIdMappingTechniques()
      An object which defines the ID mapping technique and any additional configurations.

      Returns union: either IResolvable or CfnIdMappingWorkflow.IdMappingTechniquesProperty

    • setIdMappingTechniques

      @Stability(Stable) public void setIdMappingTechniques(@NotNull IResolvable value)
      An object which defines the ID mapping technique and any additional configurations.

    • setIdMappingTechniques

      @Stability(Stable) public void setIdMappingTechniques(@NotNull CfnIdMappingWorkflow.IdMappingTechniquesProperty value)
      An object which defines the ID mapping technique and any additional configurations.

    • getInputSourceConfig

      @Stability(Stable) @NotNull public Object getInputSourceConfig()
      A list of InputSource objects, which have the fields InputSourceARN and SchemaName .

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnIdMappingWorkflow.IdMappingWorkflowInputSourceProperty>

    • setInputSourceConfig

      @Stability(Stable) public void setInputSourceConfig(@NotNull IResolvable value)
      A list of InputSource objects, which have the fields InputSourceARN and SchemaName .

    • setInputSourceConfig

      @Stability(Stable) public void setInputSourceConfig(@NotNull List<Object> value)
      A list of InputSource objects, which have the fields InputSourceARN and SchemaName .

    • getRoleArn

      @Stability(Stable) @NotNull public String getRoleArn()
      The Amazon Resource Name (ARN) of the IAM role.

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the IAM role.

    • getWorkflowName

      @Stability(Stable) @NotNull public String getWorkflowName()
      The name of the workflow.

    • setWorkflowName

      @Stability(Stable) public void setWorkflowName(@NotNull String value)
      The name of the workflow.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the workflow.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the workflow.

    • getIdMappingIncrementalRunConfig

      @Stability(Stable) @Nullable public Object getIdMappingIncrementalRunConfig()
      Returns union: either IResolvable or CfnIdMappingWorkflow.IdMappingIncrementalRunConfigProperty

    • setIdMappingIncrementalRunConfig

      @Stability(Stable) public void setIdMappingIncrementalRunConfig(@Nullable IResolvable value)

    • setIdMappingIncrementalRunConfig

      @Stability(Stable) public void setIdMappingIncrementalRunConfig(@Nullable CfnIdMappingWorkflow.IdMappingIncrementalRunConfigProperty value)

    • getOutputSourceConfig

      @Stability(Stable) @Nullable public Object getOutputSourceConfig()
      A list of IdMappingWorkflowOutputSource objects, each of which contains fields outputS3Path and KMSArn .

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnIdMappingWorkflow.IdMappingWorkflowOutputSourceProperty>

    • setOutputSourceConfig

      @Stability(Stable) public void setOutputSourceConfig(@Nullable IResolvable value)
      A list of IdMappingWorkflowOutputSource objects, each of which contains fields outputS3Path and KMSArn .

    • setOutputSourceConfig

      @Stability(Stable) public void setOutputSourceConfig(@Nullable List<Object> value)
      A list of IdMappingWorkflowOutputSource objects, each of which contains fields outputS3Path and KMSArn .

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags used to organize, track, or control access for this resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags used to organize, track, or control access for this resource.