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.98.0 (build 00b106d)", date="2024-05-08T21:35:14.693Z") @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
                 .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")
                 .build())
         // the properties below are optional
         .artifactConfig(ArtifactConfigProperty.builder()
                 .s3Encryption(S3EncryptionProperty.builder()
                         .encryptionMode("encryptionMode")
                         .kmsKeyArn("kmsKeyArn")
                         .build())
                 .build())
         .deleteLambdaResourcesOnCanaryDeletion(false)
         .failureRetentionPeriod(123)
         .runConfig(RunConfigProperty.builder()
                 .activeTracing(false)
                 .environmentVariables(Map.of(
                         "environmentVariablesKey", "environmentVariables"))
                 .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()))
                 .build())
         .vpcConfig(VPCConfigProperty.builder()
                 .securityGroupIds(List.of("securityGroupIds"))
                 .subnetIds(List.of("subnetIds"))
                 // the properties below are optional
                 .vpcId("vpcId")
                 .build())
         .build();

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    CfnCanaryProps.Builder
    A builder for CfnCanaryProps
    static final class 
    CfnCanaryProps.Jsii$Proxy
    An implementation for CfnCanaryProps

  • Method Summary

    Modifier and Type
    Method
    Description
    static CfnCanaryProps.Builder
    builder()
     
    default Object
    getArtifactConfig()
    A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.
    String
    getArtifactS3Location()
    The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary.
    Object
    getCode()
    Use this structure to input your script code for the canary.
    default Object
    getDeleteLambdaResourcesOnCanaryDeletion()
    Deprecated.
    this property has been deprecated
    String
    getExecutionRoleArn()
    The ARN of the IAM role to be used to run the canary.
    default Number
    getFailureRetentionPeriod()
    The number of days to retain data about failed runs of this canary.
    String
    getName()
    The name for this canary.
    default Object
    getRunConfig()
    A structure that contains input information for a canary run.
    String
    getRuntimeVersion()
    Specifies the runtime version to use for the canary.
    Object
    getSchedule()
    A structure that contains information about how often the canary is to run, and when these runs are to stop.
    default Object
    getStartCanaryAfterCreation()
    Specify TRUE to have the canary start making runs immediately after it is created.
    default Number
    getSuccessRetentionPeriod()
    The number of days to retain data about successful runs of this canary.
    default List<CfnTag>
    getTags()
    The list of key-value pairs that are associated with the canary.
    default Object
    getVisualReference()
    If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run to use as the baseline for screenshots, and the coordinates of any parts of the screen to ignore during the visual monitoring comparison.
    default Object
    getVpcConfig()
    If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson