Package io.github.cdklabs.cdk.ecs.codedeploy

Class ApiCanary

  • All Implemented Interfaces:
    software.amazon.awscdk.IResource, software.amazon.awscdk.services.ec2.IConnectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-06T18:16:18.984Z")
@Stability(Experimental)
public class ApiCanary
extends software.amazon.awscdk.services.synthetics.Canary
    (experimental) A CloudWatch Synthetic Canary for monitoring APIs.

    • Nested Class Summary

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

      • 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

        software.amazon.awscdk.services.ec2.IConnectable.Jsii$Default, software.amazon.awscdk.services.ec2.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

        software.amazon.awscdk.IResource.Jsii$Default

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected ApiCanary​(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)  
      protected ApiCanary​(software.amazon.jsii.JsiiObjectRef objRef)  
        ApiCanary​(software.constructs.Construct scope, String id, ApiCanaryProps props)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addTestStep​(ApiTestStep step)
      (experimental) Add a new test step to this canary.
      software.amazon.awscdk.services.cloudwatch.Alarm getDurationAlarm()
      (experimental) A CloudWatch Alarm that triggers when the duration of the tests exceeds the given threshold over the past 2 periods.
      software.amazon.awscdk.services.cloudwatch.Alarm getSuccessAlarm()
      (experimental) A CloudWatch Alarm that triggers when the success rate falls below 100% over the past 2 periods.
      void setDurationAlarm​(software.amazon.awscdk.services.cloudwatch.Alarm value)
      (experimental) A CloudWatch Alarm that triggers when the duration of the tests exceeds the given threshold over the past 2 periods.
      void setSuccessAlarm​(software.amazon.awscdk.services.cloudwatch.Alarm value)
      (experimental) A CloudWatch Alarm that triggers when the success rate falls below 100% over the past 2 periods.

      • Methods inherited from class software.amazon.awscdk.services.synthetics.Canary

        getArtifactsBucket, getCanaryId, getCanaryName, getCanaryState, getConnections, getRole, metricDuration, metricDuration, metricFailed, metricFailed, metricSuccessPercent, metricSuccessPercent

      • 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 interface software.constructs.IConstruct

        getNode

      • Methods inherited from interface software.amazon.jsii.JsiiSerializable

        $jsii$toJson

    • Constructor Detail

      • ApiCanary

        protected ApiCanary​(software.amazon.jsii.JsiiObjectRef objRef)

      • ApiCanary

        protected ApiCanary​(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

      • ApiCanary

        @Stability(Experimental)
public ApiCanary​(@NotNull
                 software.constructs.Construct scope,
                 @NotNull
                 String id,
                 @NotNull
                 ApiCanaryProps props)
        Parameters:
        scope - This parameter is required.
        id - This parameter is required.
        props - This parameter is required.

    • Method Detail

      • addTestStep

        @Stability(Experimental)
public void addTestStep​(@NotNull
                        ApiTestStep step)
        (experimental) Add a new test step to this canary.

        Parameters:
        step -
        • ApiTestStep to add.
        This parameter is required.

      • getSuccessAlarm

        @Stability(Experimental)
@NotNull
public software.amazon.awscdk.services.cloudwatch.Alarm getSuccessAlarm()
        (experimental) A CloudWatch Alarm that triggers when the success rate falls below 100% over the past 2 periods.

      • setSuccessAlarm

        @Stability(Experimental)
public void setSuccessAlarm​(@NotNull
                            software.amazon.awscdk.services.cloudwatch.Alarm value)
        (experimental) A CloudWatch Alarm that triggers when the success rate falls below 100% over the past 2 periods.

      • getDurationAlarm

        @Stability(Experimental)
@Nullable
public software.amazon.awscdk.services.cloudwatch.Alarm getDurationAlarm()
        (experimental) A CloudWatch Alarm that triggers when the duration of the tests exceeds the given threshold over the past 2 periods.

      • setDurationAlarm

        @Stability(Experimental)
public void setDurationAlarm​(@Nullable
                             software.amazon.awscdk.services.cloudwatch.Alarm value)
        (experimental) A CloudWatch Alarm that triggers when the duration of the tests exceeds the given threshold over the past 2 periods.