Skip to content

Creates a canary

Description

Creates a canary. Canaries are scripts that monitor your endpoints and APIs from the outside-in. Canaries help you check the availability and latency of your web services and troubleshoot anomalies by investigating load time data, screenshots of the UI, logs, and metrics. You can set up a canary to run continuously or just once.

Do not use create_canary to modify an existing canary. Use update_canary instead.

To create canaries, you must have the CloudWatchSyntheticsFullAccess policy. If you are creating a new IAM role for the canary, you also need the iam:CreateRole, iam:CreatePolicy and iam:AttachRolePolicy permissions. For more information, see Necessary Roles and Permissions.

Do not include secrets or proprietary information in your canary names. The canary name makes up part of the Amazon Resource Name (ARN) for the canary, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries.

Usage

synthetics_create_canary(Name, Code, ArtifactS3Location,
  ExecutionRoleArn, Schedule, RunConfig, SuccessRetentionPeriodInDays,
  FailureRetentionPeriodInDays, RuntimeVersion, VpcConfig,
  ResourcesToReplicateTags, ProvisionedResourceCleanup, BrowserConfigs,
  AddReplicaLocations, Tags, ArtifactConfig, KmsKeyArn)

Arguments

  • Name

    [required] 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

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

  • ArtifactS3Location

    [required] 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

    [required] 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

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

  • RunConfig

    A structure that contains the configuration for individual canary runs, such as timeout value and environment variables.

    Environment variable keys and values are encrypted at rest using Amazon Web Services owned KMS keys. However, the environment variables are not encrypted on the client side. Do not store sensitive information in them.

  • SuccessRetentionPeriodInDays

    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 get_canary_runs, as well as the range of information displayed in the Synthetics console.

  • FailureRetentionPeriodInDays

    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 get_canary_runs, as well as the range of information displayed in the Synthetics console.

  • RuntimeVersion

    [required] 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

    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.

  • ResourcesToReplicateTags

    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

    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 delete_canary operation determines whether the Lambda functions and layers will be deleted.

  • BrowserConfigs

    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

    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

    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

    A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.

  • KmsKeyArn

    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.

Value

A list with the following syntax:

list(
  Canary = list(
    Id = "string",
    Name = "string",
    Code = list(
      SourceLocationArn = "string",
      Handler = "string",
      BlueprintTypes = list(
        "string"
      ),
      Dependencies = list(
        list(
          Type = "LambdaLayer",
          Reference = "string"
        )
      )
    ),
    ExecutionRoleArn = "string",
    Schedule = list(
      Expression = "string",
      DurationInSeconds = 123,
      RetryConfig = list(
        MaxRetries = 123
      )
    ),
    RunConfig = list(
      TimeoutInSeconds = 123,
      MemoryInMB = 123,
      ActiveTracing = TRUE|FALSE,
      EphemeralStorage = 123
    ),
    SuccessRetentionPeriodInDays = 123,
    FailureRetentionPeriodInDays = 123,
    Status = list(
      State = "CREATING"|"READY"|"STARTING"|"RUNNING"|"UPDATING"|"STOPPING"|"STOPPED"|"ERROR"|"DELETING",
      StateReason = "string",
      StateReasonCode = "INVALID_PERMISSIONS"|"CREATE_PENDING"|"CREATE_IN_PROGRESS"|"CREATE_FAILED"|"UPDATE_PENDING"|"UPDATE_IN_PROGRESS"|"UPDATE_COMPLETE"|"ROLLBACK_COMPLETE"|"ROLLBACK_FAILED"|"DELETE_IN_PROGRESS"|"DELETE_FAILED"|"SYNC_DELETE_IN_PROGRESS"
    ),
    Timeline = list(
      Created = as.POSIXct(
        "2015-01-01"
      ),
      LastModified = as.POSIXct(
        "2015-01-01"
      ),
      LastStarted = as.POSIXct(
        "2015-01-01"
      ),
      LastStopped = as.POSIXct(
        "2015-01-01"
      )
    ),
    ArtifactS3Location = "string",
    EngineArn = "string",
    RuntimeVersion = "string",
    VpcConfig = list(
      VpcId = "string",
      SubnetIds = list(
        "string"
      ),
      SecurityGroupIds = list(
        "string"
      ),
      Ipv6AllowedForDualStack = TRUE|FALSE
    ),
    VisualReference = list(
      BaseScreenshots = list(
        list(
          ScreenshotName = "string",
          IgnoreCoordinates = list(
            "string"
          )
        )
      ),
      BaseCanaryRunId = "string",
      BrowserType = "CHROME"|"FIREFOX"
    ),
    ProvisionedResourceCleanup = "AUTOMATIC"|"OFF",
    BrowserConfigs = list(
      list(
        BrowserType = "CHROME"|"FIREFOX"
      )
    ),
    EngineConfigs = list(
      list(
        EngineArn = "string",
        BrowserType = "CHROME"|"FIREFOX"
      )
    ),
    VisualReferences = list(
      list(
        BaseScreenshots = list(
          list(
            ScreenshotName = "string",
            IgnoreCoordinates = list(
              "string"
            )
          )
        ),
        BaseCanaryRunId = "string",
        BrowserType = "CHROME"|"FIREFOX"
      )
    ),
    MultiLocationConfig = list(
      LocationType = "Primary"|"Replica",
      PrimaryLocation = "string",
      Replicas = list(
        list(
          Location = "string",
          ReplicationStatus = list(
            State = "InProgress"|"InSync"|"Inconsistent",
            StateReason = "string",
            StateReasonCode = "string"
          ),
          CanaryState = "CREATING"|"READY"|"STARTING"|"RUNNING"|"UPDATING"|"STOPPING"|"STOPPED"|"ERROR"|"DELETING",
          LastModified = as.POSIXct(
            "2015-01-01"
          ),
          VpcConfig = list(
            VpcId = "string",
            SubnetIds = list(
              "string"
            ),
            SecurityGroupIds = list(
              "string"
            ),
            Ipv6AllowedForDualStack = TRUE|FALSE
          )
        )
      ),
      ReplicationState = "InProgress"|"InSync"|"Inconsistent"
    ),
    Tags = list(
      "string"
    ),
    ArtifactConfig = list(
      S3Encryption = list(
        EncryptionMode = "SSE_S3"|"SSE_KMS",
        KmsKeyArn = "string"
      )
    ),
    KmsKeyArn = "string",
    DryRunConfig = list(
      DryRunId = "string",
      LastDryRunExecutionStatus = "string"
    )
  )
)

Request syntax

svc$create_canary(
  Name = "string",
  Code = list(
    S3Bucket = "string",
    S3Key = "string",
    S3Version = "string",
    ZipFile = raw,
    Handler = "string",
    BlueprintTypes = list(
      "string"
    ),
    Dependencies = list(
      list(
        Type = "LambdaLayer",
        Reference = "string"
      )
    )
  ),
  ArtifactS3Location = "string",
  ExecutionRoleArn = "string",
  Schedule = list(
    Expression = "string",
    DurationInSeconds = 123,
    RetryConfig = list(
      MaxRetries = 123
    )
  ),
  RunConfig = list(
    TimeoutInSeconds = 123,
    MemoryInMB = 123,
    ActiveTracing = TRUE|FALSE,
    EnvironmentVariables = list(
      "string"
    ),
    EphemeralStorage = 123
  ),
  SuccessRetentionPeriodInDays = 123,
  FailureRetentionPeriodInDays = 123,
  RuntimeVersion = "string",
  VpcConfig = list(
    SubnetIds = list(
      "string"
    ),
    SecurityGroupIds = list(
      "string"
    ),
    Ipv6AllowedForDualStack = TRUE|FALSE
  ),
  ResourcesToReplicateTags = list(
    "lambda-function"
  ),
  ProvisionedResourceCleanup = "AUTOMATIC"|"OFF",
  BrowserConfigs = list(
    list(
      BrowserType = "CHROME"|"FIREFOX"
    )
  ),
  AddReplicaLocations = list(
    list(
      Location = "string",
      VpcConfig = list(
        SubnetIds = list(
          "string"
        ),
        SecurityGroupIds = list(
          "string"
        ),
        Ipv6AllowedForDualStack = TRUE|FALSE
      ),
      KmsKeyArn = "string"
    )
  ),
  Tags = list(
    "string"
  ),
  ArtifactConfig = list(
    S3Encryption = list(
      EncryptionMode = "SSE_S3"|"SSE_KMS",
      KmsKeyArn = "string"
    )
  ),
  KmsKeyArn = "string"
)