schema_mappings

Creates, updates, deletes or gets a schema_mapping resource or lists schema_mappings in a region

Overview

Name	schema_mappings
Type	Resource
Description	SchemaMapping defined in AWS Entity Resolution service
Id	aws.entityresolution.schema_mappings

Fields

Name	Datatype	Description
schema_name	string	The name of the SchemaMapping
description	string	The description of the SchemaMapping
mapped_input_fields	array	The SchemaMapping attributes input
tags	array
schema_arn	string	The SchemaMapping arn associated with the Schema
created_at	string	The time of this SchemaMapping got created
updated_at	string	The time of this SchemaMapping got last updated at
has_workflows	boolean	The boolean value that indicates whether or not a SchemaMapping has MatchingWorkflows that are associated with
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	SchemaName, MappedInputFields, 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 schema_mappings in a region.

SELECT
region,
schema_name,
description,
mapped_input_fields,
tags,
schema_arn,
created_at,
updated_at,
has_workflows
FROM aws.entityresolution.schema_mappings
WHERE region = 'us-east-1';

Gets all properties from an individual schema_mapping.

SELECT
region,
schema_name,
description,
mapped_input_fields,
tags,
schema_arn,
created_at,
updated_at,
has_workflows
FROM aws.entityresolution.schema_mappings
WHERE region = 'us-east-1' AND data__Identifier = '<SchemaName>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.entityresolution.schema_mappings (
 SchemaName,
 MappedInputFields,
 region
)
SELECT 
'{{ SchemaName }}',
 '{{ MappedInputFields }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.entityresolution.schema_mappings (
 SchemaName,
 Description,
 MappedInputFields,
 Tags,
 region
)
SELECT 
 '{{ SchemaName }}',
 '{{ Description }}',
 '{{ MappedInputFields }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: schema_mapping
    props:
      - name: SchemaName
        value: '{{ SchemaName }}'
      - name: Description
        value: '{{ Description }}'
      - name: MappedInputFields
        value:
          - FieldName: '{{ FieldName }}'
            Type: '{{ Type }}'
            SubType: '{{ SubType }}'
            GroupName: null
            MatchKey: null
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

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

Permissions

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

Create

entityresolution:CreateSchemaMapping,
entityresolution:GetSchemaMapping,
entityresolution:TagResource

Read

entityresolution:GetSchemaMapping,
entityresolution:ListTagsForResource

Delete

entityresolution:DeleteSchemaMapping,
entityresolution:GetSchemaMapping

Update

entityresolution:GetSchemaMapping,
entityresolution:UpdateSchemaMapping,
entityresolution:ListTagsForResource,
entityresolution:TagResource,
entityresolution:UntagResource

List

entityresolution:ListSchemaMappings