Package software.amazon.awscdk.services.synthetics
AWS::Synthetics Construct Library
This module is part of the AWS Cloud Development Kit project.
import software.amazon.awscdk.services.synthetics.*;
There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:
- Search Construct Hub for Synthetics construct libraries
- Use the automatically generated L1 constructs, in the same way you would use the CloudFormation AWS::Synthetics resources directly.
An experimental construct library for this service is available in preview. Since it is not stable yet, it is distributed as a separate package so that you can pin its version independently of the rest of the CDK. See the package:
@aws-cdk/aws-synthetics-alpha
There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.
For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::Synthetics.
(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)
-
ClassDescriptionCreates or updates a canary.A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3 .A builder for
CfnCanary.ArtifactConfigPropertyAn implementation forCfnCanary.ArtifactConfigPropertyA structure representing a screenshot that is used as a baseline during visual monitoring comparisons made by the canary.A builder forCfnCanary.BaseScreenshotPropertyAn implementation forCfnCanary.BaseScreenshotPropertyA fluent builder forCfnCanary.Use this structure to input your script code for the canary.A builder forCfnCanary.CodePropertyAn implementation forCfnCanary.CodePropertyA structure that contains input information for a canary run.A builder forCfnCanary.RunConfigPropertyAn implementation forCfnCanary.RunConfigPropertyA structure that contains the configuration of the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3 .A builder forCfnCanary.S3EncryptionPropertyAn implementation forCfnCanary.S3EncryptionPropertyThis structure specifies how often a canary is to make runs and the date and time when it should stop making runs.A builder forCfnCanary.SchedulePropertyAn implementation forCfnCanary.SchedulePropertyDefines the screenshots to use as the baseline for comparisons during visual monitoring comparisons during future runs of this canary.A builder forCfnCanary.VisualReferencePropertyAn implementation forCfnCanary.VisualReferencePropertyIf this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint.A builder forCfnCanary.VPCConfigPropertyAn implementation forCfnCanary.VPCConfigPropertyProperties for defining aCfnCanary.A builder forCfnCanaryPropsAn implementation forCfnCanaryPropsCreates or updates a group which you can use to associate canaries with each other, including cross-Region canaries.A fluent builder forCfnGroup.Properties for defining aCfnGroup.A builder forCfnGroupPropsAn implementation forCfnGroupProps