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

#include <Canary.h>

Public Member Functions

 Canary ()
 
 Canary (Aws::Utils::Json::JsonView jsonValue)
 
Canaryoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetId () const
 
bool IdHasBeenSet () const
 
void SetId (const Aws::String &value)
 
void SetId (Aws::String &&value)
 
void SetId (const char *value)
 
CanaryWithId (const Aws::String &value)
 
CanaryWithId (Aws::String &&value)
 
CanaryWithId (const char *value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
CanaryWithName (const Aws::String &value)
 
CanaryWithName (Aws::String &&value)
 
CanaryWithName (const char *value)
 
const CanaryCodeOutputGetCode () const
 
bool CodeHasBeenSet () const
 
void SetCode (const CanaryCodeOutput &value)
 
void SetCode (CanaryCodeOutput &&value)
 
CanaryWithCode (const CanaryCodeOutput &value)
 
CanaryWithCode (CanaryCodeOutput &&value)
 
const Aws::StringGetExecutionRoleArn () const
 
bool ExecutionRoleArnHasBeenSet () const
 
void SetExecutionRoleArn (const Aws::String &value)
 
void SetExecutionRoleArn (Aws::String &&value)
 
void SetExecutionRoleArn (const char *value)
 
CanaryWithExecutionRoleArn (const Aws::String &value)
 
CanaryWithExecutionRoleArn (Aws::String &&value)
 
CanaryWithExecutionRoleArn (const char *value)
 
const CanaryScheduleOutputGetSchedule () const
 
bool ScheduleHasBeenSet () const
 
void SetSchedule (const CanaryScheduleOutput &value)
 
void SetSchedule (CanaryScheduleOutput &&value)
 
CanaryWithSchedule (const CanaryScheduleOutput &value)
 
CanaryWithSchedule (CanaryScheduleOutput &&value)
 
const CanaryRunConfigOutputGetRunConfig () const
 
bool RunConfigHasBeenSet () const
 
void SetRunConfig (const CanaryRunConfigOutput &value)
 
void SetRunConfig (CanaryRunConfigOutput &&value)
 
CanaryWithRunConfig (const CanaryRunConfigOutput &value)
 
CanaryWithRunConfig (CanaryRunConfigOutput &&value)
 
int GetSuccessRetentionPeriodInDays () const
 
bool SuccessRetentionPeriodInDaysHasBeenSet () const
 
void SetSuccessRetentionPeriodInDays (int value)
 
CanaryWithSuccessRetentionPeriodInDays (int value)
 
int GetFailureRetentionPeriodInDays () const
 
bool FailureRetentionPeriodInDaysHasBeenSet () const
 
void SetFailureRetentionPeriodInDays (int value)
 
CanaryWithFailureRetentionPeriodInDays (int value)
 
const CanaryStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const CanaryStatus &value)
 
void SetStatus (CanaryStatus &&value)
 
CanaryWithStatus (const CanaryStatus &value)
 
CanaryWithStatus (CanaryStatus &&value)
 
const CanaryTimelineGetTimeline () const
 
bool TimelineHasBeenSet () const
 
void SetTimeline (const CanaryTimeline &value)
 
void SetTimeline (CanaryTimeline &&value)
 
CanaryWithTimeline (const CanaryTimeline &value)
 
CanaryWithTimeline (CanaryTimeline &&value)
 
const Aws::StringGetArtifactS3Location () const
 
bool ArtifactS3LocationHasBeenSet () const
 
void SetArtifactS3Location (const Aws::String &value)
 
void SetArtifactS3Location (Aws::String &&value)
 
void SetArtifactS3Location (const char *value)
 
CanaryWithArtifactS3Location (const Aws::String &value)
 
CanaryWithArtifactS3Location (Aws::String &&value)
 
CanaryWithArtifactS3Location (const char *value)
 
const Aws::StringGetEngineArn () const
 
bool EngineArnHasBeenSet () const
 
void SetEngineArn (const Aws::String &value)
 
void SetEngineArn (Aws::String &&value)
 
void SetEngineArn (const char *value)
 
CanaryWithEngineArn (const Aws::String &value)
 
CanaryWithEngineArn (Aws::String &&value)
 
CanaryWithEngineArn (const char *value)
 
const Aws::StringGetRuntimeVersion () const
 
bool RuntimeVersionHasBeenSet () const
 
void SetRuntimeVersion (const Aws::String &value)
 
void SetRuntimeVersion (Aws::String &&value)
 
void SetRuntimeVersion (const char *value)
 
CanaryWithRuntimeVersion (const Aws::String &value)
 
CanaryWithRuntimeVersion (Aws::String &&value)
 
CanaryWithRuntimeVersion (const char *value)
 
const VpcConfigOutputGetVpcConfig () const
 
bool VpcConfigHasBeenSet () const
 
void SetVpcConfig (const VpcConfigOutput &value)
 
void SetVpcConfig (VpcConfigOutput &&value)
 
CanaryWithVpcConfig (const VpcConfigOutput &value)
 
CanaryWithVpcConfig (VpcConfigOutput &&value)
 
const VisualReferenceOutputGetVisualReference () const
 
bool VisualReferenceHasBeenSet () const
 
void SetVisualReference (const VisualReferenceOutput &value)
 
void SetVisualReference (VisualReferenceOutput &&value)
 
CanaryWithVisualReference (const VisualReferenceOutput &value)
 
CanaryWithVisualReference (VisualReferenceOutput &&value)
 
const Aws::Map< Aws::String, Aws::String > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetTags (Aws::Map< Aws::String, Aws::String > &&value)
 
CanaryWithTags (const Aws::Map< Aws::String, Aws::String > &value)
 
CanaryWithTags (Aws::Map< Aws::String, Aws::String > &&value)
 
CanaryAddTags (const Aws::String &key, const Aws::String &value)
 
CanaryAddTags (Aws::String &&key, const Aws::String &value)
 
CanaryAddTags (const Aws::String &key, Aws::String &&value)
 
CanaryAddTags (Aws::String &&key, Aws::String &&value)
 
CanaryAddTags (const char *key, Aws::String &&value)
 
CanaryAddTags (Aws::String &&key, const char *value)
 
CanaryAddTags (const char *key, const char *value)
 
const ArtifactConfigOutputGetArtifactConfig () const
 
bool ArtifactConfigHasBeenSet () const
 
void SetArtifactConfig (const ArtifactConfigOutput &value)
 
void SetArtifactConfig (ArtifactConfigOutput &&value)
 
CanaryWithArtifactConfig (const ArtifactConfigOutput &value)
 
CanaryWithArtifactConfig (ArtifactConfigOutput &&value)
 

Detailed Description

This structure contains all information about one canary in your account.

See Also:

AWS API Reference

Definition at line 41 of file Canary.h.

Constructor & Destructor Documentation

◆ Canary() [1/2]

Aws::Synthetics::Model::Canary::Canary ( )

◆ Canary() [2/2]

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

Member Function Documentation

◆ AddTags() [1/7]

Canary& Aws::Synthetics::Model::Canary::AddTags ( Aws::String &&  key,
Aws::String &&  value 
)
inline

The list of key-value pairs that are associated with the canary.

Definition at line 661 of file Canary.h.

◆ AddTags() [2/7]

Canary& Aws::Synthetics::Model::Canary::AddTags ( Aws::String &&  key,
const Aws::String value 
)
inline

The list of key-value pairs that are associated with the canary.

Definition at line 651 of file Canary.h.

◆ AddTags() [3/7]

Canary& Aws::Synthetics::Model::Canary::AddTags ( Aws::String &&  key,
const char *  value 
)
inline

The list of key-value pairs that are associated with the canary.

Definition at line 671 of file Canary.h.

◆ AddTags() [4/7]

Canary& Aws::Synthetics::Model::Canary::AddTags ( const Aws::String key,
Aws::String &&  value 
)
inline

The list of key-value pairs that are associated with the canary.

Definition at line 656 of file Canary.h.

◆ AddTags() [5/7]

Canary& Aws::Synthetics::Model::Canary::AddTags ( const Aws::String key,
const Aws::String value 
)
inline

The list of key-value pairs that are associated with the canary.

Definition at line 646 of file Canary.h.

◆ AddTags() [6/7]

Canary& Aws::Synthetics::Model::Canary::AddTags ( const char *  key,
Aws::String &&  value 
)
inline

The list of key-value pairs that are associated with the canary.

Definition at line 666 of file Canary.h.

◆ AddTags() [7/7]

Canary& Aws::Synthetics::Model::Canary::AddTags ( const char *  key,
const char *  value 
)
inline

The list of key-value pairs that are associated with the canary.

Definition at line 676 of file Canary.h.

◆ ArtifactConfigHasBeenSet()

bool Aws::Synthetics::Model::Canary::ArtifactConfigHasBeenSet ( ) const
inline

A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.

Definition at line 691 of file Canary.h.

◆ ArtifactS3LocationHasBeenSet()

bool Aws::Synthetics::Model::Canary::ArtifactS3LocationHasBeenSet ( ) const
inline

The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary. Artifacts include the log file, screenshots, and HAR files.

Definition at line 376 of file Canary.h.

◆ CodeHasBeenSet()

bool Aws::Synthetics::Model::Canary::CodeHasBeenSet ( ) const
inline

Definition at line 136 of file Canary.h.

◆ EngineArnHasBeenSet()

bool Aws::Synthetics::Model::Canary::EngineArnHasBeenSet ( ) const
inline

The ARN of the Lambda function that is used as your canary's engine. For more information about Lambda ARN format, see Resources and Conditions for Lambda Actions.

Definition at line 429 of file Canary.h.

◆ ExecutionRoleArnHasBeenSet()

bool Aws::Synthetics::Model::Canary::ExecutionRoleArnHasBeenSet ( ) const
inline

The ARN of the IAM role used to run the canary. This role must include lambda.amazonaws.com as a principal in the trust policy.

Definition at line 161 of file Canary.h.

◆ FailureRetentionPeriodInDaysHasBeenSet()

bool Aws::Synthetics::Model::Canary::FailureRetentionPeriodInDaysHasBeenSet ( ) const
inline

The number of days to retain data about failed runs of this canary.

Definition at line 285 of file Canary.h.

◆ GetArtifactConfig()

const ArtifactConfigOutput& Aws::Synthetics::Model::Canary::GetArtifactConfig ( ) const
inline

A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.

Definition at line 684 of file Canary.h.

◆ GetArtifactS3Location()

const Aws::String& Aws::Synthetics::Model::Canary::GetArtifactS3Location ( ) const
inline

The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary. Artifacts include the log file, screenshots, and HAR files.

Definition at line 370 of file Canary.h.

◆ GetCode()

const CanaryCodeOutput& Aws::Synthetics::Model::Canary::GetCode ( ) const
inline

Definition at line 133 of file Canary.h.

◆ GetEngineArn()

const Aws::String& Aws::Synthetics::Model::Canary::GetEngineArn ( ) const
inline

The ARN of the Lambda function that is used as your canary's engine. For more information about Lambda ARN format, see Resources and Conditions for Lambda Actions.

Definition at line 421 of file Canary.h.

◆ GetExecutionRoleArn()

const Aws::String& Aws::Synthetics::Model::Canary::GetExecutionRoleArn ( ) const
inline

The ARN of the IAM role used to run the canary. This role must include lambda.amazonaws.com as a principal in the trust policy.

Definition at line 155 of file Canary.h.

◆ GetFailureRetentionPeriodInDays()

int Aws::Synthetics::Model::Canary::GetFailureRetentionPeriodInDays ( ) const
inline

The number of days to retain data about failed runs of this canary.

Definition at line 280 of file Canary.h.

◆ GetId()

const Aws::String& Aws::Synthetics::Model::Canary::GetId ( ) const
inline

The unique ID of this canary.

Definition at line 53 of file Canary.h.

◆ GetName()

const Aws::String& Aws::Synthetics::Model::Canary::GetName ( ) const
inline

The name of the canary.

Definition at line 94 of file Canary.h.

◆ GetRunConfig()

const CanaryRunConfigOutput& Aws::Synthetics::Model::Canary::GetRunConfig ( ) const
inline

Definition at line 238 of file Canary.h.

◆ GetRuntimeVersion()

const Aws::String& Aws::Synthetics::Model::Canary::GetRuntimeVersion ( ) const
inline

Specifies the runtime version to use for the canary. For more information about runtime versions, see Canary Runtime Versions.

Definition at line 486 of file Canary.h.

◆ GetSchedule()

const CanaryScheduleOutput& Aws::Synthetics::Model::Canary::GetSchedule ( ) const
inline

A structure that contains information about how often the canary is to run, and when these runs are to stop.

Definition at line 204 of file Canary.h.

◆ GetStatus()

const CanaryStatus& Aws::Synthetics::Model::Canary::GetStatus ( ) const
inline

A structure that contains information about the canary's status.

Definition at line 301 of file Canary.h.

◆ GetSuccessRetentionPeriodInDays()

int Aws::Synthetics::Model::Canary::GetSuccessRetentionPeriodInDays ( ) const
inline

The number of days to retain data about successful runs of this canary.

Definition at line 259 of file Canary.h.

◆ GetTags()

const Aws::Map<Aws::String, Aws::String>& Aws::Synthetics::Model::Canary::GetTags ( ) const
inline

The list of key-value pairs that are associated with the canary.

Definition at line 616 of file Canary.h.

◆ GetTimeline()

const CanaryTimeline& Aws::Synthetics::Model::Canary::GetTimeline ( ) const
inline

A structure that contains information about when the canary was created, modified, and most recently run.

Definition at line 333 of file Canary.h.

◆ GetVisualReference()

const VisualReferenceOutput& Aws::Synthetics::Model::Canary::GetVisualReference ( ) const
inline

If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run to use as the baseline for screenshots, and the coordinates of any parts of the screen to ignore during the visual monitoring comparison.

Definition at line 570 of file Canary.h.

◆ GetVpcConfig()

const VpcConfigOutput& Aws::Synthetics::Model::Canary::GetVpcConfig ( ) const
inline

Definition at line 546 of file Canary.h.

◆ IdHasBeenSet()

bool Aws::Synthetics::Model::Canary::IdHasBeenSet ( ) const
inline

The unique ID of this canary.

Definition at line 58 of file Canary.h.

◆ Jsonize()

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

◆ NameHasBeenSet()

bool Aws::Synthetics::Model::Canary::NameHasBeenSet ( ) const
inline

The name of the canary.

Definition at line 99 of file Canary.h.

◆ operator=()

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

◆ RunConfigHasBeenSet()

bool Aws::Synthetics::Model::Canary::RunConfigHasBeenSet ( ) const
inline

Definition at line 241 of file Canary.h.

◆ RuntimeVersionHasBeenSet()

bool Aws::Synthetics::Model::Canary::RuntimeVersionHasBeenSet ( ) const
inline

Specifies the runtime version to use for the canary. For more information about runtime versions, see Canary Runtime Versions.

Definition at line 494 of file Canary.h.

◆ ScheduleHasBeenSet()

bool Aws::Synthetics::Model::Canary::ScheduleHasBeenSet ( ) const
inline

A structure that contains information about how often the canary is to run, and when these runs are to stop.

Definition at line 210 of file Canary.h.

◆ SetArtifactConfig() [1/2]

void Aws::Synthetics::Model::Canary::SetArtifactConfig ( ArtifactConfigOutput &&  value)
inline

A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.

Definition at line 705 of file Canary.h.

◆ SetArtifactConfig() [2/2]

void Aws::Synthetics::Model::Canary::SetArtifactConfig ( const ArtifactConfigOutput value)
inline

A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.

Definition at line 698 of file Canary.h.

◆ SetArtifactS3Location() [1/3]

void Aws::Synthetics::Model::Canary::SetArtifactS3Location ( Aws::String &&  value)
inline

The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary. Artifacts include the log file, screenshots, and HAR files.

Definition at line 388 of file Canary.h.

◆ SetArtifactS3Location() [2/3]

void Aws::Synthetics::Model::Canary::SetArtifactS3Location ( const Aws::String value)
inline

The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary. Artifacts include the log file, screenshots, and HAR files.

Definition at line 382 of file Canary.h.

◆ SetArtifactS3Location() [3/3]

void Aws::Synthetics::Model::Canary::SetArtifactS3Location ( const char *  value)
inline

The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary. Artifacts include the log file, screenshots, and HAR files.

Definition at line 394 of file Canary.h.

◆ SetCode() [1/2]

void Aws::Synthetics::Model::Canary::SetCode ( CanaryCodeOutput &&  value)
inline

Definition at line 142 of file Canary.h.

◆ SetCode() [2/2]

void Aws::Synthetics::Model::Canary::SetCode ( const CanaryCodeOutput value)
inline

Definition at line 139 of file Canary.h.

◆ SetEngineArn() [1/3]

void Aws::Synthetics::Model::Canary::SetEngineArn ( Aws::String &&  value)
inline

The ARN of the Lambda function that is used as your canary's engine. For more information about Lambda ARN format, see Resources and Conditions for Lambda Actions.

Definition at line 445 of file Canary.h.

◆ SetEngineArn() [2/3]

void Aws::Synthetics::Model::Canary::SetEngineArn ( const Aws::String value)
inline

The ARN of the Lambda function that is used as your canary's engine. For more information about Lambda ARN format, see Resources and Conditions for Lambda Actions.

Definition at line 437 of file Canary.h.

◆ SetEngineArn() [3/3]

void Aws::Synthetics::Model::Canary::SetEngineArn ( const char *  value)
inline

The ARN of the Lambda function that is used as your canary's engine. For more information about Lambda ARN format, see Resources and Conditions for Lambda Actions.

Definition at line 453 of file Canary.h.

◆ SetExecutionRoleArn() [1/3]

void Aws::Synthetics::Model::Canary::SetExecutionRoleArn ( Aws::String &&  value)
inline

The ARN of the IAM role used to run the canary. This role must include lambda.amazonaws.com as a principal in the trust policy.

Definition at line 173 of file Canary.h.

◆ SetExecutionRoleArn() [2/3]

void Aws::Synthetics::Model::Canary::SetExecutionRoleArn ( const Aws::String value)
inline

The ARN of the IAM role used to run the canary. This role must include lambda.amazonaws.com as a principal in the trust policy.

Definition at line 167 of file Canary.h.

◆ SetExecutionRoleArn() [3/3]

void Aws::Synthetics::Model::Canary::SetExecutionRoleArn ( const char *  value)
inline

The ARN of the IAM role used to run the canary. This role must include lambda.amazonaws.com as a principal in the trust policy.

Definition at line 179 of file Canary.h.

◆ SetFailureRetentionPeriodInDays()

void Aws::Synthetics::Model::Canary::SetFailureRetentionPeriodInDays ( int  value)
inline

The number of days to retain data about failed runs of this canary.

Definition at line 290 of file Canary.h.

◆ SetId() [1/3]

void Aws::Synthetics::Model::Canary::SetId ( Aws::String &&  value)
inline

The unique ID of this canary.

Definition at line 68 of file Canary.h.

◆ SetId() [2/3]

void Aws::Synthetics::Model::Canary::SetId ( const Aws::String value)
inline

The unique ID of this canary.

Definition at line 63 of file Canary.h.

◆ SetId() [3/3]

void Aws::Synthetics::Model::Canary::SetId ( const char *  value)
inline

The unique ID of this canary.

Definition at line 73 of file Canary.h.

◆ SetName() [1/3]

void Aws::Synthetics::Model::Canary::SetName ( Aws::String &&  value)
inline

The name of the canary.

Definition at line 109 of file Canary.h.

◆ SetName() [2/3]

void Aws::Synthetics::Model::Canary::SetName ( const Aws::String value)
inline

The name of the canary.

Definition at line 104 of file Canary.h.

◆ SetName() [3/3]

void Aws::Synthetics::Model::Canary::SetName ( const char *  value)
inline

The name of the canary.

Definition at line 114 of file Canary.h.

◆ SetRunConfig() [1/2]

void Aws::Synthetics::Model::Canary::SetRunConfig ( CanaryRunConfigOutput &&  value)
inline

Definition at line 247 of file Canary.h.

◆ SetRunConfig() [2/2]

void Aws::Synthetics::Model::Canary::SetRunConfig ( const CanaryRunConfigOutput value)
inline

Definition at line 244 of file Canary.h.

◆ SetRuntimeVersion() [1/3]

void Aws::Synthetics::Model::Canary::SetRuntimeVersion ( Aws::String &&  value)
inline

Specifies the runtime version to use for the canary. For more information about runtime versions, see Canary Runtime Versions.

Definition at line 510 of file Canary.h.

◆ SetRuntimeVersion() [2/3]

void Aws::Synthetics::Model::Canary::SetRuntimeVersion ( const Aws::String value)
inline

Specifies the runtime version to use for the canary. For more information about runtime versions, see Canary Runtime Versions.

Definition at line 502 of file Canary.h.

◆ SetRuntimeVersion() [3/3]

void Aws::Synthetics::Model::Canary::SetRuntimeVersion ( const char *  value)
inline

Specifies the runtime version to use for the canary. For more information about runtime versions, see Canary Runtime Versions.

Definition at line 518 of file Canary.h.

◆ SetSchedule() [1/2]

void Aws::Synthetics::Model::Canary::SetSchedule ( CanaryScheduleOutput &&  value)
inline

A structure that contains information about how often the canary is to run, and when these runs are to stop.

Definition at line 222 of file Canary.h.

◆ SetSchedule() [2/2]

void Aws::Synthetics::Model::Canary::SetSchedule ( const CanaryScheduleOutput value)
inline

A structure that contains information about how often the canary is to run, and when these runs are to stop.

Definition at line 216 of file Canary.h.

◆ SetStatus() [1/2]

void Aws::Synthetics::Model::Canary::SetStatus ( CanaryStatus &&  value)
inline

A structure that contains information about the canary's status.

Definition at line 316 of file Canary.h.

◆ SetStatus() [2/2]

void Aws::Synthetics::Model::Canary::SetStatus ( const CanaryStatus value)
inline

A structure that contains information about the canary's status.

Definition at line 311 of file Canary.h.

◆ SetSuccessRetentionPeriodInDays()

void Aws::Synthetics::Model::Canary::SetSuccessRetentionPeriodInDays ( int  value)
inline

The number of days to retain data about successful runs of this canary.

Definition at line 269 of file Canary.h.

◆ SetTags() [1/2]

void Aws::Synthetics::Model::Canary::SetTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The list of key-value pairs that are associated with the canary.

Definition at line 631 of file Canary.h.

◆ SetTags() [2/2]

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

The list of key-value pairs that are associated with the canary.

Definition at line 626 of file Canary.h.

◆ SetTimeline() [1/2]

void Aws::Synthetics::Model::Canary::SetTimeline ( CanaryTimeline &&  value)
inline

A structure that contains information about when the canary was created, modified, and most recently run.

Definition at line 351 of file Canary.h.

◆ SetTimeline() [2/2]

void Aws::Synthetics::Model::Canary::SetTimeline ( const CanaryTimeline value)
inline

A structure that contains information about when the canary was created, modified, and most recently run.

Definition at line 345 of file Canary.h.

◆ SetVisualReference() [1/2]

void Aws::Synthetics::Model::Canary::SetVisualReference ( const VisualReferenceOutput value)
inline

If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run to use as the baseline for screenshots, and the coordinates of any parts of the screen to ignore during the visual monitoring comparison.

Definition at line 586 of file Canary.h.

◆ SetVisualReference() [2/2]

void Aws::Synthetics::Model::Canary::SetVisualReference ( VisualReferenceOutput &&  value)
inline

If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run to use as the baseline for screenshots, and the coordinates of any parts of the screen to ignore during the visual monitoring comparison.

Definition at line 594 of file Canary.h.

◆ SetVpcConfig() [1/2]

void Aws::Synthetics::Model::Canary::SetVpcConfig ( const VpcConfigOutput value)
inline

Definition at line 552 of file Canary.h.

◆ SetVpcConfig() [2/2]

void Aws::Synthetics::Model::Canary::SetVpcConfig ( VpcConfigOutput &&  value)
inline

Definition at line 555 of file Canary.h.

◆ StatusHasBeenSet()

bool Aws::Synthetics::Model::Canary::StatusHasBeenSet ( ) const
inline

A structure that contains information about the canary's status.

Definition at line 306 of file Canary.h.

◆ SuccessRetentionPeriodInDaysHasBeenSet()

bool Aws::Synthetics::Model::Canary::SuccessRetentionPeriodInDaysHasBeenSet ( ) const
inline

The number of days to retain data about successful runs of this canary.

Definition at line 264 of file Canary.h.

◆ TagsHasBeenSet()

bool Aws::Synthetics::Model::Canary::TagsHasBeenSet ( ) const
inline

The list of key-value pairs that are associated with the canary.

Definition at line 621 of file Canary.h.

◆ TimelineHasBeenSet()

bool Aws::Synthetics::Model::Canary::TimelineHasBeenSet ( ) const
inline

A structure that contains information about when the canary was created, modified, and most recently run.

Definition at line 339 of file Canary.h.

◆ VisualReferenceHasBeenSet()

bool Aws::Synthetics::Model::Canary::VisualReferenceHasBeenSet ( ) const
inline

If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run to use as the baseline for screenshots, and the coordinates of any parts of the screen to ignore during the visual monitoring comparison.

Definition at line 578 of file Canary.h.

◆ VpcConfigHasBeenSet()

bool Aws::Synthetics::Model::Canary::VpcConfigHasBeenSet ( ) const
inline

Definition at line 549 of file Canary.h.

◆ WithArtifactConfig() [1/2]

Canary& Aws::Synthetics::Model::Canary::WithArtifactConfig ( ArtifactConfigOutput &&  value)
inline

A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.

Definition at line 719 of file Canary.h.

◆ WithArtifactConfig() [2/2]

Canary& Aws::Synthetics::Model::Canary::WithArtifactConfig ( const ArtifactConfigOutput value)
inline

A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.

Definition at line 712 of file Canary.h.

◆ WithArtifactS3Location() [1/3]

Canary& Aws::Synthetics::Model::Canary::WithArtifactS3Location ( Aws::String &&  value)
inline

The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary. Artifacts include the log file, screenshots, and HAR files.

Definition at line 406 of file Canary.h.

◆ WithArtifactS3Location() [2/3]

Canary& Aws::Synthetics::Model::Canary::WithArtifactS3Location ( const Aws::String value)
inline

The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary. Artifacts include the log file, screenshots, and HAR files.

Definition at line 400 of file Canary.h.

◆ WithArtifactS3Location() [3/3]

Canary& Aws::Synthetics::Model::Canary::WithArtifactS3Location ( const char *  value)
inline

The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary. Artifacts include the log file, screenshots, and HAR files.

Definition at line 412 of file Canary.h.

◆ WithCode() [1/2]

Canary& Aws::Synthetics::Model::Canary::WithCode ( CanaryCodeOutput &&  value)
inline

Definition at line 148 of file Canary.h.

◆ WithCode() [2/2]

Canary& Aws::Synthetics::Model::Canary::WithCode ( const CanaryCodeOutput value)
inline

Definition at line 145 of file Canary.h.

◆ WithEngineArn() [1/3]

Canary& Aws::Synthetics::Model::Canary::WithEngineArn ( Aws::String &&  value)
inline

The ARN of the Lambda function that is used as your canary's engine. For more information about Lambda ARN format, see Resources and Conditions for Lambda Actions.

Definition at line 469 of file Canary.h.

◆ WithEngineArn() [2/3]

Canary& Aws::Synthetics::Model::Canary::WithEngineArn ( const Aws::String value)
inline

The ARN of the Lambda function that is used as your canary's engine. For more information about Lambda ARN format, see Resources and Conditions for Lambda Actions.

Definition at line 461 of file Canary.h.

◆ WithEngineArn() [3/3]

Canary& Aws::Synthetics::Model::Canary::WithEngineArn ( const char *  value)
inline

The ARN of the Lambda function that is used as your canary's engine. For more information about Lambda ARN format, see Resources and Conditions for Lambda Actions.

Definition at line 477 of file Canary.h.

◆ WithExecutionRoleArn() [1/3]

Canary& Aws::Synthetics::Model::Canary::WithExecutionRoleArn ( Aws::String &&  value)
inline

The ARN of the IAM role used to run the canary. This role must include lambda.amazonaws.com as a principal in the trust policy.

Definition at line 191 of file Canary.h.

◆ WithExecutionRoleArn() [2/3]

Canary& Aws::Synthetics::Model::Canary::WithExecutionRoleArn ( const Aws::String value)
inline

The ARN of the IAM role used to run the canary. This role must include lambda.amazonaws.com as a principal in the trust policy.

Definition at line 185 of file Canary.h.

◆ WithExecutionRoleArn() [3/3]

Canary& Aws::Synthetics::Model::Canary::WithExecutionRoleArn ( const char *  value)
inline

The ARN of the IAM role used to run the canary. This role must include lambda.amazonaws.com as a principal in the trust policy.

Definition at line 197 of file Canary.h.

◆ WithFailureRetentionPeriodInDays()

Canary& Aws::Synthetics::Model::Canary::WithFailureRetentionPeriodInDays ( int  value)
inline

The number of days to retain data about failed runs of this canary.

Definition at line 295 of file Canary.h.

◆ WithId() [1/3]

Canary& Aws::Synthetics::Model::Canary::WithId ( Aws::String &&  value)
inline

The unique ID of this canary.

Definition at line 83 of file Canary.h.

◆ WithId() [2/3]

Canary& Aws::Synthetics::Model::Canary::WithId ( const Aws::String value)
inline

The unique ID of this canary.

Definition at line 78 of file Canary.h.

◆ WithId() [3/3]

Canary& Aws::Synthetics::Model::Canary::WithId ( const char *  value)
inline

The unique ID of this canary.

Definition at line 88 of file Canary.h.

◆ WithName() [1/3]

Canary& Aws::Synthetics::Model::Canary::WithName ( Aws::String &&  value)
inline

The name of the canary.

Definition at line 124 of file Canary.h.

◆ WithName() [2/3]

Canary& Aws::Synthetics::Model::Canary::WithName ( const Aws::String value)
inline

The name of the canary.

Definition at line 119 of file Canary.h.

◆ WithName() [3/3]

Canary& Aws::Synthetics::Model::Canary::WithName ( const char *  value)
inline

The name of the canary.

Definition at line 129 of file Canary.h.

◆ WithRunConfig() [1/2]

Canary& Aws::Synthetics::Model::Canary::WithRunConfig ( CanaryRunConfigOutput &&  value)
inline

Definition at line 253 of file Canary.h.

◆ WithRunConfig() [2/2]

Canary& Aws::Synthetics::Model::Canary::WithRunConfig ( const CanaryRunConfigOutput value)
inline

Definition at line 250 of file Canary.h.

◆ WithRuntimeVersion() [1/3]

Canary& Aws::Synthetics::Model::Canary::WithRuntimeVersion ( Aws::String &&  value)
inline

Specifies the runtime version to use for the canary. For more information about runtime versions, see Canary Runtime Versions.

Definition at line 534 of file Canary.h.

◆ WithRuntimeVersion() [2/3]

Canary& Aws::Synthetics::Model::Canary::WithRuntimeVersion ( const Aws::String value)
inline

Specifies the runtime version to use for the canary. For more information about runtime versions, see Canary Runtime Versions.

Definition at line 526 of file Canary.h.

◆ WithRuntimeVersion() [3/3]

Canary& Aws::Synthetics::Model::Canary::WithRuntimeVersion ( const char *  value)
inline

Specifies the runtime version to use for the canary. For more information about runtime versions, see Canary Runtime Versions.

Definition at line 542 of file Canary.h.

◆ WithSchedule() [1/2]

Canary& Aws::Synthetics::Model::Canary::WithSchedule ( CanaryScheduleOutput &&  value)
inline

A structure that contains information about how often the canary is to run, and when these runs are to stop.

Definition at line 234 of file Canary.h.

◆ WithSchedule() [2/2]

Canary& Aws::Synthetics::Model::Canary::WithSchedule ( const CanaryScheduleOutput value)
inline

A structure that contains information about how often the canary is to run, and when these runs are to stop.

Definition at line 228 of file Canary.h.

◆ WithStatus() [1/2]

Canary& Aws::Synthetics::Model::Canary::WithStatus ( CanaryStatus &&  value)
inline

A structure that contains information about the canary's status.

Definition at line 326 of file Canary.h.

◆ WithStatus() [2/2]

Canary& Aws::Synthetics::Model::Canary::WithStatus ( const CanaryStatus value)
inline

A structure that contains information about the canary's status.

Definition at line 321 of file Canary.h.

◆ WithSuccessRetentionPeriodInDays()

Canary& Aws::Synthetics::Model::Canary::WithSuccessRetentionPeriodInDays ( int  value)
inline

The number of days to retain data about successful runs of this canary.

Definition at line 274 of file Canary.h.

◆ WithTags() [1/2]

Canary& Aws::Synthetics::Model::Canary::WithTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The list of key-value pairs that are associated with the canary.

Definition at line 641 of file Canary.h.

◆ WithTags() [2/2]

Canary& Aws::Synthetics::Model::Canary::WithTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

The list of key-value pairs that are associated with the canary.

Definition at line 636 of file Canary.h.

◆ WithTimeline() [1/2]

Canary& Aws::Synthetics::Model::Canary::WithTimeline ( CanaryTimeline &&  value)
inline

A structure that contains information about when the canary was created, modified, and most recently run.

Definition at line 363 of file Canary.h.

◆ WithTimeline() [2/2]

Canary& Aws::Synthetics::Model::Canary::WithTimeline ( const CanaryTimeline value)
inline

A structure that contains information about when the canary was created, modified, and most recently run.

Definition at line 357 of file Canary.h.

◆ WithVisualReference() [1/2]

Canary& Aws::Synthetics::Model::Canary::WithVisualReference ( const VisualReferenceOutput value)
inline

If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run to use as the baseline for screenshots, and the coordinates of any parts of the screen to ignore during the visual monitoring comparison.

Definition at line 602 of file Canary.h.

◆ WithVisualReference() [2/2]

Canary& Aws::Synthetics::Model::Canary::WithVisualReference ( VisualReferenceOutput &&  value)
inline

If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run to use as the baseline for screenshots, and the coordinates of any parts of the screen to ignore during the visual monitoring comparison.

Definition at line 610 of file Canary.h.

◆ WithVpcConfig() [1/2]

Canary& Aws::Synthetics::Model::Canary::WithVpcConfig ( const VpcConfigOutput value)
inline

Definition at line 558 of file Canary.h.

◆ WithVpcConfig() [2/2]

Canary& Aws::Synthetics::Model::Canary::WithVpcConfig ( VpcConfigOutput &&  value)
inline

Definition at line 561 of file Canary.h.


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