@Generated(value="software.amazon.awssdk:codegen") public final class CanaryCodeInput extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CanaryCodeInput.Builder,CanaryCodeInput>
Use this structure to input your script code for the canary. This structure contains the Lambda handler with the
location where the canary should start running the script. If the script is stored in an S3 bucket, the bucket name,
key, and version are also included. If the script was passed into the canary directly, the script code is contained
in the value of Zipfile
.
Modifier and Type | Class and Description |
---|---|
static interface |
CanaryCodeInput.Builder |
Modifier and Type | Method and Description |
---|---|
static CanaryCodeInput.Builder |
builder() |
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) |
String |
handler()
The entry point to use for the source code when running the canary.
|
int |
hashCode() |
String |
s3Bucket()
If your canary script is located in S3, specify the full bucket name here.
|
String |
s3Key()
The S3 key of your script.
|
String |
s3Version()
The S3 version ID of your script.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CanaryCodeInput.Builder> |
serializableBuilderClass() |
CanaryCodeInput.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.
|
SdkBytes |
zipFile()
If you input your canary script directly into the canary instead of referring to an S3 location, the value of
this parameter is the .zip file that contains the script.
|
copy
public final String s3Bucket()
If your canary script is located in S3, specify the full bucket name here. The bucket must already exist. Specify
the full bucket name, including s3://
as the start of the bucket name.
s3://
as the start of the bucket name.public final String s3Key()
The S3 key of your script. For more information, see Working with Amazon S3 Objects.
public final String s3Version()
The S3 version ID of your script.
public final SdkBytes zipFile()
If you input your canary script directly into the canary instead of referring to an S3 location, the value of this parameter is the .zip file that contains the script. It can be up to 5 MB.
public final String handler()
The entry point to use for the source code when running the canary. This value must end with the string
.handler
.
.handler
.public CanaryCodeInput.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CanaryCodeInput.Builder,CanaryCodeInput>
public static CanaryCodeInput.Builder builder()
public static Class<? extends CanaryCodeInput.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.