awscc.synthetics_canary¶
Filters¶
event
reduce
value
Actions¶
delete¶
Parent base class for filters and actions.
properties:
type:
enum:
- delete
required:
- type
Permissions - synthetics:DeleteCanary, synthetics:GetCanary
update¶
Parent base class for filters and actions.
definitions:
ArtifactConfig:
additionalProperties: false
properties:
S3Encryption:
additionalProperties: false
properties:
EncryptionMode:
description: 'Encryption mode for encrypting artifacts when uploading
to S3. Valid values: SSE_S3 and SSE_KMS.'
type: string
KmsKeyArn:
description: KMS key Arn for encrypting artifacts when uploading to S3.
You must specify KMS key Arn for SSE_KMS encryption mode only.
type: string
type: object
type: object
BaseScreenshot:
properties:
IgnoreCoordinates:
description: List of coordinates of rectangles to be ignored during visual
testing
items:
description: Coordinates of a rectangle to be ignored during visual testing
type: string
type: array
ScreenshotName:
description: Name of the screenshot to be used as base reference for visual
testing
type: string
required:
- ScreenshotName
type: object
Code:
additionalProperties: false
oneOf:
- required:
- S3Bucket
- S3Key
- required:
- Script
properties:
Handler:
type: string
S3Bucket:
type: string
S3Key:
type: string
S3ObjectVersion:
type: string
Script:
type: string
required:
- Handler
type: object
RunConfig:
additionalProperties: false
properties:
ActiveTracing:
description: Enable active tracing if set to true
type: boolean
EnvironmentVariables:
additionalProperties: false
description: Environment variable key-value pairs.
patternProperties:
'[a-zA-Z][a-zA-Z0-9_]+':
type: string
type: object
MemoryInMB:
description: Provide maximum memory available for canary in MB
type: integer
TimeoutInSeconds:
description: Provide maximum canary timeout per run in seconds
type: integer
type: object
S3Encryption:
additionalProperties: false
properties:
EncryptionMode:
description: 'Encryption mode for encrypting artifacts when uploading to S3.
Valid values: SSE_S3 and SSE_KMS.'
type: string
KmsKeyArn:
description: KMS key Arn for encrypting artifacts when uploading to S3. You
must specify KMS key Arn for SSE_KMS encryption mode only.
type: string
type: object
Schedule:
additionalProperties: false
properties:
DurationInSeconds:
type: string
Expression:
type: string
required:
- Expression
type: object
Tag:
additionalProperties: false
description: A key-value pair to associate with a resource.
properties:
Key:
description: 'The key name of the tag. You can specify a value that is 1 to
127 Unicode characters in length and cannot be prefixed with aws:. You can
use any of the following characters: the set of Unicode letters, digits,
whitespace, _, ., /, =, +, and -. '
maxLength: 128
minLength: 1
type: string
Value:
description: 'The value for the tag. You can specify a value that is 1 to
255 Unicode characters in length and cannot be prefixed with aws:. You can
use any of the following characters: the set of Unicode letters, digits,
whitespace, _, ., /, =, +, and -. '
maxLength: 256
minLength: 0
type: string
required:
- Value
- Key
type: object
VPCConfig:
additionalProperties: false
properties:
SecurityGroupIds:
items:
type: string
type: array
SubnetIds:
items:
type: string
type: array
VpcId:
type: string
required:
- SubnetIds
- SecurityGroupIds
type: object
VisualReference:
additionalProperties: false
properties:
BaseCanaryRunId:
description: Canary run id to be used as base reference for visual testing
type: string
BaseScreenshots:
description: List of screenshots used as base reference for visual testing
items:
properties:
IgnoreCoordinates:
description: List of coordinates of rectangles to be ignored during
visual testing
items:
description: Coordinates of a rectangle to be ignored during visual
testing
type: string
type: array
ScreenshotName:
description: Name of the screenshot to be used as base reference for
visual testing
type: string
required:
- ScreenshotName
type: object
type: array
required:
- BaseCanaryRunId
type: object
properties:
ArtifactConfig:
additionalProperties: false
properties:
S3Encryption:
additionalProperties: false
properties:
EncryptionMode:
description: 'Encryption mode for encrypting artifacts when uploading
to S3. Valid values: SSE_S3 and SSE_KMS.'
type: string
KmsKeyArn:
description: KMS key Arn for encrypting artifacts when uploading to S3.
You must specify KMS key Arn for SSE_KMS encryption mode only.
type: string
type: object
type: object
ArtifactS3Location:
description: Provide the s3 bucket output location for test results
pattern: ^(s3|S3)://
type: string
Code:
additionalProperties: false
oneOf:
- required:
- S3Bucket
- S3Key
- required:
- Script
properties:
Handler:
type: string
S3Bucket:
type: string
S3Key:
type: string
S3ObjectVersion:
type: string
Script:
type: string
required:
- Handler
type: object
ExecutionRoleArn:
description: Lambda Execution role used to run your canaries
type: string
FailureRetentionPeriod:
description: Retention period of failed canary runs represented in number of days
type: integer
RunConfig:
additionalProperties: false
properties:
ActiveTracing:
description: Enable active tracing if set to true
type: boolean
EnvironmentVariables:
additionalProperties: false
description: Environment variable key-value pairs.
patternProperties:
'[a-zA-Z][a-zA-Z0-9_]+':
type: string
type: object
MemoryInMB:
description: Provide maximum memory available for canary in MB
type: integer
TimeoutInSeconds:
description: Provide maximum canary timeout per run in seconds
type: integer
type: object
RuntimeVersion:
description: Runtime version of Synthetics Library
type: string
Schedule:
additionalProperties: false
properties:
DurationInSeconds:
type: string
Expression:
type: string
required:
- Expression
type: object
StartCanaryAfterCreation:
description: Runs canary if set to True. Default is False
type: boolean
SuccessRetentionPeriod:
description: Retention period of successful canary runs represented in number
of days
type: integer
Tags:
items:
additionalProperties: false
description: A key-value pair to associate with a resource.
properties:
Key:
description: 'The key name of the tag. You can specify a value that is 1
to 127 Unicode characters in length and cannot be prefixed with aws:.
You can use any of the following characters: the set of Unicode letters,
digits, whitespace, _, ., /, =, +, and -. '
maxLength: 128
minLength: 1
type: string
Value:
description: 'The value for the tag. You can specify a value that is 1 to
255 Unicode characters in length and cannot be prefixed with aws:. You
can use any of the following characters: the set of Unicode letters, digits,
whitespace, _, ., /, =, +, and -. '
maxLength: 256
minLength: 0
type: string
required:
- Value
- Key
type: object
type: array
uniqueItems: false
VPCConfig:
additionalProperties: false
properties:
SecurityGroupIds:
items:
type: string
type: array
SubnetIds:
items:
type: string
type: array
VpcId:
type: string
required:
- SubnetIds
- SecurityGroupIds
type: object
VisualReference:
additionalProperties: false
properties:
BaseCanaryRunId:
description: Canary run id to be used as base reference for visual testing
type: string
BaseScreenshots:
description: List of screenshots used as base reference for visual testing
items:
properties:
IgnoreCoordinates:
description: List of coordinates of rectangles to be ignored during
visual testing
items:
description: Coordinates of a rectangle to be ignored during visual
testing
type: string
type: array
ScreenshotName:
description: Name of the screenshot to be used as base reference for
visual testing
type: string
required:
- ScreenshotName
type: object
type: array
required:
- BaseCanaryRunId
type: object
type:
enum:
- update
Permissions - synthetics:UpdateCanary, synthetics:StartCanary, synthetics:StopCanary, synthetics:TagResource, synthetics:UntagResource