software.amazon.awssdk.services.synthetics.model

Interface CanaryRunConfigInput.Builder

All Superinterfaces:

Buildable, CopyableBuilder<CanaryRunConfigInput.Builder,CanaryRunConfigInput>, SdkBuilder<CanaryRunConfigInput.Builder,CanaryRunConfigInput>, SdkPojo

Enclosing class:

CanaryRunConfigInput

public static interface CanaryRunConfigInput.Builder
extends SdkPojo, CopyableBuilder<CanaryRunConfigInput.Builder,CanaryRunConfigInput>

Method Summary

Modifier and Type	Method and Description
CanaryRunConfigInput.Builder	activeTracing(Boolean activeTracing) Specifies whether this canary is to use active AWS X-Ray tracing when it runs.
CanaryRunConfigInput.Builder	environmentVariables(Map<String,String> environmentVariables) Specifies the keys and values to use for any environment variables used in the canary script.
CanaryRunConfigInput.Builder	memoryInMB(Integer memoryInMB) The maximum amount of memory available to the canary while it is running, in MB.
CanaryRunConfigInput.Builder	timeoutInSeconds(Integer timeoutInSeconds) How long the canary is allowed to run before it must stop.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

timeoutInSeconds

CanaryRunConfigInput.Builder timeoutInSeconds(Integer 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 14 minutes.

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 14 minutes.

Returns:

Returns a reference to this object so that method calls can be chained together.

memoryInMB

CanaryRunConfigInput.Builder memoryInMB(Integer memoryInMB)

The maximum amount of memory available to the canary while it is running, in MB. This value must be a multiple of 64.

Parameters:

memoryInMB - The maximum amount of memory available to the canary while it is running, in MB. This value must be a multiple of 64.

Returns:

Returns a reference to this object so that method calls can be chained together.

activeTracing

CanaryRunConfigInput.Builder activeTracing(Boolean 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.

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:

Returns a reference to this object so that method calls can be chained together.

environmentVariables

CanaryRunConfigInput.Builder environmentVariables(Map<String,String> 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.

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:

Returns a reference to this object so that method calls can be chained together.