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

#include <UpdateCanaryRequest.h>

+ Inheritance diagram for Aws::Synthetics::Model::UpdateCanaryRequest:

Public Member Functions

 UpdateCanaryRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
UpdateCanaryRequestWithName (const Aws::String &value)
 
UpdateCanaryRequestWithName (Aws::String &&value)
 
UpdateCanaryRequestWithName (const char *value)
 
const CanaryCodeInputGetCode () const
 
bool CodeHasBeenSet () const
 
void SetCode (const CanaryCodeInput &value)
 
void SetCode (CanaryCodeInput &&value)
 
UpdateCanaryRequestWithCode (const CanaryCodeInput &value)
 
UpdateCanaryRequestWithCode (CanaryCodeInput &&value)
 
const Aws::StringGetExecutionRoleArn () const
 
bool ExecutionRoleArnHasBeenSet () const
 
void SetExecutionRoleArn (const Aws::String &value)
 
void SetExecutionRoleArn (Aws::String &&value)
 
void SetExecutionRoleArn (const char *value)
 
UpdateCanaryRequestWithExecutionRoleArn (const Aws::String &value)
 
UpdateCanaryRequestWithExecutionRoleArn (Aws::String &&value)
 
UpdateCanaryRequestWithExecutionRoleArn (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)
 
UpdateCanaryRequestWithRuntimeVersion (const Aws::String &value)
 
UpdateCanaryRequestWithRuntimeVersion (Aws::String &&value)
 
UpdateCanaryRequestWithRuntimeVersion (const char *value)
 
const CanaryScheduleInputGetSchedule () const
 
bool ScheduleHasBeenSet () const
 
void SetSchedule (const CanaryScheduleInput &value)
 
void SetSchedule (CanaryScheduleInput &&value)
 
UpdateCanaryRequestWithSchedule (const CanaryScheduleInput &value)
 
UpdateCanaryRequestWithSchedule (CanaryScheduleInput &&value)
 
const CanaryRunConfigInputGetRunConfig () const
 
bool RunConfigHasBeenSet () const
 
void SetRunConfig (const CanaryRunConfigInput &value)
 
void SetRunConfig (CanaryRunConfigInput &&value)
 
UpdateCanaryRequestWithRunConfig (const CanaryRunConfigInput &value)
 
UpdateCanaryRequestWithRunConfig (CanaryRunConfigInput &&value)
 
int GetSuccessRetentionPeriodInDays () const
 
bool SuccessRetentionPeriodInDaysHasBeenSet () const
 
void SetSuccessRetentionPeriodInDays (int value)
 
UpdateCanaryRequestWithSuccessRetentionPeriodInDays (int value)
 
int GetFailureRetentionPeriodInDays () const
 
bool FailureRetentionPeriodInDaysHasBeenSet () const
 
void SetFailureRetentionPeriodInDays (int value)
 
UpdateCanaryRequestWithFailureRetentionPeriodInDays (int value)
 
const VpcConfigInputGetVpcConfig () const
 
bool VpcConfigHasBeenSet () const
 
void SetVpcConfig (const VpcConfigInput &value)
 
void SetVpcConfig (VpcConfigInput &&value)
 
UpdateCanaryRequestWithVpcConfig (const VpcConfigInput &value)
 
UpdateCanaryRequestWithVpcConfig (VpcConfigInput &&value)
 
const VisualReferenceInputGetVisualReference () const
 
bool VisualReferenceHasBeenSet () const
 
void SetVisualReference (const VisualReferenceInput &value)
 
void SetVisualReference (VisualReferenceInput &&value)
 
UpdateCanaryRequestWithVisualReference (const VisualReferenceInput &value)
 
UpdateCanaryRequestWithVisualReference (VisualReferenceInput &&value)
 
const Aws::StringGetArtifactS3Location () const
 
bool ArtifactS3LocationHasBeenSet () const
 
void SetArtifactS3Location (const Aws::String &value)
 
void SetArtifactS3Location (Aws::String &&value)
 
void SetArtifactS3Location (const char *value)
 
UpdateCanaryRequestWithArtifactS3Location (const Aws::String &value)
 
UpdateCanaryRequestWithArtifactS3Location (Aws::String &&value)
 
UpdateCanaryRequestWithArtifactS3Location (const char *value)
 
const ArtifactConfigInputGetArtifactConfig () const
 
bool ArtifactConfigHasBeenSet () const
 
void SetArtifactConfig (const ArtifactConfigInput &value)
 
void SetArtifactConfig (ArtifactConfigInput &&value)
 
UpdateCanaryRequestWithArtifactConfig (const ArtifactConfigInput &value)
 
UpdateCanaryRequestWithArtifactConfig (ArtifactConfigInput &&value)
 
- Public Member Functions inherited from Aws::Synthetics::SyntheticsRequest
virtual ~SyntheticsRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::Synthetics::SyntheticsRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 27 of file UpdateCanaryRequest.h.

Constructor & Destructor Documentation

◆ UpdateCanaryRequest()

Aws::Synthetics::Model::UpdateCanaryRequest::UpdateCanaryRequest ( )

Member Function Documentation

◆ ArtifactConfigHasBeenSet()

bool Aws::Synthetics::Model::UpdateCanaryRequest::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 646 of file UpdateCanaryRequest.h.

◆ ArtifactS3LocationHasBeenSet()

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

The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. Artifacts include the log file, screenshots, and HAR files. The name of the S3 bucket can't include a period (.).

Definition at line 589 of file UpdateCanaryRequest.h.

◆ CodeHasBeenSet()

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

A structure that includes the entry point from which the canary should start running your script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included.

Definition at line 118 of file UpdateCanaryRequest.h.

◆ ExecutionRoleArnHasBeenSet()

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

The ARN of the IAM role to be used to run the canary. This role must already exist, and must include lambda.amazonaws.com as a principal in the trust policy. The role must also have the following permissions:

  • s3:PutObject

  • s3:GetBucketLocation

  • s3:ListAllMyBuckets

  • cloudwatch:PutMetricData

  • logs:CreateLogGroup

  • logs:CreateLogStream

  • logs:CreateLogStream

Definition at line 175 of file UpdateCanaryRequest.h.

◆ FailureRetentionPeriodInDaysHasBeenSet()

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

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

Definition at line 430 of file UpdateCanaryRequest.h.

◆ GetArtifactConfig()

const ArtifactConfigInput& Aws::Synthetics::Model::UpdateCanaryRequest::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 639 of file UpdateCanaryRequest.h.

◆ GetArtifactS3Location()

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

The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. Artifacts include the log file, screenshots, and HAR files. The name of the S3 bucket can't include a period (.).

Definition at line 582 of file UpdateCanaryRequest.h.

◆ GetCode()

const CanaryCodeInput& Aws::Synthetics::Model::UpdateCanaryRequest::GetCode ( ) const
inline

A structure that includes the entry point from which the canary should start running your script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included.

Definition at line 111 of file UpdateCanaryRequest.h.

◆ GetExecutionRoleArn()

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

The ARN of the IAM role to be used to run the canary. This role must already exist, and must include lambda.amazonaws.com as a principal in the trust policy. The role must also have the following permissions:

  • s3:PutObject

  • s3:GetBucketLocation

  • s3:ListAllMyBuckets

  • cloudwatch:PutMetricData

  • logs:CreateLogGroup

  • logs:CreateLogStream

  • logs:CreateLogStream

Definition at line 161 of file UpdateCanaryRequest.h.

◆ GetFailureRetentionPeriodInDays()

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

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

Definition at line 425 of file UpdateCanaryRequest.h.

◆ GetName()

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

The name of the canary that you want to update. To find the names of your canaries, use DescribeCanaries.

You cannot change the name of a canary that has already been created.

Definition at line 47 of file UpdateCanaryRequest.h.

◆ GetRunConfig()

const CanaryRunConfigInput& Aws::Synthetics::Model::UpdateCanaryRequest::GetRunConfig ( ) const
inline

A structure that contains the timeout value that is used for each individual run of the canary.

Definition at line 368 of file UpdateCanaryRequest.h.

◆ GetRuntimeVersion()

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

Specifies the runtime version to use for the canary. For a list of valid runtime versions and for more information about runtime versions, see Canary Runtime Versions.

Definition at line 268 of file UpdateCanaryRequest.h.

◆ GetSchedule()

const CanaryScheduleInput& Aws::Synthetics::Model::UpdateCanaryRequest::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 331 of file UpdateCanaryRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::Synthetics::Model::UpdateCanaryRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file UpdateCanaryRequest.h.

◆ GetSuccessRetentionPeriodInDays()

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

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

Definition at line 404 of file UpdateCanaryRequest.h.

◆ GetVisualReference()

const VisualReferenceInput& Aws::Synthetics::Model::UpdateCanaryRequest::GetVisualReference ( ) const
inline

Defines the screenshots to use as the baseline for comparisons during visual monitoring comparisons during future runs of this canary. If you omit this parameter, no changes are made to any baseline screenshots that the canary might be using already.

Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2 runtime or later. For more information, see Visual monitoring and Visual monitoring blueprint

Definition at line 509 of file UpdateCanaryRequest.h.

◆ GetVpcConfig()

const VpcConfigInput& Aws::Synthetics::Model::UpdateCanaryRequest::GetVpcConfig ( ) const
inline

If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint. For more information, see Running a Canary in a VPC.

Definition at line 450 of file UpdateCanaryRequest.h.

◆ NameHasBeenSet()

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

The name of the canary that you want to update. To find the names of your canaries, use DescribeCanaries.

You cannot change the name of a canary that has already been created.

Definition at line 55 of file UpdateCanaryRequest.h.

◆ RunConfigHasBeenSet()

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

A structure that contains the timeout value that is used for each individual run of the canary.

Definition at line 374 of file UpdateCanaryRequest.h.

◆ RuntimeVersionHasBeenSet()

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

Specifies the runtime version to use for the canary. For a list of valid runtime versions and for more information about runtime versions, see Canary Runtime Versions.

Definition at line 276 of file UpdateCanaryRequest.h.

◆ ScheduleHasBeenSet()

bool Aws::Synthetics::Model::UpdateCanaryRequest::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 337 of file UpdateCanaryRequest.h.

◆ SerializePayload()

Aws::String Aws::Synthetics::Model::UpdateCanaryRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetArtifactConfig() [1/2]

void Aws::Synthetics::Model::UpdateCanaryRequest::SetArtifactConfig ( ArtifactConfigInput &&  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 660 of file UpdateCanaryRequest.h.

◆ SetArtifactConfig() [2/2]

void Aws::Synthetics::Model::UpdateCanaryRequest::SetArtifactConfig ( const ArtifactConfigInput 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 653 of file UpdateCanaryRequest.h.

◆ SetArtifactS3Location() [1/3]

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

The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. Artifacts include the log file, screenshots, and HAR files. The name of the S3 bucket can't include a period (.).

Definition at line 603 of file UpdateCanaryRequest.h.

◆ SetArtifactS3Location() [2/3]

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

The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. Artifacts include the log file, screenshots, and HAR files. The name of the S3 bucket can't include a period (.).

Definition at line 596 of file UpdateCanaryRequest.h.

◆ SetArtifactS3Location() [3/3]

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

The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. Artifacts include the log file, screenshots, and HAR files. The name of the S3 bucket can't include a period (.).

Definition at line 610 of file UpdateCanaryRequest.h.

◆ SetCode() [1/2]

void Aws::Synthetics::Model::UpdateCanaryRequest::SetCode ( CanaryCodeInput &&  value)
inline

A structure that includes the entry point from which the canary should start running your script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included.

Definition at line 132 of file UpdateCanaryRequest.h.

◆ SetCode() [2/2]

void Aws::Synthetics::Model::UpdateCanaryRequest::SetCode ( const CanaryCodeInput value)
inline

A structure that includes the entry point from which the canary should start running your script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included.

Definition at line 125 of file UpdateCanaryRequest.h.

◆ SetExecutionRoleArn() [1/3]

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

The ARN of the IAM role to be used to run the canary. This role must already exist, and must include lambda.amazonaws.com as a principal in the trust policy. The role must also have the following permissions:

  • s3:PutObject

  • s3:GetBucketLocation

  • s3:ListAllMyBuckets

  • cloudwatch:PutMetricData

  • logs:CreateLogGroup

  • logs:CreateLogStream

  • logs:CreateLogStream

Definition at line 203 of file UpdateCanaryRequest.h.

◆ SetExecutionRoleArn() [2/3]

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

The ARN of the IAM role to be used to run the canary. This role must already exist, and must include lambda.amazonaws.com as a principal in the trust policy. The role must also have the following permissions:

  • s3:PutObject

  • s3:GetBucketLocation

  • s3:ListAllMyBuckets

  • cloudwatch:PutMetricData

  • logs:CreateLogGroup

  • logs:CreateLogStream

  • logs:CreateLogStream

Definition at line 189 of file UpdateCanaryRequest.h.

◆ SetExecutionRoleArn() [3/3]

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

The ARN of the IAM role to be used to run the canary. This role must already exist, and must include lambda.amazonaws.com as a principal in the trust policy. The role must also have the following permissions:

  • s3:PutObject

  • s3:GetBucketLocation

  • s3:ListAllMyBuckets

  • cloudwatch:PutMetricData

  • logs:CreateLogGroup

  • logs:CreateLogStream

  • logs:CreateLogStream

Definition at line 217 of file UpdateCanaryRequest.h.

◆ SetFailureRetentionPeriodInDays()

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

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

Definition at line 435 of file UpdateCanaryRequest.h.

◆ SetName() [1/3]

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

The name of the canary that you want to update. To find the names of your canaries, use DescribeCanaries.

You cannot change the name of a canary that has already been created.

Definition at line 71 of file UpdateCanaryRequest.h.

◆ SetName() [2/3]

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

The name of the canary that you want to update. To find the names of your canaries, use DescribeCanaries.

You cannot change the name of a canary that has already been created.

Definition at line 63 of file UpdateCanaryRequest.h.

◆ SetName() [3/3]

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

The name of the canary that you want to update. To find the names of your canaries, use DescribeCanaries.

You cannot change the name of a canary that has already been created.

Definition at line 79 of file UpdateCanaryRequest.h.

◆ SetRunConfig() [1/2]

void Aws::Synthetics::Model::UpdateCanaryRequest::SetRunConfig ( CanaryRunConfigInput &&  value)
inline

A structure that contains the timeout value that is used for each individual run of the canary.

Definition at line 386 of file UpdateCanaryRequest.h.

◆ SetRunConfig() [2/2]

void Aws::Synthetics::Model::UpdateCanaryRequest::SetRunConfig ( const CanaryRunConfigInput value)
inline

A structure that contains the timeout value that is used for each individual run of the canary.

Definition at line 380 of file UpdateCanaryRequest.h.

◆ SetRuntimeVersion() [1/3]

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

Specifies the runtime version to use for the canary. For a list of valid runtime versions and for more information about runtime versions, see Canary Runtime Versions.

Definition at line 292 of file UpdateCanaryRequest.h.

◆ SetRuntimeVersion() [2/3]

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

Specifies the runtime version to use for the canary. For a list of valid runtime versions and for more information about runtime versions, see Canary Runtime Versions.

Definition at line 284 of file UpdateCanaryRequest.h.

◆ SetRuntimeVersion() [3/3]

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

Specifies the runtime version to use for the canary. For a list of valid runtime versions and for more information about runtime versions, see Canary Runtime Versions.

Definition at line 300 of file UpdateCanaryRequest.h.

◆ SetSchedule() [1/2]

void Aws::Synthetics::Model::UpdateCanaryRequest::SetSchedule ( CanaryScheduleInput &&  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 349 of file UpdateCanaryRequest.h.

◆ SetSchedule() [2/2]

void Aws::Synthetics::Model::UpdateCanaryRequest::SetSchedule ( const CanaryScheduleInput 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 343 of file UpdateCanaryRequest.h.

◆ SetSuccessRetentionPeriodInDays()

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

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

Definition at line 414 of file UpdateCanaryRequest.h.

◆ SetVisualReference() [1/2]

void Aws::Synthetics::Model::UpdateCanaryRequest::SetVisualReference ( const VisualReferenceInput value)
inline

Defines the screenshots to use as the baseline for comparisons during visual monitoring comparisons during future runs of this canary. If you omit this parameter, no changes are made to any baseline screenshots that the canary might be using already.

Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2 runtime or later. For more information, see Visual monitoring and Visual monitoring blueprint

Definition at line 535 of file UpdateCanaryRequest.h.

◆ SetVisualReference() [2/2]

void Aws::Synthetics::Model::UpdateCanaryRequest::SetVisualReference ( VisualReferenceInput &&  value)
inline

Defines the screenshots to use as the baseline for comparisons during visual monitoring comparisons during future runs of this canary. If you omit this parameter, no changes are made to any baseline screenshots that the canary might be using already.

Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2 runtime or later. For more information, see Visual monitoring and Visual monitoring blueprint

Definition at line 548 of file UpdateCanaryRequest.h.

◆ SetVpcConfig() [1/2]

void Aws::Synthetics::Model::UpdateCanaryRequest::SetVpcConfig ( const VpcConfigInput value)
inline

If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint. For more information, see Running a Canary in a VPC.

Definition at line 468 of file UpdateCanaryRequest.h.

◆ SetVpcConfig() [2/2]

void Aws::Synthetics::Model::UpdateCanaryRequest::SetVpcConfig ( VpcConfigInput &&  value)
inline

If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint. For more information, see Running a Canary in a VPC.

Definition at line 477 of file UpdateCanaryRequest.h.

◆ SuccessRetentionPeriodInDaysHasBeenSet()

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

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

Definition at line 409 of file UpdateCanaryRequest.h.

◆ VisualReferenceHasBeenSet()

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

Defines the screenshots to use as the baseline for comparisons during visual monitoring comparisons during future runs of this canary. If you omit this parameter, no changes are made to any baseline screenshots that the canary might be using already.

Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2 runtime or later. For more information, see Visual monitoring and Visual monitoring blueprint

Definition at line 522 of file UpdateCanaryRequest.h.

◆ VpcConfigHasBeenSet()

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

If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint. For more information, see Running a Canary in a VPC.

Definition at line 459 of file UpdateCanaryRequest.h.

◆ WithArtifactConfig() [1/2]

UpdateCanaryRequest& Aws::Synthetics::Model::UpdateCanaryRequest::WithArtifactConfig ( ArtifactConfigInput &&  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 674 of file UpdateCanaryRequest.h.

◆ WithArtifactConfig() [2/2]

UpdateCanaryRequest& Aws::Synthetics::Model::UpdateCanaryRequest::WithArtifactConfig ( const ArtifactConfigInput 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 667 of file UpdateCanaryRequest.h.

◆ WithArtifactS3Location() [1/3]

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

The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. Artifacts include the log file, screenshots, and HAR files. The name of the S3 bucket can't include a period (.).

Definition at line 624 of file UpdateCanaryRequest.h.

◆ WithArtifactS3Location() [2/3]

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

The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. Artifacts include the log file, screenshots, and HAR files. The name of the S3 bucket can't include a period (.).

Definition at line 617 of file UpdateCanaryRequest.h.

◆ WithArtifactS3Location() [3/3]

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

The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. Artifacts include the log file, screenshots, and HAR files. The name of the S3 bucket can't include a period (.).

Definition at line 631 of file UpdateCanaryRequest.h.

◆ WithCode() [1/2]

UpdateCanaryRequest& Aws::Synthetics::Model::UpdateCanaryRequest::WithCode ( CanaryCodeInput &&  value)
inline

A structure that includes the entry point from which the canary should start running your script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included.

Definition at line 146 of file UpdateCanaryRequest.h.

◆ WithCode() [2/2]

UpdateCanaryRequest& Aws::Synthetics::Model::UpdateCanaryRequest::WithCode ( const CanaryCodeInput value)
inline

A structure that includes the entry point from which the canary should start running your script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included.

Definition at line 139 of file UpdateCanaryRequest.h.

◆ WithExecutionRoleArn() [1/3]

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

The ARN of the IAM role to be used to run the canary. This role must already exist, and must include lambda.amazonaws.com as a principal in the trust policy. The role must also have the following permissions:

  • s3:PutObject

  • s3:GetBucketLocation

  • s3:ListAllMyBuckets

  • cloudwatch:PutMetricData

  • logs:CreateLogGroup

  • logs:CreateLogStream

  • logs:CreateLogStream

Definition at line 245 of file UpdateCanaryRequest.h.

◆ WithExecutionRoleArn() [2/3]

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

The ARN of the IAM role to be used to run the canary. This role must already exist, and must include lambda.amazonaws.com as a principal in the trust policy. The role must also have the following permissions:

  • s3:PutObject

  • s3:GetBucketLocation

  • s3:ListAllMyBuckets

  • cloudwatch:PutMetricData

  • logs:CreateLogGroup

  • logs:CreateLogStream

  • logs:CreateLogStream

Definition at line 231 of file UpdateCanaryRequest.h.

◆ WithExecutionRoleArn() [3/3]

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

The ARN of the IAM role to be used to run the canary. This role must already exist, and must include lambda.amazonaws.com as a principal in the trust policy. The role must also have the following permissions:

  • s3:PutObject

  • s3:GetBucketLocation

  • s3:ListAllMyBuckets

  • cloudwatch:PutMetricData

  • logs:CreateLogGroup

  • logs:CreateLogStream

  • logs:CreateLogStream

Definition at line 259 of file UpdateCanaryRequest.h.

◆ WithFailureRetentionPeriodInDays()

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

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

Definition at line 440 of file UpdateCanaryRequest.h.

◆ WithName() [1/3]

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

The name of the canary that you want to update. To find the names of your canaries, use DescribeCanaries.

You cannot change the name of a canary that has already been created.

Definition at line 95 of file UpdateCanaryRequest.h.

◆ WithName() [2/3]

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

The name of the canary that you want to update. To find the names of your canaries, use DescribeCanaries.

You cannot change the name of a canary that has already been created.

Definition at line 87 of file UpdateCanaryRequest.h.

◆ WithName() [3/3]

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

The name of the canary that you want to update. To find the names of your canaries, use DescribeCanaries.

You cannot change the name of a canary that has already been created.

Definition at line 103 of file UpdateCanaryRequest.h.

◆ WithRunConfig() [1/2]

UpdateCanaryRequest& Aws::Synthetics::Model::UpdateCanaryRequest::WithRunConfig ( CanaryRunConfigInput &&  value)
inline

A structure that contains the timeout value that is used for each individual run of the canary.

Definition at line 398 of file UpdateCanaryRequest.h.

◆ WithRunConfig() [2/2]

UpdateCanaryRequest& Aws::Synthetics::Model::UpdateCanaryRequest::WithRunConfig ( const CanaryRunConfigInput value)
inline

A structure that contains the timeout value that is used for each individual run of the canary.

Definition at line 392 of file UpdateCanaryRequest.h.

◆ WithRuntimeVersion() [1/3]

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

Specifies the runtime version to use for the canary. For a list of valid runtime versions and for more information about runtime versions, see Canary Runtime Versions.

Definition at line 316 of file UpdateCanaryRequest.h.

◆ WithRuntimeVersion() [2/3]

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

Specifies the runtime version to use for the canary. For a list of valid runtime versions and for more information about runtime versions, see Canary Runtime Versions.

Definition at line 308 of file UpdateCanaryRequest.h.

◆ WithRuntimeVersion() [3/3]

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

Specifies the runtime version to use for the canary. For a list of valid runtime versions and for more information about runtime versions, see Canary Runtime Versions.

Definition at line 324 of file UpdateCanaryRequest.h.

◆ WithSchedule() [1/2]

UpdateCanaryRequest& Aws::Synthetics::Model::UpdateCanaryRequest::WithSchedule ( CanaryScheduleInput &&  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 361 of file UpdateCanaryRequest.h.

◆ WithSchedule() [2/2]

UpdateCanaryRequest& Aws::Synthetics::Model::UpdateCanaryRequest::WithSchedule ( const CanaryScheduleInput 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 355 of file UpdateCanaryRequest.h.

◆ WithSuccessRetentionPeriodInDays()

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

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

Definition at line 419 of file UpdateCanaryRequest.h.

◆ WithVisualReference() [1/2]

UpdateCanaryRequest& Aws::Synthetics::Model::UpdateCanaryRequest::WithVisualReference ( const VisualReferenceInput value)
inline

Defines the screenshots to use as the baseline for comparisons during visual monitoring comparisons during future runs of this canary. If you omit this parameter, no changes are made to any baseline screenshots that the canary might be using already.

Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2 runtime or later. For more information, see Visual monitoring and Visual monitoring blueprint

Definition at line 561 of file UpdateCanaryRequest.h.

◆ WithVisualReference() [2/2]

UpdateCanaryRequest& Aws::Synthetics::Model::UpdateCanaryRequest::WithVisualReference ( VisualReferenceInput &&  value)
inline

Defines the screenshots to use as the baseline for comparisons during visual monitoring comparisons during future runs of this canary. If you omit this parameter, no changes are made to any baseline screenshots that the canary might be using already.

Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2 runtime or later. For more information, see Visual monitoring and Visual monitoring blueprint

Definition at line 574 of file UpdateCanaryRequest.h.

◆ WithVpcConfig() [1/2]

UpdateCanaryRequest& Aws::Synthetics::Model::UpdateCanaryRequest::WithVpcConfig ( const VpcConfigInput value)
inline

If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint. For more information, see Running a Canary in a VPC.

Definition at line 486 of file UpdateCanaryRequest.h.

◆ WithVpcConfig() [2/2]

UpdateCanaryRequest& Aws::Synthetics::Model::UpdateCanaryRequest::WithVpcConfig ( VpcConfigInput &&  value)
inline

If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint. For more information, see Running a Canary in a VPC.

Definition at line 495 of file UpdateCanaryRequest.h.


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