CanaryRunConfigOutput - Amazon CloudWatch Synthetics

CanaryRunConfigOutput

A structure that contains information about a canary run.

Contents

ActiveTracing

Displays whether this canary run used active X-Ray tracing.

Type: Boolean

Required: No

EphemeralStorage

Specifies the amount of ephemeral storage (in MB) to allocate for the canary run during execution. This temporary storage is used for storing canary run artifacts (which are uploaded to an Amazon S3 bucket at the end of the run), and any canary browser operations. This temporary storage is cleared after the run is completed. Default storage value is 1024 MB.

Type: Integer

Valid Range: Minimum value of 1024. Maximum value of 5120.

Required: No

MemoryInMB

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

Type: Integer

Valid Range: Minimum value of 960. Maximum value of 3008.

Required: No

TimeoutInSeconds

How long the canary is allowed to run before it must stop.

Type: Integer

Valid Range: Minimum value of 3. Maximum value of 840.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: