Class UpdateCanaryRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateCanaryRequest.Builder,
UpdateCanaryRequest>
-
Nested Class Summary
Nested Classes -
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.final List
<BrowserConfig> A structure that specifies the browser type to use for a canary run.static UpdateCanaryRequest.Builder
builder()
final CanaryCodeInput
code()
A structure that includes the entry point from which the canary should start running your script.final String
dryRunId()
Update the existing canary using the updated configurations from the DryRun associated with the DryRunId.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 boolean
For responses, this returns true if the service returned a value for the BrowserConfigs property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the VisualReferences property.final String
name()
The name of the canary that you want to update.Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted.final String
Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted.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 List
<VisualReferenceInput> A list of visual reference configurations for the canary, one for each browser type that the canary is configured to run on.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 Amazon 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 Amazon 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.
Environment variable keys and values are encrypted at rest using Amazon Web Services owned KMS keys. However, the environment variables are not encrypted on the client side. Do not store sensitive information in them.
- Returns:
- A structure that contains the timeout value that is used for each individual run of the canary.
Environment variable keys and values are encrypted at rest using Amazon Web Services owned KMS keys. However, the environment variables are not encrypted on the client side. Do not store sensitive information in them.
-
successRetentionPeriodInDays
The number of days to retain data about successful runs of this canary.
This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console.
- Returns:
- The number of days to retain data about successful runs of this canary.
This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console.
-
failureRetentionPeriodInDays
The number of days to retain data about failed runs of this canary.
This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console.
- Returns:
- The number of days to retain data about failed runs of this canary.
This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console.
-
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 Amazon 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 Amazon 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.
-
provisionedResourceCleanup
Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted.
If the value of this parameter is
OFF
, then the value of theDeleteLambda
parameter of the DeleteCanary operation determines whether the Lambda functions and layers will be deleted.If the service returns an enum value that is not available in the current SDK version,
provisionedResourceCleanup
will returnProvisionedResourceCleanupSetting.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprovisionedResourceCleanupAsString()
.- Returns:
- Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is
deleted.
If the value of this parameter is
OFF
, then the value of theDeleteLambda
parameter of the DeleteCanary operation determines whether the Lambda functions and layers will be deleted. - See Also:
-
provisionedResourceCleanupAsString
Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted.
If the value of this parameter is
OFF
, then the value of theDeleteLambda
parameter of the DeleteCanary operation determines whether the Lambda functions and layers will be deleted.If the service returns an enum value that is not available in the current SDK version,
provisionedResourceCleanup
will returnProvisionedResourceCleanupSetting.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprovisionedResourceCleanupAsString()
.- Returns:
- Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is
deleted.
If the value of this parameter is
OFF
, then the value of theDeleteLambda
parameter of the DeleteCanary operation determines whether the Lambda functions and layers will be deleted. - See Also:
-
dryRunId
Update the existing canary using the updated configurations from the DryRun associated with the DryRunId.
When you use the
dryRunId
field when updating a canary, the only other field you can provide is theSchedule
. Adding any other field will thrown an exception.- Returns:
- Update the existing canary using the updated configurations from the DryRun associated with the
DryRunId.
When you use the
dryRunId
field when updating a canary, the only other field you can provide is theSchedule
. Adding any other field will thrown an exception.
-
hasVisualReferences
public final boolean hasVisualReferences()For responses, this returns true if the service returned a value for the VisualReferences property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
visualReferences
A list of visual reference configurations for the canary, one for each browser type that the canary is configured to run on. Visual references are used for visual monitoring comparisons.
syn-nodejs-puppeteer-11.0
and above, andsyn-nodejs-playwright-3.0
and above, only supportsvisualReferences
.visualReference
field is not supported.Versions older than
syn-nodejs-puppeteer-11.0
supports bothvisualReference
andvisualReferences
for backward compatibility. It is recommended to usevisualReferences
for consistency and future compatibility.For multibrowser visual monitoring, you can update the baseline for all configured browsers in a single update call by specifying a list of VisualReference objects, one per browser. Each VisualReference object maps to a specific browser configuration, allowing you to manage visual baselines for multiple browsers simultaneously.
For single configuration canaries using Chrome browser (default browser), use visualReferences for
syn-nodejs-puppeteer-11.0
and above, andsyn-nodejs-playwright-3.0
and above canaries. The browserType in the visualReference object is not mandatory.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasVisualReferences()
method.- Returns:
- A list of visual reference configurations for the canary, one for each browser type that the canary is
configured to run on. Visual references are used for visual monitoring comparisons.
syn-nodejs-puppeteer-11.0
and above, andsyn-nodejs-playwright-3.0
and above, only supportsvisualReferences
.visualReference
field is not supported.Versions older than
syn-nodejs-puppeteer-11.0
supports bothvisualReference
andvisualReferences
for backward compatibility. It is recommended to usevisualReferences
for consistency and future compatibility.For multibrowser visual monitoring, you can update the baseline for all configured browsers in a single update call by specifying a list of VisualReference objects, one per browser. Each VisualReference object maps to a specific browser configuration, allowing you to manage visual baselines for multiple browsers simultaneously.
For single configuration canaries using Chrome browser (default browser), use visualReferences for
syn-nodejs-puppeteer-11.0
and above, andsyn-nodejs-playwright-3.0
and above canaries. The browserType in the visualReference object is not mandatory.
-
hasBrowserConfigs
public final boolean hasBrowserConfigs()For responses, this returns true if the service returned a value for the BrowserConfigs property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
browserConfigs
A structure that specifies the browser type to use for a canary run. CloudWatch Synthetics supports running canaries on both
CHROME
andFIREFOX
browsers.If not specified,
browserConfigs
defaults to Chrome.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasBrowserConfigs()
method.- Returns:
- A structure that specifies the browser type to use for a canary run. CloudWatch Synthetics supports
running canaries on both
CHROME
andFIREFOX
browsers.If not specified,
browserConfigs
defaults to Chrome.
-
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
-
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
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-