Package software.amazon.awscdk.services.synthetics

Class CfnCanary.RunConfigProperty.Builder

java.lang.Object
software.amazon.awscdk.services.synthetics.CfnCanary.RunConfigProperty.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnCanary.RunConfigProperty>
Enclosing interface:
CfnCanary.RunConfigProperty
@Stability(Stable) public static final class CfnCanary.RunConfigProperty.Builder extends Object implements software.amazon.jsii.Builder<CfnCanary.RunConfigProperty>
A builder for CfnCanary.RunConfigProperty

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • activeTracing

      @Stability(Stable) public CfnCanary.RunConfigProperty.Builder activeTracing(Boolean activeTracing)
      Sets the value of CfnCanary.RunConfigProperty.getActiveTracing()
      Parameters:
      activeTracing - Specifies whether this canary is to use active AWS X-Ray tracing when it runs. Active tracing enables this canary run to be displayed in the ServiceLens and X-Ray service maps even if the canary does not hit an endpoint that has X-Ray tracing enabled. Using X-Ray tracing incurs charges. For more information, see Canaries and X-Ray tracing .

      You can enable active tracing only for canaries that use version syn-nodejs-2.0 or later for their canary runtime.

      Returns:
      this

    • activeTracing

      @Stability(Stable) public CfnCanary.RunConfigProperty.Builder activeTracing(IResolvable activeTracing)
      Sets the value of CfnCanary.RunConfigProperty.getActiveTracing()
      Parameters:
      activeTracing - Specifies whether this canary is to use active AWS X-Ray tracing when it runs. Active tracing enables this canary run to be displayed in the ServiceLens and X-Ray service maps even if the canary does not hit an endpoint that has X-Ray tracing enabled. Using X-Ray tracing incurs charges. For more information, see Canaries and X-Ray tracing .

      You can enable active tracing only for canaries that use version syn-nodejs-2.0 or later for their canary runtime.

      Returns:
      this

    • environmentVariables

      @Stability(Stable) public CfnCanary.RunConfigProperty.Builder environmentVariables(IResolvable environmentVariables)
      Sets the value of CfnCanary.RunConfigProperty.getEnvironmentVariables()
      Parameters:
      environmentVariables - Specifies the keys and values to use for any environment variables used in the canary script. Use the following format:

      { "key1" : "value1", "key2" : "value2", ...}

      Keys must start with a letter and be at least two characters. The total size of your environment variables cannot exceed 4 KB. You can't specify any Lambda reserved environment variables as the keys for your environment variables. For more information about reserved keys, see Runtime environment variables .

      Returns:
      this

    • environmentVariables

      @Stability(Stable) public CfnCanary.RunConfigProperty.Builder environmentVariables(Map<String,String> environmentVariables)
      Sets the value of CfnCanary.RunConfigProperty.getEnvironmentVariables()
      Parameters:
      environmentVariables - Specifies the keys and values to use for any environment variables used in the canary script. Use the following format:

      { "key1" : "value1", "key2" : "value2", ...}

      Keys must start with a letter and be at least two characters. The total size of your environment variables cannot exceed 4 KB. You can't specify any Lambda reserved environment variables as the keys for your environment variables. For more information about reserved keys, see Runtime environment variables .

      Returns:
      this

    • memoryInMb

      @Stability(Stable) public CfnCanary.RunConfigProperty.Builder memoryInMb(Number memoryInMb)
      Sets the value of CfnCanary.RunConfigProperty.getMemoryInMb()
      Parameters:
      memoryInMb - The maximum amount of memory that the canary can use while running. This value must be a multiple of 64. The range is 960 to 3008.
      Returns:
      this

    • timeoutInSeconds

      @Stability(Stable) public CfnCanary.RunConfigProperty.Builder timeoutInSeconds(Number timeoutInSeconds)
      Sets the value of CfnCanary.RunConfigProperty.getTimeoutInSeconds()
      Parameters:
      timeoutInSeconds - How long the canary is allowed to run before it must stop. You can't set this time to be longer than the frequency of the runs of this canary.

      If you omit this field, the frequency of the canary is used as this value, up to a maximum of 900 seconds.

      Returns:
      this

    • build

      @Stability(Stable) public CfnCanary.RunConfigProperty build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnCanary.RunConfigProperty>
      Returns:
      a new instance of CfnCanary.RunConfigProperty
      Throws:
      NullPointerException - if any required attribute was not provided