ApiCanary.Builder |
ApiCanary.Builder.artifactsBucketLocation(software.amazon.awscdk.services.synthetics.ArtifactsBucketLocation artifactsBucketLocation) |
(experimental) The s3 location that stores the data of the canary runs.
|
ApiCanary.Builder |
ApiCanary.Builder.baseUrl(String baseUrl) |
(experimental) The base URL to use for tests.
|
ApiCanary.Builder |
ApiCanary.Builder.canaryName(String canaryName) |
(experimental) The name of the canary.
|
static ApiCanary.Builder |
ApiCanary.Builder.create(software.constructs.Construct scope,
String id) |
|
ApiCanary.Builder |
ApiCanary.Builder.durationAlarmThreshold(software.amazon.awscdk.Duration durationAlarmThreshold) |
(experimental) The threshold for triggering an alarm on the test duration.
|
ApiCanary.Builder |
ApiCanary.Builder.failureRetentionPeriod(software.amazon.awscdk.Duration failureRetentionPeriod) |
(experimental) How many days should failed runs be retained.
|
ApiCanary.Builder |
ApiCanary.Builder.role(software.amazon.awscdk.services.iam.IRole role) |
(experimental) Canary execution role.
|
ApiCanary.Builder |
ApiCanary.Builder.schedule(software.amazon.awscdk.services.synthetics.Schedule schedule) |
(experimental) Specify the schedule for how often the canary runs.
|
ApiCanary.Builder |
ApiCanary.Builder.securityGroups(List<? extends software.amazon.awscdk.services.ec2.ISecurityGroup> securityGroups) |
(experimental) The list of security groups to associate with the canary's network interfaces.
|
ApiCanary.Builder |
ApiCanary.Builder.startAfterCreation(Boolean startAfterCreation) |
(experimental) Whether or not the canary should start after creation.
|
ApiCanary.Builder |
ApiCanary.Builder.steps(List<? extends ApiTestStep> steps) |
(experimental) The steps to perform in the synthetic test.
|
ApiCanary.Builder |
ApiCanary.Builder.successRetentionPeriod(software.amazon.awscdk.Duration successRetentionPeriod) |
(experimental) How many days should successful runs be retained.
|
ApiCanary.Builder |
ApiCanary.Builder.threadCount(Number threadCount) |
(experimental) The number of threads to run concurrently for the synthetic test.
|
ApiCanary.Builder |
ApiCanary.Builder.timeToLive(software.amazon.awscdk.Duration timeToLive) |
(experimental) How long the canary will be in a 'RUNNING' state.
|
ApiCanary.Builder |
ApiCanary.Builder.vpc(software.amazon.awscdk.services.ec2.IVpc vpc) |
(experimental) The VPC where this canary is run.
|
ApiCanary.Builder |
ApiCanary.Builder.vpcSubnets(software.amazon.awscdk.services.ec2.SubnetSelection vpcSubnets) |
(experimental) Where to place the network interfaces within the VPC.
|