pulumi-aws-kotlin/com.pulumi.aws.synthetics.kotlin/Canary

Canary

class Canary : KotlinCustomResource

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

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

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

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

Properties

arn

val arn: Output<String>

Amazon Resource Name (ARN) of the Canary.

artifactConfig

val artifactConfig: Output<CanaryArtifactConfig>?

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

artifactS3Location

val artifactS3Location: Output<String>

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

deleteLambda

val deleteLambda: Output<Boolean>?

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

engineArn

val engineArn: Output<String>

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

executionRoleArn

val executionRoleArn: Output<String>

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

failureRetentionPeriod

val failureRetentionPeriod: Output<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

val handler: Output<String>

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

val id: Output<String>

name

val name: Output<String>

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

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

runConfig

val runConfig: Output<CanaryRunConfig>

Configuration block for individual canary runs. Detailed below.

runtimeVersion

val runtimeVersion: Output<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

val s3Bucket: Output<String>?

Full bucket name which is used if your canary script is located in S3. The bucket must already exist. Conflicts with zip_file.

s3Key

val s3Key: Output<String>?

S3 key of your script. Conflicts with zip_file.

s3Version

val s3Version: Output<String>?

S3 version ID of your script. Conflicts with zip_file.

schedule

val schedule: Output<CanarySchedule>

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

val sourceLocationArn: Output<String>

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

startCanary

val startCanary: Output<Boolean>?

Whether to run or stop the canary.

status

val status: Output<String>

Canary status.

successRetentionPeriod

val successRetentionPeriod: Output<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.