id_mapping_workflows

Creates, updates, deletes or gets an id_mapping_workflow resource or lists id_mapping_workflows in a region

Overview

Name	id_mapping_workflows
Type	Resource
Description	IdMappingWorkflow defined in AWS Entity Resolution service
Id	aws.entityresolution.id_mapping_workflows

Fields

Name	Datatype	Description
description	string	The description of the IdMappingWorkflow
input_source_config	array
id_mapping_techniques	object
workflow_name	string	The name of the IdMappingWorkflow
created_at	string	The time of this SchemaMapping got created
output_source_config	array
workflow_arn	string	The default IdMappingWorkflow arn
updated_at	string	The time of this SchemaMapping got last updated at
role_arn	string
tags	array
region	string	AWS region.

For more information, see AWS::EntityResolution::IdMappingWorkflow.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	WorkflowName, InputSourceConfig, IdMappingTechniques, RoleArn, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all id_mapping_workflows in a region.

SELECT
region,
description,
input_source_config,
id_mapping_techniques,
workflow_name,
created_at,
output_source_config,
workflow_arn,
updated_at,
role_arn,
tags
FROM aws.entityresolution.id_mapping_workflows
WHERE region = 'us-east-1';

Gets all properties from an individual id_mapping_workflow.

SELECT
region,
description,
input_source_config,
id_mapping_techniques,
workflow_name,
created_at,
output_source_config,
workflow_arn,
updated_at,
role_arn,
tags
FROM aws.entityresolution.id_mapping_workflows
WHERE region = 'us-east-1' AND data__Identifier = '<WorkflowName>';

INSERT example

Use the following StackQL query and manifest file to create a new id_mapping_workflow resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.entityresolution.id_mapping_workflows (
 InputSourceConfig,
 IdMappingTechniques,
 WorkflowName,
 RoleArn,
 region
)
SELECT 
'{{ InputSourceConfig }}',
 '{{ IdMappingTechniques }}',
 '{{ WorkflowName }}',
 '{{ RoleArn }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.entityresolution.id_mapping_workflows (
 Description,
 InputSourceConfig,
 IdMappingTechniques,
 WorkflowName,
 OutputSourceConfig,
 RoleArn,
 Tags,
 region
)
SELECT 
 '{{ Description }}',
 '{{ InputSourceConfig }}',
 '{{ IdMappingTechniques }}',
 '{{ WorkflowName }}',
 '{{ OutputSourceConfig }}',
 '{{ RoleArn }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: id_mapping_workflow
    props:
      - name: Description
        value: '{{ Description }}'
      - name: InputSourceConfig
        value:
          - Type: '{{ Type }}'
            InputSourceARN: '{{ InputSourceARN }}'
            SchemaArn: '{{ SchemaArn }}'
      - name: IdMappingTechniques
        value:
          RuleBasedProperties:
            AttributeMatchingModel: '{{ AttributeMatchingModel }}'
            RuleDefinitionType: '{{ RuleDefinitionType }}'
            Rules:
              - RuleName: '{{ RuleName }}'
                MatchingKeys:
                  - '{{ MatchingKeys[0] }}'
            RecordMatchingModel: '{{ RecordMatchingModel }}'
          ProviderProperties:
            ProviderServiceArn: '{{ ProviderServiceArn }}'
            ProviderConfiguration: {}
            IntermediateSourceConfiguration:
              IntermediateS3Path: '{{ IntermediateS3Path }}'
          IdMappingType: '{{ IdMappingType }}'
      - name: WorkflowName
        value: '{{ WorkflowName }}'
      - name: OutputSourceConfig
        value:
          - KMSArn: '{{ KMSArn }}'
            OutputS3Path: '{{ OutputS3Path }}'
      - name: RoleArn
        value: '{{ RoleArn }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.entityresolution.id_mapping_workflows
WHERE data__Identifier = '<WorkflowName>'
AND region = 'us-east-1';

Permissions

To operate on the id_mapping_workflows resource, the following permissions are required:

Read

entityresolution:GetIdMappingWorkflow,
entityresolution:ListTagsForResource

Create

entityresolution:CreateIdMappingWorkflow,
entityresolution:GetIdMappingWorkflow,
entityresolution:TagResource,
kms:CreateGrant,
kms:DescribeKey,
iam:PassRole

Update

entityresolution:GetIdMappingWorkflow,
entityresolution:UpdateIdMappingWorkflow,
entityresolution:ListTagsForResource,
entityresolution:TagResource,
entityresolution:UntagResource,
iam:PassRole,
kms:CreateGrant,
kms:DescribeKey

List

entityresolution:ListIdMappingWorkflows

Delete

entityresolution:DeleteIdMappingWorkflow,
entityresolution:GetIdMappingWorkflow,
entityresolution:UntagResource