id_namespaces

Creates, updates, deletes or gets an id_namespace resource or lists id_namespaces in a region

Overview

Name	id_namespaces
Type	Resource
Description	IdNamespace defined in AWS Entity Resolution service
Id	awscc.entityresolution.id_namespaces

Fields

get (all properties)

Name	Datatype	Description
id_namespace_name	string
description	string
▶input_source_config	array
▶id_mapping_workflow_properties	array
type	string
role_arn	string
id_namespace_arn	string	The arn associated with the IdNamespace
created_at	string	The date and time when the IdNamespace was created
updated_at	string	The date and time when the IdNamespace was updated
▶tags	array
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
id_namespace_name	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	id_namespaces	INSERT	IdNamespaceName, Type, region
delete_resource	id_namespaces	DELETE	Identifier, region
update_resource	id_namespaces	UPDATE	Identifier, PatchDocument, region
list_resources	id_namespaces_list_only	SELECT	region
get_resource	id_namespaces	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual id_namespace.

SELECT
  region,
  id_namespace_name,
  description,
  input_source_config,
  id_mapping_workflow_properties,
  type,
  role_arn,
  id_namespace_arn,
  created_at,
  updated_at,
  tags
FROM awscc.entityresolution.id_namespaces
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ id_namespace_name }}';

list (identifiers only)

Lists all id_namespaces in a region.

SELECT
  region,
  id_namespace_name
FROM awscc.entityresolution.id_namespaces_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.entityresolution.id_namespaces (
  IdNamespaceName,
  Type,
  region
)
SELECT
  '{{ id_namespace_name }}',
  '{{ type }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.entityresolution.id_namespaces (
  IdNamespaceName,
  Description,
  InputSourceConfig,
  IdMappingWorkflowProperties,
  Type,
  RoleArn,
  Tags,
  region
)
SELECT
  '{{ id_namespace_name }}',
  '{{ description }}',
  '{{ input_source_config }}',
  '{{ id_mapping_workflow_properties }}',
  '{{ type }}',
  '{{ role_arn }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: id_namespace
    props:
      - name: id_namespace_name
        value: '{{ id_namespace_name }}'
      - name: description
        value: '{{ description }}'
      - name: input_source_config
        value:
          - input_source_arn: '{{ input_source_arn }}'
            schema_name: null
      - name: id_mapping_workflow_properties
        value:
          - id_mapping_type: '{{ id_mapping_type }}'
            rule_based_properties:
              rules:
                - rule_name: '{{ rule_name }}'
                  matching_keys:
                    - '{{ matching_keys[0] }}'
              rule_definition_types:
                - '{{ rule_definition_types[0] }}'
              attribute_matching_model: '{{ attribute_matching_model }}'
              record_matching_models:
                - '{{ record_matching_models[0] }}'
            provider_properties:
              provider_service_arn: '{{ provider_service_arn }}'
              provider_configuration: {}
      - name: type
        value: '{{ 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_namespace resource, using stack-deploy.

/*+ update */
UPDATE awscc.entityresolution.id_namespaces
SET PatchDocument = string('{{ {
    "Description": description,
    "InputSourceConfig": input_source_config,
    "IdMappingWorkflowProperties": id_mapping_workflow_properties,
    "Type": type,
    "RoleArn": role_arn,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id_namespace_name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.entityresolution.id_namespaces
WHERE
  Identifier = '{{ id_namespace_name }}' AND
  region = 'us-east-1';

Permissions

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

Create

entityresolution:CreateIdNamespace,
entityresolution:TagResource,
iam:PassRole

Read

entityresolution:GetIdNamespace,
entityresolution:ListTagsForResource

Update

entityresolution:UpdateIdNamespace,
entityresolution:ListTagsForResource,
entityresolution:TagResource,
entityresolution:UntagResource,
iam:PassRole

Delete

entityresolution:DeleteIdNamespace,
entityresolution:GetIdNamespace,
entityresolution:UntagResource

List

entityresolution:ListIdNamespaces