aws_synthetics_canary

account_id

Type: STRING

artifact_config

Type: STRUCT
Provider name: ArtifactConfig
Description: A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.

• s3_encryption
  Type: STRUCT
  Provider name: S3Encryption
  Description: A structure that contains the configuration of encryption settings for canary artifacts that are stored in Amazon S3.
  
  • encryption_mode
    Type: STRING
    Provider name: EncryptionMode
    Description: The encryption method to use for artifacts created by this canary. Specify SSE_S3 to use server-side encryption (SSE) with an Amazon S3-managed key. Specify SSE-KMS to use server-side encryption with a customer-managed KMS key. If you omit this parameter, an Amazon Web Services-managed KMS key is used.
    
  • kms_key_arn
    Type: STRING
    Provider name: KmsKeyArn
    Description: The ARN of the customer-managed KMS key to use, if you specify SSE-KMS for EncryptionMode
    

artifact_s3_location

Type: STRING
Provider name: ArtifactS3Location
Description: The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary. Artifacts include the log file, screenshots, and HAR files.

code

Type: STRUCT
Provider name: Code

• handler
  Type: STRING
  Provider name: Handler
  Description: The entry point to use for the source code when running the canary.
  
• source_location_arn
  Type: STRING
  Provider name: SourceLocationArn
  Description: The ARN of the Lambda layer where Synthetics stores the canary script code.
  

engine_arn

Type: STRING
Provider name: EngineArn
Description: The ARN of the Lambda function that is used as your canary’s engine. For more information about Lambda ARN format, see Resources and Conditions for Lambda Actions.

execution_role_arn

Type: STRING
Provider name: ExecutionRoleArn
Description: The ARN of the IAM role used to run the canary. This role must include lambda.amazonaws.com as a principal in the trust policy.

failure_retention_period_in_days

Type: INT32
Provider name: FailureRetentionPeriodInDays
Description: The number of days to retain data about failed runs of this canary.

id

Type: STRING
Provider name: Id
Description: The unique ID of this canary.

name

Type: STRING
Provider name: Name
Description: The name of the canary.

provisioned_resource_cleanup

Type: STRING
Provider name: ProvisionedResourceCleanup
Description: Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted. If it is AUTOMATIC, the Lambda functions and layers will be deleted when the canary is deleted. If the value of this parameter is OFF, then the value of the DeleteLambda parameter of the DeleteCanary operation determines whether the Lambda functions and layers will be deleted.

run_config

Type: STRUCT
Provider name: RunConfig

• active_tracing
  Type: BOOLEAN
  Provider name: ActiveTracing
  Description: Displays whether this canary run used active X-Ray tracing.
  
• memory_in_mb
  Type: INT32
  Provider name: MemoryInMB
  Description: The maximum amount of memory available to the canary while it is running, in MB. This value must be a multiple of 64.
  
• timeout_in_seconds
  Type: INT32
  Provider name: TimeoutInSeconds
  Description: How long the canary is allowed to run before it must stop.
  

runtime_version

Type: STRING
Provider name: RuntimeVersion
Description: Specifies the runtime version to use for the canary. For more information about runtime versions, see Canary Runtime Versions.

schedule

Type: STRUCT
Provider name: Schedule
Description: A structure that contains information about how often the canary is to run, and when these runs are to stop.

• duration_in_seconds
  Type: INT64
  Provider name: DurationInSeconds
  Description: How long, in seconds, for the canary to continue making regular runs after it was created. The runs are performed according to the schedule in the Expression value.
  
• expression
  Type: STRING
  Provider name: Expression
  Description: A rate expression or a cron expression that defines how often the canary is to run. For a rate expression, 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. Use cron(expression) to specify a cron expression. For information about the syntax for cron expressions, see Scheduling canary runs using cron.
  

status

Type: STRUCT
Provider name: Status
Description: A structure that contains information about the canary’s status.

• state
  Type: STRING
  Provider name: State
  Description: The current state of the canary.
  
• state_reason
  Type: STRING
  Provider name: StateReason
  Description: If the canary has insufficient permissions to run, this field provides more details.
  
• state_reason_code
  Type: STRING
  Provider name: StateReasonCode
  Description: If the canary cannot run or has failed, this field displays the reason.
  

success_retention_period_in_days

Type: INT32
Provider name: SuccessRetentionPeriodInDays
Description: The number of days to retain data about successful runs of this canary.

tags

Type: UNORDERED_LIST_STRING

timeline

Type: STRUCT
Provider name: Timeline
Description: A structure that contains information about when the canary was created, modified, and most recently run.

• created
  Type: TIMESTAMP
  Provider name: Created
  Description: The date and time the canary was created.
  
• last_modified
  Type: TIMESTAMP
  Provider name: LastModified
  Description: The date and time the canary was most recently modified.
  
• last_started
  Type: TIMESTAMP
  Provider name: LastStarted
  Description: The date and time that the canary’s most recent run started.
  
• last_stopped
  Type: TIMESTAMP
  Provider name: LastStopped
  Description: The date and time that the canary’s most recent run ended.
  

visual_reference

Type: STRUCT
Provider name: VisualReference
Description: If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run to use as the baseline for screenshots, and the coordinates of any parts of the screen to ignore during the visual monitoring comparison.

• base_canary_run_id
  Type: STRING
  Provider name: BaseCanaryRunId
  Description: The ID of the canary run that produced the baseline screenshots that are used for visual monitoring comparisons by this canary.
  
• base_screenshots
  Type: UNORDERED_LIST_STRUCT
  Provider name: BaseScreenshots
  Description: An array of screenshots that are used as the baseline for comparisons during visual monitoring.
  
  • ignore_coordinates
    Type: UNORDERED_LIST_STRING
    Provider name: IgnoreCoordinates
    Description: Coordinates that define the part of a screen to ignore during screenshot comparisons. To obtain the coordinates to use here, use the CloudWatch console to draw the boundaries on the screen. For more information, see Editing or deleting a canary
    
  • screenshot_name
    Type: STRING
    Provider name: ScreenshotName
    Description: The name of the screenshot. This is generated the first time the canary is run after the UpdateCanary operation that specified for this canary to perform visual monitoring.
    

vpc_config

Type: STRUCT
Provider name: VpcConfig

• ipv6_allowed_for_dual_stack
  Type: BOOLEAN
  Provider name: Ipv6AllowedForDualStack
  Description: Indicates whether this canary allows outbound IPv6 traffic if it is connected to dual-stack subnets.
  
• security_group_ids
  Type: UNORDERED_LIST_STRING
  Provider name: SecurityGroupIds
  Description: The IDs of the security groups for this canary.
  
• subnet_ids
  Type: UNORDERED_LIST_STRING
  Provider name: SubnetIds
  Description: The IDs of the subnets where this canary is to run.
  
• vpc_id
  Type: STRING
  Provider name: VpcId
  Description: The IDs of the VPC where this canary is to run.