domains

Creates, updates, deletes or gets a domain resource or lists domains in a region

Overview

Name	domains
Type	Resource
Description	A domain defined for 3rd party data source in Profile Service
Id	awscc.customerprofiles.domains

Fields

get (all properties)

Name	Datatype	Description
domain_name	string	The unique name of the domain.
dead_letter_queue_url	string	The URL of the SQS dead letter queue
default_encryption_key	string	The default encryption key
default_expiration_days	integer	The default number of days until the data within the domain expires.
▶matching	object	The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains. After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.
▶rule_based_matching	object	The process of matching duplicate profiles using the Rule-Based matching. If RuleBasedMatching = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the RuleBasedMatchingRequest. You can use the ListRuleBasedMatches and GetSimilarProfiles API to return and review the results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest, you can download the results from S3.
▶stats	object	Usage-specific statistics about the domain.
▶tags	array	The tags (keys and values) associated with the domain
created_at	string	The time of this integration got created
last_updated_at	string	The time of this integration got last updated at
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
domain_name	string	The unique name of the domain.
region	string	AWS region.

For more information, see AWS::CustomerProfiles::Domain.

Methods

Name	Resource	Accessible by	Required Params
create_resource	domains	INSERT	DomainName, DefaultExpirationDays, region
delete_resource	domains	DELETE	Identifier, region
update_resource	domains	UPDATE	Identifier, PatchDocument, region
list_resources	domains_list_only	SELECT	region
get_resource	domains	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual domain.

SELECT
  region,
  domain_name,
  dead_letter_queue_url,
  default_encryption_key,
  default_expiration_days,
  matching,
  rule_based_matching,
  stats,
  tags,
  created_at,
  last_updated_at
FROM awscc.customerprofiles.domains
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ domain_name }}';

list (identifiers only)

Lists all domains in a region.

SELECT
  region,
  domain_name
FROM awscc.customerprofiles.domains_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.customerprofiles.domains (
  DomainName,
  DefaultExpirationDays,
  region
)
SELECT
  '{{ domain_name }}',
  '{{ default_expiration_days }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.customerprofiles.domains (
  DomainName,
  DeadLetterQueueUrl,
  DefaultEncryptionKey,
  DefaultExpirationDays,
  Matching,
  RuleBasedMatching,
  Tags,
  region
)
SELECT
  '{{ domain_name }}',
  '{{ dead_letter_queue_url }}',
  '{{ default_encryption_key }}',
  '{{ default_expiration_days }}',
  '{{ matching }}',
  '{{ rule_based_matching }}',
  '{{ 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: domain
  props:
    - name: domain_name
      value: '{{ domain_name }}'
    - name: dead_letter_queue_url
      value: '{{ dead_letter_queue_url }}'
    - name: default_encryption_key
      value: '{{ default_encryption_key }}'
    - name: default_expiration_days
      value: '{{ default_expiration_days }}'
    - name: matching
      value:
        enabled: '{{ enabled }}'
        auto_merging:
          enabled: '{{ enabled }}'
          conflict_resolution:
            conflict_resolving_model: '{{ conflict_resolving_model }}'
            source_name: '{{ source_name }}'
          consolidation:
            matching_attributes_list:
              - - '{{ 0[0] }}'
          min_allowed_confidence_score_for_merging: null
        exporting_config:
          s3_exporting:
            s3_bucket_name: '{{ s3_bucket_name }}'
            s3_key_name: '{{ s3_key_name }}'
        job_schedule:
          day_of_the_week: '{{ day_of_the_week }}'
          time: '{{ time }}'
    - name: rule_based_matching
      value:
        enabled: '{{ enabled }}'
        attribute_types_selector:
          attribute_matching_model: '{{ attribute_matching_model }}'
          address:
            - '{{ address[0] }}'
          email_address:
            - '{{ email_address[0] }}'
          phone_number:
            - '{{ phone_number[0] }}'
        conflict_resolution: null
        exporting_config: null
        matching_rules:
          - rule:
              - '{{ rule[0] }}'
        max_allowed_rule_level_for_matching: '{{ max_allowed_rule_level_for_matching }}'
        max_allowed_rule_level_for_merging: '{{ max_allowed_rule_level_for_merging }}'
        status: '{{ status }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.customerprofiles.domains
SET PatchDocument = string('{{ {
    "DeadLetterQueueUrl": dead_letter_queue_url,
    "DefaultEncryptionKey": default_encryption_key,
    "DefaultExpirationDays": default_expiration_days,
    "Matching": matching,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ domain_name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.customerprofiles.domains
WHERE
  Identifier = '{{ domain_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 domains resource, the following permissions are required:

Create

profile:CreateDomain,
profile:TagResource

Read

profile:GetDomain

Update

profile:GetDomain,
profile:UpdateDomain,
profile:UntagResource,
profile:TagResource

Delete

profile:DeleteDomain

List

profile:ListDomains