Get a detailed overview of this resourceList the top 5 use cases for this resourceBuild a program using aws.synthetics.CanaryRepository[AWS Classic pulumi/pulumi-aws](https://github.com/pulumi/pulumi-aws)LicenseApache-2.0NotesThis Pulumi package is based on the [`aws` Terraform Provider](https://github.com/hashicorp/terraform-provider-aws).

1. [Packages](/content/registry/index.html)
2. [Packages](/content/registry/packages/index.html)
3. [AWS](/content/registry/packages/aws/index.html)
4. [API Docs](/content/registry/packages/aws/api-docs/index.html)
5. [synthetics](/content/registry/packages/aws/api-docs/synthetics/index.html)
6. [Canary](/content/registry/packages/aws/api-docs/synthetics/canary/index.html)

AWS v7.32.0, May 29 26

AWS v7.32.0, May 29 26

Viewing docs for AWS v7.32.0

published on Friday, May 29, 2026 by Pulumi

[Schema (JSON)](/content/registry/packages/aws/schema.json)

[pulumi/pulumi-aws](https://github.com/pulumi/pulumi-aws)

v7.32.0 (7.x, latest)v6.83.1 (6.x)v5.43.0 (5.x)

# aws.synthetics.Canary [Anchor](/content/registry/packages/aws/api-docs/synthetics/canary/\#aws-synthetics-canary/index.html)

Explore with Neo

[Explain this resource](https://app.pulumi.com/neo?prompt=Explain+the+resource+aws.synthetics.Canary.+Provide+a+detailed+overview+of+its+purpose%2C+architecture%2C+and+typical+responsibilities.&prefer_signup=true) [Show real-world scenarios](https://app.pulumi.com/neo?prompt=List+the+top+five+real-world+scenarios+where+aws.synthetics.Canary+delivers+the+most+value.+Describe+why+it+is+useful+for+each.&prefer_signup=true) [Provision a new instance](https://app.pulumi.com/neo?prompt=Generate+a+Pulumi+program+that+provisions+aws.synthetics.Canary.+Include+any+required+configuration+and+showcase+best+practices.&prefer_signup=true)

Viewing docs for AWS v7.32.0

published on Friday, May 29, 2026 by Pulumi

[Schema (JSON)](/content/registry/packages/aws/schema.json)

[pulumi/pulumi-aws](https://github.com/pulumi/pulumi-aws)

v7.32.0 (7.x, latest)v6.83.1 (6.x)v5.43.0 (5.x)

## On this page

## On this page

- [Example Usage](/content/registry/packages/aws/api-docs/synthetics/canary/#example-usage/index.html)
- [Create Canary Resource](/content/registry/packages/aws/api-docs/synthetics/canary/#create/index.html)
- [Constructor syntax](/content/registry/packages/aws/api-docs/synthetics/canary/#constructor-syntax/index.html)
- [Constructor example](/content/registry/packages/aws/api-docs/synthetics/canary/#constructor-example/index.html)
- [Canary Resource Properties](/content/registry/packages/aws/api-docs/synthetics/canary/#properties/index.html)
- [Inputs](/content/registry/packages/aws/api-docs/synthetics/canary/#inputs/index.html)
- [Outputs](/content/registry/packages/aws/api-docs/synthetics/canary/#outputs/index.html)
- [Look up Existing Canary Resource](/content/registry/packages/aws/api-docs/synthetics/canary/#look-up/index.html)
- [Supporting Types](/content/registry/packages/aws/api-docs/synthetics/canary/#supporting-types/index.html)
- [Import](/content/registry/packages/aws/api-docs/synthetics/canary/#import/index.html)
- [Package Details](/content/registry/packages/aws/api-docs/synthetics/canary/#package-details/index.html)

* * *

Related Resources

[iam.Role](/content/registry/packages/aws/api-docs/iam/role/index.html)

[s3.Bucket](/content/registry/packages/aws/api-docs/s3/bucket/index.html)

[s3.BucketObjectv2](/content/registry/packages/aws/api-docs/s3/bucketobjectv2/index.html)

[s3.BucketV2](/content/registry/packages/aws/api-docs/s3/bucketv2/index.html)

- Copy Page

- [Request a Change](https://github.com/pulumi/registry/issues/new?body=File:%20[themes%2fdefault%2fcontent/%2fregistry%2fpackages%2faws%2fapi-docs%2fsynthetics%2fcanary](https%3a%2f%2fwww.pulumi.com%2fregistry%2fpackages%2faws%2fapi-docs%2fsynthetics%2fcanary%2f))

[Scroll to top](/content/registry/packages/aws/api-docs/synthetics/canary/# "Scroll to top"/index.html)

Provides a Synthetics Canary resource.

> **NOTE:** When you create a canary, AWS creates supporting implicit resources. See the Amazon CloudWatch Synthetics documentation on [DeleteCanary](https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DeleteCanary.html) for a full list. Neither AWS nor this provider deletes these implicit resources automatically when the canary is deleted. Before deleting a canary, ensure you have all the information about the canary that you need to delete the implicit resources using the AWS Console, or AWS CLI.

## Example Usage [Anchor](/content/registry/packages/aws/api-docs/synthetics/canary/\#example-usage/index.html)

- TypeScript
- Python
- Go
- C#
- Java
- YAML
- HCL PREVIEW

```typescript
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const some = new aws.synthetics.Canary("some", {
    name: "some-canary",
    artifactS3Location: "s3://some-bucket/",
    executionRoleArn: "some-role",
    handler: "exports.handler",
    zipFile: "test-fixtures/lambdatest.zip",
    runtimeVersion: "syn-1.0",
    schedule: {
        expression: "rate(0 minute)",
    },
});
```

Copy

```python
import pulumi
import pulumi_aws as aws

some = aws.synthetics.Canary("some",
    name="some-canary",
    artifact_s3_location="s3://some-bucket/",
    execution_role_arn="some-role",
    handler="exports.handler",
    zip_file="test-fixtures/lambdatest.zip",
    runtime_version="syn-1.0",
    schedule={
        "expression": "rate(0 minute)",
    })
```

Copy

```go
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/synthetics"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := synthetics.NewCanary(ctx, "some", &synthetics.CanaryArgs{
			Name:               pulumi.String("some-canary"),
			ArtifactS3Location: pulumi.String("s3://some-bucket/"),
			ExecutionRoleArn:   pulumi.String("some-role"),
			Handler:            pulumi.String("exports.handler"),
			ZipFile:            pulumi.String("test-fixtures/lambdatest.zip"),
			RuntimeVersion:     pulumi.String("syn-1.0"),
			Schedule: &synthetics.CanaryScheduleArgs{
				Expression: pulumi.String("rate(0 minute)"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
```

Copy

```csharp
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var some = new Aws.Synthetics.Canary("some", new()
    {
        Name = "some-canary",
        ArtifactS3Location = "s3://some-bucket/",
        ExecutionRoleArn = "some-role",
        Handler = "exports.handler",
        ZipFile = "test-fixtures/lambdatest.zip",
        RuntimeVersion = "syn-1.0",
        Schedule = new Aws.Synthetics.Inputs.CanaryScheduleArgs
        {
            Expression = "rate(0 minute)",
        },
    });

});
```

Copy

```java
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.synthetics.Canary;
import com.pulumi.aws.synthetics.CanaryArgs;
import com.pulumi.aws.synthetics.inputs.CanaryScheduleArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

public static void stack(Context ctx) {
        var some = new Canary("some", CanaryArgs.builder()
            .name("some-canary")
            .artifactS3Location("s3://some-bucket/")
            .executionRoleArn("some-role")
            .handler("exports.handler")
            .zipFile("test-fixtures/lambdatest.zip")
            .runtimeVersion("syn-1.0")
            .schedule(CanaryScheduleArgs.builder()
                .expression("rate(0 minute)")
                .build())
            .build());

}
}
```

Copy

```yaml
resources:
  some:
    type: aws:synthetics:Canary
    properties:
      name: some-canary
      artifactS3Location: s3://some-bucket/
      executionRoleArn: some-role
      handler: exports.handler
      zipFile: test-fixtures/lambdatest.zip
      runtimeVersion: syn-1.0
      schedule:
        expression: rate(0 minute)
```

Copy

```hcl
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_synthetics_canary" "some" {
  name                 = "some-canary"
  artifact_s3_location = "s3://some-bucket/"
  execution_role_arn   = "some-role"
  handler              = "exports.handler"
  zip_file             = "test-fixtures/lambdatest.zip"
  runtime_version      = "syn-1.0"
  schedule = {
    expression = "rate(0 minute)"
  }
}
```

Copy

## Create Canary Resource [Anchor](/content/registry/packages/aws/api-docs/synthetics/canary/\#create/index.html)

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see [Resources](/content/docs/concepts/resources/index.html).

### Constructor syntax [Anchor](/content/registry/packages/aws/api-docs/synthetics/canary/\#constructor-syntax/index.html)

- TypeScript
- Python
- Go
- C#
- Java
- YAML
- HCL PREVIEW

```typescript
new Canary(name: string, args: CanaryArgs, opts?: CustomResourceOptions);
```

```python
@overload
def Canary(resource_name: str,
           args: CanaryArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Canary(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           handler: Optional[str] = None,
           artifact_s3_location: Optional[str] = None,
           schedule: Optional[CanaryScheduleArgs] = None,
           execution_role_arn: Optional[str] = None,
           runtime_version: Optional[str] = None,
           run_config: Optional[CanaryRunConfigArgs] = None,
           s3_version: Optional[str] = None,
           region: Optional[str] = None,
           artifact_config: Optional[CanaryArtifactConfigArgs] = None,
           failure_retention_period: Optional[int] = None,
           s3_bucket: Optional[str] = None,
           s3_key: Optional[str] = None,
           name: Optional[str] = None,
           delete_lambda: Optional[bool] = None,
           start_canary: Optional[bool] = None,
           success_retention_period: Optional[int] = None,
           tags: Optional[Mapping[str, str]] = None,
           vpc_config: Optional[CanaryVpcConfigArgs] = None,
           zip_file: Optional[str] = None)
```

```go
func NewCanary(ctx *Context, name string, args CanaryArgs, opts ...ResourceOption) (*Canary, error)
```

```csharp
public Canary(string name, CanaryArgs args, CustomResourceOptions? opts = null)
```

```java
public Canary(String name, CanaryArgs args)
public Canary(String name, CanaryArgs args, CustomResourceOptions options)
```

```yaml
type: aws:synthetics:Canary
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
```

```hcl
resource "aws_synthetics_canary" "name" {
    # resource properties
}
```

#### Parameters [Anchor](/content/registry/packages/aws/api-docs/synthetics/canary/\#parameters/index.html)

nameThis property is required.stringThe unique name of the resource.argsThis property is required.[CanaryArgs](/content/registry/packages/aws/api-docs/synthetics/canary/#inputs/index.html)The arguments to resource properties.opts[CustomResourceOptions](/content/docs/reference/pkg/nodejs/pulumi/pulumi/#CustomResourceOptions/index.html)Bag of options to control resource's behavior.

resource\_nameThis property is required.strThe unique name of the resource.argsThis property is required.[CanaryArgs](/content/registry/packages/aws/api-docs/synthetics/canary/#inputs/index.html)The arguments to resource properties.opts[ResourceOptions](/content/docs/reference/pkg/python/pulumi/#pulumi.ResourceOptions)Bag of options to control resource's behavior.

ctx[Context](https://pkg.go.dev/github.com/pulumi/pulumi/sdk/v3/go/pulumi?tab=doc#Context)Context object for the current deployment.nameThis property is required.stringThe unique name of the resource.argsThis property is required.[CanaryArgs](/content/registry/packages/aws/api-docs/synthetics/canary/#inputs/index.html)The arguments to resource properties.opts[ResourceOption](https://pkg.go.dev/github.com/pulumi/pulumi/sdk/v3/go/pulumi?tab=doc#ResourceOption)Bag of options to control resource's behavior.

nameThis property is required.stringThe unique name of the resource.argsThis property is required.[CanaryArgs](/content/registry/packages/aws/api-docs/synthetics/canary/#inputs/index.html)The arguments to resource properties.opts[CustomResourceOptions](/content/docs/reference/pkg/dotnet/Pulumi/Pulumi.CustomResourceOptions.html)Bag of options to control resource's behavior.

nameThis property is required.StringThe unique name of the resource.argsThis property is required.[CanaryArgs](/content/registry/packages/aws/api-docs/synthetics/canary/#inputs/index.html)The arguments to resource properties.optionsCustomResourceOptionsBag of options to control resource's behavior.

### Constructor example [Anchor](/content/registry/packages/aws/api-docs/synthetics/canary/\#constructor-example/index.html)

The following reference example uses placeholder values for all [input properties](/content/registry/packages/aws/api-docs/synthetics/canary/#inputs/index.html).

- TypeScript
- Python
- Go
- C#
- Java
- YAML
- HCL PREVIEW

```csharp
var canaryResource = new Aws.Synthetics.Canary("canaryResource", new()
{
    Handler = "string",
    ArtifactS3Location = "string",
    Schedule = new Aws.Synthetics.Inputs.CanaryScheduleArgs
    {
        Expression = "string",
        DurationInSeconds = 0,
        RetryConfig = new Aws.Synthetics.Inputs.CanaryScheduleRetryConfigArgs
        {
            MaxRetries = 0,
        },
    },
    ExecutionRoleArn = "string",
    RuntimeVersion = "string",
    RunConfig = new Aws.Synthetics.Inputs.CanaryRunConfigArgs
    {
        ActiveTracing = false,
        EnvironmentVariables =
        {
            { "string", "string" },
        },
        EphemeralStorage = 0,
        MemoryInMb = 0,
        TimeoutInSeconds = 0,
    },
    S3Version = "string",
    Region = "string",
    ArtifactConfig = new Aws.Synthetics.Inputs.CanaryArtifactConfigArgs
    {
        S3Encryption = new Aws.Synthetics.Inputs.CanaryArtifactConfigS3EncryptionArgs
        {
            EncryptionMode = "string",
            KmsKeyArn = "string",
        },
    },
    FailureRetentionPeriod = 0,
    S3Bucket = "string",
    S3Key = "string",
    Name = "string",
    DeleteLambda = false,
    StartCanary = false,
    SuccessRetentionPeriod = 0,
    Tags =
    {
        { "string", "string" },
    },
    VpcConfig = new Aws.Synthetics.Inputs.CanaryVpcConfigArgs
    {
        Ipv6AllowedForDualStack = false,
        SecurityGroupIds = new[]
        {
            "string",
        },
        SubnetIds = new[]
        {
            "string",
        },
        VpcId = "string",
    },
    ZipFile = "string",
});
```

Copy

```go
example, err := synthetics.NewCanary(ctx, "canaryResource", &synthetics.CanaryArgs{
	Handler:            pulumi.String("string"),
	ArtifactS3Location: pulumi.String("string"),
	Schedule: &synthetics.CanaryScheduleArgs{
		Expression:        pulumi.String("string"),
		DurationInSeconds: pulumi.Int(0),
		RetryConfig: &synthetics.CanaryScheduleRetryConfigArgs{
			MaxRetries: pulumi.Int(0),
		},
	},
	ExecutionRoleArn: pulumi.String("string"),
	RuntimeVersion:   pulumi.String("string"),
	RunConfig: &synthetics.CanaryRunConfigArgs{
		ActiveTracing: pulumi.Bool(false),
		EnvironmentVariables: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		EphemeralStorage: pulumi.Int(0),
		MemoryInMb:       pulumi.Int(0),
		TimeoutInSeconds: pulumi.Int(0),
	},
	S3Version: pulumi.String("string"),
	Region:    pulumi.String("string"),
	ArtifactConfig: &synthetics.CanaryArtifactConfigArgs{
		S3Encryption: &synthetics.CanaryArtifactConfigS3EncryptionArgs{
			EncryptionMode: pulumi.String("string"),
			KmsKeyArn:      pulumi.String("string"),
		},
	},
	FailureRetentionPeriod: pulumi.Int(0),
	S3Bucket:               pulumi.String("string"),
	S3Key:                  pulumi.String("string"),
	Name:                   pulumi.String("string"),
	DeleteLambda:           pulumi.Bool(false),
	StartCanary:            pulumi.Bool(false),
	SuccessRetentionPeriod: pulumi.Int(0),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	VpcConfig: &synthetics.CanaryVpcConfigArgs{
		Ipv6AllowedForDualStack: pulumi.Bool(false),
		SecurityGroupIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		SubnetIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		VpcId: pulumi.String("string"),
	},
	ZipFile: pulumi.String("string"),
})
```

Copy

```hcl
resource "aws_synthetics_canary" "canaryResource" {
  handler              = "string"
  artifact_s3_location = "string"
  schedule = {
    expression          = "string"
    duration_in_seconds = 0
    retry_config = {
      max_retries = 0
    }
  }
  execution_role_arn = "string"
  runtime_version    = "string"
  run_config = {
    active_tracing = false
    environment_variables = {
      "string" = "string"
    }
    ephemeral_storage  = 0
    memory_in_mb       = 0
    timeout_in_seconds = 0
  }
  s3_version = "string"
  region     = "string"
  artifact_config = {
    s3_encryption = {
      encryption_mode = "string"
      kms_key_arn     = "string"
    }
  }
  failure_retention_period = 0
  s3_bucket                = "string"
  s3_key                   = "string"
  name                     = "string"
  delete_lambda            = false
  start_canary             = false
  success_retention_period = 0
  tags = {
    "string" = "string"
  }
  vpc_config = {
    ipv6_allowed_for_dual_stack = false
    security_group_ids          = ["string"]
    subnet_ids                  = ["string"]
    vpc_id                      = "string"
  }
  zip_file = "string"
}
```

Copy

```java
var canaryResource = new Canary("canaryResource", CanaryArgs.builder()
    .handler("string")
    .artifactS3Location("string")
    .schedule(CanaryScheduleArgs.builder()
        .expression("string")
        .durationInSeconds(0)
        .retryConfig(CanaryScheduleRetryConfigArgs.builder()
            .maxRetries(0)
            .build())
        .build())
    .executionRoleArn("string")
    .runtimeVersion("string")
    .runConfig(CanaryRunConfigArgs.builder()
        .activeTracing(false)
        .environmentVariables(Map.of("string", "string"))
        .ephemeralStorage(0)
        .memoryInMb(0)
        .timeoutInSeconds(0)
        .build())
    .s3Version("string")
    .region("string")
    .artifactConfig(CanaryArtifactConfigArgs.builder()
        .s3Encryption(CanaryArtifactConfigS3EncryptionArgs.builder()
            .encryptionMode("string")
            .kmsKeyArn("string")
            .build())
        .build())
    .failureRetentionPeriod(0)
    .s3Bucket("string")
    .s3Key("string")
    .name("string")
    .deleteLambda(false)
    .startCanary(false)
    .successRetentionPeriod(0)
    .tags(Map.of("string", "string"))
    .vpcConfig(CanaryVpcConfigArgs.builder()
        .ipv6AllowedForDualStack(false)
        .securityGroupIds("string")
        .subnetIds("string")
        .vpcId("string")
        .build())
    .zipFile("string")
    .build());
```

Copy

```python
canary_resource = aws.synthetics.Canary("canaryResource",
    handler="string",
    artifact_s3_location="string",
    schedule={
        "expression": "string",
        "duration_in_seconds": 0,
        "retry_config": {
            "max_retries": 0,
        },
    },
    execution_role_arn="string",
    runtime_version="string",
    run_config={
        "active_tracing": False,
        "environment_variables": {
            "string": "string",
        },
        "ephemeral_storage": 0,
        "memory_in_mb": 0,
        "timeout_in_seconds": 0,
    },
    s3_version="string",
    region="string",
    artifact_config={
        "s3_encryption": {
            "encryption_mode": "string",
            "kms_key_arn": "string",
        },
    },
    failure_retention_period=0,
    s3_bucket="string",
    s3_key="string",
    name="string",
    delete_lambda=False,
    start_canary=False,
    success_retention_period=0,
    tags={
        "string": "string",
    },
    vpc_config={
        "ipv6_allowed_for_dual_stack": False,
        "security_group_ids": ["string"],
        "subnet_ids": ["string"],
        "vpc_id": "string",
    },
    zip_file="string")
```

Copy

```typescript
const canaryResource = new aws.synthetics.Canary("canaryResource", {
    handler: "string",
    artifactS3Location: "string",
    schedule: {
        expression: "string",
        durationInSeconds: 0,
        retryConfig: {
            maxRetries: 0,
        },
    },
    executionRoleArn: "string",
    runtimeVersion: "string",
    runConfig: {
        activeTracing: false,
        environmentVariables: {
            string: "string",
        },
        ephemeralStorage: 0,
        memoryInMb: 0,
        timeoutInSeconds: 0,
    },
    s3Version: "string",
    region: "string",
    artifactConfig: {
        s3Encryption: {
            encryptionMode: "string",
            kmsKeyArn: "string",
        },
    },
    failureRetentionPeriod: 0,
    s3Bucket: "string",
    s3Key: "string",
    name: "string",
    deleteLambda: false,
    startCanary: false,
    successRetentionPeriod: 0,
    tags: {
        string: "string",
    },
    vpcConfig: {
        ipv6AllowedForDualStack: false,
        securityGroupIds: ["string"],
        subnetIds: ["string"],
        vpcId: "string",
    },
    zipFile: "string",
});
```

Copy

```yaml
type: aws:synthetics:Canary
properties:
    artifactConfig:
        s3Encryption:
            encryptionMode: string
            kmsKeyArn: string
    artifactS3Location: string
    deleteLambda: false
    executionRoleArn: string
    failureRetentionPeriod: 0
    handler: string
    name: string
    region: string
    runConfig:
        activeTracing: false
        environmentVariables:
            string: string
        ephemeralStorage: 0
        memoryInMb: 0
        timeoutInSeconds: 0
    runtimeVersion: string
    s3Bucket: string
    s3Key: string
    s3Version: string
    schedule:
        durationInSeconds: 0
        expression: string
        retryConfig:
            maxRetries: 0
    startCanary: false
    successRetentionPeriod: 0
    tags:
        string: string
    vpcConfig:
        ipv6AllowedForDualStack: false
        securityGroupIds:
            - string
        subnetIds:
            - string
        vpcId: string
    zipFile: string
```

Copy

## Canary Resource Properties [Anchor](/content/registry/packages/aws/api-docs/synthetics/canary/\#properties/index.html)

To learn more about resource properties and how to use them, see [Inputs and Outputs](/content/docs/intro/concepts/inputs-outputs/index.html) in the Architecture and Concepts docs.

### Inputs [Anchor](/content/registry/packages/aws/api-docs/synthetics/canary/\#inputs/index.html)

In Python, inputs that are objects can be passed either as [argument classes or as dictionary literals](/content/docs/languages-sdks/python/#inputs-and-outputs/index.html).

The Canary resource accepts the following [input](/content/docs/intro/concepts/inputs-outputs/index.html) properties:

[ArtifactS3Location](/content/registry/packages/aws/api-docs/synthetics/canary/#artifacts3location_csharp/index.html)This property is required.stringLocation in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.[ExecutionRoleArn](/content/registry/packages/aws/api-docs/synthetics/canary/#executionrolearn_csharp/index.html)This property is required.stringARN of the IAM role to be used to run the canary. see [AWS Docs](https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CreateCanary.html#API_CreateCanary_RequestSyntax) for permissions needs for IAM Role.[Handler](/content/registry/packages/aws/api-docs/synthetics/canary/#handler_csharp/index.html)This property is required.stringEntry point to use for the source code when running the canary. This value must end with the string `.handler` .[RuntimeVersion](/content/registry/packages/aws/api-docs/synthetics/canary/#runtimeversion_csharp/index.html)This property is required.stringRuntime version to use for the canary. Versions change often so consult the [Amazon CloudWatch documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html) for the latest valid versions. Values include `syn-python-selenium-1.0`, `syn-nodejs-puppeteer-3.0`, `syn-nodejs-2.2`, `syn-nodejs-2.1`, `syn-nodejs-2.0`, and `syn-1.0`.[Schedule](/content/registry/packages/aws/api-docs/synthetics/canary/#schedule_csharp/index.html)This property is required.[CanarySchedule](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryschedule/index.html)

Configuration block providing how often the canary is to run and when these test runs are to stop. Detailed below.

The following arguments are optional:

[ArtifactConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#artifactconfig_csharp/index.html)[CanaryArtifactConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryartifactconfig/index.html)configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See Artifact Config.[DeleteLambda](/content/registry/packages/aws/api-docs/synthetics/canary/#deletelambda_csharp/index.html)boolSpecifies whether to also delete the Lambda functions and layers used by this canary. The default is `false`.[FailureRetentionPeriod](/content/registry/packages/aws/api-docs/synthetics/canary/#failureretentionperiod_csharp/index.html)intNumber 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.[Name](/content/registry/packages/aws/api-docs/synthetics/canary/#name_csharp/index.html)Changes to this property will trigger replacement.stringName for this canary. Has a maximum length of 255 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore.[Region](/content/registry/packages/aws/api-docs/synthetics/canary/#region_csharp/index.html)stringRegion where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.[RunConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#runconfig_csharp/index.html)[CanaryRunConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryrunconfig/index.html)Configuration block for individual canary runs. Detailed below.[S3Bucket](/content/registry/packages/aws/api-docs/synthetics/canary/#s3bucket_csharp/index.html)stringFull bucket name which is used if your canary script is located in S3. The bucket must already exist. **Conflicts with `zipFile`.**[S3Key](/content/registry/packages/aws/api-docs/synthetics/canary/#s3key_csharp/index.html)stringS3 key of your script. **Conflicts with `zipFile`.**[S3Version](/content/registry/packages/aws/api-docs/synthetics/canary/#s3version_csharp/index.html)stringS3 version ID of your script. **Conflicts with `zipFile`.**[StartCanary](/content/registry/packages/aws/api-docs/synthetics/canary/#startcanary_csharp/index.html)boolWhether to run or stop the canary.[SuccessRetentionPeriod](/content/registry/packages/aws/api-docs/synthetics/canary/#successretentionperiod_csharp/index.html)intNumber 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.[Tags](/content/registry/packages/aws/api-docs/synthetics/canary/#tags_csharp/index.html)Dictionary<string, string>Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.[VpcConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#vpcconfig_csharp/index.html)[CanaryVpcConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryvpcconfig/index.html)Configuration block. Detailed below.[ZipFile](/content/registry/packages/aws/api-docs/synthetics/canary/#zipfile_csharp/index.html)stringZIP file that contains the script, if you input your canary script directly into the canary instead of referring to an S3 location. It can be up to 225KB. **Conflicts with `s3Bucket`, `s3Key`, and `s3Version`.**

[ArtifactS3Location](/content/registry/packages/aws/api-docs/synthetics/canary/#artifacts3location_go/index.html)This property is required.stringLocation in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.[ExecutionRoleArn](/content/registry/packages/aws/api-docs/synthetics/canary/#executionrolearn_go/index.html)This property is required.stringARN of the IAM role to be used to run the canary. see [AWS Docs](https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CreateCanary.html#API_CreateCanary_RequestSyntax) for permissions needs for IAM Role.[Handler](/content/registry/packages/aws/api-docs/synthetics/canary/#handler_go/index.html)This property is required.stringEntry point to use for the source code when running the canary. This value must end with the string `.handler` .[RuntimeVersion](/content/registry/packages/aws/api-docs/synthetics/canary/#runtimeversion_go/index.html)This property is required.stringRuntime version to use for the canary. Versions change often so consult the [Amazon CloudWatch documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html) for the latest valid versions. Values include `syn-python-selenium-1.0`, `syn-nodejs-puppeteer-3.0`, `syn-nodejs-2.2`, `syn-nodejs-2.1`, `syn-nodejs-2.0`, and `syn-1.0`.[Schedule](/content/registry/packages/aws/api-docs/synthetics/canary/#schedule_go/index.html)This property is required.[CanaryScheduleArgs](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryschedule/index.html)

Configuration block providing how often the canary is to run and when these test runs are to stop. Detailed below.

The following arguments are optional:

[ArtifactConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#artifactconfig_go/index.html)[CanaryArtifactConfigArgs](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryartifactconfig/index.html)configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See Artifact Config.[DeleteLambda](/content/registry/packages/aws/api-docs/synthetics/canary/#deletelambda_go/index.html)boolSpecifies whether to also delete the Lambda functions and layers used by this canary. The default is `false`.[FailureRetentionPeriod](/content/registry/packages/aws/api-docs/synthetics/canary/#failureretentionperiod_go/index.html)intNumber 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.[Name](/content/registry/packages/aws/api-docs/synthetics/canary/#name_go/index.html)Changes to this property will trigger replacement.stringName for this canary. Has a maximum length of 255 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore.[Region](/content/registry/packages/aws/api-docs/synthetics/canary/#region_go/index.html)stringRegion where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.[RunConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#runconfig_go/index.html)[CanaryRunConfigArgs](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryrunconfig/index.html)Configuration block for individual canary runs. Detailed below.[S3Bucket](/content/registry/packages/aws/api-docs/synthetics/canary/#s3bucket_go/index.html)stringFull bucket name which is used if your canary script is located in S3. The bucket must already exist. **Conflicts with `zipFile`.**[S3Key](/content/registry/packages/aws/api-docs/synthetics/canary/#s3key_go/index.html)stringS3 key of your script. **Conflicts with `zipFile`.**[S3Version](/content/registry/packages/aws/api-docs/synthetics/canary/#s3version_go/index.html)stringS3 version ID of your script. **Conflicts with `zipFile`.**[StartCanary](/content/registry/packages/aws/api-docs/synthetics/canary/#startcanary_go/index.html)boolWhether to run or stop the canary.[SuccessRetentionPeriod](/content/registry/packages/aws/api-docs/synthetics/canary/#successretentionperiod_go/index.html)intNumber 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.[Tags](/content/registry/packages/aws/api-docs/synthetics/canary/#tags_go/index.html)map\[string\]stringKey-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.[VpcConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#vpcconfig_go/index.html)[CanaryVpcConfigArgs](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryvpcconfig/index.html)Configuration block. Detailed below.[ZipFile](/content/registry/packages/aws/api-docs/synthetics/canary/#zipfile_go/index.html)stringZIP file that contains the script, if you input your canary script directly into the canary instead of referring to an S3 location. It can be up to 225KB. **Conflicts with `s3Bucket`, `s3Key`, and `s3Version`.**

[artifact\_s3\_location](/content/registry/packages/aws/api-docs/synthetics/canary/#artifact_s3_location_hcl/index.html)This property is required.stringLocation in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.[execution\_role\_arn](/content/registry/packages/aws/api-docs/synthetics/canary/#execution_role_arn_hcl/index.html)This property is required.stringARN of the IAM role to be used to run the canary. see [AWS Docs](https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CreateCanary.html#API_CreateCanary_RequestSyntax) for permissions needs for IAM Role.[handler](/content/registry/packages/aws/api-docs/synthetics/canary/#handler_hcl/index.html)This property is required.stringEntry point to use for the source code when running the canary. This value must end with the string `.handler` .[runtime\_version](/content/registry/packages/aws/api-docs/synthetics/canary/#runtime_version_hcl/index.html)This property is required.stringRuntime version to use for the canary. Versions change often so consult the [Amazon CloudWatch documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html) for the latest valid versions. Values include `syn-python-selenium-1.0`, `syn-nodejs-puppeteer-3.0`, `syn-nodejs-2.2`, `syn-nodejs-2.1`, `syn-nodejs-2.0`, and `syn-1.0`.[schedule](/content/registry/packages/aws/api-docs/synthetics/canary/#schedule_hcl/index.html)This property is required.[object](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryschedule/index.html)

Configuration block providing how often the canary is to run and when these test runs are to stop. Detailed below.

The following arguments are optional:

[artifact\_config](/content/registry/packages/aws/api-docs/synthetics/canary/#artifact_config_hcl/index.html)[object](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryartifactconfig/index.html)configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See Artifact Config.[delete\_lambda](/content/registry/packages/aws/api-docs/synthetics/canary/#delete_lambda_hcl/index.html)boolSpecifies whether to also delete the Lambda functions and layers used by this canary. The default is `false`.[failure\_retention\_period](/content/registry/packages/aws/api-docs/synthetics/canary/#failure_retention_period_hcl/index.html)numberNumber 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.[name](/content/registry/packages/aws/api-docs/synthetics/canary/#name_hcl/index.html)Changes to this property will trigger replacement.stringName for this canary. Has a maximum length of 255 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore.[region](/content/registry/packages/aws/api-docs/synthetics/canary/#region_hcl/index.html)stringRegion where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.[run\_config](/content/registry/packages/aws/api-docs/synthetics/canary/#run_config_hcl/index.html)[object](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryrunconfig/index.html)Configuration block for individual canary runs. Detailed below.[s3\_bucket](/content/registry/packages/aws/api-docs/synthetics/canary/#s3_bucket_hcl/index.html)stringFull bucket name which is used if your canary script is located in S3. The bucket must already exist. **Conflicts with `zipFile`.**[s3\_key](/content/registry/packages/aws/api-docs/synthetics/canary/#s3_key_hcl/index.html)stringS3 key of your script. **Conflicts with `zipFile`.**[s3\_version](/content/registry/packages/aws/api-docs/synthetics/canary/#s3_version_hcl/index.html)stringS3 version ID of your script. **Conflicts with `zipFile`.**[start\_canary](/content/registry/packages/aws/api-docs/synthetics/canary/#start_canary_hcl/index.html)boolWhether to run or stop the canary.[success\_retention\_period](/content/registry/packages/aws/api-docs/synthetics/canary/#success_retention_period_hcl/index.html)numberNumber 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.[tags](/content/registry/packages/aws/api-docs/synthetics/canary/#tags_hcl/index.html)map(string)Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.[vpc\_config](/content/registry/packages/aws/api-docs/synthetics/canary/#vpc_config_hcl/index.html)[object](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryvpcconfig/index.html)Configuration block. Detailed below.[zip\_file](/content/registry/packages/aws/api-docs/synthetics/canary/#zip_file_hcl/index.html)stringZIP file that contains the script, if you input your canary script directly into the canary instead of referring to an S3 location. It can be up to 225KB. **Conflicts with `s3Bucket`, `s3Key`, and `s3Version`.**

[artifactS3Location](/content/registry/packages/aws/api-docs/synthetics/canary/#artifacts3location_java/index.html)This property is required.StringLocation in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.[executionRoleArn](/content/registry/packages/aws/api-docs/synthetics/canary/#executionrolearn_java/index.html)This property is required.StringARN of the IAM role to be used to run the canary. see [AWS Docs](https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CreateCanary.html#API_CreateCanary_RequestSyntax) for permissions needs for IAM Role.[handler](/content/registry/packages/aws/api-docs/synthetics/canary/#handler_java/index.html)This property is required.StringEntry point to use for the source code when running the canary. This value must end with the string `.handler` .[runtimeVersion](/content/registry/packages/aws/api-docs/synthetics/canary/#runtimeversion_java/index.html)This property is required.StringRuntime version to use for the canary. Versions change often so consult the [Amazon CloudWatch documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html) for the latest valid versions. Values include `syn-python-selenium-1.0`, `syn-nodejs-puppeteer-3.0`, `syn-nodejs-2.2`, `syn-nodejs-2.1`, `syn-nodejs-2.0`, and `syn-1.0`.[schedule](/content/registry/packages/aws/api-docs/synthetics/canary/#schedule_java/index.html)This property is required.[CanarySchedule](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryschedule/index.html)

Configuration block providing how often the canary is to run and when these test runs are to stop. Detailed below.

The following arguments are optional:

[artifactConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#artifactconfig_java/index.html)[CanaryArtifactConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryartifactconfig/index.html)configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See Artifact Config.[deleteLambda](/content/registry/packages/aws/api-docs/synthetics/canary/#deletelambda_java/index.html)BooleanSpecifies whether to also delete the Lambda functions and layers used by this canary. The default is `false`.[failureRetentionPeriod](/content/registry/packages/aws/api-docs/synthetics/canary/#failureretentionperiod_java/index.html)IntegerNumber 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.[name](/content/registry/packages/aws/api-docs/synthetics/canary/#name_java/index.html)Changes to this property will trigger replacement.StringName for this canary. Has a maximum length of 255 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore.[region](/content/registry/packages/aws/api-docs/synthetics/canary/#region_java/index.html)StringRegion where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.[runConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#runconfig_java/index.html)[CanaryRunConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryrunconfig/index.html)Configuration block for individual canary runs. Detailed below.[s3Bucket](/content/registry/packages/aws/api-docs/synthetics/canary/#s3bucket_java/index.html)StringFull bucket name which is used if your canary script is located in S3. The bucket must already exist. **Conflicts with `zipFile`.**[s3Key](/content/registry/packages/aws/api-docs/synthetics/canary/#s3key_java/index.html)StringS3 key of your script. **Conflicts with `zipFile`.**[s3Version](/content/registry/packages/aws/api-docs/synthetics/canary/#s3version_java/index.html)StringS3 version ID of your script. **Conflicts with `zipFile`.**[startCanary](/content/registry/packages/aws/api-docs/synthetics/canary/#startcanary_java/index.html)BooleanWhether to run or stop the canary.[successRetentionPeriod](/content/registry/packages/aws/api-docs/synthetics/canary/#successretentionperiod_java/index.html)IntegerNumber 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.[tags](/content/registry/packages/aws/api-docs/synthetics/canary/#tags_java/index.html)Map<String,String>Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.[vpcConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#vpcconfig_java/index.html)[CanaryVpcConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryvpcconfig/index.html)Configuration block. Detailed below.[zipFile](/content/registry/packages/aws/api-docs/synthetics/canary/#zipfile_java/index.html)StringZIP file that contains the script, if you input your canary script directly into the canary instead of referring to an S3 location. It can be up to 225KB. **Conflicts with `s3Bucket`, `s3Key`, and `s3Version`.**

[artifactS3Location](/content/registry/packages/aws/api-docs/synthetics/canary/#artifacts3location_nodejs/index.html)This property is required.stringLocation in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.[executionRoleArn](/content/registry/packages/aws/api-docs/synthetics/canary/#executionrolearn_nodejs/index.html)This property is required.stringARN of the IAM role to be used to run the canary. see [AWS Docs](https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CreateCanary.html#API_CreateCanary_RequestSyntax) for permissions needs for IAM Role.[handler](/content/registry/packages/aws/api-docs/synthetics/canary/#handler_nodejs/index.html)This property is required.stringEntry point to use for the source code when running the canary. This value must end with the string `.handler` .[runtimeVersion](/content/registry/packages/aws/api-docs/synthetics/canary/#runtimeversion_nodejs/index.html)This property is required.stringRuntime version to use for the canary. Versions change often so consult the [Amazon CloudWatch documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html) for the latest valid versions. Values include `syn-python-selenium-1.0`, `syn-nodejs-puppeteer-3.0`, `syn-nodejs-2.2`, `syn-nodejs-2.1`, `syn-nodejs-2.0`, and `syn-1.0`.[schedule](/content/registry/packages/aws/api-docs/synthetics/canary/#schedule_nodejs/index.html)This property is required.[CanarySchedule](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryschedule/index.html)

Configuration block providing how often the canary is to run and when these test runs are to stop. Detailed below.

The following arguments are optional:

[artifactConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#artifactconfig_nodejs/index.html)[CanaryArtifactConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryartifactconfig/index.html)configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See Artifact Config.[deleteLambda](/content/registry/packages/aws/api-docs/synthetics/canary/#deletelambda_nodejs/index.html)booleanSpecifies whether to also delete the Lambda functions and layers used by this canary. The default is `false`.[failureRetentionPeriod](/content/registry/packages/aws/api-docs/synthetics/canary/#failureretentionperiod_nodejs/index.html)numberNumber 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.[name](/content/registry/packages/aws/api-docs/synthetics/canary/#name_nodejs/index.html)Changes to this property will trigger replacement.stringName for this canary. Has a maximum length of 255 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore.[region](/content/registry/packages/aws/api-docs/synthetics/canary/#region_nodejs/index.html)stringRegion where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.[runConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#runconfig_nodejs/index.html)[CanaryRunConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryrunconfig/index.html)Configuration block for individual canary runs. Detailed below.[s3Bucket](/content/registry/packages/aws/api-docs/synthetics/canary/#s3bucket_nodejs/index.html)stringFull bucket name which is used if your canary script is located in S3. The bucket must already exist. **Conflicts with `zipFile`.**[s3Key](/content/registry/packages/aws/api-docs/synthetics/canary/#s3key_nodejs/index.html)stringS3 key of your script. **Conflicts with `zipFile`.**[s3Version](/content/registry/packages/aws/api-docs/synthetics/canary/#s3version_nodejs/index.html)stringS3 version ID of your script. **Conflicts with `zipFile`.**[startCanary](/content/registry/packages/aws/api-docs/synthetics/canary/#startcanary_nodejs/index.html)booleanWhether to run or stop the canary.[successRetentionPeriod](/content/registry/packages/aws/api-docs/synthetics/canary/#successretentionperiod_nodejs/index.html)numberNumber 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.[tags](/content/registry/packages/aws/api-docs/synthetics/canary/#tags_nodejs/index.html){\[key: string\]: string}Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.[vpcConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#vpcconfig_nodejs/index.html)[CanaryVpcConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryvpcconfig/index.html)Configuration block. Detailed below.[zipFile](/content/registry/packages/aws/api-docs/synthetics/canary/#zipfile_nodejs/index.html)stringZIP file that contains the script, if you input your canary script directly into the canary instead of referring to an S3 location. It can be up to 225KB. **Conflicts with `s3Bucket`, `s3Key`, and `s3Version`.**

[artifact\_s3\_location](/content/registry/packages/aws/api-docs/synthetics/canary/#artifact_s3_location_python/index.html)This property is required.strLocation in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.[execution\_role\_arn](/content/registry/packages/aws/api-docs/synthetics/canary/#execution_role_arn_python/index.html)This property is required.strARN of the IAM role to be used to run the canary. see [AWS Docs](https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CreateCanary.html#API_CreateCanary_RequestSyntax) for permissions needs for IAM Role.[handler](/content/registry/packages/aws/api-docs/synthetics/canary/#handler_python/index.html)This property is required.strEntry point to use for the source code when running the canary. This value must end with the string `.handler` .[runtime\_version](/content/registry/packages/aws/api-docs/synthetics/canary/#runtime_version_python/index.html)This property is required.strRuntime version to use for the canary. Versions change often so consult the [Amazon CloudWatch documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html) for the latest valid versions. Values include `syn-python-selenium-1.0`, `syn-nodejs-puppeteer-3.0`, `syn-nodejs-2.2`, `syn-nodejs-2.1`, `syn-nodejs-2.0`, and `syn-1.0`.[schedule](/content/registry/packages/aws/api-docs/synthetics/canary/#schedule_python/index.html)This property is required.[CanaryScheduleArgs](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryschedule/index.html)

Configuration block providing how often the canary is to run and when these test runs are to stop. Detailed below.

The following arguments are optional:

[artifact\_config](/content/registry/packages/aws/api-docs/synthetics/canary/#artifact_config_python/index.html)[CanaryArtifactConfigArgs](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryartifactconfig/index.html)configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See Artifact Config.[delete\_lambda](/content/registry/packages/aws/api-docs/synthetics/canary/#delete_lambda_python/index.html)boolSpecifies whether to also delete the Lambda functions and layers used by this canary. The default is `false`.[failure\_retention\_period](/content/registry/packages/aws/api-docs/synthetics/canary/#failure_retention_period_python/index.html)intNumber 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.[name](/content/registry/packages/aws/api-docs/synthetics/canary/#name_python/index.html)Changes to this property will trigger replacement.strName for this canary. Has a maximum length of 255 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore.[region](/content/registry/packages/aws/api-docs/synthetics/canary/#region_python/index.html)strRegion where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.[run\_config](/content/registry/packages/aws/api-docs/synthetics/canary/#run_config_python/index.html)[CanaryRunConfigArgs](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryrunconfig/index.html)Configuration block for individual canary runs. Detailed below.[s3\_bucket](/content/registry/packages/aws/api-docs/synthetics/canary/#s3_bucket_python/index.html)strFull bucket name which is used if your canary script is located in S3. The bucket must already exist. **Conflicts with `zipFile`.**[s3\_key](/content/registry/packages/aws/api-docs/synthetics/canary/#s3_key_python/index.html)strS3 key of your script. **Conflicts with `zipFile`.**[s3\_version](/content/registry/packages/aws/api-docs/synthetics/canary/#s3_version_python/index.html)strS3 version ID of your script. **Conflicts with `zipFile`.**[start\_canary](/content/registry/packages/aws/api-docs/synthetics/canary/#start_canary_python/index.html)boolWhether to run or stop the canary.[success\_retention\_period](/content/registry/packages/aws/api-docs/synthetics/canary/#success_retention_period_python/index.html)intNumber 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.[tags](/content/registry/packages/aws/api-docs/synthetics/canary/#tags_python/index.html)Mapping\[str, str\]Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.[vpc\_config](/content/registry/packages/aws/api-docs/synthetics/canary/#vpc_config_python/index.html)[CanaryVpcConfigArgs](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryvpcconfig/index.html)Configuration block. Detailed below.[zip\_file](/content/registry/packages/aws/api-docs/synthetics/canary/#zip_file_python/index.html)strZIP file that contains the script, if you input your canary script directly into the canary instead of referring to an S3 location. It can be up to 225KB. **Conflicts with `s3Bucket`, `s3Key`, and `s3Version`.**

[artifactS3Location](/content/registry/packages/aws/api-docs/synthetics/canary/#artifacts3location_yaml/index.html)This property is required.StringLocation in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.[executionRoleArn](/content/registry/packages/aws/api-docs/synthetics/canary/#executionrolearn_yaml/index.html)This property is required.StringARN of the IAM role to be used to run the canary. see [AWS Docs](https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CreateCanary.html#API_CreateCanary_RequestSyntax) for permissions needs for IAM Role.[handler](/content/registry/packages/aws/api-docs/synthetics/canary/#handler_yaml/index.html)This property is required.StringEntry point to use for the source code when running the canary. This value must end with the string `.handler` .[runtimeVersion](/content/registry/packages/aws/api-docs/synthetics/canary/#runtimeversion_yaml/index.html)This property is required.StringRuntime version to use for the canary. Versions change often so consult the [Amazon CloudWatch documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html) for the latest valid versions. Values include `syn-python-selenium-1.0`, `syn-nodejs-puppeteer-3.0`, `syn-nodejs-2.2`, `syn-nodejs-2.1`, `syn-nodejs-2.0`, and `syn-1.0`.[schedule](/content/registry/packages/aws/api-docs/synthetics/canary/#schedule_yaml/index.html)This property is required.[Property Map](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryschedule/index.html)

Configuration block providing how often the canary is to run and when these test runs are to stop. Detailed below.

The following arguments are optional:

[artifactConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#artifactconfig_yaml/index.html)[Property Map](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryartifactconfig/index.html)configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See Artifact Config.[deleteLambda](/content/registry/packages/aws/api-docs/synthetics/canary/#deletelambda_yaml/index.html)BooleanSpecifies whether to also delete the Lambda functions and layers used by this canary. The default is `false`.[failureRetentionPeriod](/content/registry/packages/aws/api-docs/synthetics/canary/#failureretentionperiod_yaml/index.html)NumberNumber 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.[name](/content/registry/packages/aws/api-docs/synthetics/canary/#name_yaml/index.html)Changes to this property will trigger replacement.StringName for this canary. Has a maximum length of 255 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore.[region](/content/registry/packages/aws/api-docs/synthetics/canary/#region_yaml/index.html)StringRegion where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.[runConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#runconfig_yaml/index.html)[Property Map](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryrunconfig/index.html)Configuration block for individual canary runs. Detailed below.[s3Bucket](/content/registry/packages/aws/api-docs/synthetics/canary/#s3bucket_yaml/index.html)StringFull bucket name which is used if your canary script is located in S3. The bucket must already exist. **Conflicts with `zipFile`.**[s3Key](/content/registry/packages/aws/api-docs/synthetics/canary/#s3key_yaml/index.html)StringS3 key of your script. **Conflicts with `zipFile`.**[s3Version](/content/registry/packages/aws/api-docs/synthetics/canary/#s3version_yaml/index.html)StringS3 version ID of your script. **Conflicts with `zipFile`.**[startCanary](/content/registry/packages/aws/api-docs/synthetics/canary/#startcanary_yaml/index.html)BooleanWhether to run or stop the canary.[successRetentionPeriod](/content/registry/packages/aws/api-docs/synthetics/canary/#successretentionperiod_yaml/index.html)NumberNumber 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.[tags](/content/registry/packages/aws/api-docs/synthetics/canary/#tags_yaml/index.html)Map<String>Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.[vpcConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#vpcconfig_yaml/index.html)[Property Map](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryvpcconfig/index.html)Configuration block. Detailed below.[zipFile](/content/registry/packages/aws/api-docs/synthetics/canary/#zipfile_yaml/index.html)StringZIP file that contains the script, if you input your canary script directly into the canary instead of referring to an S3 location. It can be up to 225KB. **Conflicts with `s3Bucket`, `s3Key`, and `s3Version`.**

### Outputs [Anchor](/content/registry/packages/aws/api-docs/synthetics/canary/\#outputs/index.html)

All [input](/content/registry/packages/aws/api-docs/synthetics/canary/#inputs/index.html) properties are implicitly available as output properties. Additionally, the Canary resource produces the following output properties:

[Arn](/content/registry/packages/aws/api-docs/synthetics/canary/#arn_csharp/index.html)stringAmazon Resource Name (ARN) of the Canary.[EngineArn](/content/registry/packages/aws/api-docs/synthetics/canary/#enginearn_csharp/index.html)stringARN of the Lambda function that is used as your canary's engine.[Id](/content/registry/packages/aws/api-docs/synthetics/canary/#id_csharp/index.html)stringThe provider-assigned unique ID for this managed resource.[SourceLocationArn](/content/registry/packages/aws/api-docs/synthetics/canary/#sourcelocationarn_csharp/index.html)stringARN of the Lambda layer where Synthetics stores the canary script code.[Status](/content/registry/packages/aws/api-docs/synthetics/canary/#status_csharp/index.html)stringCanary status.[TagsAll](/content/registry/packages/aws/api-docs/synthetics/canary/#tagsall_csharp/index.html)Dictionary<string, string>A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.[Timelines](/content/registry/packages/aws/api-docs/synthetics/canary/#timelines_csharp/index.html)[List<CanaryTimeline>](/content/registry/packages/aws/api-docs/synthetics/canary/#canarytimeline/index.html)Structure that contains information about when the canary was created, modified, and most recently run. see Timeline.

[Arn](/content/registry/packages/aws/api-docs/synthetics/canary/#arn_go/index.html)stringAmazon Resource Name (ARN) of the Canary.[EngineArn](/content/registry/packages/aws/api-docs/synthetics/canary/#enginearn_go/index.html)stringARN of the Lambda function that is used as your canary's engine.[Id](/content/registry/packages/aws/api-docs/synthetics/canary/#id_go/index.html)stringThe provider-assigned unique ID for this managed resource.[SourceLocationArn](/content/registry/packages/aws/api-docs/synthetics/canary/#sourcelocationarn_go/index.html)stringARN of the Lambda layer where Synthetics stores the canary script code.[Status](/content/registry/packages/aws/api-docs/synthetics/canary/#status_go/index.html)stringCanary status.[TagsAll](/content/registry/packages/aws/api-docs/synthetics/canary/#tagsall_go/index.html)map\[string\]stringA map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.[Timelines](/content/registry/packages/aws/api-docs/synthetics/canary/#timelines_go/index.html)[\[\]CanaryTimeline](/content/registry/packages/aws/api-docs/synthetics/canary/#canarytimeline/index.html)Structure that contains information about when the canary was created, modified, and most recently run. see Timeline.

[arn](/content/registry/packages/aws/api-docs/synthetics/canary/#arn_hcl/index.html)stringAmazon Resource Name (ARN) of the Canary.[engine\_arn](/content/registry/packages/aws/api-docs/synthetics/canary/#engine_arn_hcl/index.html)stringARN of the Lambda function that is used as your canary's engine.[id](/content/registry/packages/aws/api-docs/synthetics/canary/#id_hcl/index.html)stringThe provider-assigned unique ID for this managed resource.[source\_location\_arn](/content/registry/packages/aws/api-docs/synthetics/canary/#source_location_arn_hcl/index.html)stringARN of the Lambda layer where Synthetics stores the canary script code.[status](/content/registry/packages/aws/api-docs/synthetics/canary/#status_hcl/index.html)stringCanary status.[tags\_all](/content/registry/packages/aws/api-docs/synthetics/canary/#tags_all_hcl/index.html)map(string)A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.[timelines](/content/registry/packages/aws/api-docs/synthetics/canary/#timelines_hcl/index.html)[list(object)](/content/registry/packages/aws/api-docs/synthetics/canary/#canarytimeline/index.html)Structure that contains information about when the canary was created, modified, and most recently run. see Timeline.

[arn](/content/registry/packages/aws/api-docs/synthetics/canary/#arn_java/index.html)StringAmazon Resource Name (ARN) of the Canary.[engineArn](/content/registry/packages/aws/api-docs/synthetics/canary/#enginearn_java/index.html)StringARN of the Lambda function that is used as your canary's engine.[id](/content/registry/packages/aws/api-docs/synthetics/canary/#id_java/index.html)StringThe provider-assigned unique ID for this managed resource.[sourceLocationArn](/content/registry/packages/aws/api-docs/synthetics/canary/#sourcelocationarn_java/index.html)StringARN of the Lambda layer where Synthetics stores the canary script code.[status](/content/registry/packages/aws/api-docs/synthetics/canary/#status_java/index.html)StringCanary status.[tagsAll](/content/registry/packages/aws/api-docs/synthetics/canary/#tagsall_java/index.html)Map<String,String>A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.[timelines](/content/registry/packages/aws/api-docs/synthetics/canary/#timelines_java/index.html)[List<CanaryTimeline>](/content/registry/packages/aws/api-docs/synthetics/canary/#canarytimeline/index.html)Structure that contains information about when the canary was created, modified, and most recently run. see Timeline.

[arn](/content/registry/packages/aws/api-docs/synthetics/canary/#arn_nodejs/index.html)stringAmazon Resource Name (ARN) of the Canary.[engineArn](/content/registry/packages/aws/api-docs/synthetics/canary/#enginearn_nodejs/index.html)stringARN of the Lambda function that is used as your canary's engine.[id](/content/registry/packages/aws/api-docs/synthetics/canary/#id_nodejs/index.html)stringThe provider-assigned unique ID for this managed resource.[sourceLocationArn](/content/registry/packages/aws/api-docs/synthetics/canary/#sourcelocationarn_nodejs/index.html)stringARN of the Lambda layer where Synthetics stores the canary script code.[status](/content/registry/packages/aws/api-docs/synthetics/canary/#status_nodejs/index.html)stringCanary status.[tagsAll](/content/registry/packages/aws/api-docs/synthetics/canary/#tagsall_nodejs/index.html){\[key: string\]: string}A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.[timelines](/content/registry/packages/aws/api-docs/synthetics/canary/#timelines_nodejs/index.html)[CanaryTimeline\[\]](/content/registry/packages/aws/api-docs/synthetics/canary/#canarytimeline/index.html)Structure that contains information about when the canary was created, modified, and most recently run. see Timeline.

[arn](/content/registry/packages/aws/api-docs/synthetics/canary/#arn_python/index.html)strAmazon Resource Name (ARN) of the Canary.[engine\_arn](/content/registry/packages/aws/api-docs/synthetics/canary/#engine_arn_python/index.html)strARN of the Lambda function that is used as your canary's engine.[id](/content/registry/packages/aws/api-docs/synthetics/canary/#id_python/index.html)strThe provider-assigned unique ID for this managed resource.[source\_location\_arn](/content/registry/packages/aws/api-docs/synthetics/canary/#source_location_arn_python/index.html)strARN of the Lambda layer where Synthetics stores the canary script code.[status](/content/registry/packages/aws/api-docs/synthetics/canary/#status_python/index.html)strCanary status.[tags\_all](/content/registry/packages/aws/api-docs/synthetics/canary/#tags_all_python/index.html)Mapping\[str, str\]A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.[timelines](/content/registry/packages/aws/api-docs/synthetics/canary/#timelines_python/index.html)[Sequence\[CanaryTimeline\]](/content/registry/packages/aws/api-docs/synthetics/canary/#canarytimeline/index.html)Structure that contains information about when the canary was created, modified, and most recently run. see Timeline.

[arn](/content/registry/packages/aws/api-docs/synthetics/canary/#arn_yaml/index.html)StringAmazon Resource Name (ARN) of the Canary.[engineArn](/content/registry/packages/aws/api-docs/synthetics/canary/#enginearn_yaml/index.html)StringARN of the Lambda function that is used as your canary's engine.[id](/content/registry/packages/aws/api-docs/synthetics/canary/#id_yaml/index.html)StringThe provider-assigned unique ID for this managed resource.[sourceLocationArn](/content/registry/packages/aws/api-docs/synthetics/canary/#sourcelocationarn_yaml/index.html)StringARN of the Lambda layer where Synthetics stores the canary script code.[status](/content/registry/packages/aws/api-docs/synthetics/canary/#status_yaml/index.html)StringCanary status.[tagsAll](/content/registry/packages/aws/api-docs/synthetics/canary/#tagsall_yaml/index.html)Map<String>A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.[timelines](/content/registry/packages/aws/api-docs/synthetics/canary/#timelines_yaml/index.html)[List<Property Map>](/content/registry/packages/aws/api-docs/synthetics/canary/#canarytimeline/index.html)Structure that contains information about when the canary was created, modified, and most recently run. see Timeline.

## Look up Existing Canary Resource [Anchor](/content/registry/packages/aws/api-docs/synthetics/canary/\#look-up/index.html)

Get an existing Canary resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

- TypeScript
- Python
- Go
- C#
- Java
- YAML
- HCL PREVIEW

```typescript
public static get(name: string, id: Input<ID>, state?: CanaryState, opts?: CustomResourceOptions): Canary
```

```python
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        artifact_config: Optional[CanaryArtifactConfigArgs] = None,
        artifact_s3_location: Optional[str] = None,
        delete_lambda: Optional[bool] = None,
        engine_arn: Optional[str] = None,
        execution_role_arn: Optional[str] = None,
        failure_retention_period: Optional[int] = None,
        handler: Optional[str] = None,
        name: Optional[str] = None,
        region: Optional[str] = None,
        run_config: Optional[CanaryRunConfigArgs] = None,
        runtime_version: Optional[str] = None,
        s3_bucket: Optional[str] = None,
        s3_key: Optional[str] = None,
        s3_version: Optional[str] = None,
        schedule: Optional[CanaryScheduleArgs] = None,
        source_location_arn: Optional[str] = None,
        start_canary: Optional[bool] = None,
        status: Optional[str] = None,
        success_retention_period: Optional[int] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        timelines: Optional[Sequence[CanaryTimelineArgs]] = None,
        vpc_config: Optional[CanaryVpcConfigArgs] = None,
        zip_file: Optional[str] = None) -> Canary
```

```go
func GetCanary(ctx *Context, name string, id IDInput, state *CanaryState, opts ...ResourceOption) (*Canary, error)
```

```csharp
public static Canary Get(string name, Input<string> id, CanaryState? state, CustomResourceOptions? opts = null)
```

```java
public static Canary get(String name, Output<String> id, CanaryState state, CustomResourceOptions options)
```

```yaml
resources:  _:    type: aws:synthetics:Canary    get:      id: ${id}
```

```hcl
import {
  to = aws_synthetics_canary.example
  id = "${id}"
}
```

nameThis property is required.The unique name of the resulting resource.idThis property is required.The _unique_ provider ID of the resource to lookup.stateAny extra arguments used during the lookup.optsA bag of options that control this resource's behavior.

resource\_nameThis property is required.The unique name of the resulting resource.idThis property is required.The _unique_ provider ID of the resource to lookup.

The following state arguments are supported:

[Arn](/content/registry/packages/aws/api-docs/synthetics/canary/#state_arn_csharp/index.html)stringAmazon Resource Name (ARN) of the Canary.[ArtifactConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#state_artifactconfig_csharp/index.html)[CanaryArtifactConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryartifactconfig/index.html)configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See Artifact Config.[ArtifactS3Location](/content/registry/packages/aws/api-docs/synthetics/canary/#state_artifacts3location_csharp/index.html)stringLocation in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.[DeleteLambda](/content/registry/packages/aws/api-docs/synthetics/canary/#state_deletelambda_csharp/index.html)boolSpecifies whether to also delete the Lambda functions and layers used by this canary. The default is `false`.[EngineArn](/content/registry/packages/aws/api-docs/synthetics/canary/#state_enginearn_csharp/index.html)stringARN of the Lambda function that is used as your canary's engine.[ExecutionRoleArn](/content/registry/packages/aws/api-docs/synthetics/canary/#state_executionrolearn_csharp/index.html)stringARN of the IAM role to be used to run the canary. see [AWS Docs](https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CreateCanary.html#API_CreateCanary_RequestSyntax) for permissions needs for IAM Role.[FailureRetentionPeriod](/content/registry/packages/aws/api-docs/synthetics/canary/#state_failureretentionperiod_csharp/index.html)intNumber 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.[Handler](/content/registry/packages/aws/api-docs/synthetics/canary/#state_handler_csharp/index.html)stringEntry point to use for the source code when running the canary. This value must end with the string `.handler` .[Name](/content/registry/packages/aws/api-docs/synthetics/canary/#state_name_csharp/index.html)Changes to this property will trigger replacement.stringName for this canary. Has a maximum length of 255 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore.[Region](/content/registry/packages/aws/api-docs/synthetics/canary/#state_region_csharp/index.html)stringRegion where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.[RunConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#state_runconfig_csharp/index.html)[CanaryRunConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryrunconfig/index.html)Configuration block for individual canary runs. Detailed below.[RuntimeVersion](/content/registry/packages/aws/api-docs/synthetics/canary/#state_runtimeversion_csharp/index.html)stringRuntime version to use for the canary. Versions change often so consult the [Amazon CloudWatch documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html) for the latest valid versions. Values include `syn-python-selenium-1.0`, `syn-nodejs-puppeteer-3.0`, `syn-nodejs-2.2`, `syn-nodejs-2.1`, `syn-nodejs-2.0`, and `syn-1.0`.[S3Bucket](/content/registry/packages/aws/api-docs/synthetics/canary/#state_s3bucket_csharp/index.html)stringFull bucket name which is used if your canary script is located in S3. The bucket must already exist. **Conflicts with `zipFile`.**[S3Key](/content/registry/packages/aws/api-docs/synthetics/canary/#state_s3key_csharp/index.html)stringS3 key of your script. **Conflicts with `zipFile`.**[S3Version](/content/registry/packages/aws/api-docs/synthetics/canary/#state_s3version_csharp/index.html)stringS3 version ID of your script. **Conflicts with `zipFile`.**[Schedule](/content/registry/packages/aws/api-docs/synthetics/canary/#state_schedule_csharp/index.html)[CanarySchedule](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryschedule/index.html)

Configuration block providing how often the canary is to run and when these test runs are to stop. Detailed below.

The following arguments are optional:

[SourceLocationArn](/content/registry/packages/aws/api-docs/synthetics/canary/#state_sourcelocationarn_csharp/index.html)stringARN of the Lambda layer where Synthetics stores the canary script code.[StartCanary](/content/registry/packages/aws/api-docs/synthetics/canary/#state_startcanary_csharp/index.html)boolWhether to run or stop the canary.[Status](/content/registry/packages/aws/api-docs/synthetics/canary/#state_status_csharp/index.html)stringCanary status.[SuccessRetentionPeriod](/content/registry/packages/aws/api-docs/synthetics/canary/#state_successretentionperiod_csharp/index.html)intNumber 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.[Tags](/content/registry/packages/aws/api-docs/synthetics/canary/#state_tags_csharp/index.html)Dictionary<string, string>Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.[TagsAll](/content/registry/packages/aws/api-docs/synthetics/canary/#state_tagsall_csharp/index.html)Dictionary<string, string>A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.[Timelines](/content/registry/packages/aws/api-docs/synthetics/canary/#state_timelines_csharp/index.html)[List<CanaryTimeline>](/content/registry/packages/aws/api-docs/synthetics/canary/#canarytimeline/index.html)Structure that contains information about when the canary was created, modified, and most recently run. see Timeline.[VpcConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#state_vpcconfig_csharp/index.html)[CanaryVpcConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryvpcconfig/index.html)Configuration block. Detailed below.[ZipFile](/content/registry/packages/aws/api-docs/synthetics/canary/#state_zipfile_csharp/index.html)stringZIP file that contains the script, if you input your canary script directly into the canary instead of referring to an S3 location. It can be up to 225KB. **Conflicts with `s3Bucket`, `s3Key`, and `s3Version`.**

[Arn](/content/registry/packages/aws/api-docs/synthetics/canary/#state_arn_go/index.html)stringAmazon Resource Name (ARN) of the Canary.[ArtifactConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#state_artifactconfig_go/index.html)[CanaryArtifactConfigArgs](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryartifactconfig/index.html)configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See Artifact Config.[ArtifactS3Location](/content/registry/packages/aws/api-docs/synthetics/canary/#state_artifacts3location_go/index.html)stringLocation in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.[DeleteLambda](/content/registry/packages/aws/api-docs/synthetics/canary/#state_deletelambda_go/index.html)boolSpecifies whether to also delete the Lambda functions and layers used by this canary. The default is `false`.[EngineArn](/content/registry/packages/aws/api-docs/synthetics/canary/#state_enginearn_go/index.html)stringARN of the Lambda function that is used as your canary's engine.[ExecutionRoleArn](/content/registry/packages/aws/api-docs/synthetics/canary/#state_executionrolearn_go/index.html)stringARN of the IAM role to be used to run the canary. see [AWS Docs](https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CreateCanary.html#API_CreateCanary_RequestSyntax) for permissions needs for IAM Role.[FailureRetentionPeriod](/content/registry/packages/aws/api-docs/synthetics/canary/#state_failureretentionperiod_go/index.html)intNumber 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.[Handler](/content/registry/packages/aws/api-docs/synthetics/canary/#state_handler_go/index.html)stringEntry point to use for the source code when running the canary. This value must end with the string `.handler` .[Name](/content/registry/packages/aws/api-docs/synthetics/canary/#state_name_go/index.html)Changes to this property will trigger replacement.stringName for this canary. Has a maximum length of 255 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore.[Region](/content/registry/packages/aws/api-docs/synthetics/canary/#state_region_go/index.html)stringRegion where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.[RunConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#state_runconfig_go/index.html)[CanaryRunConfigArgs](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryrunconfig/index.html)Configuration block for individual canary runs. Detailed below.[RuntimeVersion](/content/registry/packages/aws/api-docs/synthetics/canary/#state_runtimeversion_go/index.html)stringRuntime version to use for the canary. Versions change often so consult the [Amazon CloudWatch documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html) for the latest valid versions. Values include `syn-python-selenium-1.0`, `syn-nodejs-puppeteer-3.0`, `syn-nodejs-2.2`, `syn-nodejs-2.1`, `syn-nodejs-2.0`, and `syn-1.0`.[S3Bucket](/content/registry/packages/aws/api-docs/synthetics/canary/#state_s3bucket_go/index.html)stringFull bucket name which is used if your canary script is located in S3. The bucket must already exist. **Conflicts with `zipFile`.**[S3Key](/content/registry/packages/aws/api-docs/synthetics/canary/#state_s3key_go/index.html)stringS3 key of your script. **Conflicts with `zipFile`.**[S3Version](/content/registry/packages/aws/api-docs/synthetics/canary/#state_s3version_go/index.html)stringS3 version ID of your script. **Conflicts with `zipFile`.**[Schedule](/content/registry/packages/aws/api-docs/synthetics/canary/#state_schedule_go/index.html)[CanaryScheduleArgs](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryschedule/index.html)

Configuration block providing how often the canary is to run and when these test runs are to stop. Detailed below.

The following arguments are optional:

[SourceLocationArn](/content/registry/packages/aws/api-docs/synthetics/canary/#state_sourcelocationarn_go/index.html)stringARN of the Lambda layer where Synthetics stores the canary script code.[StartCanary](/content/registry/packages/aws/api-docs/synthetics/canary/#state_startcanary_go/index.html)boolWhether to run or stop the canary.[Status](/content/registry/packages/aws/api-docs/synthetics/canary/#state_status_go/index.html)stringCanary status.[SuccessRetentionPeriod](/content/registry/packages/aws/api-docs/synthetics/canary/#state_successretentionperiod_go/index.html)intNumber 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.[Tags](/content/registry/packages/aws/api-docs/synthetics/canary/#state_tags_go/index.html)map\[string\]stringKey-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.[TagsAll](/content/registry/packages/aws/api-docs/synthetics/canary/#state_tagsall_go/index.html)map\[string\]stringA map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.[Timelines](/content/registry/packages/aws/api-docs/synthetics/canary/#state_timelines_go/index.html)[\[\]CanaryTimelineArgs](/content/registry/packages/aws/api-docs/synthetics/canary/#canarytimeline/index.html)Structure that contains information about when the canary was created, modified, and most recently run. see Timeline.[VpcConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#state_vpcconfig_go/index.html)[CanaryVpcConfigArgs](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryvpcconfig/index.html)Configuration block. Detailed below.[ZipFile](/content/registry/packages/aws/api-docs/synthetics/canary/#state_zipfile_go/index.html)stringZIP file that contains the script, if you input your canary script directly into the canary instead of referring to an S3 location. It can be up to 225KB. **Conflicts with `s3Bucket`, `s3Key`, and `s3Version`.**

[arn](/content/registry/packages/aws/api-docs/synthetics/canary/#state_arn_hcl/index.html)stringAmazon Resource Name (ARN) of the Canary.[artifact\_config](/content/registry/packages/aws/api-docs/synthetics/canary/#state_artifact_config_hcl/index.html)[object](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryartifactconfig/index.html)configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See Artifact Config.[artifact\_s3\_location](/content/registry/packages/aws/api-docs/synthetics/canary/#state_artifact_s3_location_hcl/index.html)stringLocation in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.[delete\_lambda](/content/registry/packages/aws/api-docs/synthetics/canary/#state_delete_lambda_hcl/index.html)boolSpecifies whether to also delete the Lambda functions and layers used by this canary. The default is `false`.[engine\_arn](/content/registry/packages/aws/api-docs/synthetics/canary/#state_engine_arn_hcl/index.html)stringARN of the Lambda function that is used as your canary's engine.[execution\_role\_arn](/content/registry/packages/aws/api-docs/synthetics/canary/#state_execution_role_arn_hcl/index.html)stringARN of the IAM role to be used to run the canary. see [AWS Docs](https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CreateCanary.html#API_CreateCanary_RequestSyntax) for permissions needs for IAM Role.[failure\_retention\_period](/content/registry/packages/aws/api-docs/synthetics/canary/#state_failure_retention_period_hcl/index.html)numberNumber 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.[handler](/content/registry/packages/aws/api-docs/synthetics/canary/#state_handler_hcl/index.html)stringEntry point to use for the source code when running the canary. This value must end with the string `.handler` .[name](/content/registry/packages/aws/api-docs/synthetics/canary/#state_name_hcl/index.html)Changes to this property will trigger replacement.stringName for this canary. Has a maximum length of 255 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore.[region](/content/registry/packages/aws/api-docs/synthetics/canary/#state_region_hcl/index.html)stringRegion where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.[run\_config](/content/registry/packages/aws/api-docs/synthetics/canary/#state_run_config_hcl/index.html)[object](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryrunconfig/index.html)Configuration block for individual canary runs. Detailed below.[runtime\_version](/content/registry/packages/aws/api-docs/synthetics/canary/#state_runtime_version_hcl/index.html)stringRuntime version to use for the canary. Versions change often so consult the [Amazon CloudWatch documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html) for the latest valid versions. Values include `syn-python-selenium-1.0`, `syn-nodejs-puppeteer-3.0`, `syn-nodejs-2.2`, `syn-nodejs-2.1`, `syn-nodejs-2.0`, and `syn-1.0`.[s3\_bucket](/content/registry/packages/aws/api-docs/synthetics/canary/#state_s3_bucket_hcl/index.html)stringFull bucket name which is used if your canary script is located in S3. The bucket must already exist. **Conflicts with `zipFile`.**[s3\_key](/content/registry/packages/aws/api-docs/synthetics/canary/#state_s3_key_hcl/index.html)stringS3 key of your script. **Conflicts with `zipFile`.**[s3\_version](/content/registry/packages/aws/api-docs/synthetics/canary/#state_s3_version_hcl/index.html)stringS3 version ID of your script. **Conflicts with `zipFile`.**[schedule](/content/registry/packages/aws/api-docs/synthetics/canary/#state_schedule_hcl/index.html)[object](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryschedule/index.html)

Configuration block providing how often the canary is to run and when these test runs are to stop. Detailed below.

The following arguments are optional:

[source\_location\_arn](/content/registry/packages/aws/api-docs/synthetics/canary/#state_source_location_arn_hcl/index.html)stringARN of the Lambda layer where Synthetics stores the canary script code.[start\_canary](/content/registry/packages/aws/api-docs/synthetics/canary/#state_start_canary_hcl/index.html)boolWhether to run or stop the canary.[status](/content/registry/packages/aws/api-docs/synthetics/canary/#state_status_hcl/index.html)stringCanary status.[success\_retention\_period](/content/registry/packages/aws/api-docs/synthetics/canary/#state_success_retention_period_hcl/index.html)numberNumber 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.[tags](/content/registry/packages/aws/api-docs/synthetics/canary/#state_tags_hcl/index.html)map(string)Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.[tags\_all](/content/registry/packages/aws/api-docs/synthetics/canary/#state_tags_all_hcl/index.html)map(string)A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.[timelines](/content/registry/packages/aws/api-docs/synthetics/canary/#state_timelines_hcl/index.html)[list(object)](/content/registry/packages/aws/api-docs/synthetics/canary/#canarytimeline/index.html)Structure that contains information about when the canary was created, modified, and most recently run. see Timeline.[vpc\_config](/content/registry/packages/aws/api-docs/synthetics/canary/#state_vpc_config_hcl/index.html)[object](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryvpcconfig/index.html)Configuration block. Detailed below.[zip\_file](/content/registry/packages/aws/api-docs/synthetics/canary/#state_zip_file_hcl/index.html)stringZIP file that contains the script, if you input your canary script directly into the canary instead of referring to an S3 location. It can be up to 225KB. **Conflicts with `s3Bucket`, `s3Key`, and `s3Version`.**

[arn](/content/registry/packages/aws/api-docs/synthetics/canary/#state_arn_java/index.html)StringAmazon Resource Name (ARN) of the Canary.[artifactConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#state_artifactconfig_java/index.html)[CanaryArtifactConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryartifactconfig/index.html)configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See Artifact Config.[artifactS3Location](/content/registry/packages/aws/api-docs/synthetics/canary/#state_artifacts3location_java/index.html)StringLocation in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.[deleteLambda](/content/registry/packages/aws/api-docs/synthetics/canary/#state_deletelambda_java/index.html)BooleanSpecifies whether to also delete the Lambda functions and layers used by this canary. The default is `false`.[engineArn](/content/registry/packages/aws/api-docs/synthetics/canary/#state_enginearn_java/index.html)StringARN of the Lambda function that is used as your canary's engine.[executionRoleArn](/content/registry/packages/aws/api-docs/synthetics/canary/#state_executionrolearn_java/index.html)StringARN of the IAM role to be used to run the canary. see [AWS Docs](https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CreateCanary.html#API_CreateCanary_RequestSyntax) for permissions needs for IAM Role.[failureRetentionPeriod](/content/registry/packages/aws/api-docs/synthetics/canary/#state_failureretentionperiod_java/index.html)IntegerNumber 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.[handler](/content/registry/packages/aws/api-docs/synthetics/canary/#state_handler_java/index.html)StringEntry point to use for the source code when running the canary. This value must end with the string `.handler` .[name](/content/registry/packages/aws/api-docs/synthetics/canary/#state_name_java/index.html)Changes to this property will trigger replacement.StringName for this canary. Has a maximum length of 255 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore.[region](/content/registry/packages/aws/api-docs/synthetics/canary/#state_region_java/index.html)StringRegion where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.[runConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#state_runconfig_java/index.html)[CanaryRunConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryrunconfig/index.html)Configuration block for individual canary runs. Detailed below.[runtimeVersion](/content/registry/packages/aws/api-docs/synthetics/canary/#state_runtimeversion_java/index.html)StringRuntime version to use for the canary. Versions change often so consult the [Amazon CloudWatch documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html) for the latest valid versions. Values include `syn-python-selenium-1.0`, `syn-nodejs-puppeteer-3.0`, `syn-nodejs-2.2`, `syn-nodejs-2.1`, `syn-nodejs-2.0`, and `syn-1.0`.[s3Bucket](/content/registry/packages/aws/api-docs/synthetics/canary/#state_s3bucket_java/index.html)StringFull bucket name which is used if your canary script is located in S3. The bucket must already exist. **Conflicts with `zipFile`.**[s3Key](/content/registry/packages/aws/api-docs/synthetics/canary/#state_s3key_java/index.html)StringS3 key of your script. **Conflicts with `zipFile`.**[s3Version](/content/registry/packages/aws/api-docs/synthetics/canary/#state_s3version_java/index.html)StringS3 version ID of your script. **Conflicts with `zipFile`.**[schedule](/content/registry/packages/aws/api-docs/synthetics/canary/#state_schedule_java/index.html)[CanarySchedule](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryschedule/index.html)

Configuration block providing how often the canary is to run and when these test runs are to stop. Detailed below.

The following arguments are optional:

[sourceLocationArn](/content/registry/packages/aws/api-docs/synthetics/canary/#state_sourcelocationarn_java/index.html)StringARN of the Lambda layer where Synthetics stores the canary script code.[startCanary](/content/registry/packages/aws/api-docs/synthetics/canary/#state_startcanary_java/index.html)BooleanWhether to run or stop the canary.[status](/content/registry/packages/aws/api-docs/synthetics/canary/#state_status_java/index.html)StringCanary status.[successRetentionPeriod](/content/registry/packages/aws/api-docs/synthetics/canary/#state_successretentionperiod_java/index.html)IntegerNumber 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.[tags](/content/registry/packages/aws/api-docs/synthetics/canary/#state_tags_java/index.html)Map<String,String>Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.[tagsAll](/content/registry/packages/aws/api-docs/synthetics/canary/#state_tagsall_java/index.html)Map<String,String>A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.[timelines](/content/registry/packages/aws/api-docs/synthetics/canary/#state_timelines_java/index.html)[List<CanaryTimeline>](/content/registry/packages/aws/api-docs/synthetics/canary/#canarytimeline/index.html)Structure that contains information about when the canary was created, modified, and most recently run. see Timeline.[vpcConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#state_vpcconfig_java/index.html)[CanaryVpcConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryvpcconfig/index.html)Configuration block. Detailed below.[zipFile](/content/registry/packages/aws/api-docs/synthetics/canary/#state_zipfile_java/index.html)StringZIP file that contains the script, if you input your canary script directly into the canary instead of referring to an S3 location. It can be up to 225KB. **Conflicts with `s3Bucket`, `s3Key`, and `s3Version`.**

[arn](/content/registry/packages/aws/api-docs/synthetics/canary/#state_arn_nodejs/index.html)stringAmazon Resource Name (ARN) of the Canary.[artifactConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#state_artifactconfig_nodejs/index.html)[CanaryArtifactConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryartifactconfig/index.html)configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See Artifact Config.[artifactS3Location](/content/registry/packages/aws/api-docs/synthetics/canary/#state_artifacts3location_nodejs/index.html)stringLocation in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.[deleteLambda](/content/registry/packages/aws/api-docs/synthetics/canary/#state_deletelambda_nodejs/index.html)booleanSpecifies whether to also delete the Lambda functions and layers used by this canary. The default is `false`.[engineArn](/content/registry/packages/aws/api-docs/synthetics/canary/#state_enginearn_nodejs/index.html)stringARN of the Lambda function that is used as your canary's engine.[executionRoleArn](/content/registry/packages/aws/api-docs/synthetics/canary/#state_executionrolearn_nodejs/index.html)stringARN of the IAM role to be used to run the canary. see [AWS Docs](https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CreateCanary.html#API_CreateCanary_RequestSyntax) for permissions needs for IAM Role.[failureRetentionPeriod](/content/registry/packages/aws/api-docs/synthetics/canary/#state_failureretentionperiod_nodejs/index.html)numberNumber 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.[handler](/content/registry/packages/aws/api-docs/synthetics/canary/#state_handler_nodejs/index.html)stringEntry point to use for the source code when running the canary. This value must end with the string `.handler` .[name](/content/registry/packages/aws/api-docs/synthetics/canary/#state_name_nodejs/index.html)Changes to this property will trigger replacement.stringName for this canary. Has a maximum length of 255 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore.[region](/content/registry/packages/aws/api-docs/synthetics/canary/#state_region_nodejs/index.html)stringRegion where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.[runConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#state_runconfig_nodejs/index.html)[CanaryRunConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryrunconfig/index.html)Configuration block for individual canary runs. Detailed below.[runtimeVersion](/content/registry/packages/aws/api-docs/synthetics/canary/#state_runtimeversion_nodejs/index.html)stringRuntime version to use for the canary. Versions change often so consult the [Amazon CloudWatch documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html) for the latest valid versions. Values include `syn-python-selenium-1.0`, `syn-nodejs-puppeteer-3.0`, `syn-nodejs-2.2`, `syn-nodejs-2.1`, `syn-nodejs-2.0`, and `syn-1.0`.[s3Bucket](/content/registry/packages/aws/api-docs/synthetics/canary/#state_s3bucket_nodejs/index.html)stringFull bucket name which is used if your canary script is located in S3. The bucket must already exist. **Conflicts with `zipFile`.**[s3Key](/content/registry/packages/aws/api-docs/synthetics/canary/#state_s3key_nodejs/index.html)stringS3 key of your script. **Conflicts with `zipFile`.**[s3Version](/content/registry/packages/aws/api-docs/synthetics/canary/#state_s3version_nodejs/index.html)stringS3 version ID of your script. **Conflicts with `zipFile`.**[schedule](/content/registry/packages/aws/api-docs/synthetics/canary/#state_schedule_nodejs/index.html)[CanarySchedule](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryschedule/index.html)

Configuration block providing how often the canary is to run and when these test runs are to stop. Detailed below.

The following arguments are optional:

[sourceLocationArn](/content/registry/packages/aws/api-docs/synthetics/canary/#state_sourcelocationarn_nodejs/index.html)stringARN of the Lambda layer where Synthetics stores the canary script code.[startCanary](/content/registry/packages/aws/api-docs/synthetics/canary/#state_startcanary_nodejs/index.html)booleanWhether to run or stop the canary.[status](/content/registry/packages/aws/api-docs/synthetics/canary/#state_status_nodejs/index.html)stringCanary status.[successRetentionPeriod](/content/registry/packages/aws/api-docs/synthetics/canary/#state_successretentionperiod_nodejs/index.html)numberNumber 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.[tags](/content/registry/packages/aws/api-docs/synthetics/canary/#state_tags_nodejs/index.html){\[key: string\]: string}Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.[tagsAll](/content/registry/packages/aws/api-docs/synthetics/canary/#state_tagsall_nodejs/index.html){\[key: string\]: string}A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.[timelines](/content/registry/packages/aws/api-docs/synthetics/canary/#state_timelines_nodejs/index.html)[CanaryTimeline\[\]](/content/registry/packages/aws/api-docs/synthetics/canary/#canarytimeline/index.html)Structure that contains information about when the canary was created, modified, and most recently run. see Timeline.[vpcConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#state_vpcconfig_nodejs/index.html)[CanaryVpcConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryvpcconfig/index.html)Configuration block. Detailed below.[zipFile](/content/registry/packages/aws/api-docs/synthetics/canary/#state_zipfile_nodejs/index.html)stringZIP file that contains the script, if you input your canary script directly into the canary instead of referring to an S3 location. It can be up to 225KB. **Conflicts with `s3Bucket`, `s3Key`, and `s3Version`.**

[arn](/content/registry/packages/aws/api-docs/synthetics/canary/#state_arn_python/index.html)strAmazon Resource Name (ARN) of the Canary.[artifact\_config](/content/registry/packages/aws/api-docs/synthetics/canary/#state_artifact_config_python/index.html)[CanaryArtifactConfigArgs](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryartifactconfig/index.html)configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See Artifact Config.[artifact\_s3\_location](/content/registry/packages/aws/api-docs/synthetics/canary/#state_artifact_s3_location_python/index.html)strLocation in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.[delete\_lambda](/content/registry/packages/aws/api-docs/synthetics/canary/#state_delete_lambda_python/index.html)boolSpecifies whether to also delete the Lambda functions and layers used by this canary. The default is `false`.[engine\_arn](/content/registry/packages/aws/api-docs/synthetics/canary/#state_engine_arn_python/index.html)strARN of the Lambda function that is used as your canary's engine.[execution\_role\_arn](/content/registry/packages/aws/api-docs/synthetics/canary/#state_execution_role_arn_python/index.html)strARN of the IAM role to be used to run the canary. see [AWS Docs](https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CreateCanary.html#API_CreateCanary_RequestSyntax) for permissions needs for IAM Role.[failure\_retention\_period](/content/registry/packages/aws/api-docs/synthetics/canary/#state_failure_retention_period_python/index.html)intNumber 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.[handler](/content/registry/packages/aws/api-docs/synthetics/canary/#state_handler_python/index.html)strEntry point to use for the source code when running the canary. This value must end with the string `.handler` .[name](/content/registry/packages/aws/api-docs/synthetics/canary/#state_name_python/index.html)Changes to this property will trigger replacement.strName for this canary. Has a maximum length of 255 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore.[region](/content/registry/packages/aws/api-docs/synthetics/canary/#state_region_python/index.html)strRegion where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.[run\_config](/content/registry/packages/aws/api-docs/synthetics/canary/#state_run_config_python/index.html)[CanaryRunConfigArgs](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryrunconfig/index.html)Configuration block for individual canary runs. Detailed below.[runtime\_version](/content/registry/packages/aws/api-docs/synthetics/canary/#state_runtime_version_python/index.html)strRuntime version to use for the canary. Versions change often so consult the [Amazon CloudWatch documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html) for the latest valid versions. Values include `syn-python-selenium-1.0`, `syn-nodejs-puppeteer-3.0`, `syn-nodejs-2.2`, `syn-nodejs-2.1`, `syn-nodejs-2.0`, and `syn-1.0`.[s3\_bucket](/content/registry/packages/aws/api-docs/synthetics/canary/#state_s3_bucket_python/index.html)strFull bucket name which is used if your canary script is located in S3. The bucket must already exist. **Conflicts with `zipFile`.**[s3\_key](/content/registry/packages/aws/api-docs/synthetics/canary/#state_s3_key_python/index.html)strS3 key of your script. **Conflicts with `zipFile`.**[s3\_version](/content/registry/packages/aws/api-docs/synthetics/canary/#state_s3_version_python/index.html)strS3 version ID of your script. **Conflicts with `zipFile`.**[schedule](/content/registry/packages/aws/api-docs/synthetics/canary/#state_schedule_python/index.html)[CanaryScheduleArgs](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryschedule/index.html)

Configuration block providing how often the canary is to run and when these test runs are to stop. Detailed below.

The following arguments are optional:

[source\_location\_arn](/content/registry/packages/aws/api-docs/synthetics/canary/#state_source_location_arn_python/index.html)strARN of the Lambda layer where Synthetics stores the canary script code.[start\_canary](/content/registry/packages/aws/api-docs/synthetics/canary/#state_start_canary_python/index.html)boolWhether to run or stop the canary.[status](/content/registry/packages/aws/api-docs/synthetics/canary/#state_status_python/index.html)strCanary status.[success\_retention\_period](/content/registry/packages/aws/api-docs/synthetics/canary/#state_success_retention_period_python/index.html)intNumber 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.[tags](/content/registry/packages/aws/api-docs/synthetics/canary/#state_tags_python/index.html)Mapping\[str, str\]Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.[tags\_all](/content/registry/packages/aws/api-docs/synthetics/canary/#state_tags_all_python/index.html)Mapping\[str, str\]A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.[timelines](/content/registry/packages/aws/api-docs/synthetics/canary/#state_timelines_python/index.html)[Sequence\[CanaryTimelineArgs\]](/content/registry/packages/aws/api-docs/synthetics/canary/#canarytimeline/index.html)Structure that contains information about when the canary was created, modified, and most recently run. see Timeline.[vpc\_config](/content/registry/packages/aws/api-docs/synthetics/canary/#state_vpc_config_python/index.html)[CanaryVpcConfigArgs](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryvpcconfig/index.html)Configuration block. Detailed below.[zip\_file](/content/registry/packages/aws/api-docs/synthetics/canary/#state_zip_file_python/index.html)strZIP file that contains the script, if you input your canary script directly into the canary instead of referring to an S3 location. It can be up to 225KB. **Conflicts with `s3Bucket`, `s3Key`, and `s3Version`.**

[arn](/content/registry/packages/aws/api-docs/synthetics/canary/#state_arn_yaml/index.html)StringAmazon Resource Name (ARN) of the Canary.[artifactConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#state_artifactconfig_yaml/index.html)[Property Map](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryartifactconfig/index.html)configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See Artifact Config.[artifactS3Location](/content/registry/packages/aws/api-docs/synthetics/canary/#state_artifacts3location_yaml/index.html)StringLocation in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.[deleteLambda](/content/registry/packages/aws/api-docs/synthetics/canary/#state_deletelambda_yaml/index.html)BooleanSpecifies whether to also delete the Lambda functions and layers used by this canary. The default is `false`.[engineArn](/content/registry/packages/aws/api-docs/synthetics/canary/#state_enginearn_yaml/index.html)StringARN of the Lambda function that is used as your canary's engine.[executionRoleArn](/content/registry/packages/aws/api-docs/synthetics/canary/#state_executionrolearn_yaml/index.html)StringARN of the IAM role to be used to run the canary. see [AWS Docs](https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CreateCanary.html#API_CreateCanary_RequestSyntax) for permissions needs for IAM Role.[failureRetentionPeriod](/content/registry/packages/aws/api-docs/synthetics/canary/#state_failureretentionperiod_yaml/index.html)NumberNumber 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.[handler](/content/registry/packages/aws/api-docs/synthetics/canary/#state_handler_yaml/index.html)StringEntry point to use for the source code when running the canary. This value must end with the string `.handler` .[name](/content/registry/packages/aws/api-docs/synthetics/canary/#state_name_yaml/index.html)Changes to this property will trigger replacement.StringName for this canary. Has a maximum length of 255 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore.[region](/content/registry/packages/aws/api-docs/synthetics/canary/#state_region_yaml/index.html)StringRegion where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.[runConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#state_runconfig_yaml/index.html)[Property Map](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryrunconfig/index.html)Configuration block for individual canary runs. Detailed below.[runtimeVersion](/content/registry/packages/aws/api-docs/synthetics/canary/#state_runtimeversion_yaml/index.html)StringRuntime version to use for the canary. Versions change often so consult the [Amazon CloudWatch documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html) for the latest valid versions. Values include `syn-python-selenium-1.0`, `syn-nodejs-puppeteer-3.0`, `syn-nodejs-2.2`, `syn-nodejs-2.1`, `syn-nodejs-2.0`, and `syn-1.0`.[s3Bucket](/content/registry/packages/aws/api-docs/synthetics/canary/#state_s3bucket_yaml/index.html)StringFull bucket name which is used if your canary script is located in S3. The bucket must already exist. **Conflicts with `zipFile`.**[s3Key](/content/registry/packages/aws/api-docs/synthetics/canary/#state_s3key_yaml/index.html)StringS3 key of your script. **Conflicts with `zipFile`.**[s3Version](/content/registry/packages/aws/api-docs/synthetics/canary/#state_s3version_yaml/index.html)StringS3 version ID of your script. **Conflicts with `zipFile`.**[schedule](/content/registry/packages/aws/api-docs/synthetics/canary/#state_schedule_yaml/index.html)[Property Map](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryschedule/index.html)

Configuration block providing how often the canary is to run and when these test runs are to stop. Detailed below.

The following arguments are optional:

[sourceLocationArn](/content/registry/packages/aws/api-docs/synthetics/canary/#state_sourcelocationarn_yaml/index.html)StringARN of the Lambda layer where Synthetics stores the canary script code.[startCanary](/content/registry/packages/aws/api-docs/synthetics/canary/#state_startcanary_yaml/index.html)BooleanWhether to run or stop the canary.[status](/content/registry/packages/aws/api-docs/synthetics/canary/#state_status_yaml/index.html)StringCanary status.[successRetentionPeriod](/content/registry/packages/aws/api-docs/synthetics/canary/#state_successretentionperiod_yaml/index.html)NumberNumber 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.[tags](/content/registry/packages/aws/api-docs/synthetics/canary/#state_tags_yaml/index.html)Map<String>Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.[tagsAll](/content/registry/packages/aws/api-docs/synthetics/canary/#state_tagsall_yaml/index.html)Map<String>A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.[timelines](/content/registry/packages/aws/api-docs/synthetics/canary/#state_timelines_yaml/index.html)[List<Property Map>](/content/registry/packages/aws/api-docs/synthetics/canary/#canarytimeline/index.html)Structure that contains information about when the canary was created, modified, and most recently run. see Timeline.[vpcConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#state_vpcconfig_yaml/index.html)[Property Map](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryvpcconfig/index.html)Configuration block. Detailed below.[zipFile](/content/registry/packages/aws/api-docs/synthetics/canary/#state_zipfile_yaml/index.html)StringZIP file that contains the script, if you input your canary script directly into the canary instead of referring to an S3 location. It can be up to 225KB. **Conflicts with `s3Bucket`, `s3Key`, and `s3Version`.**

## Supporting Types [Anchor](/content/registry/packages/aws/api-docs/synthetics/canary/\#supporting-types/index.html)

#### CanaryArtifactConfig  , CanaryArtifactConfigArgs   [Anchor](/content/registry/packages/aws/api-docs/synthetics/canary/\#canaryartifactconfig/index.html)

[S3Encryption](/content/registry/packages/aws/api-docs/synthetics/canary/#s3encryption_csharp/index.html)[CanaryArtifactConfigS3Encryption](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryartifactconfigs3encryption/index.html)Configuration of the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See S3 Encryption.

[S3Encryption](/content/registry/packages/aws/api-docs/synthetics/canary/#s3encryption_go/index.html)[CanaryArtifactConfigS3Encryption](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryartifactconfigs3encryption/index.html)Configuration of the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See S3 Encryption.

[s3\_encryption](/content/registry/packages/aws/api-docs/synthetics/canary/#s3_encryption_hcl/index.html)[object](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryartifactconfigs3encryption/index.html)Configuration of the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See S3 Encryption.

[s3Encryption](/content/registry/packages/aws/api-docs/synthetics/canary/#s3encryption_java/index.html)[CanaryArtifactConfigS3Encryption](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryartifactconfigs3encryption/index.html)Configuration of the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See S3 Encryption.

[s3Encryption](/content/registry/packages/aws/api-docs/synthetics/canary/#s3encryption_nodejs/index.html)[CanaryArtifactConfigS3Encryption](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryartifactconfigs3encryption/index.html)Configuration of the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See S3 Encryption.

[s3\_encryption](/content/registry/packages/aws/api-docs/synthetics/canary/#s3_encryption_python/index.html)[CanaryArtifactConfigS3Encryption](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryartifactconfigs3encryption/index.html)Configuration of the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See S3 Encryption.

[s3Encryption](/content/registry/packages/aws/api-docs/synthetics/canary/#s3encryption_yaml/index.html)[Property Map](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryartifactconfigs3encryption/index.html)Configuration of the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See S3 Encryption.

#### CanaryArtifactConfigS3Encryption  , CanaryArtifactConfigS3EncryptionArgs   [Anchor](/content/registry/packages/aws/api-docs/synthetics/canary/\#canaryartifactconfigs3encryption/index.html)

[EncryptionMode](/content/registry/packages/aws/api-docs/synthetics/canary/#encryptionmode_csharp/index.html)stringThe encryption method to use for artifacts created by this canary. Valid values are: `SSE_S3` and `SSE_KMS`.[KmsKeyArn](/content/registry/packages/aws/api-docs/synthetics/canary/#kmskeyarn_csharp/index.html)stringThe ARN of the customer-managed KMS key to use, if you specify `SSE_KMS` for `encryptionMode`.

[EncryptionMode](/content/registry/packages/aws/api-docs/synthetics/canary/#encryptionmode_go/index.html)stringThe encryption method to use for artifacts created by this canary. Valid values are: `SSE_S3` and `SSE_KMS`.[KmsKeyArn](/content/registry/packages/aws/api-docs/synthetics/canary/#kmskeyarn_go/index.html)stringThe ARN of the customer-managed KMS key to use, if you specify `SSE_KMS` for `encryptionMode`.

[encryption\_mode](/content/registry/packages/aws/api-docs/synthetics/canary/#encryption_mode_hcl/index.html)stringThe encryption method to use for artifacts created by this canary. Valid values are: `SSE_S3` and `SSE_KMS`.[kms\_key\_arn](/content/registry/packages/aws/api-docs/synthetics/canary/#kms_key_arn_hcl/index.html)stringThe ARN of the customer-managed KMS key to use, if you specify `SSE_KMS` for `encryptionMode`.

[encryptionMode](/content/registry/packages/aws/api-docs/synthetics/canary/#encryptionmode_java/index.html)StringThe encryption method to use for artifacts created by this canary. Valid values are: `SSE_S3` and `SSE_KMS`.[kmsKeyArn](/content/registry/packages/aws/api-docs/synthetics/canary/#kmskeyarn_java/index.html)StringThe ARN of the customer-managed KMS key to use, if you specify `SSE_KMS` for `encryptionMode`.

[encryptionMode](/content/registry/packages/aws/api-docs/synthetics/canary/#encryptionmode_nodejs/index.html)stringThe encryption method to use for artifacts created by this canary. Valid values are: `SSE_S3` and `SSE_KMS`.[kmsKeyArn](/content/registry/packages/aws/api-docs/synthetics/canary/#kmskeyarn_nodejs/index.html)stringThe ARN of the customer-managed KMS key to use, if you specify `SSE_KMS` for `encryptionMode`.

[encryption\_mode](/content/registry/packages/aws/api-docs/synthetics/canary/#encryption_mode_python/index.html)strThe encryption method to use for artifacts created by this canary. Valid values are: `SSE_S3` and `SSE_KMS`.[kms\_key\_arn](/content/registry/packages/aws/api-docs/synthetics/canary/#kms_key_arn_python/index.html)strThe ARN of the customer-managed KMS key to use, if you specify `SSE_KMS` for `encryptionMode`.

[encryptionMode](/content/registry/packages/aws/api-docs/synthetics/canary/#encryptionmode_yaml/index.html)StringThe encryption method to use for artifacts created by this canary. Valid values are: `SSE_S3` and `SSE_KMS`.[kmsKeyArn](/content/registry/packages/aws/api-docs/synthetics/canary/#kmskeyarn_yaml/index.html)StringThe ARN of the customer-managed KMS key to use, if you specify `SSE_KMS` for `encryptionMode`.

#### CanaryRunConfig  , CanaryRunConfigArgs   [Anchor](/content/registry/packages/aws/api-docs/synthetics/canary/\#canaryrunconfig/index.html)

[ActiveTracing](/content/registry/packages/aws/api-docs/synthetics/canary/#activetracing_csharp/index.html)boolWhether this canary is to use active AWS X-Ray tracing when it runs. You can enable active tracing only for canaries that use version syn-nodejs-2.0 or later for their canary runtime.[EnvironmentVariables](/content/registry/packages/aws/api-docs/synthetics/canary/#environmentvariables_csharp/index.html)Dictionary<string, string>Map of environment variables that are accessible from the canary during execution. Please see [AWS Docs](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime) for variables reserved for Lambda.[EphemeralStorage](/content/registry/packages/aws/api-docs/synthetics/canary/#ephemeralstorage_csharp/index.html)intAmount of ephemeral storage (in MB) allocated for the canary run during execution. Defaults to 1024.[MemoryInMb](/content/registry/packages/aws/api-docs/synthetics/canary/#memoryinmb_csharp/index.html)intMaximum amount of memory available to the canary while it is running, in MB. The value you specify must be a multiple of 64.[TimeoutInSeconds](/content/registry/packages/aws/api-docs/synthetics/canary/#timeoutinseconds_csharp/index.html)intNumber of seconds the canary is allowed to run before it must stop. If you omit this field, the frequency of the canary is used, up to a maximum of 840 (14 minutes).

[ActiveTracing](/content/registry/packages/aws/api-docs/synthetics/canary/#activetracing_go/index.html)boolWhether this canary is to use active AWS X-Ray tracing when it runs. You can enable active tracing only for canaries that use version syn-nodejs-2.0 or later for their canary runtime.[EnvironmentVariables](/content/registry/packages/aws/api-docs/synthetics/canary/#environmentvariables_go/index.html)map\[string\]stringMap of environment variables that are accessible from the canary during execution. Please see [AWS Docs](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime) for variables reserved for Lambda.[EphemeralStorage](/content/registry/packages/aws/api-docs/synthetics/canary/#ephemeralstorage_go/index.html)intAmount of ephemeral storage (in MB) allocated for the canary run during execution. Defaults to 1024.[MemoryInMb](/content/registry/packages/aws/api-docs/synthetics/canary/#memoryinmb_go/index.html)intMaximum amount of memory available to the canary while it is running, in MB. The value you specify must be a multiple of 64.[TimeoutInSeconds](/content/registry/packages/aws/api-docs/synthetics/canary/#timeoutinseconds_go/index.html)intNumber of seconds the canary is allowed to run before it must stop. If you omit this field, the frequency of the canary is used, up to a maximum of 840 (14 minutes).

[active\_tracing](/content/registry/packages/aws/api-docs/synthetics/canary/#active_tracing_hcl/index.html)boolWhether this canary is to use active AWS X-Ray tracing when it runs. You can enable active tracing only for canaries that use version syn-nodejs-2.0 or later for their canary runtime.[environment\_variables](/content/registry/packages/aws/api-docs/synthetics/canary/#environment_variables_hcl/index.html)map(string)Map of environment variables that are accessible from the canary during execution. Please see [AWS Docs](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime) for variables reserved for Lambda.[ephemeral\_storage](/content/registry/packages/aws/api-docs/synthetics/canary/#ephemeral_storage_hcl/index.html)numberAmount of ephemeral storage (in MB) allocated for the canary run during execution. Defaults to 1024.[memory\_in\_mb](/content/registry/packages/aws/api-docs/synthetics/canary/#memory_in_mb_hcl/index.html)numberMaximum amount of memory available to the canary while it is running, in MB. The value you specify must be a multiple of 64.[timeout\_in\_seconds](/content/registry/packages/aws/api-docs/synthetics/canary/#timeout_in_seconds_hcl/index.html)numberNumber of seconds the canary is allowed to run before it must stop. If you omit this field, the frequency of the canary is used, up to a maximum of 840 (14 minutes).

[activeTracing](/content/registry/packages/aws/api-docs/synthetics/canary/#activetracing_java/index.html)BooleanWhether this canary is to use active AWS X-Ray tracing when it runs. You can enable active tracing only for canaries that use version syn-nodejs-2.0 or later for their canary runtime.[environmentVariables](/content/registry/packages/aws/api-docs/synthetics/canary/#environmentvariables_java/index.html)Map<String,String>Map of environment variables that are accessible from the canary during execution. Please see [AWS Docs](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime) for variables reserved for Lambda.[ephemeralStorage](/content/registry/packages/aws/api-docs/synthetics/canary/#ephemeralstorage_java/index.html)IntegerAmount of ephemeral storage (in MB) allocated for the canary run during execution. Defaults to 1024.[memoryInMb](/content/registry/packages/aws/api-docs/synthetics/canary/#memoryinmb_java/index.html)IntegerMaximum amount of memory available to the canary while it is running, in MB. The value you specify must be a multiple of 64.[timeoutInSeconds](/content/registry/packages/aws/api-docs/synthetics/canary/#timeoutinseconds_java/index.html)IntegerNumber of seconds the canary is allowed to run before it must stop. If you omit this field, the frequency of the canary is used, up to a maximum of 840 (14 minutes).

[activeTracing](/content/registry/packages/aws/api-docs/synthetics/canary/#activetracing_nodejs/index.html)booleanWhether this canary is to use active AWS X-Ray tracing when it runs. You can enable active tracing only for canaries that use version syn-nodejs-2.0 or later for their canary runtime.[environmentVariables](/content/registry/packages/aws/api-docs/synthetics/canary/#environmentvariables_nodejs/index.html){\[key: string\]: string}Map of environment variables that are accessible from the canary during execution. Please see [AWS Docs](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime) for variables reserved for Lambda.[ephemeralStorage](/content/registry/packages/aws/api-docs/synthetics/canary/#ephemeralstorage_nodejs/index.html)numberAmount of ephemeral storage (in MB) allocated for the canary run during execution. Defaults to 1024.[memoryInMb](/content/registry/packages/aws/api-docs/synthetics/canary/#memoryinmb_nodejs/index.html)numberMaximum amount of memory available to the canary while it is running, in MB. The value you specify must be a multiple of 64.[timeoutInSeconds](/content/registry/packages/aws/api-docs/synthetics/canary/#timeoutinseconds_nodejs/index.html)numberNumber of seconds the canary is allowed to run before it must stop. If you omit this field, the frequency of the canary is used, up to a maximum of 840 (14 minutes).

[active\_tracing](/content/registry/packages/aws/api-docs/synthetics/canary/#active_tracing_python/index.html)boolWhether this canary is to use active AWS X-Ray tracing when it runs. You can enable active tracing only for canaries that use version syn-nodejs-2.0 or later for their canary runtime.[environment\_variables](/content/registry/packages/aws/api-docs/synthetics/canary/#environment_variables_python/index.html)Mapping\[str, str\]Map of environment variables that are accessible from the canary during execution. Please see [AWS Docs](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime) for variables reserved for Lambda.[ephemeral\_storage](/content/registry/packages/aws/api-docs/synthetics/canary/#ephemeral_storage_python/index.html)intAmount of ephemeral storage (in MB) allocated for the canary run during execution. Defaults to 1024.[memory\_in\_mb](/content/registry/packages/aws/api-docs/synthetics/canary/#memory_in_mb_python/index.html)intMaximum amount of memory available to the canary while it is running, in MB. The value you specify must be a multiple of 64.[timeout\_in\_seconds](/content/registry/packages/aws/api-docs/synthetics/canary/#timeout_in_seconds_python/index.html)intNumber of seconds the canary is allowed to run before it must stop. If you omit this field, the frequency of the canary is used, up to a maximum of 840 (14 minutes).

[activeTracing](/content/registry/packages/aws/api-docs/synthetics/canary/#activetracing_yaml/index.html)BooleanWhether this canary is to use active AWS X-Ray tracing when it runs. You can enable active tracing only for canaries that use version syn-nodejs-2.0 or later for their canary runtime.[environmentVariables](/content/registry/packages/aws/api-docs/synthetics/canary/#environmentvariables_yaml/index.html)Map<String>Map of environment variables that are accessible from the canary during execution. Please see [AWS Docs](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime) for variables reserved for Lambda.[ephemeralStorage](/content/registry/packages/aws/api-docs/synthetics/canary/#ephemeralstorage_yaml/index.html)NumberAmount of ephemeral storage (in MB) allocated for the canary run during execution. Defaults to 1024.[memoryInMb](/content/registry/packages/aws/api-docs/synthetics/canary/#memoryinmb_yaml/index.html)NumberMaximum amount of memory available to the canary while it is running, in MB. The value you specify must be a multiple of 64.[timeoutInSeconds](/content/registry/packages/aws/api-docs/synthetics/canary/#timeoutinseconds_yaml/index.html)NumberNumber of seconds the canary is allowed to run before it must stop. If you omit this field, the frequency of the canary is used, up to a maximum of 840 (14 minutes).

#### CanarySchedule  , CanaryScheduleArgs   [Anchor](/content/registry/packages/aws/api-docs/synthetics/canary/\#canaryschedule/index.html)

[Expression](/content/registry/packages/aws/api-docs/synthetics/canary/#expression_csharp/index.html)This property is required.stringRate expression or cron expression that defines how often the canary is to run. For rate expression, the syntax is `rate(number unit)`. _unit_ can be `minute`, `minutes`, or `hour`. For cron expression, the syntax is `cron(expression)`. For more information about the syntax for cron expressions, see [Scheduling canary runs using cron](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html).[DurationInSeconds](/content/registry/packages/aws/api-docs/synthetics/canary/#durationinseconds_csharp/index.html)intDuration in seconds, for the canary to continue making regular runs according to the schedule in the Expression value.[RetryConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#retryconfig_csharp/index.html)[CanaryScheduleRetryConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryscheduleretryconfig/index.html)Configuration block for canary retries. Detailed below.

[Expression](/content/registry/packages/aws/api-docs/synthetics/canary/#expression_go/index.html)This property is required.stringRate expression or cron expression that defines how often the canary is to run. For rate expression, the syntax is `rate(number unit)`. _unit_ can be `minute`, `minutes`, or `hour`. For cron expression, the syntax is `cron(expression)`. For more information about the syntax for cron expressions, see [Scheduling canary runs using cron](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html).[DurationInSeconds](/content/registry/packages/aws/api-docs/synthetics/canary/#durationinseconds_go/index.html)intDuration in seconds, for the canary to continue making regular runs according to the schedule in the Expression value.[RetryConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#retryconfig_go/index.html)[CanaryScheduleRetryConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryscheduleretryconfig/index.html)Configuration block for canary retries. Detailed below.

[expression](/content/registry/packages/aws/api-docs/synthetics/canary/#expression_hcl/index.html)This property is required.stringRate expression or cron expression that defines how often the canary is to run. For rate expression, the syntax is `rate(number unit)`. _unit_ can be `minute`, `minutes`, or `hour`. For cron expression, the syntax is `cron(expression)`. For more information about the syntax for cron expressions, see [Scheduling canary runs using cron](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html).[duration\_in\_seconds](/content/registry/packages/aws/api-docs/synthetics/canary/#duration_in_seconds_hcl/index.html)numberDuration in seconds, for the canary to continue making regular runs according to the schedule in the Expression value.[retry\_config](/content/registry/packages/aws/api-docs/synthetics/canary/#retry_config_hcl/index.html)[object](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryscheduleretryconfig/index.html)Configuration block for canary retries. Detailed below.

[expression](/content/registry/packages/aws/api-docs/synthetics/canary/#expression_java/index.html)This property is required.StringRate expression or cron expression that defines how often the canary is to run. For rate expression, the syntax is `rate(number unit)`. _unit_ can be `minute`, `minutes`, or `hour`. For cron expression, the syntax is `cron(expression)`. For more information about the syntax for cron expressions, see [Scheduling canary runs using cron](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html).[durationInSeconds](/content/registry/packages/aws/api-docs/synthetics/canary/#durationinseconds_java/index.html)IntegerDuration in seconds, for the canary to continue making regular runs according to the schedule in the Expression value.[retryConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#retryconfig_java/index.html)[CanaryScheduleRetryConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryscheduleretryconfig/index.html)Configuration block for canary retries. Detailed below.

[expression](/content/registry/packages/aws/api-docs/synthetics/canary/#expression_nodejs/index.html)This property is required.stringRate expression or cron expression that defines how often the canary is to run. For rate expression, the syntax is `rate(number unit)`. _unit_ can be `minute`, `minutes`, or `hour`. For cron expression, the syntax is `cron(expression)`. For more information about the syntax for cron expressions, see [Scheduling canary runs using cron](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html).[durationInSeconds](/content/registry/packages/aws/api-docs/synthetics/canary/#durationinseconds_nodejs/index.html)numberDuration in seconds, for the canary to continue making regular runs according to the schedule in the Expression value.[retryConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#retryconfig_nodejs/index.html)[CanaryScheduleRetryConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryscheduleretryconfig/index.html)Configuration block for canary retries. Detailed below.

[expression](/content/registry/packages/aws/api-docs/synthetics/canary/#expression_python/index.html)This property is required.strRate expression or cron expression that defines how often the canary is to run. For rate expression, the syntax is `rate(number unit)`. _unit_ can be `minute`, `minutes`, or `hour`. For cron expression, the syntax is `cron(expression)`. For more information about the syntax for cron expressions, see [Scheduling canary runs using cron](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html).[duration\_in\_seconds](/content/registry/packages/aws/api-docs/synthetics/canary/#duration_in_seconds_python/index.html)intDuration in seconds, for the canary to continue making regular runs according to the schedule in the Expression value.[retry\_config](/content/registry/packages/aws/api-docs/synthetics/canary/#retry_config_python/index.html)[CanaryScheduleRetryConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryscheduleretryconfig/index.html)Configuration block for canary retries. Detailed below.

[expression](/content/registry/packages/aws/api-docs/synthetics/canary/#expression_yaml/index.html)This property is required.StringRate expression or cron expression that defines how often the canary is to run. For rate expression, the syntax is `rate(number unit)`. _unit_ can be `minute`, `minutes`, or `hour`. For cron expression, the syntax is `cron(expression)`. For more information about the syntax for cron expressions, see [Scheduling canary runs using cron](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html).[durationInSeconds](/content/registry/packages/aws/api-docs/synthetics/canary/#durationinseconds_yaml/index.html)NumberDuration in seconds, for the canary to continue making regular runs according to the schedule in the Expression value.[retryConfig](/content/registry/packages/aws/api-docs/synthetics/canary/#retryconfig_yaml/index.html)[Property Map](/content/registry/packages/aws/api-docs/synthetics/canary/#canaryscheduleretryconfig/index.html)Configuration block for canary retries. Detailed below.

#### CanaryScheduleRetryConfig  , CanaryScheduleRetryConfigArgs   [Anchor](/content/registry/packages/aws/api-docs/synthetics/canary/\#canaryscheduleretryconfig/index.html)

[MaxRetries](/content/registry/packages/aws/api-docs/synthetics/canary/#maxretries_csharp/index.html)This property is required.intMaximum number of retries. The value must be less than or equal to `2`. If `maxRetries` is `2`, `run_config.timeout_in_seconds` should be less than 600 seconds. Defaults to `0`.

[MaxRetries](/content/registry/packages/aws/api-docs/synthetics/canary/#maxretries_go/index.html)This property is required.intMaximum number of retries. The value must be less than or equal to `2`. If `maxRetries` is `2`, `run_config.timeout_in_seconds` should be less than 600 seconds. Defaults to `0`.

[max\_retries](/content/registry/packages/aws/api-docs/synthetics/canary/#max_retries_hcl/index.html)This property is required.numberMaximum number of retries. The value must be less than or equal to `2`. If `maxRetries` is `2`, `run_config.timeout_in_seconds` should be less than 600 seconds. Defaults to `0`.

[maxRetries](/content/registry/packages/aws/api-docs/synthetics/canary/#maxretries_java/index.html)This property is required.IntegerMaximum number of retries. The value must be less than or equal to `2`. If `maxRetries` is `2`, `run_config.timeout_in_seconds` should be less than 600 seconds. Defaults to `0`.

[maxRetries](/content/registry/packages/aws/api-docs/synthetics/canary/#maxretries_nodejs/index.html)This property is required.numberMaximum number of retries. The value must be less than or equal to `2`. If `maxRetries` is `2`, `run_config.timeout_in_seconds` should be less than 600 seconds. Defaults to `0`.

[max\_retries](/content/registry/packages/aws/api-docs/synthetics/canary/#max_retries_python/index.html)This property is required.intMaximum number of retries. The value must be less than or equal to `2`. If `maxRetries` is `2`, `run_config.timeout_in_seconds` should be less than 600 seconds. Defaults to `0`.

[maxRetries](/content/registry/packages/aws/api-docs/synthetics/canary/#maxretries_yaml/index.html)This property is required.NumberMaximum number of retries. The value must be less than or equal to `2`. If `maxRetries` is `2`, `run_config.timeout_in_seconds` should be less than 600 seconds. Defaults to `0`.

#### CanaryTimeline  , CanaryTimelineArgs   [Anchor](/content/registry/packages/aws/api-docs/synthetics/canary/\#canarytimeline/index.html)

[Created](/content/registry/packages/aws/api-docs/synthetics/canary/#created_csharp/index.html)stringDate and time the canary was created.[LastModified](/content/registry/packages/aws/api-docs/synthetics/canary/#lastmodified_csharp/index.html)stringDate and time the canary was most recently modified.[LastStarted](/content/registry/packages/aws/api-docs/synthetics/canary/#laststarted_csharp/index.html)stringDate and time that the canary's most recent run started.[LastStopped](/content/registry/packages/aws/api-docs/synthetics/canary/#laststopped_csharp/index.html)stringDate and time that the canary's most recent run ended.

[Created](/content/registry/packages/aws/api-docs/synthetics/canary/#created_go/index.html)stringDate and time the canary was created.[LastModified](/content/registry/packages/aws/api-docs/synthetics/canary/#lastmodified_go/index.html)stringDate and time the canary was most recently modified.[LastStarted](/content/registry/packages/aws/api-docs/synthetics/canary/#laststarted_go/index.html)stringDate and time that the canary's most recent run started.[LastStopped](/content/registry/packages/aws/api-docs/synthetics/canary/#laststopped_go/index.html)stringDate and time that the canary's most recent run ended.

[created](/content/registry/packages/aws/api-docs/synthetics/canary/#created_hcl/index.html)stringDate and time the canary was created.[last\_modified](/content/registry/packages/aws/api-docs/synthetics/canary/#last_modified_hcl/index.html)stringDate and time the canary was most recently modified.[last\_started](/content/registry/packages/aws/api-docs/synthetics/canary/#last_started_hcl/index.html)stringDate and time that the canary's most recent run started.[last\_stopped](/content/registry/packages/aws/api-docs/synthetics/canary/#last_stopped_hcl/index.html)stringDate and time that the canary's most recent run ended.

[created](/content/registry/packages/aws/api-docs/synthetics/canary/#created_java/index.html)StringDate and time the canary was created.[lastModified](/content/registry/packages/aws/api-docs/synthetics/canary/#lastmodified_java/index.html)StringDate and time the canary was most recently modified.[lastStarted](/content/registry/packages/aws/api-docs/synthetics/canary/#laststarted_java/index.html)StringDate and time that the canary's most recent run started.[lastStopped](/content/registry/packages/aws/api-docs/synthetics/canary/#laststopped_java/index.html)StringDate and time that the canary's most recent run ended.

[created](/content/registry/packages/aws/api-docs/synthetics/canary/#created_nodejs/index.html)stringDate and time the canary was created.[lastModified](/content/registry/packages/aws/api-docs/synthetics/canary/#lastmodified_nodejs/index.html)stringDate and time the canary was most recently modified.[lastStarted](/content/registry/packages/aws/api-docs/synthetics/canary/#laststarted_nodejs/index.html)stringDate and time that the canary's most recent run started.[lastStopped](/content/registry/packages/aws/api-docs/synthetics/canary/#laststopped_nodejs/index.html)stringDate and time that the canary's most recent run ended.

[created](/content/registry/packages/aws/api-docs/synthetics/canary/#created_python/index.html)strDate and time the canary was created.[last\_modified](/content/registry/packages/aws/api-docs/synthetics/canary/#last_modified_python/index.html)strDate and time the canary was most recently modified.[last\_started](/content/registry/packages/aws/api-docs/synthetics/canary/#last_started_python/index.html)strDate and time that the canary's most recent run started.[last\_stopped](/content/registry/packages/aws/api-docs/synthetics/canary/#last_stopped_python/index.html)strDate and time that the canary's most recent run ended.

[created](/content/registry/packages/aws/api-docs/synthetics/canary/#created_yaml/index.html)StringDate and time the canary was created.[lastModified](/content/registry/packages/aws/api-docs/synthetics/canary/#lastmodified_yaml/index.html)StringDate and time the canary was most recently modified.[lastStarted](/content/registry/packages/aws/api-docs/synthetics/canary/#laststarted_yaml/index.html)StringDate and time that the canary's most recent run started.[lastStopped](/content/registry/packages/aws/api-docs/synthetics/canary/#laststopped_yaml/index.html)StringDate and time that the canary's most recent run ended.

#### CanaryVpcConfig  , CanaryVpcConfigArgs   [Anchor](/content/registry/packages/aws/api-docs/synthetics/canary/\#canaryvpcconfig/index.html)

[Ipv6AllowedForDualStack](/content/registry/packages/aws/api-docs/synthetics/canary/#ipv6allowedfordualstack_csharp/index.html)boolIf `true`, allow outbound IPv6 traffic on VPC canaries that are connected to dual-stack subnets. The default is `false`.[SecurityGroupIds](/content/registry/packages/aws/api-docs/synthetics/canary/#securitygroupids_csharp/index.html)List<string>IDs of the security groups for this canary.[SubnetIds](/content/registry/packages/aws/api-docs/synthetics/canary/#subnetids_csharp/index.html)List<string>IDs of the subnets where this canary is to run.[VpcId](/content/registry/packages/aws/api-docs/synthetics/canary/#vpcid_csharp/index.html)stringID of the VPC where this canary is to run.

[Ipv6AllowedForDualStack](/content/registry/packages/aws/api-docs/synthetics/canary/#ipv6allowedfordualstack_go/index.html)boolIf `true`, allow outbound IPv6 traffic on VPC canaries that are connected to dual-stack subnets. The default is `false`.[SecurityGroupIds](/content/registry/packages/aws/api-docs/synthetics/canary/#securitygroupids_go/index.html)\[\]stringIDs of the security groups for this canary.[SubnetIds](/content/registry/packages/aws/api-docs/synthetics/canary/#subnetids_go/index.html)\[\]stringIDs of the subnets where this canary is to run.[VpcId](/content/registry/packages/aws/api-docs/synthetics/canary/#vpcid_go/index.html)stringID of the VPC where this canary is to run.

[ipv6\_allowed\_for\_dual\_stack](/content/registry/packages/aws/api-docs/synthetics/canary/#ipv6_allowed_for_dual_stack_hcl/index.html)boolIf `true`, allow outbound IPv6 traffic on VPC canaries that are connected to dual-stack subnets. The default is `false`.[security\_group\_ids](/content/registry/packages/aws/api-docs/synthetics/canary/#security_group_ids_hcl/index.html)list(string)IDs of the security groups for this canary.[subnet\_ids](/content/registry/packages/aws/api-docs/synthetics/canary/#subnet_ids_hcl/index.html)list(string)IDs of the subnets where this canary is to run.[vpc\_id](/content/registry/packages/aws/api-docs/synthetics/canary/#vpc_id_hcl/index.html)stringID of the VPC where this canary is to run.

[ipv6AllowedForDualStack](/content/registry/packages/aws/api-docs/synthetics/canary/#ipv6allowedfordualstack_java/index.html)BooleanIf `true`, allow outbound IPv6 traffic on VPC canaries that are connected to dual-stack subnets. The default is `false`.[securityGroupIds](/content/registry/packages/aws/api-docs/synthetics/canary/#securitygroupids_java/index.html)List<String>IDs of the security groups for this canary.[subnetIds](/content/registry/packages/aws/api-docs/synthetics/canary/#subnetids_java/index.html)List<String>IDs of the subnets where this canary is to run.[vpcId](/content/registry/packages/aws/api-docs/synthetics/canary/#vpcid_java/index.html)StringID of the VPC where this canary is to run.

[ipv6AllowedForDualStack](/content/registry/packages/aws/api-docs/synthetics/canary/#ipv6allowedfordualstack_nodejs/index.html)booleanIf `true`, allow outbound IPv6 traffic on VPC canaries that are connected to dual-stack subnets. The default is `false`.[securityGroupIds](/content/registry/packages/aws/api-docs/synthetics/canary/#securitygroupids_nodejs/index.html)string\[\]IDs of the security groups for this canary.[subnetIds](/content/registry/packages/aws/api-docs/synthetics/canary/#subnetids_nodejs/index.html)string\[\]IDs of the subnets where this canary is to run.[vpcId](/content/registry/packages/aws/api-docs/synthetics/canary/#vpcid_nodejs/index.html)stringID of the VPC where this canary is to run.

[ipv6\_allowed\_for\_dual\_stack](/content/registry/packages/aws/api-docs/synthetics/canary/#ipv6_allowed_for_dual_stack_python/index.html)boolIf `true`, allow outbound IPv6 traffic on VPC canaries that are connected to dual-stack subnets. The default is `false`.[security\_group\_ids](/content/registry/packages/aws/api-docs/synthetics/canary/#security_group_ids_python/index.html)Sequence\[str\]IDs of the security groups for this canary.[subnet\_ids](/content/registry/packages/aws/api-docs/synthetics/canary/#subnet_ids_python/index.html)Sequence\[str\]IDs of the subnets where this canary is to run.[vpc\_id](/content/registry/packages/aws/api-docs/synthetics/canary/#vpc_id_python/index.html)strID of the VPC where this canary is to run.

[ipv6AllowedForDualStack](/content/registry/packages/aws/api-docs/synthetics/canary/#ipv6allowedfordualstack_yaml/index.html)BooleanIf `true`, allow outbound IPv6 traffic on VPC canaries that are connected to dual-stack subnets. The default is `false`.[securityGroupIds](/content/registry/packages/aws/api-docs/synthetics/canary/#securitygroupids_yaml/index.html)List<String>IDs of the security groups for this canary.[subnetIds](/content/registry/packages/aws/api-docs/synthetics/canary/#subnetids_yaml/index.html)List<String>IDs of the subnets where this canary is to run.[vpcId](/content/registry/packages/aws/api-docs/synthetics/canary/#vpcid_yaml/index.html)StringID of the VPC where this canary is to run.

## Import [Anchor](/content/registry/packages/aws/api-docs/synthetics/canary/\#import/index.html)

Using `pulumi import`, import Synthetics Canaries using the `name`. For example:

```sh
$ pulumi import aws:synthetics/canary:Canary some some-canary
```

Copy

To learn more about importing existing cloud resources, see [Importing resources](/content/docs/using-pulumi/adopting-pulumi/import/index.html).

## Package Details [Anchor](/content/registry/packages/aws/api-docs/synthetics/canary/\#package-details/index.html)

Viewing docs for AWS v7.32.0

published on Friday, May 29, 2026 by Pulumi

[Schema (JSON)](/content/registry/packages/aws/schema.json)

[pulumi/pulumi-aws](https://github.com/pulumi/pulumi-aws)

v7.32.0 (7.x, latest)v6.83.1 (6.x)v5.43.0 (5.x)

## On this page

## On this page

* * *

Related Resources

[iam.Role](/content/registry/packages/aws/api-docs/iam/role/index.html)

[s3.Bucket](/content/registry/packages/aws/api-docs/s3/bucket/index.html)

[s3.BucketObjectv2](/content/registry/packages/aws/api-docs/s3/bucketobjectv2/index.html)

[s3.BucketV2](/content/registry/packages/aws/api-docs/s3/bucketv2/index.html)

- Copy Page

[Scroll to top](/content/registry/packages/aws/api-docs/synthetics/canary/# "Scroll to top"/index.html)

#### Try Pulumi Cloud free.  Your team will thank you.

[Start free trial](https://app.pulumi.com/signup?utm_source=registry&utm_medium=right-rail-banner&utm_campaign=try-pulumi-cloud&iaid=docs-try-pulumi-cloud-ad)