Package software.amazon.awscdk.services.entityresolution

Interface CfnMatchingWorkflowProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnMatchingWorkflowProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
           date="2025-06-13T09:19:37.850Z")
@Stability(Stable)
public interface CfnMatchingWorkflowProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnMatchingWorkflow.

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.*;
 CfnMatchingWorkflowProps cfnMatchingWorkflowProps = CfnMatchingWorkflowProps.builder()
         .inputSourceConfig(List.of(InputSourceProperty.builder()
                 .inputSourceArn("inputSourceArn")
                 .schemaArn("schemaArn")
                 // the properties below are optional
                 .applyNormalization(false)
                 .build()))
         .outputSourceConfig(List.of(OutputSourceProperty.builder()
                 .output(List.of(OutputAttributeProperty.builder()
                         .name("name")
                         // the properties below are optional
                         .hashed(false)
                         .build()))
                 .outputS3Path("outputS3Path")
                 // the properties below are optional
                 .applyNormalization(false)
                 .kmsArn("kmsArn")
                 .build()))
         .resolutionTechniques(ResolutionTechniquesProperty.builder()
                 .providerProperties(ProviderPropertiesProperty.builder()
                         .providerServiceArn("providerServiceArn")
                         // the properties below are optional
                         .intermediateSourceConfiguration(IntermediateSourceConfigurationProperty.builder()
                                 .intermediateS3Path("intermediateS3Path")
                                 .build())
                         .providerConfiguration(Map.of(
                                 "providerConfigurationKey", "providerConfiguration"))
                         .build())
                 .resolutionType("resolutionType")
                 .ruleBasedProperties(RuleBasedPropertiesProperty.builder()
                         .attributeMatchingModel("attributeMatchingModel")
                         .rules(List.of(RuleProperty.builder()
                                 .matchingKeys(List.of("matchingKeys"))
                                 .ruleName("ruleName")
                                 .build()))
                         // the properties below are optional
                         .matchPurpose("matchPurpose")
                         .build())
                 .build())
         .roleArn("roleArn")
         .workflowName("workflowName")
         // the properties below are optional
         .description("description")
         .incrementalRunConfig(IncrementalRunConfigProperty.builder()
                 .incrementalRunType("incrementalRunType")
                 .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-matchingworkflow.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnMatchingWorkflowProps.Builder	builder()
default String	getDescription()	A description of the workflow.
default Object	getIncrementalRunConfig()	Optional.
Object	getInputSourceConfig()	A list of InputSource objects, which have the fields InputSourceARN and SchemaName .
Object	getOutputSourceConfig()	A list of OutputSource objects, each of which contains fields OutputS3Path , ApplyNormalization , and Output .
Object	getResolutionTechniques()	An object which defines the resolutionType and the ruleBasedProperties .
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

getInputSourceConfig

@Stability(Stable)
@NotNull
Object getInputSourceConfig()

A list of InputSource objects, which have the fields InputSourceARN and SchemaName .

See Also:

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

getOutputSourceConfig

@Stability(Stable)
@NotNull
Object getOutputSourceConfig()

A list of OutputSource objects, each of which contains fields OutputS3Path , ApplyNormalization , and Output .

See Also:

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

getResolutionTechniques

@Stability(Stable)
@NotNull
Object getResolutionTechniques()

An object which defines the resolutionType and the ruleBasedProperties .

See Also:

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

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-matchingworkflow.html#cfn-entityresolution-matchingworkflow-rolearn

getWorkflowName

@Stability(Stable)
@NotNull
String getWorkflowName()

The name of the workflow.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-matchingworkflow.html#cfn-entityresolution-matchingworkflow-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-matchingworkflow.html#cfn-entityresolution-matchingworkflow-description

getIncrementalRunConfig

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

Optional.

An object that defines the incremental run type. This object contains only the incrementalRunType field, which appears as "Automatic" in the console.

For workflows where resolutionType is ML_MATCHING , incremental processing is not supported.

See Also:

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

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-matchingworkflow.html#cfn-entityresolution-matchingworkflow-tags

builder

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

Returns:

a CfnMatchingWorkflowProps.Builder of CfnMatchingWorkflowProps