Package software.amazon.awscdk.services.synthetics

Interface CfnCanaryProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnCanaryProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)", date="2025-09-02T11:25:41.718Z") @Stability(Stable) public interface CfnCanaryProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnCanary.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.synthetics.*;
 CfnCanaryProps cfnCanaryProps = CfnCanaryProps.builder()
         .artifactS3Location("artifactS3Location")
         .code(CodeProperty.builder()
                 .handler("handler")
                 // the properties below are optional
                 .dependencies(List.of(DependencyProperty.builder()
                         .reference("reference")
                         // the properties below are optional
                         .type("type")
                         .build()))
                 .s3Bucket("s3Bucket")
                 .s3Key("s3Key")
                 .s3ObjectVersion("s3ObjectVersion")
                 .script("script")
                 .sourceLocationArn("sourceLocationArn")
                 .build())
         .executionRoleArn("executionRoleArn")
         .name("name")
         .runtimeVersion("runtimeVersion")
         .schedule(ScheduleProperty.builder()
                 .expression("expression")
                 // the properties below are optional
                 .durationInSeconds("durationInSeconds")
                 .retryConfig(RetryConfigProperty.builder()
                         .maxRetries(123)
                         .build())
                 .build())
         // the properties below are optional
         .artifactConfig(ArtifactConfigProperty.builder()
                 .s3Encryption(S3EncryptionProperty.builder()
                         .encryptionMode("encryptionMode")
                         .kmsKeyArn("kmsKeyArn")
                         .build())
                 .build())
         .browserConfigs(List.of(BrowserConfigProperty.builder()
                 .browserType("browserType")
                 .build()))
         .deleteLambdaResourcesOnCanaryDeletion(false)
         .dryRunAndUpdate(false)
         .failureRetentionPeriod(123)
         .provisionedResourceCleanup("provisionedResourceCleanup")
         .resourcesToReplicateTags(List.of("resourcesToReplicateTags"))
         .runConfig(RunConfigProperty.builder()
                 .activeTracing(false)
                 .environmentVariables(Map.of(
                         "environmentVariablesKey", "environmentVariables"))
                 .ephemeralStorage(123)
                 .memoryInMb(123)
                 .timeoutInSeconds(123)
                 .build())
         .startCanaryAfterCreation(false)
         .successRetentionPeriod(123)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .visualReference(VisualReferenceProperty.builder()
                 .baseCanaryRunId("baseCanaryRunId")
                 // the properties below are optional
                 .baseScreenshots(List.of(BaseScreenshotProperty.builder()
                         .screenshotName("screenshotName")
                         // the properties below are optional
                         .ignoreCoordinates(List.of("ignoreCoordinates"))
                         .build()))
                 .browserType("browserType")
                 .build())
         .visualReferences(List.of(VisualReferenceProperty.builder()
                 .baseCanaryRunId("baseCanaryRunId")
                 // the properties below are optional
                 .baseScreenshots(List.of(BaseScreenshotProperty.builder()
                         .screenshotName("screenshotName")
                         // the properties below are optional
                         .ignoreCoordinates(List.of("ignoreCoordinates"))
                         .build()))
                 .browserType("browserType")
                 .build()))
         .vpcConfig(VPCConfigProperty.builder()
                 .securityGroupIds(List.of("securityGroupIds"))
                 .subnetIds(List.of("subnetIds"))
                 // the properties below are optional
                 .ipv6AllowedForDualStack(false)
                 .vpcId("vpcId")
                 .build())
         .build();

See Also: