Class UpdateCanaryRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.synthetics.model.SyntheticsRequest
software.amazon.awssdk.services.synthetics.model.UpdateCanaryRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateCanaryRequest.Builder,UpdateCanaryRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateCanaryRequest extends SyntheticsRequest implements ToCopyableBuilder<UpdateCanaryRequest.Builder,UpdateCanaryRequest>

  • Method Details

    • name

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

      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

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

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

      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

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

      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

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

      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.

    • vpcConfig

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

      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

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

      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

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

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

      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

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

    • dryRunId

      public final String 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 the Schedule. 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 the Schedule. Adding any other field will thrown an exception.

    • toBuilder

      public UpdateCanaryRequest.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<UpdateCanaryRequest.Builder,UpdateCanaryRequest>
      Specified by:
      toBuilder in class SyntheticsRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateCanaryRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      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.