1. Packages
  2. AWS Native
  3. API Docs
  4. entityresolution
  5. IdMappingWorkflow

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.111.0 published on Tuesday, Jul 9, 2024 by Pulumi

aws-native.entityresolution.IdMappingWorkflow

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.111.0 published on Tuesday, Jul 9, 2024 by Pulumi

    IdMappingWorkflow defined in AWS Entity Resolution service

    Create IdMappingWorkflow Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new IdMappingWorkflow(name: string, args: IdMappingWorkflowArgs, opts?: CustomResourceOptions);
    @overload
    def IdMappingWorkflow(resource_name: str,
                          args: IdMappingWorkflowArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def IdMappingWorkflow(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          id_mapping_techniques: Optional[IdMappingWorkflowIdMappingTechniquesArgs] = None,
                          input_source_config: Optional[Sequence[IdMappingWorkflowInputSourceArgs]] = None,
                          role_arn: Optional[str] = None,
                          description: Optional[str] = None,
                          output_source_config: Optional[Sequence[IdMappingWorkflowOutputSourceArgs]] = None,
                          tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                          workflow_name: Optional[str] = None)
    func NewIdMappingWorkflow(ctx *Context, name string, args IdMappingWorkflowArgs, opts ...ResourceOption) (*IdMappingWorkflow, error)
    public IdMappingWorkflow(string name, IdMappingWorkflowArgs args, CustomResourceOptions? opts = null)
    public IdMappingWorkflow(String name, IdMappingWorkflowArgs args)
    public IdMappingWorkflow(String name, IdMappingWorkflowArgs args, CustomResourceOptions options)
    
    type: aws-native:entityresolution:IdMappingWorkflow
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args IdMappingWorkflowArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args IdMappingWorkflowArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args IdMappingWorkflowArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IdMappingWorkflowArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IdMappingWorkflowArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    IdMappingWorkflow Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The IdMappingWorkflow resource accepts the following input properties:

    IdMappingTechniques Pulumi.AwsNative.EntityResolution.Inputs.IdMappingWorkflowIdMappingTechniques
    An object which defines the idMappingType and the providerProperties .
    InputSourceConfig List<Pulumi.AwsNative.EntityResolution.Inputs.IdMappingWorkflowInputSource>
    A list of InputSource objects, which have the fields InputSourceARN and SchemaName .
    RoleArn string
    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.
    Description string
    The description of the IdMappingWorkflow
    OutputSourceConfig List<Pulumi.AwsNative.EntityResolution.Inputs.IdMappingWorkflowOutputSource>
    A list of IdMappingWorkflowOutputSource objects, each of which contains fields OutputS3Path and Output .
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    The tags used to organize, track, or control access for this resource.
    WorkflowName string
    The name of the IdMappingWorkflow
    IdMappingTechniques IdMappingWorkflowIdMappingTechniquesArgs
    An object which defines the idMappingType and the providerProperties .
    InputSourceConfig []IdMappingWorkflowInputSourceArgs
    A list of InputSource objects, which have the fields InputSourceARN and SchemaName .
    RoleArn string
    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.
    Description string
    The description of the IdMappingWorkflow
    OutputSourceConfig []IdMappingWorkflowOutputSourceArgs
    A list of IdMappingWorkflowOutputSource objects, each of which contains fields OutputS3Path and Output .
    Tags TagArgs
    The tags used to organize, track, or control access for this resource.
    WorkflowName string
    The name of the IdMappingWorkflow
    idMappingTechniques IdMappingWorkflowIdMappingTechniques
    An object which defines the idMappingType and the providerProperties .
    inputSourceConfig List<IdMappingWorkflowInputSource>
    A list of InputSource objects, which have the fields InputSourceARN and SchemaName .
    roleArn String
    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.
    description String
    The description of the IdMappingWorkflow
    outputSourceConfig List<IdMappingWorkflowOutputSource>
    A list of IdMappingWorkflowOutputSource objects, each of which contains fields OutputS3Path and Output .
    tags List<Tag>
    The tags used to organize, track, or control access for this resource.
    workflowName String
    The name of the IdMappingWorkflow
    idMappingTechniques IdMappingWorkflowIdMappingTechniques
    An object which defines the idMappingType and the providerProperties .
    inputSourceConfig IdMappingWorkflowInputSource[]
    A list of InputSource objects, which have the fields InputSourceARN and SchemaName .
    roleArn string
    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.
    description string
    The description of the IdMappingWorkflow
    outputSourceConfig IdMappingWorkflowOutputSource[]
    A list of IdMappingWorkflowOutputSource objects, each of which contains fields OutputS3Path and Output .
    tags Tag[]
    The tags used to organize, track, or control access for this resource.
    workflowName string
    The name of the IdMappingWorkflow
    id_mapping_techniques IdMappingWorkflowIdMappingTechniquesArgs
    An object which defines the idMappingType and the providerProperties .
    input_source_config Sequence[IdMappingWorkflowInputSourceArgs]
    A list of InputSource objects, which have the fields InputSourceARN and SchemaName .
    role_arn str
    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.
    description str
    The description of the IdMappingWorkflow
    output_source_config Sequence[IdMappingWorkflowOutputSourceArgs]
    A list of IdMappingWorkflowOutputSource objects, each of which contains fields OutputS3Path and Output .
    tags Sequence[TagArgs]
    The tags used to organize, track, or control access for this resource.
    workflow_name str
    The name of the IdMappingWorkflow
    idMappingTechniques Property Map
    An object which defines the idMappingType and the providerProperties .
    inputSourceConfig List<Property Map>
    A list of InputSource objects, which have the fields InputSourceARN and SchemaName .
    roleArn String
    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.
    description String
    The description of the IdMappingWorkflow
    outputSourceConfig List<Property Map>
    A list of IdMappingWorkflowOutputSource objects, each of which contains fields OutputS3Path and Output .
    tags List<Property Map>
    The tags used to organize, track, or control access for this resource.
    workflowName String
    The name of the IdMappingWorkflow

    Outputs

    All input properties are implicitly available as output properties. Additionally, the IdMappingWorkflow resource produces the following output properties:

    CreatedAt string
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    WorkflowArn string
    CreatedAt string
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    WorkflowArn string
    createdAt String
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    workflowArn String
    createdAt string
    id string
    The provider-assigned unique ID for this managed resource.
    updatedAt string
    workflowArn string
    created_at str
    id str
    The provider-assigned unique ID for this managed resource.
    updated_at str
    workflow_arn str
    createdAt String
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    workflowArn String

    Supporting Types

    IdMappingWorkflowIdMappingRuleBasedProperties, IdMappingWorkflowIdMappingRuleBasedPropertiesArgs

    IdMappingWorkflowIdMappingRuleBasedPropertiesAttributeMatchingModel, IdMappingWorkflowIdMappingRuleBasedPropertiesAttributeMatchingModelArgs

    OneToOne
    ONE_TO_ONE
    ManyToMany
    MANY_TO_MANY
    IdMappingWorkflowIdMappingRuleBasedPropertiesAttributeMatchingModelOneToOne
    ONE_TO_ONE
    IdMappingWorkflowIdMappingRuleBasedPropertiesAttributeMatchingModelManyToMany
    MANY_TO_MANY
    OneToOne
    ONE_TO_ONE
    ManyToMany
    MANY_TO_MANY
    OneToOne
    ONE_TO_ONE
    ManyToMany
    MANY_TO_MANY
    ONE_TO_ONE
    ONE_TO_ONE
    MANY_TO_MANY
    MANY_TO_MANY
    "ONE_TO_ONE"
    ONE_TO_ONE
    "MANY_TO_MANY"
    MANY_TO_MANY

    IdMappingWorkflowIdMappingRuleBasedPropertiesRecordMatchingModel, IdMappingWorkflowIdMappingRuleBasedPropertiesRecordMatchingModelArgs

    OneSourceToOneTarget
    ONE_SOURCE_TO_ONE_TARGET
    ManySourceToOneTarget
    MANY_SOURCE_TO_ONE_TARGET
    IdMappingWorkflowIdMappingRuleBasedPropertiesRecordMatchingModelOneSourceToOneTarget
    ONE_SOURCE_TO_ONE_TARGET
    IdMappingWorkflowIdMappingRuleBasedPropertiesRecordMatchingModelManySourceToOneTarget
    MANY_SOURCE_TO_ONE_TARGET
    OneSourceToOneTarget
    ONE_SOURCE_TO_ONE_TARGET
    ManySourceToOneTarget
    MANY_SOURCE_TO_ONE_TARGET
    OneSourceToOneTarget
    ONE_SOURCE_TO_ONE_TARGET
    ManySourceToOneTarget
    MANY_SOURCE_TO_ONE_TARGET
    ONE_SOURCE_TO_ONE_TARGET
    ONE_SOURCE_TO_ONE_TARGET
    MANY_SOURCE_TO_ONE_TARGET
    MANY_SOURCE_TO_ONE_TARGET
    "ONE_SOURCE_TO_ONE_TARGET"
    ONE_SOURCE_TO_ONE_TARGET
    "MANY_SOURCE_TO_ONE_TARGET"
    MANY_SOURCE_TO_ONE_TARGET

    IdMappingWorkflowIdMappingRuleBasedPropertiesRuleDefinitionType, IdMappingWorkflowIdMappingRuleBasedPropertiesRuleDefinitionTypeArgs

    Source
    SOURCE
    Target
    TARGET
    IdMappingWorkflowIdMappingRuleBasedPropertiesRuleDefinitionTypeSource
    SOURCE
    IdMappingWorkflowIdMappingRuleBasedPropertiesRuleDefinitionTypeTarget
    TARGET
    Source
    SOURCE
    Target
    TARGET
    Source
    SOURCE
    Target
    TARGET
    SOURCE
    SOURCE
    TARGET
    TARGET
    "SOURCE"
    SOURCE
    "TARGET"
    TARGET

    IdMappingWorkflowIdMappingTechniques, IdMappingWorkflowIdMappingTechniquesArgs

    idMappingType "PROVIDER" | "RULE_BASED"
    The type of ID mapping.
    normalizationVersion String
    providerProperties Property Map
    An object which defines any additional configurations required by the provider service.
    ruleBasedProperties Property Map

    IdMappingWorkflowIdMappingTechniquesIdMappingType, IdMappingWorkflowIdMappingTechniquesIdMappingTypeArgs

    Provider
    PROVIDER
    RuleBased
    RULE_BASED
    IdMappingWorkflowIdMappingTechniquesIdMappingTypeProvider
    PROVIDER
    IdMappingWorkflowIdMappingTechniquesIdMappingTypeRuleBased
    RULE_BASED
    Provider
    PROVIDER
    RuleBased
    RULE_BASED
    Provider
    PROVIDER
    RuleBased
    RULE_BASED
    PROVIDER
    PROVIDER
    RULE_BASED
    RULE_BASED
    "PROVIDER"
    PROVIDER
    "RULE_BASED"
    RULE_BASED

    IdMappingWorkflowInputSource, IdMappingWorkflowInputSourceArgs

    InputSourceArn string
    An Glue table ARN for the input source table, MatchingWorkflow arn or IdNamespace ARN
    SchemaArn string
    The ARN (Amazon Resource Name) that AWS Entity Resolution generated for the SchemaMapping .
    Type Pulumi.AwsNative.EntityResolution.IdMappingWorkflowInputSourceType

    The type of ID namespace. There are two types: SOURCE and TARGET .

    The SOURCE contains configurations for sourceId data that will be processed in an ID mapping workflow.

    The TARGET contains a configuration of targetId to which all sourceIds will resolve to.

    InputSourceArn string
    An Glue table ARN for the input source table, MatchingWorkflow arn or IdNamespace ARN
    SchemaArn string
    The ARN (Amazon Resource Name) that AWS Entity Resolution generated for the SchemaMapping .
    Type IdMappingWorkflowInputSourceType

    The type of ID namespace. There are two types: SOURCE and TARGET .

    The SOURCE contains configurations for sourceId data that will be processed in an ID mapping workflow.

    The TARGET contains a configuration of targetId to which all sourceIds will resolve to.

    inputSourceArn String
    An Glue table ARN for the input source table, MatchingWorkflow arn or IdNamespace ARN
    schemaArn String
    The ARN (Amazon Resource Name) that AWS Entity Resolution generated for the SchemaMapping .
    type IdMappingWorkflowInputSourceType

    The type of ID namespace. There are two types: SOURCE and TARGET .

    The SOURCE contains configurations for sourceId data that will be processed in an ID mapping workflow.

    The TARGET contains a configuration of targetId to which all sourceIds will resolve to.

    inputSourceArn string
    An Glue table ARN for the input source table, MatchingWorkflow arn or IdNamespace ARN
    schemaArn string
    The ARN (Amazon Resource Name) that AWS Entity Resolution generated for the SchemaMapping .
    type IdMappingWorkflowInputSourceType

    The type of ID namespace. There are two types: SOURCE and TARGET .

    The SOURCE contains configurations for sourceId data that will be processed in an ID mapping workflow.

    The TARGET contains a configuration of targetId to which all sourceIds will resolve to.

    input_source_arn str
    An Glue table ARN for the input source table, MatchingWorkflow arn or IdNamespace ARN
    schema_arn str
    The ARN (Amazon Resource Name) that AWS Entity Resolution generated for the SchemaMapping .
    type IdMappingWorkflowInputSourceType

    The type of ID namespace. There are two types: SOURCE and TARGET .

    The SOURCE contains configurations for sourceId data that will be processed in an ID mapping workflow.

    The TARGET contains a configuration of targetId to which all sourceIds will resolve to.

    inputSourceArn String
    An Glue table ARN for the input source table, MatchingWorkflow arn or IdNamespace ARN
    schemaArn String
    The ARN (Amazon Resource Name) that AWS Entity Resolution generated for the SchemaMapping .
    type "SOURCE" | "TARGET"

    The type of ID namespace. There are two types: SOURCE and TARGET .

    The SOURCE contains configurations for sourceId data that will be processed in an ID mapping workflow.

    The TARGET contains a configuration of targetId to which all sourceIds will resolve to.

    IdMappingWorkflowInputSourceType, IdMappingWorkflowInputSourceTypeArgs

    Source
    SOURCE
    Target
    TARGET
    IdMappingWorkflowInputSourceTypeSource
    SOURCE
    IdMappingWorkflowInputSourceTypeTarget
    TARGET
    Source
    SOURCE
    Target
    TARGET
    Source
    SOURCE
    Target
    TARGET
    SOURCE
    SOURCE
    TARGET
    TARGET
    "SOURCE"
    SOURCE
    "TARGET"
    TARGET

    IdMappingWorkflowIntermediateSourceConfiguration, IdMappingWorkflowIntermediateSourceConfigurationArgs

    IntermediateS3Path string
    The s3 path that would be used to stage the intermediate data being generated during workflow execution.
    IntermediateS3Path string
    The s3 path that would be used to stage the intermediate data being generated during workflow execution.
    intermediateS3Path String
    The s3 path that would be used to stage the intermediate data being generated during workflow execution.
    intermediateS3Path string
    The s3 path that would be used to stage the intermediate data being generated during workflow execution.
    intermediate_s3_path str
    The s3 path that would be used to stage the intermediate data being generated during workflow execution.
    intermediateS3Path String
    The s3 path that would be used to stage the intermediate data being generated during workflow execution.

    IdMappingWorkflowOutputSource, IdMappingWorkflowOutputSourceArgs

    OutputS3Path string
    The S3 path to which Entity Resolution will write the output table
    KmsArn string
    Customer AWS KMS ARN for encryption at rest. If not provided, system will use an AWS Entity Resolution managed KMS key.
    OutputS3Path string
    The S3 path to which Entity Resolution will write the output table
    KmsArn string
    Customer AWS KMS ARN for encryption at rest. If not provided, system will use an AWS Entity Resolution managed KMS key.
    outputS3Path String
    The S3 path to which Entity Resolution will write the output table
    kmsArn String
    Customer AWS KMS ARN for encryption at rest. If not provided, system will use an AWS Entity Resolution managed KMS key.
    outputS3Path string
    The S3 path to which Entity Resolution will write the output table
    kmsArn string
    Customer AWS KMS ARN for encryption at rest. If not provided, system will use an AWS Entity Resolution managed KMS key.
    output_s3_path str
    The S3 path to which Entity Resolution will write the output table
    kms_arn str
    Customer AWS KMS ARN for encryption at rest. If not provided, system will use an AWS Entity Resolution managed KMS key.
    outputS3Path String
    The S3 path to which Entity Resolution will write the output table
    kmsArn String
    Customer AWS KMS ARN for encryption at rest. If not provided, system will use an AWS Entity Resolution managed KMS key.

    IdMappingWorkflowProviderProperties, IdMappingWorkflowProviderPropertiesArgs

    ProviderServiceArn string
    Arn of the Provider Service being used.
    IntermediateSourceConfiguration Pulumi.AwsNative.EntityResolution.Inputs.IdMappingWorkflowIntermediateSourceConfiguration
    The Amazon S3 location that temporarily stores your data while it processes. Your information won't be saved permanently.
    ProviderConfiguration Dictionary<string, string>
    Additional Provider configuration that would be required for the provider service. The Configuration must be in JSON string format
    ProviderServiceArn string
    Arn of the Provider Service being used.
    IntermediateSourceConfiguration IdMappingWorkflowIntermediateSourceConfiguration
    The Amazon S3 location that temporarily stores your data while it processes. Your information won't be saved permanently.
    ProviderConfiguration map[string]string
    Additional Provider configuration that would be required for the provider service. The Configuration must be in JSON string format
    providerServiceArn String
    Arn of the Provider Service being used.
    intermediateSourceConfiguration IdMappingWorkflowIntermediateSourceConfiguration
    The Amazon S3 location that temporarily stores your data while it processes. Your information won't be saved permanently.
    providerConfiguration Map<String,String>
    Additional Provider configuration that would be required for the provider service. The Configuration must be in JSON string format
    providerServiceArn string
    Arn of the Provider Service being used.
    intermediateSourceConfiguration IdMappingWorkflowIntermediateSourceConfiguration
    The Amazon S3 location that temporarily stores your data while it processes. Your information won't be saved permanently.
    providerConfiguration {[key: string]: string}
    Additional Provider configuration that would be required for the provider service. The Configuration must be in JSON string format
    provider_service_arn str
    Arn of the Provider Service being used.
    intermediate_source_configuration IdMappingWorkflowIntermediateSourceConfiguration
    The Amazon S3 location that temporarily stores your data while it processes. Your information won't be saved permanently.
    provider_configuration Mapping[str, str]
    Additional Provider configuration that would be required for the provider service. The Configuration must be in JSON string format
    providerServiceArn String
    Arn of the Provider Service being used.
    intermediateSourceConfiguration Property Map
    The Amazon S3 location that temporarily stores your data while it processes. Your information won't be saved permanently.
    providerConfiguration Map<String>
    Additional Provider configuration that would be required for the provider service. The Configuration must be in JSON string format

    IdMappingWorkflowRule, IdMappingWorkflowRuleArgs

    MatchingKeys List<string>
    RuleName string
    MatchingKeys []string
    RuleName string
    matchingKeys List<String>
    ruleName String
    matchingKeys string[]
    ruleName string
    matching_keys Sequence[str]
    rule_name str
    matchingKeys List<String>
    ruleName String

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.111.0 published on Tuesday, Jul 9, 2024 by Pulumi