CanaryRunConfigInput (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.synthetics.model.CanaryRunConfigInput

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CanaryRunConfigInput
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A structure that contains input information for a canary run.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CanaryRunConfigInput()

Constructors
Constructor and Description
`CanaryRunConfigInput()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CanaryRunConfigInput`	`addEnvironmentVariablesEntry(String key, String value)` Add a single EnvironmentVariables entry
`CanaryRunConfigInput`	`clearEnvironmentVariablesEntries()` Removes all the entries added into EnvironmentVariables.
`CanaryRunConfigInput`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getActiveTracing()` Specifies whether this canary is to use active X-Ray tracing when it runs.
`Map<String,String>`	`getEnvironmentVariables()` Specifies the keys and values to use for any environment variables used in the canary script.
`Integer`	`getMemoryInMB()` The maximum amount of memory available to the canary while it is running, in MB.
`Integer`	`getTimeoutInSeconds()` How long the canary is allowed to run before it must stop.
`int`	`hashCode()`
`Boolean`	`isActiveTracing()` Specifies whether this canary is to use active X-Ray tracing when it runs.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setActiveTracing(Boolean activeTracing)` Specifies whether this canary is to use active X-Ray tracing when it runs.
`void`	`setEnvironmentVariables(Map<String,String> environmentVariables)` Specifies the keys and values to use for any environment variables used in the canary script.
`void`	`setMemoryInMB(Integer memoryInMB)` The maximum amount of memory available to the canary while it is running, in MB.
`void`	`setTimeoutInSeconds(Integer timeoutInSeconds)` How long the canary is allowed to run before it must stop.
`String`	`toString()` Returns a string representation of this object.
`CanaryRunConfigInput`	`withActiveTracing(Boolean activeTracing)` Specifies whether this canary is to use active X-Ray tracing when it runs.
`CanaryRunConfigInput`	`withEnvironmentVariables(Map<String,String> environmentVariables)` Specifies the keys and values to use for any environment variables used in the canary script.
`CanaryRunConfigInput`	`withMemoryInMB(Integer memoryInMB)` The maximum amount of memory available to the canary while it is running, in MB.
`CanaryRunConfigInput`	`withTimeoutInSeconds(Integer timeoutInSeconds)` How long the canary is allowed to run before it must stop.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CanaryRunConfigInput
```
public CanaryRunConfigInput()
```
- Method Detail
  - setTimeoutInSeconds
```
public void setTimeoutInSeconds(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.
  - getTimeoutInSeconds
```
public Integer getTimeoutInSeconds()
```
    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:
    
    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.
  - withTimeoutInSeconds
```
public CanaryRunConfigInput withTimeoutInSeconds(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.
  - setMemoryInMB
```
public void setMemoryInMB(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.
  - getMemoryInMB
```
public Integer getMemoryInMB()
```
    The maximum amount of memory available to the canary while it is running, in MB. This value must be a multiple of 64.
    
    Returns:
    
    The maximum amount of memory available to the canary while it is running, in MB. This value must be a multiple of 64.
  - withMemoryInMB
```
public CanaryRunConfigInput withMemoryInMB(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.
  - setActiveTracing
```
public void setActiveTracing(Boolean activeTracing)
```
    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.
    
    Parameters:
    
    activeTracing - 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.
  - getActiveTracing
```
public Boolean getActiveTracing()
```
    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.
    
    Returns:
    
    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.
  - withActiveTracing
```
public CanaryRunConfigInput withActiveTracing(Boolean activeTracing)
```
    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.
    
    Parameters:
    
    activeTracing - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isActiveTracing
```
public Boolean isActiveTracing()
```
    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.
    
    Returns:
    
    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.
  - getEnvironmentVariables
```
public Map<String,String> getEnvironmentVariables()
```
    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.
    
    The environment variables keys and values are not encrypted. Do not store sensitive information in this field.
    
    Returns:
    
    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.
    
    The environment variables keys and values are not encrypted. Do not store sensitive information in this field.
  - setEnvironmentVariables
```
public void setEnvironmentVariables(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.
    
    The environment variables keys and values are not encrypted. Do not store sensitive information in this field.
    
    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.
    
    The environment variables keys and values are not encrypted. Do not store sensitive information in this field.
  - withEnvironmentVariables
```
public CanaryRunConfigInput withEnvironmentVariables(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.
    
    The environment variables keys and values are not encrypted. Do not store sensitive information in this field.
    
    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.
    
    The environment variables keys and values are not encrypted. Do not store sensitive information in this field.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addEnvironmentVariablesEntry
```
public CanaryRunConfigInput addEnvironmentVariablesEntry(String key,
                                                         String value)
```
    Add a single EnvironmentVariables entry
    
    See Also:
    
    withEnvironmentVariables(java.util.Map<java.lang.String, java.lang.String>)
  - clearEnvironmentVariablesEntries
```
public CanaryRunConfigInput clearEnvironmentVariablesEntries()
```
    Removes all the entries added into EnvironmentVariables.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CanaryRunConfigInput clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.780

Class CanaryRunConfigInput

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CanaryRunConfigInput

Method Detail

setTimeoutInSeconds

getTimeoutInSeconds

withTimeoutInSeconds

setMemoryInMB

getMemoryInMB

withMemoryInMB

setActiveTracing

getActiveTracing

withActiveTracing

isActiveTracing

getEnvironmentVariables

setEnvironmentVariables

withEnvironmentVariables

addEnvironmentVariablesEntry

clearEnvironmentVariablesEntries

toString

equals

hashCode

clone

marshall