import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * 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 * * ```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)", * }, * }); * ``` * * ## Import * * Using `pulumi import`, import Synthetics Canaries using the `name`. For example: * * ```sh * $ pulumi import aws:synthetics/canary:Canary some some-canary * ``` */ export declare class Canary extends pulumi.CustomResource { /** * Get an existing Canary resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: CanaryState, opts?: pulumi.CustomResourceOptions): Canary; /** * Returns true if the given object is an instance of Canary. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Canary; /** * Amazon Resource Name (ARN) of the Canary. */ readonly arn: pulumi.Output; /** * configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See Artifact Config. */ readonly artifactConfig: pulumi.Output; /** * Location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. */ readonly artifactS3Location: pulumi.Output; /** * Specifies whether to also delete the Lambda functions and layers used by this canary. The default is `false`. */ readonly deleteLambda: pulumi.Output; /** * ARN of the Lambda function that is used as your canary's engine. */ readonly engineArn: pulumi.Output; /** * ARN 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. */ readonly executionRoleArn: pulumi.Output; /** * 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. */ readonly failureRetentionPeriod: pulumi.Output; /** * Entry point to use for the source code when running the canary. This value must end with the string `.handler` . */ readonly handler: pulumi.Output; /** * Name for this canary. Has a maximum length of 255 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore. */ readonly name: pulumi.Output; /** * Region 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. */ readonly region: pulumi.Output; /** * Configuration block for individual canary runs. Detailed below. */ readonly runConfig: pulumi.Output; /** * Runtime 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`. */ readonly runtimeVersion: pulumi.Output; /** * Full bucket name which is used if your canary script is located in S3. The bucket must already exist. **Conflicts with `zipFile`.** */ readonly s3Bucket: pulumi.Output; /** * S3 key of your script. **Conflicts with `zipFile`.** */ readonly s3Key: pulumi.Output; /** * S3 version ID of your script. **Conflicts with `zipFile`.** */ readonly s3Version: pulumi.Output; /** * 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: */ readonly schedule: pulumi.Output; /** * ARN of the Lambda layer where Synthetics stores the canary script code. */ readonly sourceLocationArn: pulumi.Output; /** * Whether to run or stop the canary. */ readonly startCanary: pulumi.Output; /** * Canary status. */ readonly status: pulumi.Output; /** * 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. */ readonly successRetentionPeriod: pulumi.Output; /** * 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. */ readonly tags: pulumi.Output<{ [key: string]: string; } | undefined>; /** * A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. */ readonly tagsAll: pulumi.Output<{ [key: string]: string; }>; /** * Structure that contains information about when the canary was created, modified, and most recently run. see Timeline. */ readonly timelines: pulumi.Output; /** * Configuration block. Detailed below. */ readonly vpcConfig: pulumi.Output; /** * 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 225KB. **Conflicts with `s3Bucket`, `s3Key`, and `s3Version`.** */ readonly zipFile: pulumi.Output; /** * Create a Canary resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: CanaryArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Canary resources. */ export interface CanaryState { /** * Amazon Resource Name (ARN) of the Canary. */ arn?: pulumi.Input; /** * configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See Artifact Config. */ artifactConfig?: pulumi.Input; /** * Location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. */ artifactS3Location?: pulumi.Input; /** * Specifies whether to also delete the Lambda functions and layers used by this canary. The default is `false`. */ deleteLambda?: pulumi.Input; /** * ARN of the Lambda function that is used as your canary's engine. */ engineArn?: pulumi.Input; /** * ARN 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. */ executionRoleArn?: pulumi.Input; /** * 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. */ failureRetentionPeriod?: pulumi.Input; /** * Entry point to use for the source code when running the canary. This value must end with the string `.handler` . */ handler?: pulumi.Input; /** * Name for this canary. Has a maximum length of 255 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore. */ name?: pulumi.Input; /** * Region 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. */ region?: pulumi.Input; /** * Configuration block for individual canary runs. Detailed below. */ runConfig?: pulumi.Input; /** * Runtime 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`. */ runtimeVersion?: pulumi.Input; /** * Full bucket name which is used if your canary script is located in S3. The bucket must already exist. **Conflicts with `zipFile`.** */ s3Bucket?: pulumi.Input; /** * S3 key of your script. **Conflicts with `zipFile`.** */ s3Key?: pulumi.Input; /** * S3 version ID of your script. **Conflicts with `zipFile`.** */ s3Version?: pulumi.Input; /** * 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: */ schedule?: pulumi.Input; /** * ARN of the Lambda layer where Synthetics stores the canary script code. */ sourceLocationArn?: pulumi.Input; /** * Whether to run or stop the canary. */ startCanary?: pulumi.Input; /** * Canary status. */ status?: pulumi.Input; /** * 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. */ successRetentionPeriod?: pulumi.Input; /** * 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?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. */ tagsAll?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * Structure that contains information about when the canary was created, modified, and most recently run. see Timeline. */ timelines?: pulumi.Input[]>; /** * Configuration block. Detailed below. */ vpcConfig?: pulumi.Input; /** * 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 225KB. **Conflicts with `s3Bucket`, `s3Key`, and `s3Version`.** */ zipFile?: pulumi.Input; } /** * The set of arguments for constructing a Canary resource. */ export interface CanaryArgs { /** * configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See Artifact Config. */ artifactConfig?: pulumi.Input; /** * Location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. */ artifactS3Location: pulumi.Input; /** * Specifies whether to also delete the Lambda functions and layers used by this canary. The default is `false`. */ deleteLambda?: pulumi.Input; /** * ARN 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. */ executionRoleArn: pulumi.Input; /** * 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. */ failureRetentionPeriod?: pulumi.Input; /** * Entry point to use for the source code when running the canary. This value must end with the string `.handler` . */ handler: pulumi.Input; /** * Name for this canary. Has a maximum length of 255 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore. */ name?: pulumi.Input; /** * Region 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. */ region?: pulumi.Input; /** * Configuration block for individual canary runs. Detailed below. */ runConfig?: pulumi.Input; /** * Runtime 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`. */ runtimeVersion: pulumi.Input; /** * Full bucket name which is used if your canary script is located in S3. The bucket must already exist. **Conflicts with `zipFile`.** */ s3Bucket?: pulumi.Input; /** * S3 key of your script. **Conflicts with `zipFile`.** */ s3Key?: pulumi.Input; /** * S3 version ID of your script. **Conflicts with `zipFile`.** */ s3Version?: pulumi.Input; /** * 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: */ schedule: pulumi.Input; /** * Whether to run or stop the canary. */ startCanary?: pulumi.Input; /** * 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. */ successRetentionPeriod?: pulumi.Input; /** * 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?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * Configuration block. Detailed below. */ vpcConfig?: pulumi.Input; /** * 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 225KB. **Conflicts with `s3Bucket`, `s3Key`, and `s3Version`.** */ zipFile?: pulumi.Input; }