Package software.amazon.awscdk.services.entityresolution

Interface CfnIdMappingWorkflowProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIdMappingWorkflowProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-12-01T16:02:21.076Z")
@Stability(Stable)
public interface CfnIdMappingWorkflowProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnIdMappingWorkflow.

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.*;
 CfnIdMappingWorkflowProps cfnIdMappingWorkflowProps = CfnIdMappingWorkflowProps.builder()
         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idmappingworkflow.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnIdMappingWorkflowProps.Builder	builder()
default String	getDescription()	A description of the workflow.
default Object	getIdMappingIncrementalRunConfig()	Returns union: either IResolvable or CfnIdMappingWorkflow.IdMappingIncrementalRunConfigProperty
Object	getIdMappingTechniques()	An object which defines the ID mapping technique and any additional configurations.
Object	getInputSourceConfig()	A list of InputSource objects, which have the fields InputSourceARN and SchemaName .
default Object	getOutputSourceConfig()	A list of IdMappingWorkflowOutputSource objects, each of which contains fields outputS3Path and KMSArn .
String	getRoleArn()	The Amazon Resource Name (ARN) of the IAM role.
default List<CfnTag>	getTags()	The tags used to organize, track, or control access for this resource.
String	getWorkflowName()	The name of the workflow.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIdMappingTechniques

@Stability(Stable)
@NotNull
Object getIdMappingTechniques()

An object which defines the ID mapping technique and any additional configurations.

Returns union: either IResolvable or CfnIdMappingWorkflow.IdMappingTechniquesProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idmappingworkflow.html#cfn-entityresolution-idmappingworkflow-idmappingtechniques

getInputSourceConfig

@Stability(Stable)
@NotNull
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>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idmappingworkflow.html#cfn-entityresolution-idmappingworkflow-inputsourceconfig

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

The Amazon Resource Name (ARN) of the IAM role.

AWS Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idmappingworkflow.html#cfn-entityresolution-idmappingworkflow-rolearn

getWorkflowName

@Stability(Stable)
@NotNull
String getWorkflowName()

The name of the workflow.

There can't be multiple IdMappingWorkflows with the same name.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idmappingworkflow.html#cfn-entityresolution-idmappingworkflow-workflowname

getDescription

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

A description of the workflow.

See Also:

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

getIdMappingIncrementalRunConfig

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

Returns union: either IResolvable or CfnIdMappingWorkflow.IdMappingIncrementalRunConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idmappingworkflow.html#cfn-entityresolution-idmappingworkflow-idmappingincrementalrunconfig

getOutputSourceConfig

@Stability(Stable)
@Nullable
default 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>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idmappingworkflow.html#cfn-entityresolution-idmappingworkflow-outputsourceconfig

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags used to organize, track, or control access for this resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idmappingworkflow.html#cfn-entityresolution-idmappingworkflow-tags

builder

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

Returns:

a CfnIdMappingWorkflowProps.Builder of CfnIdMappingWorkflowProps