Interface CanaryCodeOutput.Builder

All Superinterfaces:
Buildable, CopyableBuilder<CanaryCodeOutput.Builder,CanaryCodeOutput>, SdkBuilder<CanaryCodeOutput.Builder,CanaryCodeOutput>, SdkPojo
Enclosing class:
CanaryCodeOutput
@Mutable @NotThreadSafe public static interface CanaryCodeOutput.Builder extends SdkPojo, CopyableBuilder<CanaryCodeOutput.Builder,CanaryCodeOutput>

  • Method Details

    • sourceLocationArn

      CanaryCodeOutput.Builder sourceLocationArn(String sourceLocationArn)

      The ARN of the Lambda layer where Synthetics stores the canary script code.

      Parameters:
      sourceLocationArn - The ARN of the Lambda layer where Synthetics stores the canary script code.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • handler

      CanaryCodeOutput.Builder handler(String handler)

      The entry point to use for the source code when running the canary.

      This field is required when you don't specify BlueprintTypes and is not allowed when you specify BlueprintTypes.

      Parameters:
      handler - The entry point to use for the source code when running the canary.

      This field is required when you don't specify BlueprintTypes and is not allowed when you specify BlueprintTypes.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • blueprintTypes

      CanaryCodeOutput.Builder blueprintTypes(Collection<String> blueprintTypes)

      BlueprintTypes is a list of templates that enable simplified canary creation. You can create canaries for common monitoring scenarios by providing only a JSON configuration file instead of writing custom scripts. The only supported value is multi-checks.

      Multi-checks monitors HTTP/DNS/SSL/TCP endpoints with built-in authentication schemes (Basic, API Key, OAuth, SigV4) and assertion capabilities. When you specify BlueprintTypes, the Handler field cannot be specified since the blueprint provides a pre-defined entry point.

      BlueprintTypes is supported only on canaries for syn-nodejs-3.0 runtime or later.

      Parameters:
      blueprintTypes - BlueprintTypes is a list of templates that enable simplified canary creation. You can create canaries for common monitoring scenarios by providing only a JSON configuration file instead of writing custom scripts. The only supported value is multi-checks.

      Multi-checks monitors HTTP/DNS/SSL/TCP endpoints with built-in authentication schemes (Basic, API Key, OAuth, SigV4) and assertion capabilities. When you specify BlueprintTypes, the Handler field cannot be specified since the blueprint provides a pre-defined entry point.

      BlueprintTypes is supported only on canaries for syn-nodejs-3.0 runtime or later.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • blueprintTypes

      CanaryCodeOutput.Builder blueprintTypes(String... blueprintTypes)

      BlueprintTypes is a list of templates that enable simplified canary creation. You can create canaries for common monitoring scenarios by providing only a JSON configuration file instead of writing custom scripts. The only supported value is multi-checks.

      Multi-checks monitors HTTP/DNS/SSL/TCP endpoints with built-in authentication schemes (Basic, API Key, OAuth, SigV4) and assertion capabilities. When you specify BlueprintTypes, the Handler field cannot be specified since the blueprint provides a pre-defined entry point.

      BlueprintTypes is supported only on canaries for syn-nodejs-3.0 runtime or later.

      Parameters:
      blueprintTypes - BlueprintTypes is a list of templates that enable simplified canary creation. You can create canaries for common monitoring scenarios by providing only a JSON configuration file instead of writing custom scripts. The only supported value is multi-checks.

      Multi-checks monitors HTTP/DNS/SSL/TCP endpoints with built-in authentication schemes (Basic, API Key, OAuth, SigV4) and assertion capabilities. When you specify BlueprintTypes, the Handler field cannot be specified since the blueprint provides a pre-defined entry point.

      BlueprintTypes is supported only on canaries for syn-nodejs-3.0 runtime or later.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dependencies

      CanaryCodeOutput.Builder dependencies(Collection<Dependency> dependencies)

      A list of dependencies that are used for running this canary. The dependencies are specified as a key-value pair, where the key is the type of dependency and the value is the dependency reference.

      Parameters:
      dependencies - A list of dependencies that are used for running this canary. The dependencies are specified as a key-value pair, where the key is the type of dependency and the value is the dependency reference.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dependencies

      CanaryCodeOutput.Builder dependencies(Dependency... dependencies)

      A list of dependencies that are used for running this canary. The dependencies are specified as a key-value pair, where the key is the type of dependency and the value is the dependency reference.

      Parameters:
      dependencies - A list of dependencies that are used for running this canary. The dependencies are specified as a key-value pair, where the key is the type of dependency and the value is the dependency reference.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dependencies

      CanaryCodeOutput.Builder dependencies(Consumer<Dependency.Builder>... dependencies)

      A list of dependencies that are used for running this canary. The dependencies are specified as a key-value pair, where the key is the type of dependency and the value is the dependency reference.

      This is a convenience method that creates an instance of the Dependency.Builder avoiding the need to create one manually via Dependency.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dependencies(List<Dependency>).

      Parameters:
      dependencies - a consumer that will call methods on Dependency.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: