segment_definitions

Creates, updates, deletes or gets a segment_definition resource or lists segment_definitions in a region

Overview

Name	segment_definitions
Type	Resource
Description	A segment definition resource of Amazon Connect Customer Profiles
Id	awscc.customerprofiles.segment_definitions

Fields

get (all properties)

Name	Datatype	Description
created_at	string	The time of this segment definition got created.
description	string	The description of the segment definition.
display_name	string	The display name of the segment definition.
domain_name	string	The unique name of the domain.
segment_definition_name	string	The unique name of the segment definition.
▶segment_groups	object	An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.
segment_definition_arn	string	The Amazon Resource Name (ARN) of the segment definition.
▶tags	array	The tags used to organize, track, or control access for this resource.
region	string	AWS region.

list (identifiers only)

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

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	segment_definitions	INSERT	DomainName, DisplayName, SegmentDefinitionName, SegmentGroups, region
delete_resource	segment_definitions	DELETE	Identifier, region
update_resource	segment_definitions	UPDATE	Identifier, PatchDocument, region
list_resources	segment_definitions_list_only	SELECT	region
get_resource	segment_definitions	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual segment_definition.

SELECT
  region,
  created_at,
  description,
  display_name,
  domain_name,
  segment_definition_name,
  segment_groups,
  segment_definition_arn,
  tags
FROM awscc.customerprofiles.segment_definitions
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ domain_name }}|{{ segment_definition_name }}';

list (identifiers only)

Lists all segment_definitions in a region.

SELECT
  region,
  domain_name,
  segment_definition_name
FROM awscc.customerprofiles.segment_definitions_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.customerprofiles.segment_definitions (
  DisplayName,
  DomainName,
  SegmentDefinitionName,
  SegmentGroups,
  region
)
SELECT
  '{{ display_name }}',
  '{{ domain_name }}',
  '{{ segment_definition_name }}',
  '{{ segment_groups }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.customerprofiles.segment_definitions (
  Description,
  DisplayName,
  DomainName,
  SegmentDefinitionName,
  SegmentGroups,
  Tags,
  region
)
SELECT
  '{{ description }}',
  '{{ display_name }}',
  '{{ domain_name }}',
  '{{ segment_definition_name }}',
  '{{ segment_groups }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: segment_definition
    props:
      - name: description
        value: '{{ description }}'
      - name: display_name
        value: '{{ display_name }}'
      - name: domain_name
        value: '{{ domain_name }}'
      - name: segment_definition_name
        value: '{{ segment_definition_name }}'
      - name: segment_groups
        value:
          groups:
            - dimensions:
                - null
              source_segments:
                - segment_definition_name: '{{ segment_definition_name }}'
              source_type: '{{ source_type }}'
              type: null
          include: null
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.customerprofiles.segment_definitions
SET PatchDocument = string('{{ {
    "Description": description,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ domain_name }}|{{ segment_definition_name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.customerprofiles.segment_definitions
WHERE
  Identifier = '{{ domain_name }}|{{ segment_definition_name }}' AND
  region = 'us-east-1';

Permissions

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

Create

profile:CreateSegmentDefinition,
profile:TagResource

Read

profile:GetSegmentDefinition

Update

profile:GetSegmentDefinition,
profile:UntagResource,
profile:TagResource

Delete

profile:DeleteSegmentDefinition

List

profile:ListSegmentDefinitions