features

Creates, updates, deletes or gets a feature resource or lists features in a region

Overview

Name	features
Type	Resource
Description	Resource Type definition for AWS::Evidently::Feature.
Id	awscc.evidently.features

Fields

Name	Datatype	Description
arn	string
project	string
name	string
description	string
evaluation_strategy	string
▶variations	array
default_variation	string
▶entity_overrides	array
▶tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, Project, Variations, region
delete_resource	DELETE	Identifier, region
update_resource	UPDATE	Identifier, PatchDocument, region
get_resource	SELECT	Identifier, region

SELECT examples

Gets all properties from an individual feature.

SELECT
  region,
  arn,
  project,
  name,
  description,
  evaluation_strategy,
  variations,
  default_variation,
  entity_overrides,
  tags
FROM awscc.evidently.features
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.evidently.features (
  Project,
  Name,
  Variations,
  region
)
SELECT
  '{{ project }}',
  '{{ name }}',
  '{{ variations }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.evidently.features (
  Project,
  Name,
  Description,
  EvaluationStrategy,
  Variations,
  DefaultVariation,
  EntityOverrides,
  Tags,
  region
)
SELECT
  '{{ project }}',
  '{{ name }}',
  '{{ description }}',
  '{{ evaluation_strategy }}',
  '{{ variations }}',
  '{{ default_variation }}',
  '{{ entity_overrides }}',
  '{{ 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: feature
  props:
    - name: project
      value: '{{ project }}'
    - name: name
      value: '{{ name }}'
    - name: description
      value: '{{ description }}'
    - name: evaluation_strategy
      value: '{{ evaluation_strategy }}'
    - name: variations
      value:
        - variation_name: '{{ variation_name }}'
          boolean_value: '{{ boolean_value }}'
          string_value: '{{ string_value }}'
          long_value: null
          double_value: null
    - name: default_variation
      value: '{{ default_variation }}'
    - name: entity_overrides
      value:
        - entity_id: '{{ entity_id }}'
          variation: '{{ variation }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.evidently.features
SET PatchDocument = string('{{ {
    "Description": description,
    "EvaluationStrategy": evaluation_strategy,
    "Variations": variations,
    "DefaultVariation": default_variation,
    "EntityOverrides": entity_overrides,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.evidently.features
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 features resource, the following permissions are required:

Create

evidently:CreateFeature,
evidently:TagResource,
evidently:GetFeature

Read

evidently:GetFeature,
evidently:ListTagsForResource

Update

evidently:UpdateFeature,
evidently:ListTagsForResource,
evidently:TagResource,
evidently:UntagResource,
evidently:GetFeature

Delete

evidently:DeleteFeature,
evidently:UntagResource,
evidently:GetFeature