Class Canary
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.synthetics.Canary
- All Implemented Interfaces:
IResource
,IConnectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
date="2024-08-29T22:54:26.739Z")
@Stability(Stable)
public class Canary
extends Resource
implements IConnectable
Define a new Canary.
Example:
import software.amazon.awscdk.*; Canary canary = Canary.Builder.create(this, "MyCanary") .schedule(Schedule.rate(Duration.minutes(5))) .test(Test.custom(CustomTestOptions.builder() .code(Code.fromAsset(join(__dirname, "canary"))) .handler("index.handler") .build())) .runtime(Runtime.SYNTHETICS_NODEJS_PUPPETEER_6_2) .memory(Size.mebibytes(1024)) .build();
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ec2.IConnectable
IConnectable.Jsii$Default, IConnectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource
IResource.Jsii$Default
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Canary
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
Canary
(software.amazon.jsii.JsiiObjectRef objRef) Canary
(software.constructs.Construct scope, String id, CanaryProps props) -
Method Summary
Modifier and TypeMethodDescriptionBucket where data from each canary run is stored.The canary ID.The canary Name.The state of the canary.Access the Connections object.getRole()
Execution role associated with this Canary.Measure the Duration of a single canary run, in seconds.metricDuration
(MetricOptions options) Measure the Duration of a single canary run, in seconds.Measure the number of failed canary runs over a given time period.metricFailed
(MetricOptions options) Measure the number of failed canary runs over a given time period.Measure the percentage of successful canary runs.metricSuccessPercent
(MetricOptions options) Measure the percentage of successful canary runs.Methods inherited from class software.amazon.awscdk.Resource
applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource
Methods inherited from class software.constructs.Construct
getNode, isConstruct, toString
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.constructs.IConstruct
getNode
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
Canary
protected Canary(software.amazon.jsii.JsiiObjectRef objRef) -
Canary
protected Canary(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
Canary
@Stability(Stable) public Canary(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CanaryProps props) - Parameters:
scope
- This parameter is required.id
- This parameter is required.props
- This parameter is required.
-
-
Method Details
-
metricDuration
Measure the Duration of a single canary run, in seconds.Default: avg over 5 minutes
- Parameters:
options
-- configuration options for the metric.
-
metricDuration
Measure the Duration of a single canary run, in seconds.Default: avg over 5 minutes
-
metricFailed
Measure the number of failed canary runs over a given time period.Default: sum over 5 minutes
- Parameters:
options
-- configuration options for the metric.
-
metricFailed
Measure the number of failed canary runs over a given time period.Default: sum over 5 minutes
-
metricSuccessPercent
Measure the percentage of successful canary runs.Default: avg over 5 minutes
- Parameters:
options
-- configuration options for the metric.
-
metricSuccessPercent
Measure the percentage of successful canary runs.Default: avg over 5 minutes
-
getArtifactsBucket
Bucket where data from each canary run is stored. -
getCanaryId
The canary ID. -
getCanaryName
The canary Name. -
getCanaryState
The state of the canary.For example, 'RUNNING', 'STOPPED', 'NOT STARTED', or 'ERROR'.
-
getConnections
Access the Connections object.Will fail if not a VPC-enabled Canary
- Specified by:
getConnections
in interfaceIConnectable
-
getRole
Execution role associated with this Canary.
-