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

CanaryArgs

data class CanaryArgs(val artifactConfig: Output<CanaryArtifactConfigArgs>? = null, val artifactS3Location: Output<String>? = null, val code: Output<CanaryCodeArgs>? = null, val deleteLambdaResourcesOnCanaryDeletion: Output<Boolean>? = null, val executionRoleArn: Output<String>? = null, val failureRetentionPeriod: Output<Int>? = null, val name: Output<String>? = null, val provisionedResourceCleanup: Output<CanaryProvisionedResourceCleanup>? = null, val resourcesToReplicateTags: Output<List<CanaryResourceToTag>>? = null, val runConfig: Output<CanaryRunConfigArgs>? = null, val runtimeVersion: Output<String>? = null, val schedule: Output<CanaryScheduleArgs>? = null, val startCanaryAfterCreation: Output<Boolean>? = null, val successRetentionPeriod: Output<Int>? = null, val tags: Output<List<TagArgs>>? = null, val visualReference: Output<CanaryVisualReferenceArgs>? = null, val vpcConfig: Output<CanaryVpcConfigArgs>? = null) : ConvertibleToJava<CanaryArgs>

Resource Type definition for AWS::Synthetics::Canary

Example Usage

Example

No Java example available.

Example

No Java example available.

Constructors

Link copied to clipboard
constructor(artifactConfig: Output<CanaryArtifactConfigArgs>? = null, artifactS3Location: Output<String>? = null, code: Output<CanaryCodeArgs>? = null, deleteLambdaResourcesOnCanaryDeletion: Output<Boolean>? = null, executionRoleArn: Output<String>? = null, failureRetentionPeriod: Output<Int>? = null, name: Output<String>? = null, provisionedResourceCleanup: Output<CanaryProvisionedResourceCleanup>? = null, resourcesToReplicateTags: Output<List<CanaryResourceToTag>>? = null, runConfig: Output<CanaryRunConfigArgs>? = null, runtimeVersion: Output<String>? = null, schedule: Output<CanaryScheduleArgs>? = null, startCanaryAfterCreation: Output<Boolean>? = null, successRetentionPeriod: Output<Int>? = null, tags: Output<List<TagArgs>>? = null, visualReference: Output<CanaryVisualReferenceArgs>? = null, vpcConfig: Output<CanaryVpcConfigArgs>? = null)

Properties

Link copied to clipboard
val artifactConfig: Output<CanaryArtifactConfigArgs>? = null

Provide artifact configuration

Link copied to clipboard
val artifactS3Location: Output<String>? = null

Provide the s3 bucket output location for test results

Link copied to clipboard
val code: Output<CanaryCodeArgs>? = null

Provide the canary script source

Link copied to clipboard
val deleteLambdaResourcesOnCanaryDeletion: Output<Boolean>? = null

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

Link copied to clipboard
val executionRoleArn: Output<String>? = null

Lambda Execution role used to run your canaries

Link copied to clipboard
val failureRetentionPeriod: Output<Int>? = null

Retention period of failed canary runs represented in number of days

Link copied to clipboard
val name: Output<String>? = null

Name of the canary.

Link copied to clipboard
val provisionedResourceCleanup: Output<CanaryProvisionedResourceCleanup>? = null

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

Link copied to clipboard
val resourcesToReplicateTags: Output<List<CanaryResourceToTag>>? = null

List of resources which canary tags should be replicated to.

Link copied to clipboard
val runConfig: Output<CanaryRunConfigArgs>? = null

Provide canary run configuration

Link copied to clipboard
val runtimeVersion: Output<String>? = null

Runtime version of Synthetics Library

Link copied to clipboard
val schedule: Output<CanaryScheduleArgs>? = null

Frequency to run your canaries

Link copied to clipboard
val startCanaryAfterCreation: Output<Boolean>? = null

Runs canary if set to True. Default is False

Link copied to clipboard
val successRetentionPeriod: Output<Int>? = null

Retention period of successful canary runs represented in number of days

Link copied to clipboard
val tags: Output<List<TagArgs>>? = null

The list of key-value pairs that are associated with the canary.

Link copied to clipboard
val visualReference: Output<CanaryVisualReferenceArgs>? = null

Visual reference configuration for visual testing

Link copied to clipboard
val vpcConfig: Output<CanaryVpcConfigArgs>? = null

Provide VPC Configuration if enabled.

Functions

Link copied to clipboard
open override fun toJava(): CanaryArgs