Class UpdateCanaryRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateCanaryRequest.Builder,
UpdateCanaryRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal ArtifactConfigInput
A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.final String
The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.static UpdateCanaryRequest.Builder
builder()
final CanaryCodeInput
code()
A structure that includes the entry point from which the canary should start running your script.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The ARN of the IAM role to be used to run the canary.final Integer
The number of days to retain data about failed runs of this canary.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final String
name()
The name of the canary that you want to update.final CanaryRunConfigInput
A structure that contains the timeout value that is used for each individual run of the canary.final String
Specifies the runtime version to use for the canary.final CanaryScheduleInput
schedule()
A structure that contains information about how often the canary is to run, and when these runs are to stop.static Class
<? extends UpdateCanaryRequest.Builder> final Integer
The number of days to retain data about successful runs of this canary.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final VisualReferenceInput
Defines the screenshots to use as the baseline for comparisons during visual monitoring comparisons during future runs of this canary.final VpcConfigInput
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 software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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:
- 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.
-
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:
- 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.
-
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:
- 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
-
-
-
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:
- 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.
-
schedule
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.
-
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:
- 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.
-
successRetentionPeriodInDays
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.
-
failureRetentionPeriodInDays
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.
-
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:
- 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.
-
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:
- 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
-
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:
- 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 (.).
-
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:
- A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<UpdateCanaryRequest.Builder,
UpdateCanaryRequest> - Specified by:
toBuilder
in classSyntheticsRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-