Package software.amazon.awscdk.services.synthetics

Class CfnCanary.CodeProperty.Builder

java.lang.Object

software.amazon.awscdk.services.synthetics.CfnCanary.CodeProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCanary.CodeProperty>

Enclosing interface:

CfnCanary.CodeProperty

@Stability(Stable)
public static final class CfnCanary.CodeProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnCanary.CodeProperty>

A builder for CfnCanary.CodeProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnCanary.CodeProperty.Builder	blueprintTypes(List<String> blueprintTypes)	Sets the value of CfnCanary.CodeProperty.getBlueprintTypes()
CfnCanary.CodeProperty	build()	Builds the configured instance.
CfnCanary.CodeProperty.Builder	dependencies(List<? extends Object> dependencies)	Sets the value of CfnCanary.CodeProperty.getDependencies()
CfnCanary.CodeProperty.Builder	dependencies(IResolvable dependencies)	Sets the value of CfnCanary.CodeProperty.getDependencies()
CfnCanary.CodeProperty.Builder	handler(String handler)	Sets the value of CfnCanary.CodeProperty.getHandler()
CfnCanary.CodeProperty.Builder	s3Bucket(String s3Bucket)	Sets the value of CfnCanary.CodeProperty.getS3Bucket()
CfnCanary.CodeProperty.Builder	s3Key(String s3Key)	Sets the value of CfnCanary.CodeProperty.getS3Key()
CfnCanary.CodeProperty.Builder	s3ObjectVersion(String s3ObjectVersion)	Sets the value of CfnCanary.CodeProperty.getS3ObjectVersion()
CfnCanary.CodeProperty.Builder	script(String script)	Sets the value of CfnCanary.CodeProperty.getScript()
CfnCanary.CodeProperty.Builder	sourceLocationArn(String sourceLocationArn)	Sets the value of CfnCanary.CodeProperty.getSourceLocationArn()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

blueprintTypes

@Stability(Stable)
public CfnCanary.CodeProperty.Builder blueprintTypes(List<String> blueprintTypes)

Sets the value of CfnCanary.CodeProperty.getBlueprintTypes()

Parameters:

blueprintTypes - BlueprintTypes are a list of templates that enable simplified canary creation. You can create canaries for common monitoring scenarios by providing only a JSON configuration file instead of writing custom scripts. multi-checks is the only supported value.

When you specify BlueprintTypes , the Handler field cannot be specified since the blueprint provides a pre-defined entry point.

Returns:

this

dependencies

@Stability(Stable)
public CfnCanary.CodeProperty.Builder dependencies(IResolvable dependencies)

Sets the value of CfnCanary.CodeProperty.getDependencies()

Parameters:

dependencies - List of Lambda layers to attach to the canary.

Returns:

this

dependencies

@Stability(Stable)
public CfnCanary.CodeProperty.Builder dependencies(List<? extends Object> dependencies)

Sets the value of CfnCanary.CodeProperty.getDependencies()

Parameters:

dependencies - List of Lambda layers to attach to the canary.

Returns:

this

handler

@Stability(Stable)
public CfnCanary.CodeProperty.Builder handler(String handler)

Sets the value of CfnCanary.CodeProperty.getHandler()

Parameters:

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

This field is required when you don't specify BlueprintTypes and is not allowed when you specify BlueprintTypes .

Returns:

this

s3Bucket

@Stability(Stable)
public CfnCanary.CodeProperty.Builder s3Bucket(String s3Bucket)

Sets the value of CfnCanary.CodeProperty.getS3Bucket()

Parameters:

s3Bucket - If your canary script is located in S3, specify the bucket name here. The bucket must already exist.

Returns:

this

s3Key

@Stability(Stable)
public CfnCanary.CodeProperty.Builder s3Key(String s3Key)

Sets the value of CfnCanary.CodeProperty.getS3Key()

Parameters:

s3Key - The Amazon S3 key of your script. For more information, see Working with Amazon S3 Objects .

Returns:

this

s3ObjectVersion

@Stability(Stable)
public CfnCanary.CodeProperty.Builder s3ObjectVersion(String s3ObjectVersion)

Sets the value of CfnCanary.CodeProperty.getS3ObjectVersion()

Parameters:

s3ObjectVersion - The Amazon S3 version ID of your script.

Returns:

this

script

@Stability(Stable)
public CfnCanary.CodeProperty.Builder script(String script)

Sets the value of CfnCanary.CodeProperty.getScript()

Parameters:

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

Returns:

this

sourceLocationArn

@Stability(Stable)
public CfnCanary.CodeProperty.Builder sourceLocationArn(String sourceLocationArn)

Sets the value of CfnCanary.CodeProperty.getSourceLocationArn()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnCanary.CodeProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnCanary.CodeProperty>

Returns:

a new instance of CfnCanary.CodeProperty

Throws:

NullPointerException - if any required attribute was not provided