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

Class ApiCanaryProps.Jsii$Proxy

  • All Implemented Interfaces:
    ApiCanaryProps, software.amazon.jsii.JsiiSerializable
    Enclosing interface:
    ApiCanaryProps
    @Stability(Experimental)
@Internal
public static final class ApiCanaryProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements ApiCanaryProps
    An implementation for ApiCanaryProps

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected Jsii$Proxy​(ApiCanaryProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the ApiCanaryProps.Builder.
      protected Jsii$Proxy​(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.fasterxml.jackson.databind.JsonNode $jsii$toJson()  
      boolean equals​(Object o)  
      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.
      String getCanaryName()
      (experimental) The name of the canary.
      software.amazon.awscdk.Duration getDurationAlarmThreshold()
      (experimental) The threshold for triggering an alarm on the test duration.
      software.amazon.awscdk.Duration getFailureRetentionPeriod()
      (experimental) How many days should failed runs be retained.
      software.amazon.awscdk.services.iam.IRole getRole()
      (experimental) Canary execution role.
      software.amazon.awscdk.services.synthetics.Schedule getSchedule()
      (experimental) Specify the schedule for how often the canary runs.
      List<software.amazon.awscdk.services.ec2.ISecurityGroup> getSecurityGroups()
      (experimental) The list of security groups to associate with the canary's network interfaces.
      Boolean getStartAfterCreation()
      (experimental) Whether or not the canary should start after creation.
      List<ApiTestStep> getSteps()
      (experimental) The steps to perform in the synthetic test.
      software.amazon.awscdk.Duration getSuccessRetentionPeriod()
      (experimental) How many days should successful runs be retained.
      Number getThreadCount()
      (experimental) The number of threads to run concurrently for the synthetic test.
      software.amazon.awscdk.Duration getTimeToLive()
      (experimental) How long the canary will be in a 'RUNNING' state.
      software.amazon.awscdk.services.ec2.IVpc getVpc()
      (experimental) The VPC where this canary is run.
      software.amazon.awscdk.services.ec2.SubnetSelection getVpcSubnets()
      (experimental) Where to place the network interfaces within the VPC.
      int hashCode()  

      • Methods inherited from class software.amazon.jsii.JsiiObject

        jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    • Constructor Detail

      • Jsii$Proxy

        protected Jsii$Proxy​(software.amazon.jsii.JsiiObjectRef objRef)
        Constructor that initializes the object based on values retrieved from the JsiiObject.
        Parameters:
        objRef - Reference to the JSII managed object.

    • Method Detail

      • getArtifactsBucketLocation

        public final software.amazon.awscdk.services.synthetics.ArtifactsBucketLocation getArtifactsBucketLocation()
        Description copied from interface: ApiCanaryProps
        (experimental) The s3 location that stores the data of the canary runs.

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

        Specified by:
        getArtifactsBucketLocation in interface ApiCanaryProps

      • getDurationAlarmThreshold

        public final software.amazon.awscdk.Duration getDurationAlarmThreshold()
        Description copied from interface: ApiCanaryProps
        (experimental) The threshold for triggering an alarm on the test duration.

        Default: - no alarm is created for duration

        Specified by:
        getDurationAlarmThreshold in interface ApiCanaryProps

      • getFailureRetentionPeriod

        public final software.amazon.awscdk.Duration getFailureRetentionPeriod()
        Description copied from interface: ApiCanaryProps
        (experimental) How many days should failed runs be retained.

        Default: Duration.days(31)

        Specified by:
        getFailureRetentionPeriod in interface ApiCanaryProps

      • getSchedule

        public final software.amazon.awscdk.services.synthetics.Schedule getSchedule()
        Description copied from interface: ApiCanaryProps
        (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)'

        Specified by:
        getSchedule in interface ApiCanaryProps

      • getSecurityGroups

        public final List<software.amazon.awscdk.services.ec2.ISecurityGroup> getSecurityGroups()
        Description copied from interface: ApiCanaryProps
        (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.

        Specified by:
        getSecurityGroups in interface ApiCanaryProps

      • getSuccessRetentionPeriod

        public final software.amazon.awscdk.Duration getSuccessRetentionPeriod()
        Description copied from interface: ApiCanaryProps
        (experimental) How many days should successful runs be retained.

        Default: Duration.days(31)

        Specified by:
        getSuccessRetentionPeriod in interface ApiCanaryProps

      • getThreadCount

        public final Number getThreadCount()
        Description copied from interface: ApiCanaryProps
        (experimental) The number of threads to run concurrently for the synthetic test.

        Default: - 20

        Specified by:
        getThreadCount in interface ApiCanaryProps

      • getTimeToLive

        public final software.amazon.awscdk.Duration getTimeToLive()
        Description copied from interface: ApiCanaryProps
        (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

        Specified by:
        getTimeToLive in interface ApiCanaryProps

      • getVpc

        public final software.amazon.awscdk.services.ec2.IVpc getVpc()
        Description copied from interface: ApiCanaryProps
        (experimental) The VPC where this canary is run.

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

        Default: - Not in VPC

        Specified by:
        getVpc in interface ApiCanaryProps

      • getVpcSubnets

        public final software.amazon.awscdk.services.ec2.SubnetSelection getVpcSubnets()
        Description copied from interface: ApiCanaryProps
        (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

        Specified by:
        getVpcSubnets in interface ApiCanaryProps

      • $jsii$toJson

        @Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
        Specified by:
        $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object