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

Class CfnCanaryPropsMixin.RunConfigProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

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

All Implemented Interfaces:

CfnCanaryPropsMixin.RunConfigProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnCanaryPropsMixin.RunConfigProperty

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

An implementation for CfnCanaryPropsMixin.RunConfigProperty

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

CfnCanaryPropsMixin.RunConfigProperty.Builder, CfnCanaryPropsMixin.RunConfigProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnCanaryPropsMixin.RunConfigProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnCanaryPropsMixin.RunConfigProperty.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 Object	getActiveTracing()	Specifies whether this canary is to use active AWS X-Ray tracing when it runs.
final Object	getEnvironmentVariables()	Specifies the keys and values to use for any environment variables used in the canary script.
final Number	getEphemeralStorage()	Specifies the amount of ephemeral storage (in MB) to allocate for the canary run during execution.
final Number	getMemoryInMb()	The maximum amount of memory that the canary can use while running.
final Number	getTimeoutInSeconds()	How long the canary is allowed to run before it must stop.
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.RunConfigProperty.Builder builder)

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

Method Details

getActiveTracing

public final Object getActiveTracing()

Description copied from interface: CfnCanaryPropsMixin.RunConfigProperty

Specifies whether this canary is to use active AWS X-Ray tracing when it runs.

Active tracing enables this canary run to be displayed in the ServiceLens and X-Ray service maps even if the canary does not hit an endpoint that has X-Ray tracing enabled. Using X-Ray tracing incurs charges. For more information, see Canaries and X-Ray tracing .

You can enable active tracing only for canaries that use version syn-nodejs-2.0 or later for their canary runtime.

Returns union: either Boolean or IResolvable

Specified by:

getActiveTracing in interface CfnCanaryPropsMixin.RunConfigProperty

See Also:

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

getEnvironmentVariables

public final Object getEnvironmentVariables()

Description copied from interface: CfnCanaryPropsMixin.RunConfigProperty

Specifies the keys and values to use for any environment variables used in the canary script.

Use the following format:

{ "key1" : "value1", "key2" : "value2", ...}

Keys must start with a letter and be at least two characters. The total size of your environment variables cannot exceed 4 KB. You can't specify any Lambda reserved environment variables as the keys for your environment variables. For more information about reserved keys, see Runtime environment variables .

Returns union: either Mapinvalid input: '<'String, String> or IResolvable

Specified by:

getEnvironmentVariables in interface CfnCanaryPropsMixin.RunConfigProperty

See Also:

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

getEphemeralStorage

public final Number getEphemeralStorage()

Description copied from interface: CfnCanaryPropsMixin.RunConfigProperty

Specifies the amount of ephemeral storage (in MB) to allocate for the canary run during execution.

This temporary storage is used for storing canary run artifacts (which are uploaded to an Amazon S3 bucket at the end of the run), and any canary browser operations. This temporary storage is cleared after the run is completed. Default storage value is 1024 MB.

Specified by:

getEphemeralStorage in interface CfnCanaryPropsMixin.RunConfigProperty

See Also:

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

getMemoryInMb

public final Number getMemoryInMb()

Description copied from interface: CfnCanaryPropsMixin.RunConfigProperty

The maximum amount of memory that the canary can use while running.

This value must be a multiple of 64. The range is 960 to 3008.

Specified by:

getMemoryInMb in interface CfnCanaryPropsMixin.RunConfigProperty

See Also:

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

getTimeoutInSeconds

public final Number getTimeoutInSeconds()

Description copied from interface: CfnCanaryPropsMixin.RunConfigProperty

How long the canary is allowed to run before it must stop.

You can't set this time to be longer than the frequency of the runs of this canary.

If you omit this field, the frequency of the canary is used as this value, up to a maximum of 900 seconds.

Specified by:

getTimeoutInSeconds in interface CfnCanaryPropsMixin.RunConfigProperty

See Also:

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

$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