Package software.amazon.awscdk.cfnpropertymixins.services.synthetics

Class CfnCanaryPropsMixin.CodeProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.cfnpropertymixins.services.synthetics.CfnCanaryPropsMixin.CodeProperty.Jsii$Proxy

All Implemented Interfaces:

CfnCanaryPropsMixin.CodeProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnCanaryPropsMixin.CodeProperty

@Stability(Stable)
@Internal
public static final class CfnCanaryPropsMixin.CodeProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnCanaryPropsMixin.CodeProperty

An implementation for CfnCanaryPropsMixin.CodeProperty

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.cfnpropertymixins.services.synthetics.CfnCanaryPropsMixin.CodeProperty

CfnCanaryPropsMixin.CodeProperty.Builder, CfnCanaryPropsMixin.CodeProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnCanaryPropsMixin.CodeProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnCanaryPropsMixin.CodeProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final List<String>	getBlueprintTypes()	BlueprintTypes are a list of templates that enable simplified canary creation.
final Object	getDependencies()	List of Lambda layers to attach to the canary.
final String	getHandler()	The entry point to use for the source code when running the canary.
final Object	getS3Bucket()	If your canary script is located in S3, specify the bucket name here.
final String	getS3Key()	The Amazon S3 key of your script.
final String	getS3ObjectVersion()	The Amazon S3 version ID of your script.
final String	getScript()	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.
final String	getSourceLocationArn()	The ARN of the Lambda layer where Synthetics stores the canary script code.
final int	hashCode()

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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnCanaryPropsMixin.CodeProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnCanaryPropsMixin.CodeProperty.Builder.

Method Details

getBlueprintTypes

public final List<String> getBlueprintTypes()

Description copied from interface: CfnCanaryPropsMixin.CodeProperty

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.

Specified by:

getBlueprintTypes in interface CfnCanaryPropsMixin.CodeProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-code.html#cfn-synthetics-canary-code-blueprinttypes

getDependencies

public final Object getDependencies()

Description copied from interface: CfnCanaryPropsMixin.CodeProperty

List of Lambda layers to attach to the canary.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnCanaryPropsMixin.DependencyProperty>

Specified by:

getDependencies in interface CfnCanaryPropsMixin.CodeProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-code.html#cfn-synthetics-canary-code-dependencies

getHandler

public final String getHandler()

Description copied from interface: CfnCanaryPropsMixin.CodeProperty

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 .

Specified by:

getHandler in interface CfnCanaryPropsMixin.CodeProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-code.html#cfn-synthetics-canary-code-handler

getS3Bucket

public final Object getS3Bucket()

Description copied from interface: CfnCanaryPropsMixin.CodeProperty

If your canary script is located in S3, specify the bucket name here.

The bucket must already exist.

Returns union: either String or IBucketRef

Specified by:

getS3Bucket in interface CfnCanaryPropsMixin.CodeProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-code.html#cfn-synthetics-canary-code-s3bucket

getS3Key

public final String getS3Key()

Description copied from interface: CfnCanaryPropsMixin.CodeProperty

The Amazon S3 key of your script.

For more information, see Working with Amazon S3 Objects .

Specified by:

getS3Key in interface CfnCanaryPropsMixin.CodeProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-code.html#cfn-synthetics-canary-code-s3key

getS3ObjectVersion

public final String getS3ObjectVersion()

Description copied from interface: CfnCanaryPropsMixin.CodeProperty

The Amazon S3 version ID of your script.

Specified by:

getS3ObjectVersion in interface CfnCanaryPropsMixin.CodeProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-code.html#cfn-synthetics-canary-code-s3objectversion

getScript

public final String getScript()

Description copied from interface: CfnCanaryPropsMixin.CodeProperty

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.

Specified by:

getScript in interface CfnCanaryPropsMixin.CodeProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-code.html#cfn-synthetics-canary-code-script

getSourceLocationArn

public final String getSourceLocationArn()

Description copied from interface: CfnCanaryPropsMixin.CodeProperty

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

Specified by:

getSourceLocationArn in interface CfnCanaryPropsMixin.CodeProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-code.html#cfn-synthetics-canary-code-sourcelocationarn

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object