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 = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all segments in a region.

SELECT
  region,
  arn
FROM awscc.evidently.segments_list_only
WHERE
  region = '{{ region }}';

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 }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.evidently.segments (
  Name,
  Description,
  Pattern,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ description }}',
  '{{ pattern }}',
  '{{ 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: 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 = '{{ 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 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