{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-cloudwatch/json-schema/amazon-cloudwatch-create-canary-request-schema.json",
  "title": "CreateCanaryRequest",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-cloudwatch-canary-api-openapi.yml#/components/schemas/CreateCanaryRequest",
  "type": "object",
  "properties": {
    "Name": {
      "type": "string",
      "description": "The name for this canary. Be sure to give it a descriptive name that distinguishes it from other canaries in your account. Do not include secrets or proprietary information in your canary names. The canary name makes up part of the canary ARN, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries."
    },
    "Code": {
      "$ref": "#/$defs/CanaryCodeInput"
    },
    "ArtifactS3Location": {
      "type": "string",
      "description": "The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. Artifacts include the log file, screenshots, and HAR files. The name of the Amazon S3 bucket can't include a period (.)."
    },
    "ExecutionRoleArn": {
      "type": "string",
      "description": "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:PutLogEvents"
    },
    "Schedule": {
      "$ref": "#/$defs/CanaryScheduleInput"
    },
    "RunConfig": {
      "$ref": "#/$defs/CanaryRunConfigInput"
    },
    "SuccessRetentionPeriodInDays": {
      "type": "integer",
      "description": "The number of days to retain data about successful runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days. This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console."
    },
    "FailureRetentionPeriodInDays": {
      "type": "integer",
      "description": "The number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days. This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console."
    },
    "RuntimeVersion": {
      "type": "string",
      "description": "Specifies the runtime version to use for the canary. For a list of valid runtime versions and more information about runtime versions, see Canary Runtime Versions."
    },
    "VpcConfig": {
      "$ref": "#/$defs/VpcConfigInput"
    },
    "ResourcesToReplicateTags": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "lambda-function"
        ]
      },
      "description": "To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value lambda-function. If you specify this parameter and don't specify any tags in the Tags parameter, the canary creation fails."
    },
    "ProvisionedResourceCleanup": {
      "type": "string",
      "enum": [
        "AUTOMATIC",
        "OFF"
      ],
      "description": "Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted. If you omit this parameter, the default of AUTOMATIC is used, which means that 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."
    },
    "BrowserConfigs": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/BrowserConfig"
      },
      "description": "CloudWatch Synthetics now supports multibrowser canaries for syn-nodejs-puppeteer-11.0 and syn-nodejs-playwright-3.0 runtimes. This feature allows you to run your canaries on both Firefox and Chrome browsers. To create a multibrowser canary, you need to specify the BrowserConfigs with a list of browsers you want to use. If not specified, browserConfigs defaults to Chrome."
    },
    "AddReplicaLocations": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/AddReplicaLocationInput"
      },
      "description": "A list of locations (Amazon Web Services Regions) to add as replicas for the canary. Each location specifies a Region and optional VPC configuration for the replica. You can add up to 50 replica locations."
    },
    "Tags": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "A list of key-value pairs to associate with the canary. You can associate as many as 50 tags with a canary. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values. To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value lambda-function."
    },
    "ArtifactConfig": {
      "$ref": "#/$defs/ArtifactConfigInput"
    },
    "KmsKeyArn": {
      "type": "string",
      "description": "The Amazon Resource Name (ARN) of the customer-managed AWS Key Management Service (AWS KMS) key used to encrypt the canary's AWS Lambda function environment variables at rest. If you don't specify a value, the service uses an AWS-managed key."
    }
  },
  "required": [
    "Name",
    "Code",
    "ArtifactS3Location",
    "ExecutionRoleArn",
    "Schedule",
    "RuntimeVersion"
  ],
  "$defs": {
    "AddReplicaLocationInput": {
      "type": "object",
      "properties": {
        "Location": {
          "type": "string",
          "description": "The Amazon Web Services Region where the canary replica should be created, for example us-east-1."
        },
        "VpcConfig": {
          "$ref": "#/$defs/VpcConfigInput"
        },
        "KmsKeyArn": {
          "type": "string",
          "description": "The Amazon Resource Name (ARN) of the customer-managed AWS Key Management Service (AWS KMS) key used to encrypt the canary replica's AWS Lambda function environment variables at rest. If you don't specify a value, the service uses an AWS-managed key."
        }
      },
      "required": [
        "Location"
      ]
    },
    "ArtifactConfigInput": {
      "type": "object",
      "properties": {
        "S3Encryption": {
          "$ref": "#/$defs/S3EncryptionConfig"
        }
      }
    },
    "BrowserConfig": {
      "type": "object",
      "properties": {
        "BrowserType": {
          "type": "string",
          "enum": [
            "CHROME",
            "FIREFOX"
          ],
          "description": "The browser type associated with this browser configuration."
        }
      }
    },
    "CanaryCodeInput": {
      "type": "object",
      "properties": {
        "S3Bucket": {
          "type": "string",
          "description": "If your canary script is located in Amazon S3, specify the bucket name here. Do not include s3:// as the start of the bucket name."
        },
        "S3Key": {
          "type": "string",
          "description": "The Amazon S3 key of your script. For more information, see Working with Amazon S3 Objects."
        },
        "S3Version": {
          "type": "string",
          "description": "The Amazon S3 version ID of your script."
        },
        "ZipFile": {
          "type": "string",
          "format": "byte",
          "description": "If you input your canary script directly into the canary instead of referring to an Amazon S3 location, the value of this parameter is the base64-encoded contents of the .zip file that contains the script. It must be smaller than 225 Kb. For large canary scripts, we recommend that you use an Amazon S3 location instead of inputting it directly with this parameter."
        },
        "Handler": {
          "type": "string",
          "description": "The entry point to use for the source code when running the canary. For canaries that use the syn-python-selenium-1.0 runtime or a syn-nodejs.puppeteer runtime earlier than syn-nodejs.puppeteer-3.4, the handler must be specified as fileName.handler. For syn-python-selenium-1.1, syn-nodejs.puppeteer-3.4, and later runtimes, the handler can be specified as fileName.functionName , or you can specify a folder where canary scripts reside as folder/fileName.functionName . This field is required when you don't specify BlueprintTypes and is not allowed when you specify BlueprintTypes."
        },
        "BlueprintTypes": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "BlueprintTypes is a list of templates that enable simplified canary creation. You can create canaries for common monitoring scenarios by providing only a JSON configuration file instead of writing custom scripts. The only supported value is multi-checks. Multi-checks monitors HTTP/DNS/SSL/TCP endpoints with built-in authentication schemes (Basic, API Key, OAuth, SigV4) and assertion capabilities. When you specify BlueprintTypes, the Handler field cannot be specified since the blueprint provides a pre-defined entry point. BlueprintTypes is supported only on canaries for syn-nodejs-3.0 runtime o"
        },
        "Dependencies": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Dependency"
          },
          "description": "A list of dependencies that should be used for running this canary. Specify the dependencies as a key-value pair, where the key is the type of dependency and the value is the dependency reference."
        }
      }
    },
    "CanaryRunConfigInput": {
      "type": "object",
      "properties": {
        "TimeoutInSeconds": {
          "type": "integer",
          "description": "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": {
          "type": "integer",
          "description": "The maximum amount of memory available to the canary while it is running, in MB. This value must be a multiple of 64."
        },
        "ActiveTracing": {
          "type": "boolean",
          "description": "Specifies whether this canary is to use active 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": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "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. Environment variable keys and values are encrypted at rest using Amazon Web Services owned KMS keys. However, the environment v"
        },
        "EphemeralStorage": {
          "type": "integer",
          "description": "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."
        }
      }
    },
    "CanaryScheduleInput": {
      "type": "object",
      "properties": {
        "Expression": {
          "type": "string",
          "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. You can't schedule a canary to w"
        },
        "DurationInSeconds": {
          "type": "integer",
          "description": "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."
        },
        "RetryConfig": {
          "$ref": "#/$defs/RetryConfigInput"
        }
      },
      "required": [
        "Expression"
      ]
    },
    "Dependency": {
      "type": "object",
      "properties": {
        "Type": {
          "type": "string",
          "enum": [
            "LambdaLayer"
          ],
          "description": "The type of dependency. Valid value is LambdaLayer."
        },
        "Reference": {
          "type": "string",
          "description": "The dependency reference. For Lambda layers, this is the ARN of the Lambda layer. For more information about Lambda ARN format, see Lambda."
        }
      },
      "required": [
        "Reference"
      ]
    },
    "RetryConfigInput": {
      "type": "object",
      "properties": {
        "MaxRetries": {
          "type": "integer",
          "description": "The maximum number of retries. The value must be less than or equal to 2."
        }
      },
      "required": [
        "MaxRetries"
      ]
    },
    "S3EncryptionConfig": {
      "type": "object",
      "properties": {
        "EncryptionMode": {
          "type": "string",
          "enum": [
            "SSE_S3",
            "SSE_KMS"
          ],
          "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."
        },
        "KmsKeyArn": {
          "type": "string",
          "description": "The ARN of the customer-managed KMS key to use, if you specify SSE-KMS for EncryptionMode"
        }
      }
    },
    "VpcConfigInput": {
      "type": "object",
      "properties": {
        "SubnetIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The IDs of the subnets where this canary is to run."
        },
        "SecurityGroupIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The IDs of the security groups for this canary."
        },
        "Ipv6AllowedForDualStack": {
          "type": "boolean",
          "description": "Set this to true to allow outbound IPv6 traffic on VPC canaries that are connected to dual-stack subnets. The default is false"
        }
      }
    }
  }
}