Package software.amazon.awscdk.services.synthetics

Class Code

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.synthetics.Code

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

Direct Known Subclasses:

AssetCode, InlineCode, S3Code

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:25.618Z")
@Stability(Stable)
public abstract class Code
extends software.amazon.jsii.JsiiObject

The code the canary should execute.

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

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Code()
protected	Code(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Code(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
abstract CodeConfig	bind(software.constructs.Construct scope, String handler, RuntimeFamily family)	Called when the canary is initialized to allow this object to bind to the stack, add resources and have fun.
static AssetCode	fromAsset(String assetPath)	Specify code from a local path.
static AssetCode	fromAsset(String assetPath, AssetOptions options)	Specify code from a local path.
static S3Code	fromBucket(IBucket bucket, String key)	Specify code from an s3 bucket.
static S3Code	fromBucket(IBucket bucket, String key, String objectVersion)	Specify code from an s3 bucket.
static InlineCode	fromInline(String code)	Specify code inline.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

Code

protected Code(software.amazon.jsii.JsiiObjectRef objRef)

Code

protected Code(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Code

@Stability(Stable)
protected Code()

Method Details

fromAsset

@Stability(Stable)
@NotNull
public static AssetCode fromAsset(@NotNull
 String assetPath,
 @Nullable
 AssetOptions options)

Specify code from a local path.

Path must include the folder structure nodejs/node_modules/myCanaryFilename.js.

Parameters:

assetPath - Either a directory or a .zip file. This parameter is required.

options -

Returns:

AssetCode associated with the specified path.

See Also:

• https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_WritingCanary.html#CloudWatch_Synthetics_Canaries_write_from_scratch

fromAsset

@Stability(Stable)
@NotNull
public static AssetCode fromAsset(@NotNull
 String assetPath)

Specify code from a local path.

Path must include the folder structure nodejs/node_modules/myCanaryFilename.js.

Parameters:

assetPath - Either a directory or a .zip file. This parameter is required.

Returns:

AssetCode associated with the specified path.

See Also:

• https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_WritingCanary.html#CloudWatch_Synthetics_Canaries_write_from_scratch

fromBucket

@Stability(Stable)
@NotNull
public static S3Code fromBucket(@NotNull
 IBucket bucket,
 @NotNull
 String key,
 @Nullable
 String objectVersion)

Specify code from an s3 bucket.

The object in the s3 bucket must be a .zip file that contains the structure nodejs/node_modules/myCanaryFilename.js.

Parameters:

bucket - The S3 bucket. This parameter is required.

key - The object key. This parameter is required.

objectVersion - Optional S3 object version.

Returns:

S3Code associated with the specified S3 object.

See Also:

• https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_WritingCanary.html#CloudWatch_Synthetics_Canaries_write_from_scratch

fromBucket

@Stability(Stable)
@NotNull
public static S3Code fromBucket(@NotNull
 IBucket bucket,
 @NotNull
 String key)

Specify code from an s3 bucket.

The object in the s3 bucket must be a .zip file that contains the structure nodejs/node_modules/myCanaryFilename.js.

Parameters:

bucket - The S3 bucket. This parameter is required.

key - The object key. This parameter is required.

Returns:

S3Code associated with the specified S3 object.

See Also:

• https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_WritingCanary.html#CloudWatch_Synthetics_Canaries_write_from_scratch

fromInline

@Stability(Stable)
@NotNull
public static InlineCode fromInline(@NotNull
 String code)

Specify code inline.

Parameters:

code - The actual handler code (limited to 5MB). This parameter is required.

Returns:

InlineCode with inline code.

bind

@Stability(Stable)
@NotNull
public abstract CodeConfig bind(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String handler,
 @NotNull
 RuntimeFamily family)

Called when the canary is initialized to allow this object to bind to the stack, add resources and have fun.

Parameters:

scope - The binding scope. This parameter is required.

handler - This parameter is required.

family - This parameter is required.

Returns:

a bound CodeConfig.