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

Class CfnCanaryPropsMixin.RunConfigProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.synthetics.CfnCanaryPropsMixin.RunConfigProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCanaryPropsMixin.RunConfigProperty>

Enclosing interface:

CfnCanaryPropsMixin.RunConfigProperty

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

A builder for CfnCanaryPropsMixin.RunConfigProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnCanaryPropsMixin.RunConfigProperty.Builder	activeTracing(Boolean activeTracing)	Sets the value of CfnCanaryPropsMixin.RunConfigProperty.getActiveTracing()
CfnCanaryPropsMixin.RunConfigProperty.Builder	activeTracing(IResolvable activeTracing)	Sets the value of CfnCanaryPropsMixin.RunConfigProperty.getActiveTracing()
CfnCanaryPropsMixin.RunConfigProperty	build()	Builds the configured instance.
CfnCanaryPropsMixin.RunConfigProperty.Builder	environmentVariables(Map<String,String> environmentVariables)	Sets the value of CfnCanaryPropsMixin.RunConfigProperty.getEnvironmentVariables()
CfnCanaryPropsMixin.RunConfigProperty.Builder	environmentVariables(IResolvable environmentVariables)	Sets the value of CfnCanaryPropsMixin.RunConfigProperty.getEnvironmentVariables()
CfnCanaryPropsMixin.RunConfigProperty.Builder	ephemeralStorage(Number ephemeralStorage)	Sets the value of CfnCanaryPropsMixin.RunConfigProperty.getEphemeralStorage()
CfnCanaryPropsMixin.RunConfigProperty.Builder	memoryInMb(Number memoryInMb)	Sets the value of CfnCanaryPropsMixin.RunConfigProperty.getMemoryInMb()
CfnCanaryPropsMixin.RunConfigProperty.Builder	timeoutInSeconds(Number timeoutInSeconds)	Sets the value of CfnCanaryPropsMixin.RunConfigProperty.getTimeoutInSeconds()

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

activeTracing

@Stability(Stable)
public CfnCanaryPropsMixin.RunConfigProperty.Builder activeTracing(Boolean activeTracing)

Sets the value of CfnCanaryPropsMixin.RunConfigProperty.getActiveTracing()

Parameters:

activeTracing - 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:

this

activeTracing

@Stability(Stable)
public CfnCanaryPropsMixin.RunConfigProperty.Builder activeTracing(IResolvable activeTracing)

Sets the value of CfnCanaryPropsMixin.RunConfigProperty.getActiveTracing()

Parameters:

activeTracing - 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:

this

environmentVariables

@Stability(Stable)
public CfnCanaryPropsMixin.RunConfigProperty.Builder environmentVariables(Map<String,String> environmentVariables)

Sets the value of CfnCanaryPropsMixin.RunConfigProperty.getEnvironmentVariables()

Parameters:

environmentVariables - 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:

this

environmentVariables

@Stability(Stable)
public CfnCanaryPropsMixin.RunConfigProperty.Builder environmentVariables(IResolvable environmentVariables)

Sets the value of CfnCanaryPropsMixin.RunConfigProperty.getEnvironmentVariables()

Parameters:

environmentVariables - 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:

this

ephemeralStorage

@Stability(Stable)
public CfnCanaryPropsMixin.RunConfigProperty.Builder ephemeralStorage(Number ephemeralStorage)

Sets the value of CfnCanaryPropsMixin.RunConfigProperty.getEphemeralStorage()

Parameters:

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

Returns:

this

memoryInMb

@Stability(Stable)
public CfnCanaryPropsMixin.RunConfigProperty.Builder memoryInMb(Number memoryInMb)

Sets the value of CfnCanaryPropsMixin.RunConfigProperty.getMemoryInMb()

Parameters:

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

Returns:

this

timeoutInSeconds

@Stability(Stable)
public CfnCanaryPropsMixin.RunConfigProperty.Builder timeoutInSeconds(Number timeoutInSeconds)

Sets the value of CfnCanaryPropsMixin.RunConfigProperty.getTimeoutInSeconds()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnCanaryPropsMixin.RunConfigProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnCanaryPropsMixin.RunConfigProperty>

Returns:

a new instance of CfnCanaryPropsMixin.RunConfigProperty

Throws:

NullPointerException - if any required attribute was not provided