launches

Creates, updates, deletes or gets a launch resource or lists launches in a region

Overview

Name	launches
Type	Resource
Description	Resource Type definition for AWS::Evidently::Launch.
Id	awscc.evidently.launches

Fields

Name	Datatype	Description
arn	string
name	string
project	string
description	string
randomization_salt	string
▶scheduled_splits_config	array
▶groups	array
▶metric_monitors	array
▶tags	array	An array of key-value pairs to apply to this resource.
▶execution_status	object	Start or Stop Launch Launch. Default is not started.
region	string	AWS region.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, Project, Groups, ScheduledSplitsConfig, 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 launch.

SELECT
  region,
  arn,
  name,
  project,
  description,
  randomization_salt,
  scheduled_splits_config,
  groups,
  metric_monitors,
  tags,
  execution_status
FROM awscc.evidently.launches
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ arn }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.evidently.launches (
  Name,
  Project,
  ScheduledSplitsConfig,
  Groups,
  region
)
SELECT
  '{{ name }}',
  '{{ project }}',
  '{{ scheduled_splits_config }}',
  '{{ groups }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.evidently.launches (
  Name,
  Project,
  Description,
  RandomizationSalt,
  ScheduledSplitsConfig,
  Groups,
  MetricMonitors,
  Tags,
  ExecutionStatus,
  region
)
SELECT
  '{{ name }}',
  '{{ project }}',
  '{{ description }}',
  '{{ randomization_salt }}',
  '{{ scheduled_splits_config }}',
  '{{ groups }}',
  '{{ metric_monitors }}',
  '{{ tags }}',
  '{{ execution_status }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: launch
    props:
      - name: name
        value: '{{ name }}'
      - name: project
        value: '{{ project }}'
      - name: description
        value: '{{ description }}'
      - name: randomization_salt
        value: '{{ randomization_salt }}'
      - name: scheduled_splits_config
        value:
          - start_time: '{{ start_time }}'
            group_weights:
              - group_name: '{{ group_name }}'
                split_weight: '{{ split_weight }}'
            segment_overrides:
              - segment: '{{ segment }}'
                evaluation_order: '{{ evaluation_order }}'
                weights:
                  - null
      - name: groups
        value:
          - group_name: '{{ group_name }}'
            description: '{{ description }}'
            feature: '{{ feature }}'
            variation: '{{ variation }}'
      - name: metric_monitors
        value:
          - metric_name: '{{ metric_name }}'
            entity_id_key: '{{ entity_id_key }}'
            value_key: '{{ value_key }}'
            event_pattern: '{{ event_pattern }}'
            unit_label: '{{ unit_label }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'
      - name: execution_status
        value:
          status: '{{ status }}'
          desired_state: '{{ desired_state }}'
          reason: '{{ reason }}'

UPDATE example

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

/*+ update */
UPDATE awscc.evidently.launches
SET PatchDocument = string('{{ {
    "Description": description,
    "RandomizationSalt": randomization_salt,
    "ScheduledSplitsConfig": scheduled_splits_config,
    "Groups": groups,
    "MetricMonitors": metric_monitors,
    "Tags": tags,
    "ExecutionStatus": execution_status
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

DELETE example

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

Permissions

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

Create

evidently:CreateLaunch,
evidently:TagResource,
evidently:GetLaunch,
evidently:StartLaunch

Read

evidently:GetLaunch,
evidently:ListTagsForResource

Update

evidently:UpdateLaunch,
evidently:ListTagsForResource,
evidently:TagResource,
evidently:UntagResource,
evidently:GetLaunch,
evidently:StartLaunch,
evidently:StopLaunch

Delete

evidently:DeleteLaunch,
evidently:UntagResource,
evidently:GetLaunch