AWS SDK for C++  1.9.123
AWS SDK for C++
Public Member Functions | List of all members
Aws::Synthetics::Model::CanaryRunConfigInput Class Reference

#include <CanaryRunConfigInput.h>

Public Member Functions

 CanaryRunConfigInput ()
 
 CanaryRunConfigInput (Aws::Utils::Json::JsonView jsonValue)
 
CanaryRunConfigInputoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
int GetTimeoutInSeconds () const
 
bool TimeoutInSecondsHasBeenSet () const
 
void SetTimeoutInSeconds (int value)
 
CanaryRunConfigInputWithTimeoutInSeconds (int value)
 
int GetMemoryInMB () const
 
bool MemoryInMBHasBeenSet () const
 
void SetMemoryInMB (int value)
 
CanaryRunConfigInputWithMemoryInMB (int value)
 
bool GetActiveTracing () const
 
bool ActiveTracingHasBeenSet () const
 
void SetActiveTracing (bool value)
 
CanaryRunConfigInputWithActiveTracing (bool value)
 
const Aws::Map< Aws::String, Aws::String > & GetEnvironmentVariables () const
 
bool EnvironmentVariablesHasBeenSet () const
 
void SetEnvironmentVariables (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetEnvironmentVariables (Aws::Map< Aws::String, Aws::String > &&value)
 
CanaryRunConfigInputWithEnvironmentVariables (const Aws::Map< Aws::String, Aws::String > &value)
 
CanaryRunConfigInputWithEnvironmentVariables (Aws::Map< Aws::String, Aws::String > &&value)
 
CanaryRunConfigInputAddEnvironmentVariables (const Aws::String &key, const Aws::String &value)
 
CanaryRunConfigInputAddEnvironmentVariables (Aws::String &&key, const Aws::String &value)
 
CanaryRunConfigInputAddEnvironmentVariables (const Aws::String &key, Aws::String &&value)
 
CanaryRunConfigInputAddEnvironmentVariables (Aws::String &&key, Aws::String &&value)
 
CanaryRunConfigInputAddEnvironmentVariables (const char *key, Aws::String &&value)
 
CanaryRunConfigInputAddEnvironmentVariables (Aws::String &&key, const char *value)
 
CanaryRunConfigInputAddEnvironmentVariables (const char *key, const char *value)
 

Detailed Description

A structure that contains input information for a canary run.

See Also:

AWS API Reference

Definition at line 33 of file CanaryRunConfigInput.h.

Constructor & Destructor Documentation

◆ CanaryRunConfigInput() [1/2]

Aws::Synthetics::Model::CanaryRunConfigInput::CanaryRunConfigInput ( )

◆ CanaryRunConfigInput() [2/2]

Aws::Synthetics::Model::CanaryRunConfigInput::CanaryRunConfigInput ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ ActiveTracingHasBeenSet()

bool Aws::Synthetics::Model::CanaryRunConfigInput::ActiveTracingHasBeenSet ( ) const
inline

Specifies whether this canary is to use active 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.

Definition at line 124 of file CanaryRunConfigInput.h.

◆ AddEnvironmentVariables() [1/7]

CanaryRunConfigInput& Aws::Synthetics::Model::CanaryRunConfigInput::AddEnvironmentVariables ( Aws::String &&  key,
Aws::String &&  value 
)
inline

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.

Definition at line 271 of file CanaryRunConfigInput.h.

◆ AddEnvironmentVariables() [2/7]

CanaryRunConfigInput& Aws::Synthetics::Model::CanaryRunConfigInput::AddEnvironmentVariables ( Aws::String &&  key,
const Aws::String value 
)
inline

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.

Definition at line 247 of file CanaryRunConfigInput.h.

◆ AddEnvironmentVariables() [3/7]

CanaryRunConfigInput& Aws::Synthetics::Model::CanaryRunConfigInput::AddEnvironmentVariables ( Aws::String &&  key,
const char *  value 
)
inline

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.

Definition at line 295 of file CanaryRunConfigInput.h.

◆ AddEnvironmentVariables() [4/7]

CanaryRunConfigInput& Aws::Synthetics::Model::CanaryRunConfigInput::AddEnvironmentVariables ( const Aws::String key,
Aws::String &&  value 
)
inline

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.

Definition at line 259 of file CanaryRunConfigInput.h.

◆ AddEnvironmentVariables() [5/7]

CanaryRunConfigInput& Aws::Synthetics::Model::CanaryRunConfigInput::AddEnvironmentVariables ( const Aws::String key,
const Aws::String value 
)
inline

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.

Definition at line 235 of file CanaryRunConfigInput.h.

◆ AddEnvironmentVariables() [6/7]

CanaryRunConfigInput& Aws::Synthetics::Model::CanaryRunConfigInput::AddEnvironmentVariables ( const char *  key,
Aws::String &&  value 
)
inline

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.

Definition at line 283 of file CanaryRunConfigInput.h.

◆ AddEnvironmentVariables() [7/7]

CanaryRunConfigInput& Aws::Synthetics::Model::CanaryRunConfigInput::AddEnvironmentVariables ( const char *  key,
const char *  value 
)
inline

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.

Definition at line 307 of file CanaryRunConfigInput.h.

◆ EnvironmentVariablesHasBeenSet()

bool Aws::Synthetics::Model::CanaryRunConfigInput::EnvironmentVariablesHasBeenSet ( ) const
inline

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.

Definition at line 175 of file CanaryRunConfigInput.h.

◆ GetActiveTracing()

bool Aws::Synthetics::Model::CanaryRunConfigInput::GetActiveTracing ( ) const
inline

Specifies whether this canary is to use active 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.

Definition at line 111 of file CanaryRunConfigInput.h.

◆ GetEnvironmentVariables()

const Aws::Map<Aws::String, Aws::String>& Aws::Synthetics::Model::CanaryRunConfigInput::GetEnvironmentVariables ( ) const
inline

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.

Definition at line 163 of file CanaryRunConfigInput.h.

◆ GetMemoryInMB()

int Aws::Synthetics::Model::CanaryRunConfigInput::GetMemoryInMB ( ) const
inline

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

Definition at line 79 of file CanaryRunConfigInput.h.

◆ GetTimeoutInSeconds()

int Aws::Synthetics::Model::CanaryRunConfigInput::GetTimeoutInSeconds ( ) const
inline

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.

Definition at line 48 of file CanaryRunConfigInput.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Synthetics::Model::CanaryRunConfigInput::Jsonize ( ) const

◆ MemoryInMBHasBeenSet()

bool Aws::Synthetics::Model::CanaryRunConfigInput::MemoryInMBHasBeenSet ( ) const
inline

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

Definition at line 85 of file CanaryRunConfigInput.h.

◆ operator=()

CanaryRunConfigInput& Aws::Synthetics::Model::CanaryRunConfigInput::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetActiveTracing()

void Aws::Synthetics::Model::CanaryRunConfigInput::SetActiveTracing ( bool  value)
inline

Specifies whether this canary is to use active 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.

Definition at line 137 of file CanaryRunConfigInput.h.

◆ SetEnvironmentVariables() [1/2]

void Aws::Synthetics::Model::CanaryRunConfigInput::SetEnvironmentVariables ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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.

Definition at line 199 of file CanaryRunConfigInput.h.

◆ SetEnvironmentVariables() [2/2]

void Aws::Synthetics::Model::CanaryRunConfigInput::SetEnvironmentVariables ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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.

Definition at line 187 of file CanaryRunConfigInput.h.

◆ SetMemoryInMB()

void Aws::Synthetics::Model::CanaryRunConfigInput::SetMemoryInMB ( int  value)
inline

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

Definition at line 91 of file CanaryRunConfigInput.h.

◆ SetTimeoutInSeconds()

void Aws::Synthetics::Model::CanaryRunConfigInput::SetTimeoutInSeconds ( int  value)
inline

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.

Definition at line 64 of file CanaryRunConfigInput.h.

◆ TimeoutInSecondsHasBeenSet()

bool Aws::Synthetics::Model::CanaryRunConfigInput::TimeoutInSecondsHasBeenSet ( ) const
inline

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.

Definition at line 56 of file CanaryRunConfigInput.h.

◆ WithActiveTracing()

CanaryRunConfigInput& Aws::Synthetics::Model::CanaryRunConfigInput::WithActiveTracing ( bool  value)
inline

Specifies whether this canary is to use active 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.

Definition at line 150 of file CanaryRunConfigInput.h.

◆ WithEnvironmentVariables() [1/2]

CanaryRunConfigInput& Aws::Synthetics::Model::CanaryRunConfigInput::WithEnvironmentVariables ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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.

Definition at line 223 of file CanaryRunConfigInput.h.

◆ WithEnvironmentVariables() [2/2]

CanaryRunConfigInput& Aws::Synthetics::Model::CanaryRunConfigInput::WithEnvironmentVariables ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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.

Definition at line 211 of file CanaryRunConfigInput.h.

◆ WithMemoryInMB()

CanaryRunConfigInput& Aws::Synthetics::Model::CanaryRunConfigInput::WithMemoryInMB ( int  value)
inline

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

Definition at line 97 of file CanaryRunConfigInput.h.

◆ WithTimeoutInSeconds()

CanaryRunConfigInput& Aws::Synthetics::Model::CanaryRunConfigInput::WithTimeoutInSeconds ( int  value)
inline

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.

Definition at line 72 of file CanaryRunConfigInput.h.


The documentation for this class was generated from the following file: