software.amazon.awscdk.services.synthetics.alpha

Interface CustomTestOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CustomTestOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-02-09T02:01:26.355Z")
 @Stability(value=Experimental)
public interface CustomTestOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) 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_3_8)
         .environmentVariables(Map.of(
                 "stage", "prod"))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCode

@Stability(value=Experimental)
 @NotNull
Code getCode()

(experimental) The code of the canary script.

getHandler

@Stability(value=Experimental)
 @NotNull
String getHandler()

(experimental) The handler for the code.

Must end with .handler.

builder

@Stability(value=Experimental)
static CustomTestOptions.Builder builder()

Returns:

a CustomTestOptions.Builder of CustomTestOptions