Class CanaryCodeInput

java.lang.Object
software.amazon.awssdk.services.synthetics.model.CanaryCodeInput
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CanaryCodeInput.Builder,CanaryCodeInput>
@Generated("software.amazon.awssdk:codegen") public final class CanaryCodeInput extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CanaryCodeInput.Builder,CanaryCodeInput>

Use this structure to input your script code for the canary. This structure contains the Lambda handler with the location where the canary should start running the script. If the script is stored in an Amazon S3 bucket, the bucket name, key, and version are also included. If the script was passed into the canary directly, the script code is contained in the value of Zipfile.

If you are uploading your canary scripts with an Amazon S3 bucket, your zip file should include your script in a certain folder structure.

See Also:

  • Method Details

    • s3Bucket

      public final String s3Bucket()

      If your canary script is located in Amazon S3, specify the bucket name here. Do not include s3:// as the start of the bucket name.

      Returns:
      If your canary script is located in Amazon S3, specify the bucket name here. Do not include s3:// as the start of the bucket name.

    • s3Key

      public final String s3Key()

      The Amazon S3 key of your script. For more information, see Working with Amazon S3 Objects.

      Returns:
      The Amazon S3 key of your script. For more information, see Working with Amazon S3 Objects.

    • s3Version

      public final String s3Version()

      The Amazon S3 version ID of your script.

      Returns:
      The Amazon S3 version ID of your script.

    • zipFile

      public final SdkBytes zipFile()

      If you input your canary script directly into the canary instead of referring to an Amazon S3 location, the value of this parameter is the base64-encoded contents of the .zip file that contains the script. It must be smaller than 225 Kb.

      For large canary scripts, we recommend that you use an Amazon S3 location instead of inputting it directly with this parameter.

      Returns:
      If you input your canary script directly into the canary instead of referring to an Amazon S3 location, the value of this parameter is the base64-encoded contents of the .zip file that contains the script. It must be smaller than 225 Kb.

      For large canary scripts, we recommend that you use an Amazon S3 location instead of inputting it directly with this parameter.

    • handler

      public final String handler()

      The entry point to use for the source code when running the canary. For canaries that use the syn-python-selenium-1.0 runtime or a syn-nodejs.puppeteer runtime earlier than syn-nodejs.puppeteer-3.4, the handler must be specified as fileName.handler. For syn-python-selenium-1.1, syn-nodejs.puppeteer-3.4, and later runtimes, the handler can be specified as fileName.functionName , or you can specify a folder where canary scripts reside as folder/fileName.functionName .

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

      Returns:
      The entry point to use for the source code when running the canary. For canaries that use the syn-python-selenium-1.0 runtime or a syn-nodejs.puppeteer runtime earlier than syn-nodejs.puppeteer-3.4, the handler must be specified as fileName.handler. For syn-python-selenium-1.1, syn-nodejs.puppeteer-3.4, and later runtimes, the handler can be specified as fileName.functionName , or you can specify a folder where canary scripts reside as folder/fileName.functionName .

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

    • hasBlueprintTypes

      public final boolean hasBlueprintTypes()
      For responses, this returns true if the service returned a value for the BlueprintTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • blueprintTypes

      public final List<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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasBlueprintTypes() method.

      Returns:
      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.

    • hasDependencies

      public final boolean hasDependencies()
      For responses, this returns true if the service returned a value for the Dependencies property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • dependencies

      public final List<Dependency> dependencies()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDependencies() method.

      Returns:
      A list of dependencies that should be used for running this canary. Specify the dependencies as a key-value pair, where the key is the type of dependency and the value is the dependency reference.

    • toBuilder

      public CanaryCodeInput.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CanaryCodeInput.Builder,CanaryCodeInput>
      Returns:
      a builder for type T

    • builder

      public static CanaryCodeInput.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CanaryCodeInput.Builder> serializableBuilderClass()

    • hashCode

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

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.