Package software.amazon.awscdk.services.synthetics

Interface CustomTestOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CustomTestOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:48.479Z")
@Stability(Stable)
public interface CustomTestOptions
extends software.amazon.jsii.JsiiSerializable

Properties for specifying a test.

Example:

 Canary canary = Canary.Builder.create(this, "MyCanary")
         .schedule(Schedule.rate(Duration.minutes(5)))
         .test(Test.custom(CustomTestOptions.builder()
                 .code(Code.fromAsset(join(__dirname, "canary")))
                 .handler("index.handler")
                 .build()))
         .runtime(Runtime.SYNTHETICS_NODEJS_PUPPETEER_7_0)
         .resourcesToReplicateTags(List.of(ResourceToReplicateTags.LAMBDA_FUNCTION))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CustomTestOptions.Builder	builder()
Code	getCode()	The code of the canary script.
String	getHandler()	The handler for the code.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCode

@Stability(Stable)
@NotNull
Code getCode()

The code of the canary script.

getHandler

@Stability(Stable)
@NotNull
String getHandler()

The handler for the code.

Must end with .handler.

builder

@Stability(Stable)
static CustomTestOptions.Builder builder()

Returns:

a CustomTestOptions.Builder of CustomTestOptions