Uses of Class
software.amazon.awscdk.services.synthetics.CfnCanary.Builder
Package
Description
Amazon CloudWatch Synthetics Construct Library
-
Uses of CfnCanary.Builder in software.amazon.awscdk.services.synthetics
Modifier and TypeMethodDescriptionCfnCanary.Builder.artifactConfig
(IResolvable artifactConfig) A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.CfnCanary.Builder.artifactConfig
(CfnCanary.ArtifactConfigProperty artifactConfig) A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.CfnCanary.Builder.artifactS3Location
(String artifactS3Location) The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary.CfnCanary.Builder.code
(IResolvable code) Use this structure to input your script code for the canary.CfnCanary.Builder.code
(CfnCanary.CodeProperty code) Use this structure to input your script code for the canary.static CfnCanary.Builder
CfnCanary.Builder.deleteLambdaResourcesOnCanaryDeletion
(Boolean deleteLambdaResourcesOnCanaryDeletion) Deprecated.this property has been deprecatedCfnCanary.Builder.deleteLambdaResourcesOnCanaryDeletion
(IResolvable deleteLambdaResourcesOnCanaryDeletion) Deprecated.this property has been deprecatedCfnCanary.Builder.executionRoleArn
(String executionRoleArn) The ARN of the IAM role to be used to run the canary.CfnCanary.Builder.failureRetentionPeriod
(Number failureRetentionPeriod) The number of days to retain data about failed runs of this canary.The name for this canary.CfnCanary.Builder.resourcesToReplicateTags
(List<String> resourcesToReplicateTags) To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this property with the valuelambda-function
.CfnCanary.Builder.runConfig
(IResolvable runConfig) A structure that contains input information for a canary run.CfnCanary.Builder.runConfig
(CfnCanary.RunConfigProperty runConfig) A structure that contains input information for a canary run.CfnCanary.Builder.runtimeVersion
(String runtimeVersion) Specifies the runtime version to use for the canary.CfnCanary.Builder.schedule
(IResolvable schedule) A structure that contains information about how often the canary is to run, and when these runs are to stop.CfnCanary.Builder.schedule
(CfnCanary.ScheduleProperty schedule) A structure that contains information about how often the canary is to run, and when these runs are to stop.CfnCanary.Builder.startCanaryAfterCreation
(Boolean startCanaryAfterCreation) Specify TRUE to have the canary start making runs immediately after it is created.CfnCanary.Builder.startCanaryAfterCreation
(IResolvable startCanaryAfterCreation) Specify TRUE to have the canary start making runs immediately after it is created.CfnCanary.Builder.successRetentionPeriod
(Number successRetentionPeriod) The number of days to retain data about successful runs of this canary.The list of key-value pairs that are associated with the canary.CfnCanary.Builder.visualReference
(IResolvable visualReference) 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.CfnCanary.Builder.visualReference
(CfnCanary.VisualReferenceProperty visualReference) 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.CfnCanary.Builder.vpcConfig
(IResolvable vpcConfig) 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.CfnCanary.Builder.vpcConfig
(CfnCanary.VPCConfigProperty vpcConfig) 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.