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

#include <CreateCanaryRequest.h>

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

Public Member Functions

 CreateCanaryRequest ()
 
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)
 
CreateCanaryRequestWithName (const Aws::String &value)
 
CreateCanaryRequestWithName (Aws::String &&value)
 
CreateCanaryRequestWithName (const char *value)
 
const CanaryCodeInputGetCode () const
 
bool CodeHasBeenSet () const
 
void SetCode (const CanaryCodeInput &value)
 
void SetCode (CanaryCodeInput &&value)
 
CreateCanaryRequestWithCode (const CanaryCodeInput &value)
 
CreateCanaryRequestWithCode (CanaryCodeInput &&value)
 
const Aws::StringGetArtifactS3Location () const
 
bool ArtifactS3LocationHasBeenSet () const
 
void SetArtifactS3Location (const Aws::String &value)
 
void SetArtifactS3Location (Aws::String &&value)
 
void SetArtifactS3Location (const char *value)
 
CreateCanaryRequestWithArtifactS3Location (const Aws::String &value)
 
CreateCanaryRequestWithArtifactS3Location (Aws::String &&value)
 
CreateCanaryRequestWithArtifactS3Location (const char *value)
 
const Aws::StringGetExecutionRoleArn () const
 
bool ExecutionRoleArnHasBeenSet () const
 
void SetExecutionRoleArn (const Aws::String &value)
 
void SetExecutionRoleArn (Aws::String &&value)
 
void SetExecutionRoleArn (const char *value)
 
CreateCanaryRequestWithExecutionRoleArn (const Aws::String &value)
 
CreateCanaryRequestWithExecutionRoleArn (Aws::String &&value)
 
CreateCanaryRequestWithExecutionRoleArn (const char *value)
 
const CanaryScheduleInputGetSchedule () const
 
bool ScheduleHasBeenSet () const
 
void SetSchedule (const CanaryScheduleInput &value)
 
void SetSchedule (CanaryScheduleInput &&value)
 
CreateCanaryRequestWithSchedule (const CanaryScheduleInput &value)
 
CreateCanaryRequestWithSchedule (CanaryScheduleInput &&value)
 
const CanaryRunConfigInputGetRunConfig () const
 
bool RunConfigHasBeenSet () const
 
void SetRunConfig (const CanaryRunConfigInput &value)
 
void SetRunConfig (CanaryRunConfigInput &&value)
 
CreateCanaryRequestWithRunConfig (const CanaryRunConfigInput &value)
 
CreateCanaryRequestWithRunConfig (CanaryRunConfigInput &&value)
 
int GetSuccessRetentionPeriodInDays () const
 
bool SuccessRetentionPeriodInDaysHasBeenSet () const
 
void SetSuccessRetentionPeriodInDays (int value)
 
CreateCanaryRequestWithSuccessRetentionPeriodInDays (int value)
 
int GetFailureRetentionPeriodInDays () const
 
bool FailureRetentionPeriodInDaysHasBeenSet () const
 
void SetFailureRetentionPeriodInDays (int value)
 
CreateCanaryRequestWithFailureRetentionPeriodInDays (int value)
 
const Aws::StringGetRuntimeVersion () const
 
bool RuntimeVersionHasBeenSet () const
 
void SetRuntimeVersion (const Aws::String &value)
 
void SetRuntimeVersion (Aws::String &&value)
 
void SetRuntimeVersion (const char *value)
 
CreateCanaryRequestWithRuntimeVersion (const Aws::String &value)
 
CreateCanaryRequestWithRuntimeVersion (Aws::String &&value)
 
CreateCanaryRequestWithRuntimeVersion (const char *value)
 
const VpcConfigInputGetVpcConfig () const
 
bool VpcConfigHasBeenSet () const
 
void SetVpcConfig (const VpcConfigInput &value)
 
void SetVpcConfig (VpcConfigInput &&value)
 
CreateCanaryRequestWithVpcConfig (const VpcConfigInput &value)
 
CreateCanaryRequestWithVpcConfig (VpcConfigInput &&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)
 
CreateCanaryRequestWithTags (const Aws::Map< Aws::String, Aws::String > &value)
 
CreateCanaryRequestWithTags (Aws::Map< Aws::String, Aws::String > &&value)
 
CreateCanaryRequestAddTags (const Aws::String &key, const Aws::String &value)
 
CreateCanaryRequestAddTags (Aws::String &&key, const Aws::String &value)
 
CreateCanaryRequestAddTags (const Aws::String &key, Aws::String &&value)
 
CreateCanaryRequestAddTags (Aws::String &&key, Aws::String &&value)
 
CreateCanaryRequestAddTags (const char *key, Aws::String &&value)
 
CreateCanaryRequestAddTags (Aws::String &&key, const char *value)
 
CreateCanaryRequestAddTags (const char *key, const char *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 26 of file CreateCanaryRequest.h.

Constructor & Destructor Documentation

◆ CreateCanaryRequest()

Aws::Synthetics::Model::CreateCanaryRequest::CreateCanaryRequest ( )

Member Function Documentation

◆ AddTags() [1/7]

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

A list of key-value pairs to associate with the canary. You can associate as many as 50 tags with a canary.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.

Definition at line 682 of file CreateCanaryRequest.h.

◆ AddTags() [2/7]

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

A list of key-value pairs to associate with the canary. You can associate as many as 50 tags with a canary.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.

Definition at line 664 of file CreateCanaryRequest.h.

◆ AddTags() [3/7]

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

A list of key-value pairs to associate with the canary. You can associate as many as 50 tags with a canary.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.

Definition at line 700 of file CreateCanaryRequest.h.

◆ AddTags() [4/7]

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

A list of key-value pairs to associate with the canary. You can associate as many as 50 tags with a canary.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.

Definition at line 673 of file CreateCanaryRequest.h.

◆ AddTags() [5/7]

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

A list of key-value pairs to associate with the canary. You can associate as many as 50 tags with a canary.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.

Definition at line 655 of file CreateCanaryRequest.h.

◆ AddTags() [6/7]

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

A list of key-value pairs to associate with the canary. You can associate as many as 50 tags with a canary.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.

Definition at line 691 of file CreateCanaryRequest.h.

◆ AddTags() [7/7]

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

A list of key-value pairs to associate with the canary. You can associate as many as 50 tags with a canary.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.

Definition at line 709 of file CreateCanaryRequest.h.

◆ ArtifactS3LocationHasBeenSet()

bool Aws::Synthetics::Model::CreateCanaryRequest::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.

Definition at line 184 of file CreateCanaryRequest.h.

◆ CodeHasBeenSet()

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

◆ ExecutionRoleArnHasBeenSet()

bool Aws::Synthetics::Model::CreateCanaryRequest::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:PutLogEvents

Definition at line 255 of file CreateCanaryRequest.h.

◆ FailureRetentionPeriodInDaysHasBeenSet()

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

The number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

Definition at line 457 of file CreateCanaryRequest.h.

◆ GetArtifactS3Location()

const Aws::String& Aws::Synthetics::Model::CreateCanaryRequest::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.

Definition at line 177 of file CreateCanaryRequest.h.

◆ GetCode()

const CanaryCodeInput& Aws::Synthetics::Model::CreateCanaryRequest::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 134 of file CreateCanaryRequest.h.

◆ GetExecutionRoleArn()

const Aws::String& Aws::Synthetics::Model::CreateCanaryRequest::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:PutLogEvents

Definition at line 241 of file CreateCanaryRequest.h.

◆ GetFailureRetentionPeriodInDays()

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

The number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

Definition at line 450 of file CreateCanaryRequest.h.

◆ GetName()

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

The name for this canary. Be sure to give it a descriptive name that distinguishes it from other canaries in your account.

Do not include secrets or proprietary information in your canary names. The canary name makes up part of the canary ARN, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries.

Definition at line 49 of file CreateCanaryRequest.h.

◆ GetRunConfig()

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

A structure that contains the configuration for individual canary runs, such as timeout value.

Definition at line 383 of file CreateCanaryRequest.h.

◆ GetRuntimeVersion()

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

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

Definition at line 480 of file CreateCanaryRequest.h.

◆ GetSchedule()

const CanaryScheduleInput& Aws::Synthetics::Model::CreateCanaryRequest::GetSchedule ( ) const
inline

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

Definition at line 346 of file CreateCanaryRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file CreateCanaryRequest.h.

◆ GetSuccessRetentionPeriodInDays()

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

The number of days to retain data about successful runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

Definition at line 421 of file CreateCanaryRequest.h.

◆ GetTags()

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

A list of key-value pairs to associate with the canary. You can associate as many as 50 tags with a canary.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.

Definition at line 601 of file CreateCanaryRequest.h.

◆ GetVpcConfig()

const VpcConfigInput& Aws::Synthetics::Model::CreateCanaryRequest::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 546 of file CreateCanaryRequest.h.

◆ NameHasBeenSet()

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

The name for this canary. Be sure to give it a descriptive name that distinguishes it from other canaries in your account.

Do not include secrets or proprietary information in your canary names. The canary name makes up part of the canary ARN, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries.

Definition at line 60 of file CreateCanaryRequest.h.

◆ RunConfigHasBeenSet()

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

A structure that contains the configuration for individual canary runs, such as timeout value.

Definition at line 389 of file CreateCanaryRequest.h.

◆ RuntimeVersionHasBeenSet()

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

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

Definition at line 488 of file CreateCanaryRequest.h.

◆ ScheduleHasBeenSet()

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

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

Definition at line 352 of file CreateCanaryRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetArtifactS3Location() [1/3]

void Aws::Synthetics::Model::CreateCanaryRequest::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.

Definition at line 198 of file CreateCanaryRequest.h.

◆ SetArtifactS3Location() [2/3]

void Aws::Synthetics::Model::CreateCanaryRequest::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.

Definition at line 191 of file CreateCanaryRequest.h.

◆ SetArtifactS3Location() [3/3]

void Aws::Synthetics::Model::CreateCanaryRequest::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.

Definition at line 205 of file CreateCanaryRequest.h.

◆ SetCode() [1/2]

void Aws::Synthetics::Model::CreateCanaryRequest::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 155 of file CreateCanaryRequest.h.

◆ SetCode() [2/2]

void Aws::Synthetics::Model::CreateCanaryRequest::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 148 of file CreateCanaryRequest.h.

◆ SetExecutionRoleArn() [1/3]

void Aws::Synthetics::Model::CreateCanaryRequest::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:PutLogEvents

Definition at line 283 of file CreateCanaryRequest.h.

◆ SetExecutionRoleArn() [2/3]

void Aws::Synthetics::Model::CreateCanaryRequest::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:PutLogEvents

Definition at line 269 of file CreateCanaryRequest.h.

◆ SetExecutionRoleArn() [3/3]

void Aws::Synthetics::Model::CreateCanaryRequest::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:PutLogEvents

Definition at line 297 of file CreateCanaryRequest.h.

◆ SetFailureRetentionPeriodInDays()

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

The number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

Definition at line 464 of file CreateCanaryRequest.h.

◆ SetName() [1/3]

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

The name for this canary. Be sure to give it a descriptive name that distinguishes it from other canaries in your account.

Do not include secrets or proprietary information in your canary names. The canary name makes up part of the canary ARN, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries.

Definition at line 82 of file CreateCanaryRequest.h.

◆ SetName() [2/3]

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

The name for this canary. Be sure to give it a descriptive name that distinguishes it from other canaries in your account.

Do not include secrets or proprietary information in your canary names. The canary name makes up part of the canary ARN, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries.

Definition at line 71 of file CreateCanaryRequest.h.

◆ SetName() [3/3]

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

The name for this canary. Be sure to give it a descriptive name that distinguishes it from other canaries in your account.

Do not include secrets or proprietary information in your canary names. The canary name makes up part of the canary ARN, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries.

Definition at line 93 of file CreateCanaryRequest.h.

◆ SetRunConfig() [1/2]

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

A structure that contains the configuration for individual canary runs, such as timeout value.

Definition at line 401 of file CreateCanaryRequest.h.

◆ SetRunConfig() [2/2]

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

A structure that contains the configuration for individual canary runs, such as timeout value.

Definition at line 395 of file CreateCanaryRequest.h.

◆ SetRuntimeVersion() [1/3]

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

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

Definition at line 504 of file CreateCanaryRequest.h.

◆ SetRuntimeVersion() [2/3]

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

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

Definition at line 496 of file CreateCanaryRequest.h.

◆ SetRuntimeVersion() [3/3]

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

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

Definition at line 512 of file CreateCanaryRequest.h.

◆ SetSchedule() [1/2]

void Aws::Synthetics::Model::CreateCanaryRequest::SetSchedule ( CanaryScheduleInput &&  value)
inline

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

Definition at line 364 of file CreateCanaryRequest.h.

◆ SetSchedule() [2/2]

void Aws::Synthetics::Model::CreateCanaryRequest::SetSchedule ( const CanaryScheduleInput value)
inline

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

Definition at line 358 of file CreateCanaryRequest.h.

◆ SetSuccessRetentionPeriodInDays()

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

The number of days to retain data about successful runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

Definition at line 435 of file CreateCanaryRequest.h.

◆ SetTags() [1/2]

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

A list of key-value pairs to associate with the canary. You can associate as many as 50 tags with a canary.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.

Definition at line 628 of file CreateCanaryRequest.h.

◆ SetTags() [2/2]

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

A list of key-value pairs to associate with the canary. You can associate as many as 50 tags with a canary.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.

Definition at line 619 of file CreateCanaryRequest.h.

◆ SetVpcConfig() [1/2]

void Aws::Synthetics::Model::CreateCanaryRequest::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 564 of file CreateCanaryRequest.h.

◆ SetVpcConfig() [2/2]

void Aws::Synthetics::Model::CreateCanaryRequest::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 573 of file CreateCanaryRequest.h.

◆ SuccessRetentionPeriodInDaysHasBeenSet()

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

The number of days to retain data about successful runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

Definition at line 428 of file CreateCanaryRequest.h.

◆ TagsHasBeenSet()

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

A list of key-value pairs to associate with the canary. You can associate as many as 50 tags with a canary.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.

Definition at line 610 of file CreateCanaryRequest.h.

◆ VpcConfigHasBeenSet()

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

◆ WithArtifactS3Location() [1/3]

CreateCanaryRequest& Aws::Synthetics::Model::CreateCanaryRequest::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.

Definition at line 219 of file CreateCanaryRequest.h.

◆ WithArtifactS3Location() [2/3]

CreateCanaryRequest& Aws::Synthetics::Model::CreateCanaryRequest::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.

Definition at line 212 of file CreateCanaryRequest.h.

◆ WithArtifactS3Location() [3/3]

CreateCanaryRequest& Aws::Synthetics::Model::CreateCanaryRequest::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.

Definition at line 226 of file CreateCanaryRequest.h.

◆ WithCode() [1/2]

CreateCanaryRequest& Aws::Synthetics::Model::CreateCanaryRequest::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 169 of file CreateCanaryRequest.h.

◆ WithCode() [2/2]

CreateCanaryRequest& Aws::Synthetics::Model::CreateCanaryRequest::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 162 of file CreateCanaryRequest.h.

◆ WithExecutionRoleArn() [1/3]

CreateCanaryRequest& Aws::Synthetics::Model::CreateCanaryRequest::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:PutLogEvents

Definition at line 325 of file CreateCanaryRequest.h.

◆ WithExecutionRoleArn() [2/3]

CreateCanaryRequest& Aws::Synthetics::Model::CreateCanaryRequest::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:PutLogEvents

Definition at line 311 of file CreateCanaryRequest.h.

◆ WithExecutionRoleArn() [3/3]

CreateCanaryRequest& Aws::Synthetics::Model::CreateCanaryRequest::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:PutLogEvents

Definition at line 339 of file CreateCanaryRequest.h.

◆ WithFailureRetentionPeriodInDays()

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

The number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

Definition at line 471 of file CreateCanaryRequest.h.

◆ WithName() [1/3]

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

The name for this canary. Be sure to give it a descriptive name that distinguishes it from other canaries in your account.

Do not include secrets or proprietary information in your canary names. The canary name makes up part of the canary ARN, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries.

Definition at line 115 of file CreateCanaryRequest.h.

◆ WithName() [2/3]

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

The name for this canary. Be sure to give it a descriptive name that distinguishes it from other canaries in your account.

Do not include secrets or proprietary information in your canary names. The canary name makes up part of the canary ARN, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries.

Definition at line 104 of file CreateCanaryRequest.h.

◆ WithName() [3/3]

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

The name for this canary. Be sure to give it a descriptive name that distinguishes it from other canaries in your account.

Do not include secrets or proprietary information in your canary names. The canary name makes up part of the canary ARN, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries.

Definition at line 126 of file CreateCanaryRequest.h.

◆ WithRunConfig() [1/2]

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

A structure that contains the configuration for individual canary runs, such as timeout value.

Definition at line 413 of file CreateCanaryRequest.h.

◆ WithRunConfig() [2/2]

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

A structure that contains the configuration for individual canary runs, such as timeout value.

Definition at line 407 of file CreateCanaryRequest.h.

◆ WithRuntimeVersion() [1/3]

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

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

Definition at line 528 of file CreateCanaryRequest.h.

◆ WithRuntimeVersion() [2/3]

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

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

Definition at line 520 of file CreateCanaryRequest.h.

◆ WithRuntimeVersion() [3/3]

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

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

Definition at line 536 of file CreateCanaryRequest.h.

◆ WithSchedule() [1/2]

CreateCanaryRequest& Aws::Synthetics::Model::CreateCanaryRequest::WithSchedule ( CanaryScheduleInput &&  value)
inline

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

Definition at line 376 of file CreateCanaryRequest.h.

◆ WithSchedule() [2/2]

CreateCanaryRequest& Aws::Synthetics::Model::CreateCanaryRequest::WithSchedule ( const CanaryScheduleInput value)
inline

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

Definition at line 370 of file CreateCanaryRequest.h.

◆ WithSuccessRetentionPeriodInDays()

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

The number of days to retain data about successful runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

Definition at line 442 of file CreateCanaryRequest.h.

◆ WithTags() [1/2]

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

A list of key-value pairs to associate with the canary. You can associate as many as 50 tags with a canary.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.

Definition at line 646 of file CreateCanaryRequest.h.

◆ WithTags() [2/2]

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

A list of key-value pairs to associate with the canary. You can associate as many as 50 tags with a canary.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.

Definition at line 637 of file CreateCanaryRequest.h.

◆ WithVpcConfig() [1/2]

CreateCanaryRequest& Aws::Synthetics::Model::CreateCanaryRequest::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 582 of file CreateCanaryRequest.h.

◆ WithVpcConfig() [2/2]

CreateCanaryRequest& Aws::Synthetics::Model::CreateCanaryRequest::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 591 of file CreateCanaryRequest.h.


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