@Generated(value="software.amazon.awssdk:codegen") public final class CanaryRunConfigInput extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CanaryRunConfigInput.Builder,CanaryRunConfigInput>
A structure that contains input information for a canary run.
Modifier and Type | Class and Description |
---|---|
static interface |
CanaryRunConfigInput.Builder |
Modifier and Type | Method and Description |
---|---|
Boolean |
activeTracing()
Specifies whether this canary is to use active AWS X-Ray tracing when it runs.
|
static CanaryRunConfigInput.Builder |
builder() |
Map<String,String> |
environmentVariables()
Specifies the keys and values to use for any environment variables used in the canary script.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasEnvironmentVariables()
Returns true if the EnvironmentVariables property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
int |
hashCode() |
Integer |
memoryInMB()
The maximum amount of memory available to the canary while it is running, in MB.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CanaryRunConfigInput.Builder> |
serializableBuilderClass() |
Integer |
timeoutInSeconds()
How long the canary is allowed to run before it must stop.
|
CanaryRunConfigInput.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
copy
public final 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.
If you omit this field, the frequency of the canary is used as this value, up to a maximum of 14 minutes.
public final 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.
public final 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.
You can enable active tracing only for canaries that use version syn-nodejs-2.0
or later for
their canary runtime.
public final boolean hasEnvironmentVariables()
public final 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasEnvironmentVariables()
to see if a value was sent in this field.
{ "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.
public CanaryRunConfigInput.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CanaryRunConfigInput.Builder,CanaryRunConfigInput>
public static CanaryRunConfigInput.Builder builder()
public static Class<? extends CanaryRunConfigInput.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.