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 | aws.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. |
Methods
Name | Accessible by | Required Params |
---|---|---|
create_resource | INSERT | Name, Project, Groups, ScheduledSplitsConfig, region |
delete_resource | DELETE | data__Identifier, region |
update_resource | UPDATE | data__Identifier, data__PatchDocument, region |
get_resource | SELECT | data__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 aws.evidently.launches
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';
INSERT
example
Use the following StackQL query and manifest file to create a new launch
resource, using stack-deploy
.
- Required Properties
- All Properties
- Manifest
/*+ create */
INSERT INTO aws.evidently.launches (
Name,
Project,
ScheduledSplitsConfig,
Groups,
region
)
SELECT
'{{ Name }}',
'{{ Project }}',
'{{ ScheduledSplitsConfig }}',
'{{ Groups }}',
'{{ region }}';
/*+ create */
INSERT INTO aws.evidently.launches (
Name,
Project,
Description,
RandomizationSalt,
ScheduledSplitsConfig,
Groups,
MetricMonitors,
Tags,
ExecutionStatus,
region
)
SELECT
'{{ Name }}',
'{{ Project }}',
'{{ Description }}',
'{{ RandomizationSalt }}',
'{{ ScheduledSplitsConfig }}',
'{{ Groups }}',
'{{ MetricMonitors }}',
'{{ Tags }}',
'{{ ExecutionStatus }}',
'{{ region }}';
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: RandomizationSalt
value: '{{ RandomizationSalt }}'
- name: ScheduledSplitsConfig
value:
- StartTime: '{{ StartTime }}'
GroupWeights:
- GroupName: '{{ GroupName }}'
SplitWeight: '{{ SplitWeight }}'
SegmentOverrides:
- Segment: '{{ Segment }}'
EvaluationOrder: '{{ EvaluationOrder }}'
Weights:
- null
- name: Groups
value:
- GroupName: '{{ GroupName }}'
Description: '{{ Description }}'
Feature: '{{ Feature }}'
Variation: '{{ Variation }}'
- name: MetricMonitors
value:
- MetricName: '{{ MetricName }}'
EntityIdKey: '{{ EntityIdKey }}'
ValueKey: '{{ ValueKey }}'
EventPattern: '{{ EventPattern }}'
UnitLabel: '{{ UnitLabel }}'
- name: Tags
value:
- Key: '{{ Key }}'
Value: '{{ Value }}'
- name: ExecutionStatus
value:
Status: '{{ Status }}'
DesiredState: '{{ DesiredState }}'
Reason: '{{ Reason }}'
DELETE
example
/*+ delete */
DELETE FROM aws.evidently.launches
WHERE data__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