software.amazon.awscdk.services.synthetics

Class Canary

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.synthetics.Canary

All Implemented Interfaces:

IDependable, IResource, IConnectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:41.780Z")
 @Stability(value=Experimental)
public class Canary
extends Resource
implements IConnectable

(experimental) Define a new Canary.

Example:

 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_3_1)
         .environmentVariables(Map.of(
                 "stage", "prod"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Canary.Builder (experimental) A fluent builder for Canary.

Nested 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.amazon.awscdk.core.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
	Canary(software.constructs.Construct scope, String id, CanaryProps props)
protected	Canary(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Canary(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
IBucket	getArtifactsBucket() (experimental) Bucket where data from each canary run is stored.
String	getCanaryId() (experimental) The canary ID.
String	getCanaryName() (experimental) The canary Name.
String	getCanaryState() (experimental) The state of the canary.
Connections	getConnections() (experimental) Access the Connections object.
IRole	getRole() (experimental) Execution role associated with this Canary.
Metric	metricDuration() (experimental) Measure the Duration of a single canary run, in seconds.
Metric	metricDuration(MetricOptions options) (experimental) Measure the Duration of a single canary run, in seconds.
Metric	metricFailed() (experimental) Measure the number of failed canary runs over a given time period.
Metric	metricFailed(MetricOptions options) (experimental) Measure the number of failed canary runs over a given time period.
Metric	metricSuccessPercent() (experimental) Measure the percentage of successful canary runs.
Metric	metricSuccessPercent(MetricOptions options) (experimental) Measure the percentage of successful canary runs.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

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.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

Canary

protected Canary(software.amazon.jsii.JsiiObjectRef objRef)

Canary

protected Canary(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Canary

@Stability(value=Experimental)
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 Detail

metricDuration

@Stability(value=Experimental)
 @NotNull
public Metric metricDuration(@Nullable
                                                                      MetricOptions options)

(experimental) Measure the Duration of a single canary run, in seconds.

Default: avg over 5 minutes

Parameters:

options - - configuration options for the metric.

metricDuration

@Stability(value=Experimental)
 @NotNull
public Metric metricDuration()

(experimental) Measure the Duration of a single canary run, in seconds.

Default: avg over 5 minutes

metricFailed

@Stability(value=Experimental)
 @NotNull
public Metric metricFailed(@Nullable
                                                                    MetricOptions options)

(experimental) 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

@Stability(value=Experimental)
 @NotNull
public Metric metricFailed()

(experimental) Measure the number of failed canary runs over a given time period.

Default: sum over 5 minutes

metricSuccessPercent

@Stability(value=Experimental)
 @NotNull
public Metric metricSuccessPercent(@Nullable
                                                                            MetricOptions options)

(experimental) Measure the percentage of successful canary runs.

Default: avg over 5 minutes

Parameters:

options - - configuration options for the metric.

metricSuccessPercent

@Stability(value=Experimental)
 @NotNull
public Metric metricSuccessPercent()

(experimental) Measure the percentage of successful canary runs.

Default: avg over 5 minutes

getArtifactsBucket

@Stability(value=Experimental)
 @NotNull
public IBucket getArtifactsBucket()

(experimental) Bucket where data from each canary run is stored.

getCanaryId

@Stability(value=Experimental)
 @NotNull
public String getCanaryId()

(experimental) The canary ID.

getCanaryName

@Stability(value=Experimental)
 @NotNull
public String getCanaryName()

(experimental) The canary Name.

getCanaryState

@Stability(value=Experimental)
 @NotNull
public String getCanaryState()

(experimental) The state of the canary.

For example, 'RUNNING', 'STOPPED', 'NOT STARTED', or 'ERROR'.

getConnections

@Stability(value=Experimental)
 @NotNull
public Connections getConnections()

(experimental) Access the Connections object.

Will fail if not a VPC-enabled Canary

Specified by:

getConnections in interface IConnectable

getRole

@Stability(value=Experimental)
 @NotNull
public IRole getRole()

(experimental) Execution role associated with this Canary.