Create Experiment Template

fis_create_experiment_template

R Documentation

Creates an experiment template

Description

Creates an experiment template.

An experiment template includes the following components:

• Targets: A target can be a specific resource in your Amazon Web Services environment, or one or more resources that match criteria that you specify, for example, resources that have specific tags.

• Actions: The actions to carry out on the target. You can specify multiple actions, the duration of each action, and when to start each action during an experiment.

• Stop conditions: If a stop condition is triggered while an experiment is running, the experiment is automatically stopped. You can define a stop condition as a CloudWatch alarm.

For more information, see experiment templates in the Fault Injection Service User Guide.

Usage

fis_create_experiment_template(clientToken, description, stopConditions,
  targets, actions, roleArn, tags, logConfiguration, experimentOptions,
  experimentReportConfiguration)

Arguments

clientToken	[required] Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
description	[required] A description for the experiment template.
stopConditions	[required] The stop conditions.
targets	The targets for the experiment.
actions	[required] The actions for the experiment.
roleArn	[required] The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf.
tags	The tags to apply to the experiment template.
logConfiguration	The configuration for experiment logging.
experimentOptions	The experiment options for the experiment template.
experimentReportConfiguration	The experiment report configuration for the experiment template.

Value

A list with the following syntax:

list(
  experimentTemplate = list(
    id = "string",
    arn = "string",
    description = "string",
    targets = list(
      list(
        resourceType = "string",
        resourceArns = list(
          "string"
        ),
        resourceTags = list(
          "string"
        ),
        filters = list(
          list(
            path = "string",
            values = list(
              "string"
            )
          )
        ),
        selectionMode = "string",
        parameters = list(
          "string"
        )
      )
    ),
    actions = list(
      list(
        actionId = "string",
        description = "string",
        parameters = list(
          "string"
        ),
        targets = list(
          "string"
        ),
        startAfter = list(
          "string"
        )
      )
    ),
    stopConditions = list(
      list(
        source = "string",
        value = "string"
      )
    ),
    creationTime = as.POSIXct(
      "2015-01-01"
    ),
    lastUpdateTime = as.POSIXct(
      "2015-01-01"
    ),
    roleArn = "string",
    tags = list(
      "string"
    ),
    logConfiguration = list(
      cloudWatchLogsConfiguration = list(
        logGroupArn = "string"
      ),
      s3Configuration = list(
        bucketName = "string",
        prefix = "string"
      ),
      logSchemaVersion = 123
    ),
    experimentOptions = list(
      accountTargeting = "single-account"|"multi-account",
      emptyTargetResolutionMode = "fail"|"skip"
    ),
    targetAccountConfigurationsCount = 123,
    experimentReportConfiguration = list(
      outputs = list(
        s3Configuration = list(
          bucketName = "string",
          prefix = "string"
        )
      ),
      dataSources = list(
        cloudWatchDashboards = list(
          list(
            dashboardIdentifier = "string"
          )
        )
      ),
      preExperimentDuration = "string",
      postExperimentDuration = "string"
    )
  )
)

Request syntax

svc$create_experiment_template(
  clientToken = "string",
  description = "string",
  stopConditions = list(
    list(
      source = "string",
      value = "string"
    )
  ),
  targets = list(
    list(
      resourceType = "string",
      resourceArns = list(
        "string"
      ),
      resourceTags = list(
        "string"
      ),
      filters = list(
        list(
          path = "string",
          values = list(
            "string"
          )
        )
      ),
      selectionMode = "string",
      parameters = list(
        "string"
      )
    )
  ),
  actions = list(
    list(
      actionId = "string",
      description = "string",
      parameters = list(
        "string"
      ),
      targets = list(
        "string"
      ),
      startAfter = list(
        "string"
      )
    )
  ),
  roleArn = "string",
  tags = list(
    "string"
  ),
  logConfiguration = list(
    cloudWatchLogsConfiguration = list(
      logGroupArn = "string"
    ),
    s3Configuration = list(
      bucketName = "string",
      prefix = "string"
    ),
    logSchemaVersion = 123
  ),
  experimentOptions = list(
    accountTargeting = "single-account"|"multi-account",
    emptyTargetResolutionMode = "fail"|"skip"
  ),
  experimentReportConfiguration = list(
    outputs = list(
      s3Configuration = list(
        bucketName = "string",
        prefix = "string"
      )
    ),
    dataSources = list(
      cloudWatchDashboards = list(
        list(
          dashboardIdentifier = "string"
        )
      )
    ),
    preExperimentDuration = "string",
    postExperimentDuration = "string"
  )
)