[ aws . synthetics ]

update-canary

Description

Use this operation to change the settings of a canary that has already been created.

You can’t use this operation to update the tags of an existing canary. To change the tags of an existing canary, use TagResource .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-canary
--name <value>
[--code <value>]
[--execution-role-arn <value>]
[--runtime-version <value>]
[--schedule <value>]
[--run-config <value>]
[--success-retention-period-in-days <value>]
[--failure-retention-period-in-days <value>]
[--vpc-config <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--name (string)

The name of the canary that you want to update. To find the names of your canaries, use DescribeCanaries .

You cannot change the name of a canary that has already been created.

--code (structure)

A structure that includes the entry point from which the canary should start running your script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included.

S3Bucket -> (string)

If your canary script is located in S3, specify the full bucket name here. The bucket must already exist. Specify the full bucket name, including s3:// as the start of the bucket name.

S3Key -> (string)

The S3 key of your script. For more information, see Working with Amazon S3 Objects .

S3Version -> (string)

The S3 version ID of your script.

ZipFile -> (blob)

If you input your canary script directly into the canary instead of referring to an S3 location, the value of this parameter is the .zip file that contains the script. It can be up to 5 MB.

Handler -> (string)

The entry point to use for the source code when running the canary. This value must end with the string .handler .

Shorthand Syntax:

S3Bucket=string,S3Key=string,S3Version=string,ZipFile=blob,Handler=string

JSON Syntax:

{
  "S3Bucket": "string",
  "S3Key": "string",
  "S3Version": "string",
  "ZipFile": blob,
  "Handler": "string"
}

--execution-role-arn (string)

The ARN of the IAM role to be used to run the canary. This role must already exist, and must include lambda.amazonaws.com as a principal in the trust policy. The role must also have the following permissions:

• s3:PutObject

• s3:GetBucketLocation

• s3:ListAllMyBuckets

• cloudwatch:PutMetricData

• logs:CreateLogGroup

• logs:CreateLogStream

• logs:CreateLogStream

--runtime-version (string)

Specifies the runtime version to use for the canary. For a list of valid runtime versions and for more information about runtime versions, see Canary Runtime Versions .

--schedule (structure)

A structure that contains information about how often the canary is to run, and when these runs are to stop.

Expression -> (string)

A rate expression that defines how often the canary is to run. The syntax is rate(*number unit* ) . unit can be minute , minutes , or hour .

For example, rate(1 minute) runs the canary once a minute, rate(10 minutes) runs it once every 10 minutes, and rate(1 hour) runs it once every hour. You can specify a frequency between rate(1 minute) and rate(1 hour) .

Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started.

DurationInSeconds -> (long)

How long, in seconds, for the canary to continue making regular runs according to the schedule in the Expression value. If you specify 0, the canary continues making runs until you stop it. If you omit this field, the default of 0 is used.

Shorthand Syntax:

Expression=string,DurationInSeconds=long

JSON Syntax:

{
  "Expression": "string",
  "DurationInSeconds": long
}

--run-config (structure)

A structure that contains the timeout value that is used for each individual run of the canary.

TimeoutInSeconds -> (integer)

How long the canary is allowed to run before it must stop. You can’t set this time to be longer than the frequency of the runs of this canary.

If you omit this field, the frequency of the canary is used as this value, up to a maximum of 14 minutes.

MemoryInMB -> (integer)

The maximum amount of memory available to the canary while it is running, in MB. This value must be a multiple of 64.

ActiveTracing -> (boolean)

Specifies whether this canary is to use active AWS X-Ray tracing when it runs. Active tracing enables this canary run to be displayed in the ServiceLens and X-Ray service maps even if the canary does not hit an endpoint that has X-ray tracing enabled. Using X-Ray tracing incurs charges. For more information, see Canaries and X-Ray tracing .

You can enable active tracing only for canaries that use version syn-nodejs-2.0 or later for their canary runtime.

EnvironmentVariables -> (map)

Specifies the keys and values to use for any environment variables used in the canary script. Use the following format:

{ “key1” : “value1”, “key2” : “value2”, …}

Keys must start with a letter and be at least two characters. The total size of your environment variables cannot exceed 4 KB. You can’t specify any Lambda reserved environment variables as the keys for your environment variables. For more information about reserved keys, see Runtime environment variables .

key -> (string)

value -> (string)

Shorthand Syntax:

TimeoutInSeconds=integer,MemoryInMB=integer,ActiveTracing=boolean,EnvironmentVariables={KeyName1=string,KeyName2=string}

JSON Syntax:

{
  "TimeoutInSeconds": integer,
  "MemoryInMB": integer,
  "ActiveTracing": true|false,
  "EnvironmentVariables": {"string": "string"
    ...}
}

--success-retention-period-in-days (integer)

The number of days to retain data about successful runs of this canary.

--failure-retention-period-in-days (integer)

The number of days to retain data about failed runs of this canary.

--vpc-config (structure)

If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint. For more information, see Running a Canary in a VPC .

SubnetIds -> (list)

The IDs of the subnets where this canary is to run.

(string)

SecurityGroupIds -> (list)

The IDs of the security groups for this canary.

(string)

Shorthand Syntax:

SubnetIds=string,string,SecurityGroupIds=string,string

JSON Syntax:

{
  "SubnetIds": ["string", ...],
  "SecurityGroupIds": ["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.

See ‘aws help’ for descriptions of global parameters.

Output

None