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

Canary

class Canary : KotlinCustomResource

Resource Type definition for AWS::Synthetics::Canary

Example Usage

Example

No Java example available.

Example

No Java example available.

Properties

artifactConfig

val artifactConfig: Output<CanaryArtifactConfig>?

Provide artifact configuration

artifactS3Location

val artifactS3Location: Output<String>

Provide the s3 bucket output location for test results

awsId

val awsId: Output<String>

Id of the canary

code

val code: Output<CanaryCode>

Provide the canary script source

deleteLambdaResourcesOnCanaryDeletion

val deleteLambdaResourcesOnCanaryDeletion: Output<Boolean>?

Deletes associated lambda resources created by Synthetics if set to True. Default is False

executionRoleArn

val executionRoleArn: Output<String>

Lambda Execution role used to run your canaries

failureRetentionPeriod

val failureRetentionPeriod: Output<Int>?

Retention period of failed canary runs represented in number of days

val id: Output<String>

name

val name: Output<String>

Name of the canary.

provisionedResourceCleanup

val provisionedResourceCleanup: Output<CanaryProvisionedResourceCleanup>?

Setting to control if provisioned resources created by Synthetics are deleted alongside the canary. Default is AUTOMATIC.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

resourcesToReplicateTags

val resourcesToReplicateTags: Output<List<CanaryResourceToTag>>?

List of resources which canary tags should be replicated to.

runConfig

val runConfig: Output<CanaryRunConfig>?

Provide canary run configuration

runtimeVersion

val runtimeVersion: Output<String>

Runtime version of Synthetics Library

schedule

val schedule: Output<CanarySchedule>

Frequency to run your canaries

startCanaryAfterCreation

val startCanaryAfterCreation: Output<Boolean>?

Runs canary if set to True. Default is False

state

val state: Output<String>

State of the canary

successRetentionPeriod

val successRetentionPeriod: Output<Int>?

Retention period of successful canary runs represented in number of days