AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.11.0 published on Wednesday, Aug 17, 2022 by Pulumi

Canary

Provides a Synthetics Canary resource.

NOTE: When you create a canary, AWS creates supporting implicit resources. See the Amazon CloudWatch Synthetics documentation on DeleteCanary 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

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

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

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/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{
			ArtifactS3Location: pulumi.String("s3://some-bucket/"),
			ExecutionRoleArn:   pulumi.String("some-role"),
			Handler:            pulumi.String("exports.handler"),
			RuntimeVersion:     pulumi.String("syn-1.0"),
			Schedule: &synthetics.CanaryScheduleArgs{
				Expression: pulumi.String("rate(0 minute)"),
			},
			ZipFile: pulumi.String("test-fixtures/lambdatest.zip"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
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.List;
import java.util.ArrayList;
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()        
            .artifactS3Location("s3://some-bucket/")
            .executionRoleArn("some-role")
            .handler("exports.handler")
            .runtimeVersion("syn-1.0")
            .schedule(CanaryScheduleArgs.builder()
                .expression("rate(0 minute)")
                .build())
            .zipFile("test-fixtures/lambdatest.zip")
            .build());

    }
}
import pulumi
import pulumi_aws as aws

some = aws.synthetics.Canary("some",
    artifact_s3_location="s3://some-bucket/",
    execution_role_arn="some-role",
    handler="exports.handler",
    runtime_version="syn-1.0",
    schedule=aws.synthetics.CanaryScheduleArgs(
        expression="rate(0 minute)",
    ),
    zip_file="test-fixtures/lambdatest.zip")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

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

Create a Canary Resource

new Canary(name: string, args: CanaryArgs, opts?: CustomResourceOptions);
@overload
def Canary(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           artifact_config: Optional[CanaryArtifactConfigArgs] = None,
           artifact_s3_location: Optional[str] = None,
           delete_lambda: Optional[bool] = None,
           execution_role_arn: Optional[str] = None,
           failure_retention_period: Optional[int] = None,
           handler: Optional[str] = None,
           name: 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,
           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)
@overload
def Canary(resource_name: str,
           args: CanaryArgs,
           opts: Optional[ResourceOptions] = None)
func NewCanary(ctx *Context, name string, args CanaryArgs, opts ...ResourceOption) (*Canary, error)
public Canary(string name, CanaryArgs args, CustomResourceOptions? opts = null)
public Canary(String name, CanaryArgs args)
public Canary(String name, CanaryArgs args, CustomResourceOptions options)
type: aws:synthetics:Canary
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args CanaryArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args CanaryArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args CanaryArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args CanaryArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args CanaryArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Canary Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Canary resource accepts the following input properties:

ArtifactS3Location string

Location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.

ExecutionRoleArn string

ARN of the IAM role to be used to run the canary. see AWS Docs for permissions needs for IAM Role.

Handler string

Entry point to use for the source code when running the canary. This value must end with the string .handler .

RuntimeVersion string

Runtime version to use for the canary. Versions change often so consult the Amazon CloudWatch documentation 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 CanaryScheduleArgs

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

ArtifactConfig CanaryArtifactConfigArgs

configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See Artifact Config.

DeleteLambda bool

Specifies whether to also delete the Lambda functions and layers used by this canary. The default is false.

FailureRetentionPeriod int

Number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

Name string

Name for this canary. Has a maximum length of 21 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore.

RunConfig CanaryRunConfigArgs

Configuration block for individual canary runs. Detailed below.

S3Bucket string

Full bucket name which is used if your canary script is located in S3. The bucket must already exist. Specify the full bucket name including s3:// as the start of the bucket name. Conflicts with zip_file.

S3Key string

S3 key of your script. Conflicts with zip_file.

S3Version string

S3 version ID of your script. Conflicts with zip_file.

StartCanary bool

Whether to run or stop the canary.

SuccessRetentionPeriod int

Number of days to retain data about successful runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

Tags Dictionary<string, string>

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

VpcConfig CanaryVpcConfigArgs

Configuration block. Detailed below.

ZipFile string

ZIP 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 5 MB. Conflicts with s3_bucket, s3_key, and s3_version.

ArtifactS3Location string

Location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.

ExecutionRoleArn string

ARN of the IAM role to be used to run the canary. see AWS Docs for permissions needs for IAM Role.

Handler string

Entry point to use for the source code when running the canary. This value must end with the string .handler .

RuntimeVersion string

Runtime version to use for the canary. Versions change often so consult the Amazon CloudWatch documentation 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 CanaryScheduleArgs

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

ArtifactConfig CanaryArtifactConfigArgs

configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See Artifact Config.

DeleteLambda bool

Specifies whether to also delete the Lambda functions and layers used by this canary. The default is false.

FailureRetentionPeriod int

Number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

Name string

Name for this canary. Has a maximum length of 21 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore.

RunConfig CanaryRunConfigArgs

Configuration block for individual canary runs. Detailed below.

S3Bucket string

Full bucket name which is used if your canary script is located in S3. The bucket must already exist. Specify the full bucket name including s3:// as the start of the bucket name. Conflicts with zip_file.

S3Key string

S3 key of your script. Conflicts with zip_file.

S3Version string

S3 version ID of your script. Conflicts with zip_file.

StartCanary bool

Whether to run or stop the canary.

SuccessRetentionPeriod int

Number of days to retain data about successful runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

Tags map[string]string

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

VpcConfig CanaryVpcConfigArgs

Configuration block. Detailed below.

ZipFile string

ZIP 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 5 MB. Conflicts with s3_bucket, s3_key, and s3_version.

artifactS3Location String

Location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.

executionRoleArn String

ARN of the IAM role to be used to run the canary. see AWS Docs for permissions needs for IAM Role.

handler String

Entry point to use for the source code when running the canary. This value must end with the string .handler .

runtimeVersion String

Runtime version to use for the canary. Versions change often so consult the Amazon CloudWatch documentation 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 CanaryScheduleArgs

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

artifactConfig CanaryArtifactConfigArgs

configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See Artifact Config.

deleteLambda Boolean

Specifies whether to also delete the Lambda functions and layers used by this canary. The default is false.

failureRetentionPeriod Integer

Number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

name String

Name for this canary. Has a maximum length of 21 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore.

runConfig CanaryRunConfigArgs

Configuration block for individual canary runs. Detailed below.

s3Bucket String

Full bucket name which is used if your canary script is located in S3. The bucket must already exist. Specify the full bucket name including s3:// as the start of the bucket name. Conflicts with zip_file.

s3Key String

S3 key of your script. Conflicts with zip_file.

s3Version String

S3 version ID of your script. Conflicts with zip_file.

startCanary Boolean

Whether to run or stop the canary.

successRetentionPeriod Integer

Number of days to retain data about successful runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

tags Map<String,String>

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

vpcConfig CanaryVpcConfigArgs

Configuration block. Detailed below.

zipFile String

ZIP 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 5 MB. Conflicts with s3_bucket, s3_key, and s3_version.

artifactS3Location string

Location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.

executionRoleArn string

ARN of the IAM role to be used to run the canary. see AWS Docs for permissions needs for IAM Role.

handler string

Entry point to use for the source code when running the canary. This value must end with the string .handler .

runtimeVersion string

Runtime version to use for the canary. Versions change often so consult the Amazon CloudWatch documentation 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 CanaryScheduleArgs

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

artifactConfig CanaryArtifactConfigArgs

configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See Artifact Config.

deleteLambda boolean

Specifies whether to also delete the Lambda functions and layers used by this canary. The default is false.

failureRetentionPeriod number

Number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

name string

Name for this canary. Has a maximum length of 21 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore.

runConfig CanaryRunConfigArgs

Configuration block for individual canary runs. Detailed below.

s3Bucket string

Full bucket name which is used if your canary script is located in S3. The bucket must already exist. Specify the full bucket name including s3:// as the start of the bucket name. Conflicts with zip_file.

s3Key string

S3 key of your script. Conflicts with zip_file.

s3Version string

S3 version ID of your script. Conflicts with zip_file.

startCanary boolean

Whether to run or stop the canary.

successRetentionPeriod number

Number of days to retain data about successful runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

tags {[key: string]: string}

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

vpcConfig CanaryVpcConfigArgs

Configuration block. Detailed below.

zipFile string

ZIP 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 5 MB. Conflicts with s3_bucket, s3_key, and s3_version.

artifact_s3_location str

Location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.

execution_role_arn str

ARN of the IAM role to be used to run the canary. see AWS Docs for permissions needs for IAM Role.

handler str

Entry point to use for the source code when running the canary. This value must end with the string .handler .

runtime_version str

Runtime version to use for the canary. Versions change often so consult the Amazon CloudWatch documentation 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 CanaryScheduleArgs

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

artifact_config CanaryArtifactConfigArgs

configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See Artifact Config.

delete_lambda bool

Specifies whether to also delete the Lambda functions and layers used by this canary. The default is false.

failure_retention_period int

Number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

name str

Name for this canary. Has a maximum length of 21 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore.

run_config CanaryRunConfigArgs

Configuration block for individual canary runs. Detailed below.

s3_bucket str

Full bucket name which is used if your canary script is located in S3. The bucket must already exist. Specify the full bucket name including s3:// as the start of the bucket name. Conflicts with zip_file.

s3_key str

S3 key of your script. Conflicts with zip_file.

s3_version str

S3 version ID of your script. Conflicts with zip_file.

start_canary bool

Whether to run or stop the canary.

success_retention_period int

Number of days to retain data about successful runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

tags Mapping[str, str]

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

vpc_config CanaryVpcConfigArgs

Configuration block. Detailed below.

zip_file str

ZIP 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 5 MB. Conflicts with s3_bucket, s3_key, and s3_version.

artifactS3Location String

Location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.

executionRoleArn String

ARN of the IAM role to be used to run the canary. see AWS Docs for permissions needs for IAM Role.

handler String

Entry point to use for the source code when running the canary. This value must end with the string .handler .

runtimeVersion String

Runtime version to use for the canary. Versions change often so consult the Amazon CloudWatch documentation 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 Property Map

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

artifactConfig Property Map

configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See Artifact Config.

deleteLambda Boolean

Specifies whether to also delete the Lambda functions and layers used by this canary. The default is false.

failureRetentionPeriod Number

Number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

name String

Name for this canary. Has a maximum length of 21 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore.

runConfig Property Map

Configuration block for individual canary runs. Detailed below.

s3Bucket String

Full bucket name which is used if your canary script is located in S3. The bucket must already exist. Specify the full bucket name including s3:// as the start of the bucket name. Conflicts with zip_file.

s3Key String

S3 key of your script. Conflicts with zip_file.

s3Version String

S3 version ID of your script. Conflicts with zip_file.

startCanary Boolean

Whether to run or stop the canary.

successRetentionPeriod Number

Number of days to retain data about successful runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

tags Map<String>

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

vpcConfig Property Map

Configuration block. Detailed below.

zipFile String

ZIP 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 5 MB. Conflicts with s3_bucket, s3_key, and s3_version.

Outputs

All input properties are implicitly available as output properties. Additionally, the Canary resource produces the following output properties:

Arn string

Amazon Resource Name (ARN) of the Canary.

EngineArn string

ARN of the Lambda function that is used as your canary's engine.

Id string

The provider-assigned unique ID for this managed resource.

SourceLocationArn string

ARN of the Lambda layer where Synthetics stores the canary script code.

Status string

Canary status.

TagsAll Dictionary<string, string>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Timelines List<CanaryTimeline>

Structure that contains information about when the canary was created, modified, and most recently run. see Timeline.

Arn string

Amazon Resource Name (ARN) of the Canary.

EngineArn string

ARN of the Lambda function that is used as your canary's engine.

Id string

The provider-assigned unique ID for this managed resource.

SourceLocationArn string

ARN of the Lambda layer where Synthetics stores the canary script code.

Status string

Canary status.

TagsAll map[string]string

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Timelines []CanaryTimeline

Structure that contains information about when the canary was created, modified, and most recently run. see Timeline.

arn String

Amazon Resource Name (ARN) of the Canary.

engineArn String

ARN of the Lambda function that is used as your canary's engine.

id String

The provider-assigned unique ID for this managed resource.

sourceLocationArn String

ARN of the Lambda layer where Synthetics stores the canary script code.

status String

Canary status.

tagsAll Map<String,String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

timelines List<CanaryTimeline>

Structure that contains information about when the canary was created, modified, and most recently run. see Timeline.

arn string

Amazon Resource Name (ARN) of the Canary.

engineArn string

ARN of the Lambda function that is used as your canary's engine.

id string

The provider-assigned unique ID for this managed resource.

sourceLocationArn string

ARN of the Lambda layer where Synthetics stores the canary script code.

status string

Canary status.

tagsAll {[key: string]: string}

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

timelines CanaryTimeline[]

Structure that contains information about when the canary was created, modified, and most recently run. see Timeline.

arn str

Amazon Resource Name (ARN) of the Canary.

engine_arn str

ARN of the Lambda function that is used as your canary's engine.

id str

The provider-assigned unique ID for this managed resource.

source_location_arn str

ARN of the Lambda layer where Synthetics stores the canary script code.

status str

Canary status.

tags_all Mapping[str, str]

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

timelines Sequence[CanaryTimeline]

Structure that contains information about when the canary was created, modified, and most recently run. see Timeline.

arn String

Amazon Resource Name (ARN) of the Canary.

engineArn String

ARN of the Lambda function that is used as your canary's engine.

id String

The provider-assigned unique ID for this managed resource.

sourceLocationArn String

ARN of the Lambda layer where Synthetics stores the canary script code.

status String

Canary status.

tagsAll Map<String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

timelines List<Property Map>

Structure that contains information about when the canary was created, modified, and most recently run. see Timeline.

Look up an Existing Canary Resource

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

public static get(name: string, id: Input<ID>, state?: CanaryState, opts?: CustomResourceOptions): Canary
@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,
        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
func GetCanary(ctx *Context, name string, id IDInput, state *CanaryState, opts ...ResourceOption) (*Canary, error)
public static Canary Get(string name, Input<string> id, CanaryState? state, CustomResourceOptions? opts = null)
public static Canary get(String name, Output<String> id, CanaryState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Arn string

Amazon Resource Name (ARN) of the Canary.

ArtifactConfig CanaryArtifactConfigArgs

configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See Artifact Config.

ArtifactS3Location string

Location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.

DeleteLambda bool

Specifies whether to also delete the Lambda functions and layers used by this canary. The default is false.

EngineArn string

ARN of the Lambda function that is used as your canary's engine.

ExecutionRoleArn string

ARN of the IAM role to be used to run the canary. see AWS Docs for permissions needs for IAM Role.

FailureRetentionPeriod int

Number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

Handler string

Entry point to use for the source code when running the canary. This value must end with the string .handler .

Name string

Name for this canary. Has a maximum length of 21 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore.

RunConfig CanaryRunConfigArgs

Configuration block for individual canary runs. Detailed below.

RuntimeVersion string

Runtime version to use for the canary. Versions change often so consult the Amazon CloudWatch documentation 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 string

Full bucket name which is used if your canary script is located in S3. The bucket must already exist. Specify the full bucket name including s3:// as the start of the bucket name. Conflicts with zip_file.

S3Key string

S3 key of your script. Conflicts with zip_file.

S3Version string

S3 version ID of your script. Conflicts with zip_file.

Schedule CanaryScheduleArgs

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

SourceLocationArn string

ARN of the Lambda layer where Synthetics stores the canary script code.

StartCanary bool

Whether to run or stop the canary.

Status string

Canary status.

SuccessRetentionPeriod int

Number of days to retain data about successful runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

Tags Dictionary<string, string>

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TagsAll Dictionary<string, string>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Timelines List<CanaryTimelineArgs>

Structure that contains information about when the canary was created, modified, and most recently run. see Timeline.

VpcConfig CanaryVpcConfigArgs

Configuration block. Detailed below.

ZipFile string

ZIP 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 5 MB. Conflicts with s3_bucket, s3_key, and s3_version.

Arn string

Amazon Resource Name (ARN) of the Canary.

ArtifactConfig CanaryArtifactConfigArgs

configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See Artifact Config.

ArtifactS3Location string

Location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.

DeleteLambda bool

Specifies whether to also delete the Lambda functions and layers used by this canary. The default is false.

EngineArn string

ARN of the Lambda function that is used as your canary's engine.

ExecutionRoleArn string

ARN of the IAM role to be used to run the canary. see AWS Docs for permissions needs for IAM Role.

FailureRetentionPeriod int

Number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

Handler string

Entry point to use for the source code when running the canary. This value must end with the string .handler .

Name string

Name for this canary. Has a maximum length of 21 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore.

RunConfig CanaryRunConfigArgs

Configuration block for individual canary runs. Detailed below.

RuntimeVersion string

Runtime version to use for the canary. Versions change often so consult the Amazon CloudWatch documentation 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 string

Full bucket name which is used if your canary script is located in S3. The bucket must already exist. Specify the full bucket name including s3:// as the start of the bucket name. Conflicts with zip_file.

S3Key string

S3 key of your script. Conflicts with zip_file.

S3Version string

S3 version ID of your script. Conflicts with zip_file.

Schedule CanaryScheduleArgs

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

SourceLocationArn string

ARN of the Lambda layer where Synthetics stores the canary script code.

StartCanary bool

Whether to run or stop the canary.

Status string

Canary status.

SuccessRetentionPeriod int

Number of days to retain data about successful runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

Tags map[string]string

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TagsAll map[string]string

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Timelines []CanaryTimelineArgs

Structure that contains information about when the canary was created, modified, and most recently run. see Timeline.

VpcConfig CanaryVpcConfigArgs

Configuration block. Detailed below.

ZipFile string

ZIP 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 5 MB. Conflicts with s3_bucket, s3_key, and s3_version.

arn String

Amazon Resource Name (ARN) of the Canary.

artifactConfig CanaryArtifactConfigArgs

configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See Artifact Config.

artifactS3Location String

Location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.

deleteLambda Boolean

Specifies whether to also delete the Lambda functions and layers used by this canary. The default is false.

engineArn String

ARN of the Lambda function that is used as your canary's engine.

executionRoleArn String

ARN of the IAM role to be used to run the canary. see AWS Docs for permissions needs for IAM Role.

failureRetentionPeriod Integer

Number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

handler String

Entry point to use for the source code when running the canary. This value must end with the string .handler .

name String

Name for this canary. Has a maximum length of 21 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore.

runConfig CanaryRunConfigArgs

Configuration block for individual canary runs. Detailed below.

runtimeVersion String

Runtime version to use for the canary. Versions change often so consult the Amazon CloudWatch documentation 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 String

Full bucket name which is used if your canary script is located in S3. The bucket must already exist. Specify the full bucket name including s3:// as the start of the bucket name. Conflicts with zip_file.

s3Key String

S3 key of your script. Conflicts with zip_file.

s3Version String

S3 version ID of your script. Conflicts with zip_file.

schedule CanaryScheduleArgs

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

sourceLocationArn String

ARN of the Lambda layer where Synthetics stores the canary script code.

startCanary Boolean

Whether to run or stop the canary.

status String

Canary status.

successRetentionPeriod Integer

Number of days to retain data about successful runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

tags Map<String,String>

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll Map<String,String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

timelines List<CanaryTimelineArgs>

Structure that contains information about when the canary was created, modified, and most recently run. see Timeline.

vpcConfig CanaryVpcConfigArgs

Configuration block. Detailed below.

zipFile String

ZIP 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 5 MB. Conflicts with s3_bucket, s3_key, and s3_version.

arn string

Amazon Resource Name (ARN) of the Canary.

artifactConfig CanaryArtifactConfigArgs

configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See Artifact Config.

artifactS3Location string

Location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.

deleteLambda boolean

Specifies whether to also delete the Lambda functions and layers used by this canary. The default is false.

engineArn string

ARN of the Lambda function that is used as your canary's engine.

executionRoleArn string

ARN of the IAM role to be used to run the canary. see AWS Docs for permissions needs for IAM Role.

failureRetentionPeriod number

Number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

handler string

Entry point to use for the source code when running the canary. This value must end with the string .handler .

name string

Name for this canary. Has a maximum length of 21 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore.

runConfig CanaryRunConfigArgs

Configuration block for individual canary runs. Detailed below.

runtimeVersion string

Runtime version to use for the canary. Versions change often so consult the Amazon CloudWatch documentation 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 string

Full bucket name which is used if your canary script is located in S3. The bucket must already exist. Specify the full bucket name including s3:// as the start of the bucket name. Conflicts with zip_file.

s3Key string

S3 key of your script. Conflicts with zip_file.

s3Version string

S3 version ID of your script. Conflicts with zip_file.

schedule CanaryScheduleArgs

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

sourceLocationArn string

ARN of the Lambda layer where Synthetics stores the canary script code.

startCanary boolean

Whether to run or stop the canary.

status string

Canary status.

successRetentionPeriod number

Number of days to retain data about successful runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

tags {[key: string]: string}

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll {[key: string]: string}

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

timelines CanaryTimelineArgs[]

Structure that contains information about when the canary was created, modified, and most recently run. see Timeline.

vpcConfig CanaryVpcConfigArgs

Configuration block. Detailed below.

zipFile string

ZIP 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 5 MB. Conflicts with s3_bucket, s3_key, and s3_version.

arn str

Amazon Resource Name (ARN) of the Canary.

artifact_config CanaryArtifactConfigArgs

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 str

Location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.

delete_lambda bool

Specifies whether to also delete the Lambda functions and layers used by this canary. The default is false.

engine_arn str

ARN of the Lambda function that is used as your canary's engine.

execution_role_arn str

ARN of the IAM role to be used to run the canary. see AWS Docs for permissions needs for IAM Role.

failure_retention_period int

Number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

handler str

Entry point to use for the source code when running the canary. This value must end with the string .handler .

name str

Name for this canary. Has a maximum length of 21 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore.

run_config CanaryRunConfigArgs

Configuration block for individual canary runs. Detailed below.

runtime_version str

Runtime version to use for the canary. Versions change often so consult the Amazon CloudWatch documentation 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 str

Full bucket name which is used if your canary script is located in S3. The bucket must already exist. Specify the full bucket name including s3:// as the start of the bucket name. Conflicts with zip_file.

s3_key str

S3 key of your script. Conflicts with zip_file.

s3_version str

S3 version ID of your script. Conflicts with zip_file.

schedule CanaryScheduleArgs

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

source_location_arn str

ARN of the Lambda layer where Synthetics stores the canary script code.

start_canary bool

Whether to run or stop the canary.

status str

Canary status.

success_retention_period int

Number of days to retain data about successful runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

tags Mapping[str, str]

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tags_all Mapping[str, str]

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

timelines Sequence[CanaryTimelineArgs]

Structure that contains information about when the canary was created, modified, and most recently run. see Timeline.

vpc_config CanaryVpcConfigArgs

Configuration block. Detailed below.

zip_file str

ZIP 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 5 MB. Conflicts with s3_bucket, s3_key, and s3_version.

arn String

Amazon Resource Name (ARN) of the Canary.

artifactConfig Property Map

configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See Artifact Config.

artifactS3Location String

Location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.

deleteLambda Boolean

Specifies whether to also delete the Lambda functions and layers used by this canary. The default is false.

engineArn String

ARN of the Lambda function that is used as your canary's engine.

executionRoleArn String

ARN of the IAM role to be used to run the canary. see AWS Docs for permissions needs for IAM Role.

failureRetentionPeriod Number

Number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

handler String

Entry point to use for the source code when running the canary. This value must end with the string .handler .

name String

Name for this canary. Has a maximum length of 21 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore.

runConfig Property Map

Configuration block for individual canary runs. Detailed below.

runtimeVersion String

Runtime version to use for the canary. Versions change often so consult the Amazon CloudWatch documentation 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 String

Full bucket name which is used if your canary script is located in S3. The bucket must already exist. Specify the full bucket name including s3:// as the start of the bucket name. Conflicts with zip_file.

s3Key String

S3 key of your script. Conflicts with zip_file.

s3Version String

S3 version ID of your script. Conflicts with zip_file.

schedule Property Map

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

sourceLocationArn String

ARN of the Lambda layer where Synthetics stores the canary script code.

startCanary Boolean

Whether to run or stop the canary.

status String

Canary status.

successRetentionPeriod Number

Number of days to retain data about successful runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

tags Map<String>

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll Map<String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

timelines List<Property Map>

Structure that contains information about when the canary was created, modified, and most recently run. see Timeline.

vpcConfig Property Map

Configuration block. Detailed below.

zipFile String

ZIP 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 5 MB. Conflicts with s3_bucket, s3_key, and s3_version.

Supporting Types

CanaryArtifactConfig

S3Encryption CanaryArtifactConfigS3Encryption

Configuration of the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See S3 Encryption.

S3Encryption CanaryArtifactConfigS3Encryption

Configuration of the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See S3 Encryption.

s3Encryption CanaryArtifactConfigS3Encryption

Configuration of the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See S3 Encryption.

s3Encryption CanaryArtifactConfigS3Encryption

Configuration of the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See S3 Encryption.

s3_encryption CanaryArtifactConfigS3Encryption

Configuration of the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See S3 Encryption.

s3Encryption Property Map

Configuration of the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See S3 Encryption.

CanaryArtifactConfigS3Encryption

EncryptionMode string

The encryption method to use for artifacts created by this canary. Valid values are: SSE_S3 and SSE_KMS.

KmsKeyArn string

The ARN of the customer-managed KMS key to use, if you specify SSE_KMS for encryption_mode.

EncryptionMode string

The encryption method to use for artifacts created by this canary. Valid values are: SSE_S3 and SSE_KMS.

KmsKeyArn string

The ARN of the customer-managed KMS key to use, if you specify SSE_KMS for encryption_mode.

encryptionMode String

The encryption method to use for artifacts created by this canary. Valid values are: SSE_S3 and SSE_KMS.

kmsKeyArn String

The ARN of the customer-managed KMS key to use, if you specify SSE_KMS for encryption_mode.

encryptionMode string

The encryption method to use for artifacts created by this canary. Valid values are: SSE_S3 and SSE_KMS.

kmsKeyArn string

The ARN of the customer-managed KMS key to use, if you specify SSE_KMS for encryption_mode.

encryption_mode str

The encryption method to use for artifacts created by this canary. Valid values are: SSE_S3 and SSE_KMS.

kms_key_arn str

The ARN of the customer-managed KMS key to use, if you specify SSE_KMS for encryption_mode.

encryptionMode String

The encryption method to use for artifacts created by this canary. Valid values are: SSE_S3 and SSE_KMS.

kmsKeyArn String

The ARN of the customer-managed KMS key to use, if you specify SSE_KMS for encryption_mode.

CanaryRunConfig

ActiveTracing bool

Whether 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 Dictionary<string, string>

Map of environment variables that are accessible from the canary during execution. Please see AWS Docs for variables reserved for Lambda.

MemoryInMb int

Maximum amount of memory available to the canary while it is running, in MB. The value you specify must be a multiple of 64.

TimeoutInSeconds int

Number 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 bool

Whether 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 map[string]string

Map of environment variables that are accessible from the canary during execution. Please see AWS Docs for variables reserved for Lambda.

MemoryInMb int

Maximum amount of memory available to the canary while it is running, in MB. The value you specify must be a multiple of 64.

TimeoutInSeconds int

Number 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 Boolean

Whether 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 Map<String,String>

Map of environment variables that are accessible from the canary during execution. Please see AWS Docs for variables reserved for Lambda.

memoryInMb Integer

Maximum amount of memory available to the canary while it is running, in MB. The value you specify must be a multiple of 64.

timeoutInSeconds Integer

Number 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 boolean

Whether 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 {[key: string]: string}

Map of environment variables that are accessible from the canary during execution. Please see AWS Docs for variables reserved for Lambda.

memoryInMb number

Maximum amount of memory available to the canary while it is running, in MB. The value you specify must be a multiple of 64.

timeoutInSeconds number

Number 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 bool

Whether 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 Mapping[str, str]

Map of environment variables that are accessible from the canary during execution. Please see AWS Docs for variables reserved for Lambda.

memory_in_mb int

Maximum 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 int

Number 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 Boolean

Whether 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 Map<String>

Map of environment variables that are accessible from the canary during execution. Please see AWS Docs for variables reserved for Lambda.

memoryInMb Number

Maximum amount of memory available to the canary while it is running, in MB. The value you specify must be a multiple of 64.

timeoutInSeconds Number

Number 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

Expression string

Rate 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.

DurationInSeconds int

Duration in seconds, for the canary to continue making regular runs according to the schedule in the Expression value.

Expression string

Rate 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.

DurationInSeconds int

Duration in seconds, for the canary to continue making regular runs according to the schedule in the Expression value.

expression String

Rate 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.

durationInSeconds Integer

Duration in seconds, for the canary to continue making regular runs according to the schedule in the Expression value.

expression string

Rate 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.

durationInSeconds number

Duration in seconds, for the canary to continue making regular runs according to the schedule in the Expression value.

expression str

Rate 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.

duration_in_seconds int

Duration in seconds, for the canary to continue making regular runs according to the schedule in the Expression value.

expression String

Rate 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.

durationInSeconds Number

Duration in seconds, for the canary to continue making regular runs according to the schedule in the Expression value.

CanaryTimeline

Created string

Date and time the canary was created.

LastModified string

Date and time the canary was most recently modified.

LastStarted string

Date and time that the canary's most recent run started.

LastStopped string

Date and time that the canary's most recent run ended.

Created string

Date and time the canary was created.

LastModified string

Date and time the canary was most recently modified.

LastStarted string

Date and time that the canary's most recent run started.

LastStopped string

Date and time that the canary's most recent run ended.

created String

Date and time the canary was created.

lastModified String

Date and time the canary was most recently modified.

lastStarted String

Date and time that the canary's most recent run started.

lastStopped String

Date and time that the canary's most recent run ended.

created string

Date and time the canary was created.

lastModified string

Date and time the canary was most recently modified.

lastStarted string

Date and time that the canary's most recent run started.

lastStopped string

Date and time that the canary's most recent run ended.

created str

Date and time the canary was created.

last_modified str

Date and time the canary was most recently modified.

last_started str

Date and time that the canary's most recent run started.

last_stopped str

Date and time that the canary's most recent run ended.

created String

Date and time the canary was created.

lastModified String

Date and time the canary was most recently modified.

lastStarted String

Date and time that the canary's most recent run started.

lastStopped String

Date and time that the canary's most recent run ended.

CanaryVpcConfig

SecurityGroupIds List<string>

IDs of the security groups for this canary.

SubnetIds List<string>

IDs of the subnets where this canary is to run.

VpcId string

ID of the VPC where this canary is to run.

SecurityGroupIds []string

IDs of the security groups for this canary.

SubnetIds []string

IDs of the subnets where this canary is to run.

VpcId string

ID of the VPC where this canary is to run.

securityGroupIds List<String>

IDs of the security groups for this canary.

subnetIds List<String>

IDs of the subnets where this canary is to run.

vpcId String

ID of the VPC where this canary is to run.

securityGroupIds string[]

IDs of the security groups for this canary.

subnetIds string[]

IDs of the subnets where this canary is to run.

vpcId string

ID of the VPC where this canary is to run.

security_group_ids Sequence[str]

IDs of the security groups for this canary.

subnet_ids Sequence[str]

IDs of the subnets where this canary is to run.

vpc_id str

ID of the VPC where this canary is to run.

securityGroupIds List<String>

IDs of the security groups for this canary.

subnetIds List<String>

IDs of the subnets where this canary is to run.

vpcId String

ID of the VPC where this canary is to run.

Import

Synthetics Canaries can be imported using the name, e.g.,

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

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.