@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class UpdateCanaryRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
UpdateCanaryRequest() |
Modifier and Type | Method and Description |
---|---|
UpdateCanaryRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
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.
|
addHandlerContext, 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
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.
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.
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.
You cannot change the name of a canary that has already been created.
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.
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.
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.
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.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.
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.
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.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
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
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
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
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
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
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.
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.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.
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.
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.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.
schedule
- A structure that contains information about how often the canary is to run, and when these runs are to
stop.public CanaryScheduleInput getSchedule()
A structure that contains information about how often the canary is to run, and when these runs are to stop.
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.
schedule
- A structure that contains information about how often the canary is to run, and when these runs are to
stop.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.
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.
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.
The environment variables keys and values are not encrypted. Do not store sensitive information in this field.
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.
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.
public void setSuccessRetentionPeriodInDays(Integer successRetentionPeriodInDays)
The number of days to retain data about successful runs of this canary.
successRetentionPeriodInDays
- The number of days to retain data about successful runs of this canary.public Integer getSuccessRetentionPeriodInDays()
The number of days to retain data about successful runs of this canary.
public UpdateCanaryRequest withSuccessRetentionPeriodInDays(Integer successRetentionPeriodInDays)
The number of days to retain data about successful runs of this canary.
successRetentionPeriodInDays
- The number of days to retain data about successful runs of this canary.public void setFailureRetentionPeriodInDays(Integer failureRetentionPeriodInDays)
The number of days to retain data about failed runs of this canary.
failureRetentionPeriodInDays
- The number of days to retain data about failed runs of this canary.public Integer getFailureRetentionPeriodInDays()
The number of days to retain data about failed runs of this canary.
public UpdateCanaryRequest withFailureRetentionPeriodInDays(Integer failureRetentionPeriodInDays)
The number of days to retain data about failed runs of this canary.
failureRetentionPeriodInDays
- The number of days to retain data about failed runs of this canary.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.
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.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.
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.
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.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
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
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
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
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
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
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 (.).
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 (.).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 (.).
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 (.).
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 (.).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.
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.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.
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.
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.public String toString()
toString
in class Object
Object.toString()
public UpdateCanaryRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()