Package software.amazon.awssdk.services.synthetics.model

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CanaryCodeInput.Builder

Method Summary

Modifier and Type	Method	Description
static CanaryCodeInput.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	handler()	The entry point to use for the source code when running the canary.
int	hashCode()
String	s3Bucket()	If your canary script is located in S3, specify the bucket name here.
String	s3Key()	The S3 key of your script.
String	s3Version()	The S3 version ID of your script.
List<SdkField<?>>	sdkFields()
static Class<? extends CanaryCodeInput.Builder>	serializableBuilderClass()
CanaryCodeInput.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
SdkBytes	zipFile()	If you input your canary script directly into the canary instead of referring to an S3 location, the value of this parameter is the base64-encoded contents of the .zip file that contains the script.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

s3Bucket

public final String s3Bucket()

If your canary script is located in 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 S3, specify the bucket name here. Do not include s3:// as the start of the bucket name.

s3Key

public final String s3Key()

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

Returns:

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

s3Version

public final String s3Version()

The S3 version ID of your script.

Returns:

The 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 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 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 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 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 .

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 .

toBuilder

public CanaryCodeInput.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CanaryCodeInput.Builder,CanaryCodeInput>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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