Interface ICfnMatchingWorkflowProps

Properties for defining a CfnMatchingWorkflow.

Namespace: Amazon.CDK.AWS.EntityResolution

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnMatchingWorkflowProps

Syntax (vb)

Public Interface ICfnMatchingWorkflowProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-matchingworkflow.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.EntityResolution;

             var cfnMatchingWorkflowProps = new CfnMatchingWorkflowProps {
                 InputSourceConfig = new [] { new InputSourceProperty {
                     InputSourceArn = "inputSourceArn",
                     SchemaArn = "schemaArn",

                     // the properties below are optional
                     ApplyNormalization = false
                 } },
                 OutputSourceConfig = new [] { new OutputSourceProperty {
                     Output = new [] { new OutputAttributeProperty {
                         Name = "name",

                         // the properties below are optional
                         Hashed = false
                     } },
                     OutputS3Path = "outputS3Path",

                     // the properties below are optional
                     ApplyNormalization = false,
                     KmsArn = "kmsArn"
                 } },
                 ResolutionTechniques = new ResolutionTechniquesProperty {
                     ProviderProperties = new ProviderPropertiesProperty {
                         ProviderServiceArn = "providerServiceArn",

                         // the properties below are optional
                         IntermediateSourceConfiguration = new IntermediateSourceConfigurationProperty {
                             IntermediateS3Path = "intermediateS3Path"
                         },
                         ProviderConfiguration = new Dictionary<string, string> {
                             { "providerConfigurationKey", "providerConfiguration" }
                         }
                     },
                     ResolutionType = "resolutionType",
                     RuleBasedProperties = new RuleBasedPropertiesProperty {
                         AttributeMatchingModel = "attributeMatchingModel",
                         Rules = new [] { new RuleProperty {
                             MatchingKeys = new [] { "matchingKeys" },
                             RuleName = "ruleName"
                         } },

                         // the properties below are optional
                         MatchPurpose = "matchPurpose"
                     },
                     RuleConditionProperties = new RuleConditionPropertiesProperty {
                         Rules = new [] { new RuleConditionProperty {
                             Condition = "condition",
                             RuleName = "ruleName"
                         } }
                     }
                 },
                 RoleArn = "roleArn",
                 WorkflowName = "workflowName",

                 // the properties below are optional
                 Description = "description",
                 IncrementalRunConfig = new IncrementalRunConfigProperty {
                     IncrementalRunType = "incrementalRunType"
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Properties

Description	A description of the workflow.
IncrementalRunConfig	Optional.
InputSourceConfig	A list of `InputSource` objects, which have the fields `InputSourceARN` and `SchemaName` .
OutputSourceConfig	A list of `OutputSource` objects, each of which contains fields `outputS3Path` , `applyNormalization` , `KMSArn` , and `output` .
ResolutionTechniques	An object which defines the `resolutionType` and the `ruleBasedProperties` .
RoleArn	The Amazon Resource Name (ARN) of the IAM role.
Tags	The tags used to organize, track, or control access for this resource.
WorkflowName	The name of the workflow.

Properties

Description

A description of the workflow.

string? Description { get; }

Property Value

string

Remarks

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

IncrementalRunConfig

Optional.

object? IncrementalRunConfig { get; }

Property Value

object

Remarks

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 <code>resolutionType</code> is <code>ML_MATCHING</code> or <code>PROVIDER</code> , incremental processing is not supported.

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

Type union: either IResolvable or CfnMatchingWorkflow.IIncrementalRunConfigProperty

InputSourceConfig

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

object InputSourceConfig { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or (either IResolvable or CfnMatchingWorkflow.IInputSourceProperty)[]

OutputSourceConfig

A list of OutputSource objects, each of which contains fields outputS3Path , applyNormalization , KMSArn , and output .

object OutputSourceConfig { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or (either IResolvable or CfnMatchingWorkflow.IOutputSourceProperty)[]

ResolutionTechniques

An object which defines the resolutionType and the ruleBasedProperties .

object ResolutionTechniques { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnMatchingWorkflow.IResolutionTechniquesProperty

RoleArn

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

string RoleArn { get; }

Property Value

string

Remarks

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

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

WorkflowName

The name of the workflow.

string WorkflowName { get; }

Property Value

string

Remarks

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

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