Class Canary

java.lang.Object
software.amazon.awssdk.services.synthetics.model.Canary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Canary.Builder,Canary>
@Generated("software.amazon.awssdk:codegen") public final class Canary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Canary.Builder,Canary>

This structure contains all information about one canary in your account.

See Also:

  • Method Details

    • id

      public final String id()

      The unique ID of this canary.

      Returns:
      The unique ID of this canary.

    • name

      public final String name()

      The name of the canary.

      Returns:
      The name of the canary.

    • code

      public final CanaryCodeOutput code()
      Returns the value of the Code property for this object.
      Returns:
      The value of the Code property for this object.

    • executionRoleArn

      public final String 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

      public final CanaryScheduleOutput 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

      public final CanaryRunConfigOutput runConfig()
      Returns the value of the RunConfig property for this object.
      Returns:
      The value of the RunConfig property for this object.

    • successRetentionPeriodInDays

      public final Integer 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

      public final Integer 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.

    • status

      public final CanaryStatus status()

      A structure that contains information about the canary's status.

      Returns:
      A structure that contains information about the canary's status.

    • timeline

      public final CanaryTimeline 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

      public final String 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

      public final String 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

      public final String 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

      public final VpcConfigOutput vpcConfig()
      Returns the value of the VpcConfig property for this object.
      Returns:
      The value of the VpcConfig property for this object.

    • visualReference

      public final VisualReferenceOutput 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.

    • provisionedResourceCleanup

      public final ProvisionedResourceCleanupSetting provisionedResourceCleanup()

      Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted. If it is AUTOMATIC, the Lambda functions and layers will be deleted when the canary is deleted.

      If the value of this parameter is OFF, then the value of the DeleteLambda 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 return ProvisionedResourceCleanupSetting.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from provisionedResourceCleanupAsString().

      Returns:
      Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted. If it is AUTOMATIC, the Lambda functions and layers will be deleted when the canary is deleted.

      If the value of this parameter is OFF, then the value of the DeleteLambda parameter of the DeleteCanary operation determines whether the Lambda functions and layers will be deleted.

      See Also:

    • provisionedResourceCleanupAsString

      public final String provisionedResourceCleanupAsString()

      Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted. If it is AUTOMATIC, the Lambda functions and layers will be deleted when the canary is deleted.

      If the value of this parameter is OFF, then the value of the DeleteLambda 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 return ProvisionedResourceCleanupSetting.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from provisionedResourceCleanupAsString().

      Returns:
      Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted. If it is AUTOMATIC, the Lambda functions and layers will be deleted when the canary is deleted.

      If the value of this parameter is OFF, then the value of the DeleteLambda parameter of the DeleteCanary operation determines whether the Lambda functions and layers will be deleted.

      See Also:

    • 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 the isEmpty() 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

      public final Map<String,String> 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

      public final ArtifactConfigOutput 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.

    • dryRunConfig

      public final DryRunConfigOutput dryRunConfig()

      Returns the dry run configurations for a canary.

      Returns:
      Returns the dry run configurations for a canary.

    • toBuilder

      public Canary.Builder 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 interface ToCopyableBuilder<Canary.Builder,Canary>
      Returns:
      a builder for type T

    • builder

      public static Canary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Canary.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.