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

#include <CanaryCodeInput.h>

Public Member Functions

 CanaryCodeInput ()
 
 CanaryCodeInput (Aws::Utils::Json::JsonView jsonValue)
 
CanaryCodeInputoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetS3Bucket () const
 
bool S3BucketHasBeenSet () const
 
void SetS3Bucket (const Aws::String &value)
 
void SetS3Bucket (Aws::String &&value)
 
void SetS3Bucket (const char *value)
 
CanaryCodeInputWithS3Bucket (const Aws::String &value)
 
CanaryCodeInputWithS3Bucket (Aws::String &&value)
 
CanaryCodeInputWithS3Bucket (const char *value)
 
const Aws::StringGetS3Key () const
 
bool S3KeyHasBeenSet () const
 
void SetS3Key (const Aws::String &value)
 
void SetS3Key (Aws::String &&value)
 
void SetS3Key (const char *value)
 
CanaryCodeInputWithS3Key (const Aws::String &value)
 
CanaryCodeInputWithS3Key (Aws::String &&value)
 
CanaryCodeInputWithS3Key (const char *value)
 
const Aws::StringGetS3Version () const
 
bool S3VersionHasBeenSet () const
 
void SetS3Version (const Aws::String &value)
 
void SetS3Version (Aws::String &&value)
 
void SetS3Version (const char *value)
 
CanaryCodeInputWithS3Version (const Aws::String &value)
 
CanaryCodeInputWithS3Version (Aws::String &&value)
 
CanaryCodeInputWithS3Version (const char *value)
 
const Aws::Utils::ByteBufferGetZipFile () const
 
bool ZipFileHasBeenSet () const
 
void SetZipFile (const Aws::Utils::ByteBuffer &value)
 
void SetZipFile (Aws::Utils::ByteBuffer &&value)
 
CanaryCodeInputWithZipFile (const Aws::Utils::ByteBuffer &value)
 
CanaryCodeInputWithZipFile (Aws::Utils::ByteBuffer &&value)
 
const Aws::StringGetHandler () const
 
bool HandlerHasBeenSet () const
 
void SetHandler (const Aws::String &value)
 
void SetHandler (Aws::String &&value)
 
void SetHandler (const char *value)
 
CanaryCodeInputWithHandler (const Aws::String &value)
 
CanaryCodeInputWithHandler (Aws::String &&value)
 
CanaryCodeInputWithHandler (const char *value)
 

Detailed Description

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.

See Also:

AWS API Reference

Definition at line 37 of file CanaryCodeInput.h.

Constructor & Destructor Documentation

◆ CanaryCodeInput() [1/2]

Aws::Synthetics::Model::CanaryCodeInput::CanaryCodeInput ( )

◆ CanaryCodeInput() [2/2]

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

Member Function Documentation

◆ GetHandler()

const Aws::String& Aws::Synthetics::Model::CanaryCodeInput::GetHandler ( ) const
inline

The entry point to use for the source code when running the canary. This value must end with the string .handler. The string is limited to 29 characters or fewer.

Definition at line 241 of file CanaryCodeInput.h.

◆ GetS3Bucket()

const Aws::String& Aws::Synthetics::Model::CanaryCodeInput::GetS3Bucket ( ) const
inline

If your canary script is located in S3, specify the bucket name here. Do not include s3:// as the start of the bucket name.

Definition at line 50 of file CanaryCodeInput.h.

◆ GetS3Key()

const Aws::String& Aws::Synthetics::Model::CanaryCodeInput::GetS3Key ( ) const
inline

The S3 key of your script. For more information, see Working with Amazon S3 Objects.

Definition at line 100 of file CanaryCodeInput.h.

◆ GetS3Version()

const Aws::String& Aws::Synthetics::Model::CanaryCodeInput::GetS3Version ( ) const
inline

The S3 version ID of your script.

Definition at line 155 of file CanaryCodeInput.h.

◆ GetZipFile()

const Aws::Utils::ByteBuffer& Aws::Synthetics::Model::CanaryCodeInput::GetZipFile ( ) const
inline

If you input your canary script directly into the canary instead of referring to an S3 location, the value of this parameter is the base64-encoded contents of the .zip file that contains the script. It must be smaller than 256 Kb.

Definition at line 198 of file CanaryCodeInput.h.

◆ HandlerHasBeenSet()

bool Aws::Synthetics::Model::CanaryCodeInput::HandlerHasBeenSet ( ) const
inline

The entry point to use for the source code when running the canary. This value must end with the string .handler. The string is limited to 29 characters or fewer.

Definition at line 248 of file CanaryCodeInput.h.

◆ Jsonize()

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

◆ operator=()

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

◆ S3BucketHasBeenSet()

bool Aws::Synthetics::Model::CanaryCodeInput::S3BucketHasBeenSet ( ) const
inline

If your canary script is located in S3, specify the bucket name here. Do not include s3:// as the start of the bucket name.

Definition at line 56 of file CanaryCodeInput.h.

◆ S3KeyHasBeenSet()

bool Aws::Synthetics::Model::CanaryCodeInput::S3KeyHasBeenSet ( ) const
inline

The S3 key of your script. For more information, see Working with Amazon S3 Objects.

Definition at line 107 of file CanaryCodeInput.h.

◆ S3VersionHasBeenSet()

bool Aws::Synthetics::Model::CanaryCodeInput::S3VersionHasBeenSet ( ) const
inline

The S3 version ID of your script.

Definition at line 160 of file CanaryCodeInput.h.

◆ SetHandler() [1/3]

void Aws::Synthetics::Model::CanaryCodeInput::SetHandler ( Aws::String &&  value)
inline

The entry point to use for the source code when running the canary. This value must end with the string .handler. The string is limited to 29 characters or fewer.

Definition at line 262 of file CanaryCodeInput.h.

◆ SetHandler() [2/3]

void Aws::Synthetics::Model::CanaryCodeInput::SetHandler ( const Aws::String value)
inline

The entry point to use for the source code when running the canary. This value must end with the string .handler. The string is limited to 29 characters or fewer.

Definition at line 255 of file CanaryCodeInput.h.

◆ SetHandler() [3/3]

void Aws::Synthetics::Model::CanaryCodeInput::SetHandler ( const char *  value)
inline

The entry point to use for the source code when running the canary. This value must end with the string .handler. The string is limited to 29 characters or fewer.

Definition at line 269 of file CanaryCodeInput.h.

◆ SetS3Bucket() [1/3]

void Aws::Synthetics::Model::CanaryCodeInput::SetS3Bucket ( Aws::String &&  value)
inline

If your canary script is located in S3, specify the bucket name here. Do not include s3:// as the start of the bucket name.

Definition at line 68 of file CanaryCodeInput.h.

◆ SetS3Bucket() [2/3]

void Aws::Synthetics::Model::CanaryCodeInput::SetS3Bucket ( const Aws::String value)
inline

If your canary script is located in S3, specify the bucket name here. Do not include s3:// as the start of the bucket name.

Definition at line 62 of file CanaryCodeInput.h.

◆ SetS3Bucket() [3/3]

void Aws::Synthetics::Model::CanaryCodeInput::SetS3Bucket ( const char *  value)
inline

If your canary script is located in S3, specify the bucket name here. Do not include s3:// as the start of the bucket name.

Definition at line 74 of file CanaryCodeInput.h.

◆ SetS3Key() [1/3]

void Aws::Synthetics::Model::CanaryCodeInput::SetS3Key ( Aws::String &&  value)
inline

The S3 key of your script. For more information, see Working with Amazon S3 Objects.

Definition at line 121 of file CanaryCodeInput.h.

◆ SetS3Key() [2/3]

void Aws::Synthetics::Model::CanaryCodeInput::SetS3Key ( const Aws::String value)
inline

The S3 key of your script. For more information, see Working with Amazon S3 Objects.

Definition at line 114 of file CanaryCodeInput.h.

◆ SetS3Key() [3/3]

void Aws::Synthetics::Model::CanaryCodeInput::SetS3Key ( const char *  value)
inline

The S3 key of your script. For more information, see Working with Amazon S3 Objects.

Definition at line 128 of file CanaryCodeInput.h.

◆ SetS3Version() [1/3]

void Aws::Synthetics::Model::CanaryCodeInput::SetS3Version ( Aws::String &&  value)
inline

The S3 version ID of your script.

Definition at line 170 of file CanaryCodeInput.h.

◆ SetS3Version() [2/3]

void Aws::Synthetics::Model::CanaryCodeInput::SetS3Version ( const Aws::String value)
inline

The S3 version ID of your script.

Definition at line 165 of file CanaryCodeInput.h.

◆ SetS3Version() [3/3]

void Aws::Synthetics::Model::CanaryCodeInput::SetS3Version ( const char *  value)
inline

The S3 version ID of your script.

Definition at line 175 of file CanaryCodeInput.h.

◆ SetZipFile() [1/2]

void Aws::Synthetics::Model::CanaryCodeInput::SetZipFile ( Aws::Utils::ByteBuffer &&  value)
inline

If you input your canary script directly into the canary instead of referring to an S3 location, the value of this parameter is the base64-encoded contents of the .zip file that contains the script. It must be smaller than 256 Kb.

Definition at line 219 of file CanaryCodeInput.h.

◆ SetZipFile() [2/2]

void Aws::Synthetics::Model::CanaryCodeInput::SetZipFile ( const Aws::Utils::ByteBuffer value)
inline

If you input your canary script directly into the canary instead of referring to an S3 location, the value of this parameter is the base64-encoded contents of the .zip file that contains the script. It must be smaller than 256 Kb.

Definition at line 212 of file CanaryCodeInput.h.

◆ WithHandler() [1/3]

CanaryCodeInput& Aws::Synthetics::Model::CanaryCodeInput::WithHandler ( Aws::String &&  value)
inline

The entry point to use for the source code when running the canary. This value must end with the string .handler. The string is limited to 29 characters or fewer.

Definition at line 283 of file CanaryCodeInput.h.

◆ WithHandler() [2/3]

CanaryCodeInput& Aws::Synthetics::Model::CanaryCodeInput::WithHandler ( const Aws::String value)
inline

The entry point to use for the source code when running the canary. This value must end with the string .handler. The string is limited to 29 characters or fewer.

Definition at line 276 of file CanaryCodeInput.h.

◆ WithHandler() [3/3]

CanaryCodeInput& Aws::Synthetics::Model::CanaryCodeInput::WithHandler ( const char *  value)
inline

The entry point to use for the source code when running the canary. This value must end with the string .handler. The string is limited to 29 characters or fewer.

Definition at line 290 of file CanaryCodeInput.h.

◆ WithS3Bucket() [1/3]

CanaryCodeInput& Aws::Synthetics::Model::CanaryCodeInput::WithS3Bucket ( Aws::String &&  value)
inline

If your canary script is located in S3, specify the bucket name here. Do not include s3:// as the start of the bucket name.

Definition at line 86 of file CanaryCodeInput.h.

◆ WithS3Bucket() [2/3]

CanaryCodeInput& Aws::Synthetics::Model::CanaryCodeInput::WithS3Bucket ( const Aws::String value)
inline

If your canary script is located in S3, specify the bucket name here. Do not include s3:// as the start of the bucket name.

Definition at line 80 of file CanaryCodeInput.h.

◆ WithS3Bucket() [3/3]

CanaryCodeInput& Aws::Synthetics::Model::CanaryCodeInput::WithS3Bucket ( const char *  value)
inline

If your canary script is located in S3, specify the bucket name here. Do not include s3:// as the start of the bucket name.

Definition at line 92 of file CanaryCodeInput.h.

◆ WithS3Key() [1/3]

CanaryCodeInput& Aws::Synthetics::Model::CanaryCodeInput::WithS3Key ( Aws::String &&  value)
inline

The S3 key of your script. For more information, see Working with Amazon S3 Objects.

Definition at line 142 of file CanaryCodeInput.h.

◆ WithS3Key() [2/3]

CanaryCodeInput& Aws::Synthetics::Model::CanaryCodeInput::WithS3Key ( const Aws::String value)
inline

The S3 key of your script. For more information, see Working with Amazon S3 Objects.

Definition at line 135 of file CanaryCodeInput.h.

◆ WithS3Key() [3/3]

CanaryCodeInput& Aws::Synthetics::Model::CanaryCodeInput::WithS3Key ( const char *  value)
inline

The S3 key of your script. For more information, see Working with Amazon S3 Objects.

Definition at line 149 of file CanaryCodeInput.h.

◆ WithS3Version() [1/3]

CanaryCodeInput& Aws::Synthetics::Model::CanaryCodeInput::WithS3Version ( Aws::String &&  value)
inline

The S3 version ID of your script.

Definition at line 185 of file CanaryCodeInput.h.

◆ WithS3Version() [2/3]

CanaryCodeInput& Aws::Synthetics::Model::CanaryCodeInput::WithS3Version ( const Aws::String value)
inline

The S3 version ID of your script.

Definition at line 180 of file CanaryCodeInput.h.

◆ WithS3Version() [3/3]

CanaryCodeInput& Aws::Synthetics::Model::CanaryCodeInput::WithS3Version ( const char *  value)
inline

The S3 version ID of your script.

Definition at line 190 of file CanaryCodeInput.h.

◆ WithZipFile() [1/2]

CanaryCodeInput& Aws::Synthetics::Model::CanaryCodeInput::WithZipFile ( Aws::Utils::ByteBuffer &&  value)
inline

If you input your canary script directly into the canary instead of referring to an S3 location, the value of this parameter is the base64-encoded contents of the .zip file that contains the script. It must be smaller than 256 Kb.

Definition at line 233 of file CanaryCodeInput.h.

◆ WithZipFile() [2/2]

CanaryCodeInput& Aws::Synthetics::Model::CanaryCodeInput::WithZipFile ( const Aws::Utils::ByteBuffer value)
inline

If you input your canary script directly into the canary instead of referring to an S3 location, the value of this parameter is the base64-encoded contents of the .zip file that contains the script. It must be smaller than 256 Kb.

Definition at line 226 of file CanaryCodeInput.h.

◆ ZipFileHasBeenSet()

bool Aws::Synthetics::Model::CanaryCodeInput::ZipFileHasBeenSet ( ) const
inline

If you input your canary script directly into the canary instead of referring to an S3 location, the value of this parameter is the base64-encoded contents of the .zip file that contains the script. It must be smaller than 256 Kb.

Definition at line 205 of file CanaryCodeInput.h.


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