segments

Creates, updates, deletes or gets a segment resource or lists segments in a region

Overview

Name	segments
Type	Resource
Description	Resource Type definition for AWS::Evidently::Segment
Id	awscc.evidently.segments

Fields

get (all properties)

Name	Datatype	Description
arn	string
name	string
description	string
pattern	string
▶tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
arn	string
region	string	AWS region.

For more information, see AWS::Evidently::Segment.

Methods

Name	Resource	Accessible by	Required Params
create_resource	segments	INSERT	Name, region
delete_resource	segments	DELETE	Identifier, region
list_resources	segments_list_only	SELECT	region
get_resource	segments	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual segment.

SELECT
  region,
  arn,
  name,
  description,
  pattern,
  tags
FROM awscc.evidently.segments
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all segments in a region.

SELECT
  region,
  arn
FROM awscc.evidently.segments_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.evidently.segments (
  Name,
  region
)
SELECT
  '{{ name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.evidently.segments (
  Name,
  Description,
  Pattern,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ description }}',
  '{{ pattern }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: segment
    props:
      - name: name
        value: '{{ name }}'
      - name: description
        value: '{{ description }}'
      - name: pattern
        value: '{{ pattern }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

DELETE example

/*+ delete */
DELETE FROM awscc.evidently.segments
WHERE
  Identifier = '{{ arn }}' AND
  region = 'us-east-1';

Permissions

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

Create

evidently:CreateSegment,
evidently:GetSegment,
evidently:TagResource

Read

evidently:GetSegment,
evidently:ListTagsForResource

Delete

evidently:DeleteSegment,
evidently:GetSegment,
evidently:UntagResource

List

evidently:ListSegment,
evidently:ListTagsForResource