com.amazonaws.services.synthetics.model

Class UpdateCanaryRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.synthetics.model.UpdateCanaryRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateCanaryRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateCanaryRequest()

Method Summary

Modifier and Type	Method and Description
UpdateCanaryRequest	clone()
boolean	equals(Object obj)
ArtifactConfigInput	getArtifactConfig() A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.
String	getArtifactS3Location() The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.
CanaryCodeInput	getCode() A structure that includes the entry point from which the canary should start running your script.
String	getExecutionRoleArn() The ARN of the IAM role to be used to run the canary.
Integer	getFailureRetentionPeriodInDays() The number of days to retain data about failed runs of this canary.
String	getName() The name of the canary that you want to update.
CanaryRunConfigInput	getRunConfig() A structure that contains the timeout value that is used for each individual run of the canary.
String	getRuntimeVersion() Specifies the runtime version to use for the canary.
CanaryScheduleInput	getSchedule() A structure that contains information about how often the canary is to run, and when these runs are to stop.
Integer	getSuccessRetentionPeriodInDays() The number of days to retain data about successful runs of this canary.
VisualReferenceInput	getVisualReference() Defines the screenshots to use as the baseline for comparisons during visual monitoring comparisons during future runs of this canary.
VpcConfigInput	getVpcConfig() 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.
int	hashCode()
void	setArtifactConfig(ArtifactConfigInput artifactConfig) A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.
void	setArtifactS3Location(String artifactS3Location) The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.
void	setCode(CanaryCodeInput code) A structure that includes the entry point from which the canary should start running your script.
void	setExecutionRoleArn(String executionRoleArn) The ARN of the IAM role to be used to run the canary.
void	setFailureRetentionPeriodInDays(Integer failureRetentionPeriodInDays) The number of days to retain data about failed runs of this canary.
void	setName(String name) The name of the canary that you want to update.
void	setRunConfig(CanaryRunConfigInput runConfig) A structure that contains the timeout value that is used for each individual run of the canary.
void	setRuntimeVersion(String runtimeVersion) Specifies the runtime version to use for the canary.
void	setSchedule(CanaryScheduleInput schedule) A structure that contains information about how often the canary is to run, and when these runs are to stop.
void	setSuccessRetentionPeriodInDays(Integer successRetentionPeriodInDays) The number of days to retain data about successful runs of this canary.
void	setVisualReference(VisualReferenceInput visualReference) Defines the screenshots to use as the baseline for comparisons during visual monitoring comparisons during future runs of this canary.
void	setVpcConfig(VpcConfigInput vpcConfig) 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.
String	toString() Returns a string representation of this object.
UpdateCanaryRequest	withArtifactConfig(ArtifactConfigInput artifactConfig) A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.
UpdateCanaryRequest	withArtifactS3Location(String artifactS3Location) The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.
UpdateCanaryRequest	withCode(CanaryCodeInput code) A structure that includes the entry point from which the canary should start running your script.
UpdateCanaryRequest	withExecutionRoleArn(String executionRoleArn) The ARN of the IAM role to be used to run the canary.
UpdateCanaryRequest	withFailureRetentionPeriodInDays(Integer failureRetentionPeriodInDays) The number of days to retain data about failed runs of this canary.
UpdateCanaryRequest	withName(String name) The name of the canary that you want to update.
UpdateCanaryRequest	withRunConfig(CanaryRunConfigInput runConfig) A structure that contains the timeout value that is used for each individual run of the canary.
UpdateCanaryRequest	withRuntimeVersion(String runtimeVersion) Specifies the runtime version to use for the canary.
UpdateCanaryRequest	withSchedule(CanaryScheduleInput schedule) A structure that contains information about how often the canary is to run, and when these runs are to stop.
UpdateCanaryRequest	withSuccessRetentionPeriodInDays(Integer successRetentionPeriodInDays) The number of days to retain data about successful runs of this canary.
UpdateCanaryRequest	withVisualReference(VisualReferenceInput visualReference) Defines the screenshots to use as the baseline for comparisons during visual monitoring comparisons during future runs of this canary.
UpdateCanaryRequest	withVpcConfig(VpcConfigInput vpcConfig) 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.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateCanaryRequest

public UpdateCanaryRequest()

Method Detail

setName

public void setName(String name)

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.

Parameters:

name - 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.

getName

public String getName()

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.

Returns:

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.

withName

public UpdateCanaryRequest withName(String name)

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.

Parameters:

name - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCode

public void setCode(CanaryCodeInput code)

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.

Parameters:

code - 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.

getCode

public CanaryCodeInput getCode()

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.

Returns:

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.

withCode

public UpdateCanaryRequest withCode(CanaryCodeInput code)

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.

Parameters:

code - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setExecutionRoleArn

public void setExecutionRoleArn(String executionRoleArn)

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

Parameters:

executionRoleArn - 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

getExecutionRoleArn

public String getExecutionRoleArn()

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

Returns:

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

withExecutionRoleArn

public UpdateCanaryRequest withExecutionRoleArn(String executionRoleArn)

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

Parameters:

executionRoleArn - 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

Returns:

Returns a reference to this object so that method calls can be chained together.

setRuntimeVersion

public void setRuntimeVersion(String runtimeVersion)

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.

Parameters:

runtimeVersion - 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.

getRuntimeVersion

public String getRuntimeVersion()

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.

Returns:

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.

withRuntimeVersion

public UpdateCanaryRequest withRuntimeVersion(String runtimeVersion)

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.

Parameters:

runtimeVersion - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSchedule

public void setSchedule(CanaryScheduleInput schedule)

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

Parameters:

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

getSchedule

public CanaryScheduleInput getSchedule()

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

Returns:

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

withSchedule

public UpdateCanaryRequest withSchedule(CanaryScheduleInput schedule)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setRunConfig

public void setRunConfig(CanaryRunConfigInput runConfig)

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

The environment variables keys and values are not encrypted. Do not store sensitive information in this field.

Parameters:

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

The environment variables keys and values are not encrypted. Do not store sensitive information in this field.

getRunConfig

public CanaryRunConfigInput getRunConfig()

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

The environment variables keys and values are not encrypted. Do not store sensitive information in this field.

Returns:

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

The environment variables keys and values are not encrypted. Do not store sensitive information in this field.

withRunConfig

public UpdateCanaryRequest withRunConfig(CanaryRunConfigInput runConfig)

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

The environment variables keys and values are not encrypted. Do not store sensitive information in this field.

Parameters:

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

The environment variables keys and values are not encrypted. Do not store sensitive information in this field.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSuccessRetentionPeriodInDays

public void setSuccessRetentionPeriodInDays(Integer successRetentionPeriodInDays)

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

Parameters:

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

getSuccessRetentionPeriodInDays

public Integer getSuccessRetentionPeriodInDays()

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

Returns:

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

withSuccessRetentionPeriodInDays

public UpdateCanaryRequest withSuccessRetentionPeriodInDays(Integer successRetentionPeriodInDays)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setFailureRetentionPeriodInDays

public void setFailureRetentionPeriodInDays(Integer failureRetentionPeriodInDays)

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

Parameters:

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

getFailureRetentionPeriodInDays

public Integer getFailureRetentionPeriodInDays()

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

Returns:

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

withFailureRetentionPeriodInDays

public UpdateCanaryRequest withFailureRetentionPeriodInDays(Integer failureRetentionPeriodInDays)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setVpcConfig

public void setVpcConfig(VpcConfigInput vpcConfig)

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.

Parameters:

vpcConfig - 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.

getVpcConfig

public VpcConfigInput getVpcConfig()

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.

Returns:

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.

withVpcConfig

public UpdateCanaryRequest withVpcConfig(VpcConfigInput vpcConfig)

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.

Parameters:

vpcConfig - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setVisualReference

public void setVisualReference(VisualReferenceInput visualReference)

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

Parameters:

visualReference - 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

getVisualReference

public VisualReferenceInput getVisualReference()

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

Returns:

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

withVisualReference

public UpdateCanaryRequest withVisualReference(VisualReferenceInput visualReference)

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

Parameters:

visualReference - 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

Returns:

Returns a reference to this object so that method calls can be chained together.

setArtifactS3Location

public void setArtifactS3Location(String artifactS3Location)

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 (.).

Parameters:

artifactS3Location - 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 (.).

getArtifactS3Location

public String getArtifactS3Location()

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 (.).

Returns:

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 (.).

withArtifactS3Location

public UpdateCanaryRequest withArtifactS3Location(String artifactS3Location)

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 (.).

Parameters:

artifactS3Location - 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 (.).

Returns:

Returns a reference to this object so that method calls can be chained together.

setArtifactConfig

public void setArtifactConfig(ArtifactConfigInput artifactConfig)

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

Parameters:

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

getArtifactConfig

public ArtifactConfigInput getArtifactConfig()

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

Returns:

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

withArtifactConfig

public UpdateCanaryRequest withArtifactConfig(ArtifactConfigInput artifactConfig)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdateCanaryRequest clone()

Overrides:

clone in class AmazonWebServiceRequest