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	awscc.entityresolution.id_mapping_workflows

Fields

get (all properties)

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
▶id_mapping_incremental_run_config	object
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.

list (identifiers only)

Name	Datatype	Description
workflow_name	string	The name of the IdMappingWorkflow
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	id_mapping_workflows	INSERT	WorkflowName, InputSourceConfig, IdMappingTechniques, RoleArn, region
delete_resource	id_mapping_workflows	DELETE	Identifier, region
update_resource	id_mapping_workflows	UPDATE	Identifier, PatchDocument, region
list_resources	id_mapping_workflows_list_only	SELECT	region
get_resource	id_mapping_workflows	SELECT	Identifier, region

SELECT examples

get (all properties)

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,
  id_mapping_incremental_run_config,
  workflow_arn,
  updated_at,
  role_arn,
  tags
FROM awscc.entityresolution.id_mapping_workflows
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ workflow_name }}';

list (identifiers only)

Lists all id_mapping_workflows in a region.

SELECT
  region,
  workflow_name
FROM awscc.entityresolution.id_mapping_workflows_list_only
WHERE
  region = '{{ region }}';

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 awscc.entityresolution.id_mapping_workflows (
  InputSourceConfig,
  IdMappingTechniques,
  WorkflowName,
  RoleArn,
  region
)
SELECT
  '{{ input_source_config }}',
  '{{ id_mapping_techniques }}',
  '{{ workflow_name }}',
  '{{ role_arn }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.entityresolution.id_mapping_workflows (
  Description,
  InputSourceConfig,
  IdMappingTechniques,
  WorkflowName,
  OutputSourceConfig,
  IdMappingIncrementalRunConfig,
  RoleArn,
  Tags,
  region
)
SELECT
  '{{ description }}',
  '{{ input_source_config }}',
  '{{ id_mapping_techniques }}',
  '{{ workflow_name }}',
  '{{ output_source_config }}',
  '{{ id_mapping_incremental_run_config }}',
  '{{ role_arn }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: input_source_config
      value:
        - type: '{{ type }}'
          input_source_arn: '{{ input_source_arn }}'
          schema_arn: '{{ schema_arn }}'
    - name: id_mapping_techniques
      value:
        rule_based_properties:
          attribute_matching_model: '{{ attribute_matching_model }}'
          rule_definition_type: '{{ rule_definition_type }}'
          rules:
            - rule_name: '{{ rule_name }}'
              matching_keys:
                - '{{ matching_keys[0] }}'
          record_matching_model: '{{ record_matching_model }}'
        provider_properties:
          provider_service_arn: '{{ provider_service_arn }}'
          provider_configuration: {}
          intermediate_source_configuration:
            intermediate_s3_path: '{{ intermediate_s3_path }}'
        id_mapping_type: '{{ id_mapping_type }}'
    - name: workflow_name
      value: '{{ workflow_name }}'
    - name: output_source_config
      value:
        - kms_arn: '{{ kms_arn }}'
          output_s3_path: '{{ output_s3_path }}'
    - name: id_mapping_incremental_run_config
      value:
        incremental_run_type: '{{ incremental_run_type }}'
    - name: role_arn
      value: '{{ role_arn }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.entityresolution.id_mapping_workflows
SET PatchDocument = string('{{ {
    "Description": description,
    "InputSourceConfig": input_source_config,
    "IdMappingTechniques": id_mapping_techniques,
    "OutputSourceConfig": output_source_config,
    "IdMappingIncrementalRunConfig": id_mapping_incremental_run_config,
    "RoleArn": role_arn,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ workflow_name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.entityresolution.id_mapping_workflows
WHERE
  Identifier = '{{ workflow_name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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