Package software.amazon.awscdk.services.entityresolution

Class CfnMatchingWorkflow

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.CfnMatchingWorkflow
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:31.371Z") @Stability(Stable) public class CfnMatchingWorkflow extends CfnResource implements IInspectable, ITaggableV2
Creates a MatchingWorkflow object which stores the configuration of the data processing job to be run.

It is important to note that there should not be a pre-existing MatchingWorkflow with the same name. To modify an existing workflow, utilize the UpdateMatchingWorkflow API.

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.*;
 CfnMatchingWorkflow cfnMatchingWorkflow = CfnMatchingWorkflow.Builder.create(this, "MyCfnMatchingWorkflow")
         .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:

  • 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

    • CfnMatchingWorkflow

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

    • CfnMatchingWorkflow

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

    • CfnMatchingWorkflow

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

    • getAttrCreatedAt

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

    • getAttrUpdatedAt

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

    • getAttrWorkflowArn

      @Stability(Stable) @NotNull public String getAttrWorkflowArn()
      The default MatchingWorkflow 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

    • getInputSourceConfig

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

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

    • getOutputSourceConfig

      @Stability(Stable) @NotNull public Object getOutputSourceConfig()
      A list of OutputSource objects, each of which contains fields OutputS3Path , ApplyNormalization , and Output .

    • setOutputSourceConfig

      @Stability(Stable) public void setOutputSourceConfig(@NotNull IResolvable value)
      A list of OutputSource objects, each of which contains fields OutputS3Path , ApplyNormalization , and Output .

    • setOutputSourceConfig

      @Stability(Stable) public void setOutputSourceConfig(@NotNull List<Object> value)
      A list of OutputSource objects, each of which contains fields OutputS3Path , ApplyNormalization , and Output .

    • getResolutionTechniques

      @Stability(Stable) @NotNull public Object getResolutionTechniques()
      An object which defines the resolutionType and the ruleBasedProperties .

    • setResolutionTechniques

      @Stability(Stable) public void setResolutionTechniques(@NotNull IResolvable value)
      An object which defines the resolutionType and the ruleBasedProperties .

    • setResolutionTechniques

      @Stability(Stable) public void setResolutionTechniques(@NotNull CfnMatchingWorkflow.ResolutionTechniquesProperty value)
      An object which defines the resolutionType and the ruleBasedProperties .

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

    • getIncrementalRunConfig

      @Stability(Stable) @Nullable public Object getIncrementalRunConfig()
      An object which defines an incremental run type and has only incrementalRunType as a field.

    • setIncrementalRunConfig

      @Stability(Stable) public void setIncrementalRunConfig(@Nullable IResolvable value)
      An object which defines an incremental run type and has only incrementalRunType as a field.

    • setIncrementalRunConfig

      @Stability(Stable) public void setIncrementalRunConfig(@Nullable CfnMatchingWorkflow.IncrementalRunConfigProperty value)
      An object which defines an incremental run type and has only incrementalRunType as a field.

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