Package software.amazon.awscdk.services.synthetics

Interface CfnCanary.CodeProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCanary.CodeProperty.Jsii$Proxy

Enclosing class:

CfnCanary

@Stability(Stable)
public static interface CfnCanary.CodeProperty
extends software.amazon.jsii.JsiiSerializable

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 is passed into the canary directly, the script code is contained in the value of Script .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.synthetics.*;
 CodeProperty codeProperty = CodeProperty.builder()
         .handler("handler")
         // the properties below are optional
         .s3Bucket("s3Bucket")
         .s3Key("s3Key")
         .s3ObjectVersion("s3ObjectVersion")
         .script("script")
         .sourceLocationArn("sourceLocationArn")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnCanary.CodeProperty.Builder	A builder for CfnCanary.CodeProperty
static final class	CfnCanary.CodeProperty.Jsii$Proxy	An implementation for CfnCanary.CodeProperty

Method Summary

Modifier and Type	Method	Description
static CfnCanary.CodeProperty.Builder	builder()
String	getHandler()	The entry point to use for the source code when running the canary.
default String	getS3Bucket()	If your canary script is located in S3, specify the bucket name here.
default String	getS3Key()	The S3 key of your script.
default String	getS3ObjectVersion()	The S3 version ID of your script.
default String	getScript()	If you input your canary script directly into the canary instead of referring to an S3 location, the value of this parameter is the script in plain text.
default String	getSourceLocationArn()	The ARN of the Lambda layer where Synthetics stores the canary script code.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getHandler

@Stability(Stable)
@NotNull
String getHandler()

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

getS3Bucket

@Stability(Stable)
@Nullable
default String getS3Bucket()

If your canary script is located in S3, specify the bucket name here.

The bucket must already exist.

getS3Key

@Stability(Stable)
@Nullable
default String getS3Key()

The S3 key of your script.

For more information, see Working with Amazon S3 Objects .

getS3ObjectVersion

@Stability(Stable)
@Nullable
default String getS3ObjectVersion()

The S3 version ID of your script.

getScript

@Stability(Stable)
@Nullable
default String getScript()

If you input your canary script directly into the canary instead of referring to an S3 location, the value of this parameter is the script in plain text.

It can be up to 5 MB.

getSourceLocationArn

@Stability(Stable)
@Nullable
default String getSourceLocationArn()

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

builder

@Stability(Stable)
static CfnCanary.CodeProperty.Builder builder()

Returns:

a CfnCanary.CodeProperty.Builder of CfnCanary.CodeProperty