experiment_templates

Creates, updates, deletes or gets an experiment_template resource or lists experiment_templates in a region

Overview

Name	experiment_templates
Type	Resource
Description	Resource schema for AWS::FIS::ExperimentTemplate
Id	aws.fis.experiment_templates

Fields

Name	Datatype	Description
id	string
description	string	A description for the experiment template.
targets	object	The targets for the experiment.
actions	object	The actions for the experiment.
stop_conditions	array	One or more stop conditions.
log_configuration	object
role_arn	string	The Amazon Resource Name (ARN) of an IAM role that grants the AWS FIS service permission to perform service actions on your behalf.
tags	object
experiment_options	object
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Description, StopConditions, Targets, RoleArn, Tags, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all experiment_templates in a region.

SELECT
region,
id,
description,
targets,
actions,
stop_conditions,
log_configuration,
role_arn,
tags,
experiment_options
FROM aws.fis.experiment_templates
WHERE region = 'us-east-1';

Gets all properties from an individual experiment_template.

SELECT
region,
id,
description,
targets,
actions,
stop_conditions,
log_configuration,
role_arn,
tags,
experiment_options
FROM aws.fis.experiment_templates
WHERE region = 'us-east-1' AND data__Identifier = '<Id>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.fis.experiment_templates (
 Description,
 Targets,
 StopConditions,
 RoleArn,
 Tags,
 region
)
SELECT 
'{{ Description }}',
 '{{ Targets }}',
 '{{ StopConditions }}',
 '{{ RoleArn }}',
 '{{ Tags }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.fis.experiment_templates (
 Description,
 Targets,
 Actions,
 StopConditions,
 LogConfiguration,
 RoleArn,
 Tags,
 ExperimentOptions,
 region
)
SELECT 
 '{{ Description }}',
 '{{ Targets }}',
 '{{ Actions }}',
 '{{ StopConditions }}',
 '{{ LogConfiguration }}',
 '{{ RoleArn }}',
 '{{ Tags }}',
 '{{ ExperimentOptions }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: experiment_template
    props:
      - name: Description
        value: '{{ Description }}'
      - name: Targets
        value: {}
      - name: Actions
        value: {}
      - name: StopConditions
        value:
          - Source: '{{ Source }}'
            Value: '{{ Value }}'
      - name: LogConfiguration
        value:
          CloudWatchLogsConfiguration:
            LogGroupArn: '{{ LogGroupArn }}'
          S3Configuration:
            BucketName: '{{ BucketName }}'
            Prefix: '{{ Prefix }}'
          LogSchemaVersion: '{{ LogSchemaVersion }}'
      - name: RoleArn
        value: '{{ RoleArn }}'
      - name: Tags
        value: {}
      - name: ExperimentOptions
        value:
          AccountTargeting: '{{ AccountTargeting }}'
          EmptyTargetResolutionMode: '{{ EmptyTargetResolutionMode }}'

DELETE example

/*+ delete */
DELETE FROM aws.fis.experiment_templates
WHERE data__Identifier = '<Id>'
AND region = 'us-east-1';

Permissions

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

Create

fis:CreateExperimentTemplate,
fis:TagResource,
iam:PassRole

Read

fis:GetExperimentTemplate,
fis:ListTagsForResource

Update

fis:UpdateExperimentTemplate,
fis:TagResource,
fis:UntagResource,
iam:PassRole

Delete

fis:DeleteExperimentTemplate

List

fis:ListExperimentTemplates,
fis:ListTagsForResource