Class Canary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Canary.Builder,
Canary>
This structure contains all information about one canary in your account.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal ArtifactConfigOutput
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 runs of this canary.static Canary.Builder
builder()
final CanaryCodeOutput
code()
Returns the value of the Code property for this object.final String
The ARN of the Lambda function that is used as your canary's engine.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 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) final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
id()
The unique ID of this canary.final String
name()
The name of the canary.final CanaryRunConfigOutput
Returns the value of the RunConfig property for this object.final String
Specifies the runtime version to use for the canary.final CanaryScheduleOutput
schedule()
A structure that contains information about how often the canary is to run, and when these runs are to stop.static Class
<? extends Canary.Builder> final CanaryStatus
status()
A structure that contains information about the canary's status.final Integer
The number of days to retain data about successful runs of this canary.tags()
The list of key-value pairs that are associated with the canary.final CanaryTimeline
timeline()
A structure that contains information about when the canary was created, modified, and most recently run.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 VisualReferenceOutput
If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run to use as the baseline for screenshots, and the coordinates of any parts of the screen to ignore during the visual monitoring comparison.final VpcConfigOutput
Returns the value of the VpcConfig property for this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
id
The unique ID of this canary.
- Returns:
- The unique ID of this canary.
-
name
The name of the canary.
- Returns:
- The name of the canary.
-
code
Returns the value of the Code property for this object.- Returns:
- The value of the Code property for this object.
-
executionRoleArn
The ARN of the IAM role used to run the canary. This role must include
lambda.amazonaws.com
as a principal in the trust policy.- Returns:
- The ARN of the IAM role used to run the canary. This role must include
lambda.amazonaws.com
as a principal in the trust policy.
-
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
Returns the value of the RunConfig property for this object.- Returns:
- The value of the RunConfig property for this object.
-
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.
-
status
A structure that contains information about the canary's status.
- Returns:
- A structure that contains information about the canary's status.
-
timeline
A structure that contains information about when the canary was created, modified, and most recently run.
- Returns:
- A structure that contains information about when the canary was created, modified, and most recently run.
-
artifactS3Location
The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary. Artifacts include the log file, screenshots, and HAR files.
- Returns:
- The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary. Artifacts include the log file, screenshots, and HAR files.
-
engineArn
The ARN of the Lambda function that is used as your canary's engine. For more information about Lambda ARN format, see Resources and Conditions for Lambda Actions.
- Returns:
- The ARN of the Lambda function that is used as your canary's engine. For more information about Lambda ARN format, see Resources and Conditions for Lambda Actions.
-
runtimeVersion
Specifies the runtime version to use for the canary. For more information about runtime versions, see Canary Runtime Versions.
- Returns:
- Specifies the runtime version to use for the canary. For more information about runtime versions, see Canary Runtime Versions.
-
vpcConfig
Returns the value of the VpcConfig property for this object.- Returns:
- The value of the VpcConfig property for this object.
-
visualReference
If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run to use as the baseline for screenshots, and the coordinates of any parts of the screen to ignore during the visual monitoring comparison.
- Returns:
- If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run to use as the baseline for screenshots, and the coordinates of any parts of the screen to ignore during the visual monitoring comparison.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags 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. -
tags
The list of key-value pairs that are associated with the canary.
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
hasTags()
method.- Returns:
- The list of key-value pairs that are associated with the canary.
-
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<Canary.Builder,
Canary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
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
-
sdkFields
-