create-test¶

Description¶

Creates a test for a service by configuring a test template. Each service has one test per template.

Synopsis¶

  create-test
--service-arn <value>
--test-template-arn <value>
[--logging-configuration <value>]
[--stop-conditions <value>]
[--role-name <value>]
[--parameters <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--service-arn (string) [required]

The ARN of the service to create the test for.

Constraints:

min: 31

pattern: arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023}

--test-template-arn (string) [required]

The ARN of the test template to configure.

Constraints:

min: 31

pattern: arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):([0-9]{12}|aws):[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023}

--logging-configuration (structure)

The logging configuration for the test.

s3BucketName -> (string)

The name of the S3 bucket for log delivery.

cloudWatchLogGroupArn -> (string)

The ARN of the CloudWatch Logs log group for log delivery.

Constraints:

min: 31

pattern: arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023}

logSchemaVersion -> (string)

The version of the log schema.

Shorthand Syntax:

s3BucketName=string,cloudWatchLogGroupArn=string,logSchemaVersion=string

JSON Syntax:

{
  "s3BucketName": "string",
  "cloudWatchLogGroupArn": "string",
  "logSchemaVersion": "string"
}

--stop-conditions (list)

The stop conditions for the test.

(structure)

A CloudWatch alarm that automatically stops a test run if it breaches its threshold.

source -> (string) [required]

The source of the stop condition.

Possible values:

aws:cloudwatch:alarm

none

value -> (string) [required]

The value of the stop condition, such as the ARN of the CloudWatch alarm.

Shorthand Syntax:

source=string,value=string ...

JSON Syntax:

[
  {
    "source": "aws:cloudwatch:alarm"|"none",
    "value": "string"
  }
  ...
]

--role-name (string)

The name of the IAM execution role to use when running the test.

Constraints:

min: 2

max: 60

pattern: [A-Za-z0-9][A-Za-z0-9_\-]{1,59}

--parameters (map)

The parameter values for the test.

Constraints:

min: 0

max: 20

key -> (string)

The key of a test parameter.

Constraints:

min: 1

max: 256

pattern: [\w.-]+

value -> (list)

Constraints:

min: 0

max: 10

(string)

A value of a test parameter.

Constraints:

min: 0

max: 1024

Shorthand Syntax:

KeyName1=string,string,KeyName2=string,string

JSON Syntax:

{"string": ["string", ...]
  ...}

--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.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream
off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

test -> (structure)

The created test.

testId -> (string) [required]

The unique identifier of the test.

testTemplateArn -> (string) [required]

The ARN of the test template the test was created from.

Constraints:

min: 31

pattern: arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):([0-9]{12}|aws):[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023}

serviceArn -> (string) [required]

The ARN of the service the test belongs to.

Constraints:

min: 31

pattern: arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023}

name -> (string) [required]

The name of the test.

actions -> (list)

The fault actions the test runs.

(structure)

Represents a fault action that a test runs, along with the resource type it targets.

actionId -> (string) [required]

The identifier of the fault action.

description -> (string)

A description of the fault action.

resourceType -> (string) [required]

The resource type that the action targets.

loggingConfiguration -> (structure)

The logging configuration for the test.

s3BucketName -> (string)

The name of the S3 bucket for log delivery.

cloudWatchLogGroupArn -> (string)

The ARN of the CloudWatch Logs log group for log delivery.

Constraints:

min: 31

pattern: arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023}

logSchemaVersion -> (string)

The version of the log schema.

stopConditions -> (list)

The stop conditions for the test.

(structure)

A CloudWatch alarm that automatically stops a test run if it breaches its threshold.

source -> (string) [required]

The source of the stop condition.

Possible values:

aws:cloudwatch:alarm

none

value -> (string) [required]

The value of the stop condition, such as the ARN of the CloudWatch alarm.

roleName -> (string)

The name of the IAM execution role used to run the test.

Constraints:

min: 2

max: 60

pattern: [A-Za-z0-9][A-Za-z0-9_\-]{1,59}

parameters -> (map)

The parameter values configured for the test.

Constraints:

min: 0

max: 20

key -> (string)

The key of a test parameter.

Constraints:

min: 1

max: 256

pattern: [\w.-]+

value -> (list)

Constraints:

min: 0

max: 10

(string)

A value of a test parameter.

Constraints:

min: 0

max: 1024

totalTestRuns -> (integer) [required]

The total number of runs of the test.

successfulTestRuns -> (integer) [required]

The number of successful runs of the test.

creationTime -> (timestamp) [required]

The timestamp when the test was created.

Table of Contents

Feedback

User Guide

create-test¶

Description¶

Synopsis¶

Options¶

Global Options¶

Output¶