software.amazon.awscdk.services.synthetics

Class Code

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.synthetics.Code

Direct Known Subclasses:

AssetCode, InlineCode, S3Code

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:43.939Z")
public abstract class Code
extends software.amazon.jsii.JsiiObject

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

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Code

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

Code

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

Code

protected Code()

Method Detail

fromAsset

public static AssetCode fromAsset(java.lang.String assetPath,
                                  AssetOptions options)

(experimental) 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

public static AssetCode fromAsset(java.lang.String assetPath)

(experimental) 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

public static S3Code fromBucket(IBucket bucket,
                                java.lang.String key,
                                java.lang.String objectVersion)

(experimental) 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

public static S3Code fromBucket(IBucket bucket,
                                java.lang.String key)

(experimental) 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

public static InlineCode fromInline(java.lang.String code)

(experimental) Specify code inline.

Parameters:

code - The actual handler code (limited to 4KiB). This parameter is required.

Returns:

`InlineCode` with inline code.

bind

public abstract CodeConfig bind(software.constructs.Construct scope,
                                java.lang.String handler,
                                RuntimeFamily family)

(experimental) 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`.