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

Interface ApiCanaryProps

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable
    All Known Implementing Classes:
    ApiCanaryProps.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-06T18:16:18.992Z")
@Stability(Experimental)
public interface ApiCanaryProps
extends software.amazon.jsii.JsiiSerializable

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      static ApiCanaryProps.Builder builder()  
      default software.amazon.awscdk.services.synthetics.ArtifactsBucketLocation getArtifactsBucketLocation()
      (experimental) The s3 location that stores the data of the canary runs.
      String getBaseUrl()
      (experimental) The base URL to use for tests.
      default String getCanaryName()
      (experimental) The name of the canary.
      default software.amazon.awscdk.Duration getDurationAlarmThreshold()
      (experimental) The threshold for triggering an alarm on the test duration.
      default software.amazon.awscdk.Duration getFailureRetentionPeriod()
      (experimental) How many days should failed runs be retained.
      default software.amazon.awscdk.services.iam.IRole getRole()
      (experimental) Canary execution role.
      default software.amazon.awscdk.services.synthetics.Schedule getSchedule()
      (experimental) Specify the schedule for how often the canary runs.
      default List<software.amazon.awscdk.services.ec2.ISecurityGroup> getSecurityGroups()
      (experimental) The list of security groups to associate with the canary's network interfaces.
      default Boolean getStartAfterCreation()
      (experimental) Whether or not the canary should start after creation.
      default List<ApiTestStep> getSteps()
      (experimental) The steps to perform in the synthetic test.
      default software.amazon.awscdk.Duration getSuccessRetentionPeriod()
      (experimental) How many days should successful runs be retained.
      default Number getThreadCount()
      (experimental) The number of threads to run concurrently for the synthetic test.
      default software.amazon.awscdk.Duration getTimeToLive()
      (experimental) How long the canary will be in a 'RUNNING' state.
      default software.amazon.awscdk.services.ec2.IVpc getVpc()
      (experimental) The VPC where this canary is run.
      default software.amazon.awscdk.services.ec2.SubnetSelection getVpcSubnets()
      (experimental) Where to place the network interfaces within the VPC.

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

        $jsii$toJson

    • Method Detail

      • getBaseUrl

        @Stability(Experimental)
@NotNull
String getBaseUrl()
        (experimental) The base URL to use for tests.

      • getArtifactsBucketLocation

        @Stability(Experimental)
@Nullable
default software.amazon.awscdk.services.synthetics.ArtifactsBucketLocation getArtifactsBucketLocation()
        (experimental) The s3 location that stores the data of the canary runs.

        Default: - A new s3 bucket will be created without a prefix.

      • getCanaryName

        @Stability(Experimental)
@Nullable
default String getCanaryName()
        (experimental) The name of the canary.

        Be sure to give it a descriptive name that distinguishes it from other canaries in your account.

        Do not include secrets or proprietary information in your canary name. The canary name makes up part of the canary ARN, which is included in outbound calls over the internet.

        Default: - A unique name will be generated from the construct ID

        See Also:
        https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/servicelens_canaries_security.html

      • getDurationAlarmThreshold

        @Stability(Experimental)
@Nullable
default software.amazon.awscdk.Duration getDurationAlarmThreshold()
        (experimental) The threshold for triggering an alarm on the test duration.

        Default: - no alarm is created for duration

      • getFailureRetentionPeriod

        @Stability(Experimental)
@Nullable
default software.amazon.awscdk.Duration getFailureRetentionPeriod()
        (experimental) How many days should failed runs be retained.

        Default: Duration.days(31)

      • getSchedule

        @Stability(Experimental)
@Nullable
default software.amazon.awscdk.services.synthetics.Schedule getSchedule()
        (experimental) Specify the schedule for how often the canary runs.

        For example, if you set schedule to rate(10 minutes), then the canary will run every 10 minutes. You can set the schedule with Schedule.rate(Duration) (recommended) or you can specify an expression using Schedule.expression().

        Default: 'rate(5 minutes)'

      • getSecurityGroups

        @Stability(Experimental)
@Nullable
default List<software.amazon.awscdk.services.ec2.ISecurityGroup> getSecurityGroups()
        (experimental) The list of security groups to associate with the canary's network interfaces.

        You must provide vpc when using this prop.

        Default: - If the canary is placed within a VPC and a security group is not specified a dedicated security group will be created for this canary.

      • getStartAfterCreation

        @Stability(Experimental)
@Nullable
default Boolean getStartAfterCreation()
        (experimental) Whether or not the canary should start after creation.

        Default: true

      • getSteps

        @Stability(Experimental)
@Nullable
default List<ApiTestStep> getSteps()
        (experimental) The steps to perform in the synthetic test.

      • getSuccessRetentionPeriod

        @Stability(Experimental)
@Nullable
default software.amazon.awscdk.Duration getSuccessRetentionPeriod()
        (experimental) How many days should successful runs be retained.

        Default: Duration.days(31)

      • getThreadCount

        @Stability(Experimental)
@Nullable
default Number getThreadCount()
        (experimental) The number of threads to run concurrently for the synthetic test.

        Default: - 20

      • getTimeToLive

        @Stability(Experimental)
@Nullable
default software.amazon.awscdk.Duration getTimeToLive()
        (experimental) How long the canary will be in a 'RUNNING' state.

        For example, if you set timeToLive to be 1 hour and schedule to be rate(10 minutes), your canary will run at 10 minute intervals for an hour, for a total of 6 times.

        Default: - no limit

      • getVpc

        @Stability(Experimental)
@Nullable
default software.amazon.awscdk.services.ec2.IVpc getVpc()
        (experimental) The VPC where this canary is run.

        Specify this if the canary needs to access resources in a VPC.

        Default: - Not in VPC

      • getVpcSubnets

        @Stability(Experimental)
@Nullable
default software.amazon.awscdk.services.ec2.SubnetSelection getVpcSubnets()
        (experimental) Where to place the network interfaces within the VPC.

        You must provide vpc when using this prop.

        Default: - the Vpc default strategy if not specified