update-experiment-template¶
Description¶
Updates the specified experiment template.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
update-experiment-template
--id <value>
[--description <value>]
[--stop-conditions <value>]
[--targets <value>]
[--actions <value>]
[--role-arn <value>]
[--log-configuration <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--id (string)
The ID of the experiment template.
--description (string)
A description for the template.
--stop-conditions (list)
The stop conditions for the experiment.
(structure)
Specifies a stop condition for an experiment. You can define a stop condition as a CloudWatch alarm.
source -> (string)
The source for the stop condition. Specify
aws:cloudwatch:alarmif the stop condition is defined by a CloudWatch alarm. Specifynoneif there is no stop condition.value -> (string)
The Amazon Resource Name (ARN) of the CloudWatch alarm.
Shorthand Syntax:
source=string,value=string ...
JSON Syntax:
[
{
"source": "string",
"value": "string"
}
...
]
--targets (map)
The targets for the experiment.
key -> (string)
value -> (structure)
Specifies a target for an experiment. You must specify at least one Amazon Resource Name (ARN) or at least one resource tag. You cannot specify both.
resourceType -> (string)
The resource type. The resource type must be supported for the specified action.
resourceArns -> (list)
The Amazon Resource Names (ARNs) of the targets.
(string)
resourceTags -> (map)
The tags for the target resources.
key -> (string)
value -> (string)
filters -> (list)
The filters to apply to identify target resources using specific attributes.
(structure)
Specifies a filter used for the target resource input in an experiment template.
For more information, see Resource filters in the Fault Injection Simulator User Guide .
path -> (string)
The attribute path for the filter.
values -> (list)
The attribute values for the filter.
(string)
selectionMode -> (string)
Scopes the identified resources to a specific count or percentage.
parameters -> (map)
The resource type parameters.
key -> (string)
value -> (string)
JSON Syntax:
{"string": {
"resourceType": "string",
"resourceArns": ["string", ...],
"resourceTags": {"string": "string"
...},
"filters": [
{
"path": "string",
"values": ["string", ...]
}
...
],
"selectionMode": "string",
"parameters": {"string": "string"
...}
}
...}
--actions (map)
The actions for the experiment.
key -> (string)
value -> (structure)
Specifies an action for an experiment template.
actionId -> (string)
The ID of the action.
description -> (string)
A description for the action.
parameters -> (map)
The parameters for the action, if applicable.
key -> (string)
value -> (string)
targets -> (map)
The targets for the action.
key -> (string)
value -> (string)
startAfter -> (list)
The name of the action that must be completed before the current action starts. Omit this parameter to run the action at the start of the experiment.
(string)
Shorthand Syntax:
KeyName1=actionId=string,description=string,parameters={KeyName1=string,KeyName2=string},targets={KeyName1=string,KeyName2=string},startAfter=string,string,KeyName2=actionId=string,description=string,parameters={KeyName1=string,KeyName2=string},targets={KeyName1=string,KeyName2=string},startAfter=string,string
JSON Syntax:
{"string": {
"actionId": "string",
"description": "string",
"parameters": {"string": "string"
...},
"targets": {"string": "string"
...},
"startAfter": ["string", ...]
}
...}
--role-arn (string)
The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf.
--log-configuration (structure)
The configuration for experiment logging.
cloudWatchLogsConfiguration -> (structure)
The configuration for experiment logging to Amazon CloudWatch Logs.
logGroupArn -> (string)
The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.
s3Configuration -> (structure)
The configuration for experiment logging to Amazon S3.
bucketName -> (string)
The name of the destination bucket.
prefix -> (string)
The bucket prefix.
logSchemaVersion -> (integer)
The schema version.
Shorthand Syntax:
cloudWatchLogsConfiguration={logGroupArn=string},s3Configuration={bucketName=string,prefix=string},logSchemaVersion=integer
JSON Syntax:
{
"cloudWatchLogsConfiguration": {
"logGroupArn": "string"
},
"s3Configuration": {
"bucketName": "string",
"prefix": "string"
},
"logSchemaVersion": integer
}
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
See ‘aws help’ for descriptions of global parameters.
Examples¶
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To update an experiment template
The following update-experiment-template example updates the description of the specified experiment template.
aws fis update-experiment-template \
--id ABCDE1fgHIJkLmNop \
---description myExperimentTemplate
Output:
{
"experimentTemplate": {
"id": "ABCDE1fgHIJkLmNop",
"description": "myExperimentTemplate",
"targets": {
"Instances-Target-1": {
"resourceType": "aws:ec2:instance",
"resourceArns": [
"arn:aws:ec2:us-west-2:123456789012:instance/i-12a3b4c56d78e9012"
],
"selectionMode": "ALL"
}
},
"actions": {
"testaction": {
"actionId": "aws:ec2:stop-instances",
"parameters": {},
"targets": {
"Instances": "Instances-Target-1"
}
}
},
"stopConditions": [
{
"source": "none"
}
],
"creationTime": 1616017191.124,
"lastUpdateTime": 1616017859.607,
"roleArn": "arn:aws:iam::123456789012:role/FISRole",
"tags": {
"key": "value"
}
}
}
For more information, see Update an experiment template in the AWS Fault Injection Simulator User Guide.
Output¶
experimentTemplate -> (structure)
Information about the experiment template.
id -> (string)
The ID of the experiment template.
description -> (string)
The description for the experiment template.
targets -> (map)
The targets for the experiment.
key -> (string)
value -> (structure)
Describes a target for an experiment template.
resourceType -> (string)
The resource type.
resourceArns -> (list)
The Amazon Resource Names (ARNs) of the targets.
(string)
resourceTags -> (map)
The tags for the target resources.
key -> (string)
value -> (string)
filters -> (list)
The filters to apply to identify target resources using specific attributes.
(structure)
Describes a filter used for the target resources in an experiment template.
path -> (string)
The attribute path for the filter.
values -> (list)
The attribute values for the filter.
(string)
selectionMode -> (string)
Scopes the identified resources to a specific count or percentage.
parameters -> (map)
The resource type parameters.
key -> (string)
value -> (string)
actions -> (map)
The actions for the experiment.
key -> (string)
value -> (structure)
Describes an action for an experiment template.
actionId -> (string)
The ID of the action.
description -> (string)
A description for the action.
parameters -> (map)
The parameters for the action.
key -> (string)
value -> (string)
targets -> (map)
The targets for the action.
key -> (string)
value -> (string)
startAfter -> (list)
The name of the action that must be completed before the current action starts.
(string)
stopConditions -> (list)
The stop conditions for the experiment.
(structure)
Describes a stop condition for an experiment template.
source -> (string)
The source for the stop condition.
value -> (string)
The Amazon Resource Name (ARN) of the CloudWatch alarm, if applicable.
creationTime -> (timestamp)
The time the experiment template was created.
lastUpdateTime -> (timestamp)
The time the experiment template was last updated.
roleArn -> (string)
The Amazon Resource Name (ARN) of an IAM role.
tags -> (map)
The tags for the experiment template.
key -> (string)
value -> (string)
logConfiguration -> (structure)
The configuration for experiment logging.
cloudWatchLogsConfiguration -> (structure)
The configuration for experiment logging to Amazon CloudWatch Logs.
logGroupArn -> (string)
The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.
s3Configuration -> (structure)
The configuration for experiment logging to Amazon S3.
bucketName -> (string)
The name of the destination bucket.
prefix -> (string)
The bucket prefix.
logSchemaVersion -> (integer)
The schema version.