Interface UpdateCanaryRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<UpdateCanaryRequest.Builder,UpdateCanaryRequest>, SdkBuilder<UpdateCanaryRequest.Builder,UpdateCanaryRequest>, SdkPojo, SdkRequest.Builder, SyntheticsRequest.Builder
Enclosing class:
UpdateCanaryRequest
@Mutable @NotThreadSafe public static interface UpdateCanaryRequest.Builder extends SyntheticsRequest.Builder, SdkPojo, CopyableBuilder<UpdateCanaryRequest.Builder,UpdateCanaryRequest>

  • Method Details

    • name

      UpdateCanaryRequest.Builder name(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • code

      UpdateCanaryRequest.Builder code(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • code

      default UpdateCanaryRequest.Builder code(Consumer<CanaryCodeInput.Builder> 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.

      This is a convenience method that creates an instance of the CanaryCodeInput.Builder avoiding the need to create one manually via CanaryCodeInput.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to code(CanaryCodeInput).

      Parameters:
      code - a consumer that will call methods on CanaryCodeInput.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • executionRoleArn

      UpdateCanaryRequest.Builder executionRoleArn(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • runtimeVersion

      UpdateCanaryRequest.Builder runtimeVersion(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • schedule

      UpdateCanaryRequest.Builder schedule(CanaryScheduleInput schedule)

      A structure that contains information about how often the canary is to run, and when these runs are to stop.

      Parameters:
      schedule - A structure that contains information about how often the canary is to run, and when these runs are to stop.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • schedule

      default UpdateCanaryRequest.Builder schedule(Consumer<CanaryScheduleInput.Builder> schedule)

      A structure that contains information about how often the canary is to run, and when these runs are to stop.

      This is a convenience method that creates an instance of the CanaryScheduleInput.Builder avoiding the need to create one manually via CanaryScheduleInput.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to schedule(CanaryScheduleInput).

      Parameters:
      schedule - a consumer that will call methods on CanaryScheduleInput.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • runConfig

      UpdateCanaryRequest.Builder runConfig(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • runConfig

      default UpdateCanaryRequest.Builder runConfig(Consumer<CanaryRunConfigInput.Builder> 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.

      This is a convenience method that creates an instance of the CanaryRunConfigInput.Builder avoiding the need to create one manually via CanaryRunConfigInput.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to runConfig(CanaryRunConfigInput).

      Parameters:
      runConfig - a consumer that will call methods on CanaryRunConfigInput.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • successRetentionPeriodInDays

      UpdateCanaryRequest.Builder successRetentionPeriodInDays(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • failureRetentionPeriodInDays

      UpdateCanaryRequest.Builder failureRetentionPeriodInDays(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • vpcConfig

      UpdateCanaryRequest.Builder vpcConfig(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • vpcConfig

      default UpdateCanaryRequest.Builder vpcConfig(Consumer<VpcConfigInput.Builder> 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.

      This is a convenience method that creates an instance of the VpcConfigInput.Builder avoiding the need to create one manually via VpcConfigInput.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vpcConfig(VpcConfigInput).

      Parameters:
      vpcConfig - a consumer that will call methods on VpcConfigInput.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • visualReference

      UpdateCanaryRequest.Builder visualReference(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • visualReference

      default UpdateCanaryRequest.Builder visualReference(Consumer<VisualReferenceInput.Builder> 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

      This is a convenience method that creates an instance of the VisualReferenceInput.Builder avoiding the need to create one manually via VisualReferenceInput.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to visualReference(VisualReferenceInput).

      Parameters:
      visualReference - a consumer that will call methods on VisualReferenceInput.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • artifactS3Location

      UpdateCanaryRequest.Builder artifactS3Location(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 (.).

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • artifactConfig

      UpdateCanaryRequest.Builder artifactConfig(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • artifactConfig

      default UpdateCanaryRequest.Builder artifactConfig(Consumer<ArtifactConfigInput.Builder> 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.

      This is a convenience method that creates an instance of the ArtifactConfigInput.Builder avoiding the need to create one manually via ArtifactConfigInput.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to artifactConfig(ArtifactConfigInput).

      Parameters:
      artifactConfig - a consumer that will call methods on ArtifactConfigInput.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • provisionedResourceCleanup

      UpdateCanaryRequest.Builder provisionedResourceCleanup(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • provisionedResourceCleanup

      UpdateCanaryRequest.Builder provisionedResourceCleanup(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dryRunId

      UpdateCanaryRequest.Builder dryRunId(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • visualReferences

      UpdateCanaryRequest.Builder visualReferences(Collection<VisualReferenceInput> 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, and syn-nodejs-playwright-3.0 and above, only supports visualReferences. visualReference field is not supported.

      Versions older than syn-nodejs-puppeteer-11.0 supports both visualReference and visualReferences for backward compatibility. It is recommended to use visualReferences 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, and syn-nodejs-playwright-3.0 and above canaries. The browserType in the visualReference object is not mandatory.

      Parameters:
      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, and syn-nodejs-playwright-3.0 and above, only supports visualReferences. visualReference field is not supported.

      Versions older than syn-nodejs-puppeteer-11.0 supports both visualReference and visualReferences for backward compatibility. It is recommended to use visualReferences 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, and syn-nodejs-playwright-3.0 and above canaries. The browserType in the visualReference object is not mandatory.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • visualReferences

      UpdateCanaryRequest.Builder visualReferences(VisualReferenceInput... 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, and syn-nodejs-playwright-3.0 and above, only supports visualReferences. visualReference field is not supported.

      Versions older than syn-nodejs-puppeteer-11.0 supports both visualReference and visualReferences for backward compatibility. It is recommended to use visualReferences 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, and syn-nodejs-playwright-3.0 and above canaries. The browserType in the visualReference object is not mandatory.

      Parameters:
      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, and syn-nodejs-playwright-3.0 and above, only supports visualReferences. visualReference field is not supported.

      Versions older than syn-nodejs-puppeteer-11.0 supports both visualReference and visualReferences for backward compatibility. It is recommended to use visualReferences 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, and syn-nodejs-playwright-3.0 and above canaries. The browserType in the visualReference object is not mandatory.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • visualReferences

      UpdateCanaryRequest.Builder visualReferences(Consumer<VisualReferenceInput.Builder>... 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, and syn-nodejs-playwright-3.0 and above, only supports visualReferences. visualReference field is not supported.

      Versions older than syn-nodejs-puppeteer-11.0 supports both visualReference and visualReferences for backward compatibility. It is recommended to use visualReferences 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, and syn-nodejs-playwright-3.0 and above canaries. The browserType in the visualReference object is not mandatory.

      This is a convenience method that creates an instance of the VisualReferenceInput.Builder avoiding the need to create one manually via VisualReferenceInput.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to visualReferences(List<VisualReferenceInput>).

      Parameters:
      visualReferences - a consumer that will call methods on VisualReferenceInput.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • browserConfigs

      UpdateCanaryRequest.Builder browserConfigs(Collection<BrowserConfig> browserConfigs)

      A structure that specifies the browser type to use for a canary run. CloudWatch Synthetics supports running canaries on both CHROME and FIREFOX browsers.

      If not specified, browserConfigs defaults to Chrome.

      Parameters:
      browserConfigs - A structure that specifies the browser type to use for a canary run. CloudWatch Synthetics supports running canaries on both CHROME and FIREFOX browsers.

      If not specified, browserConfigs defaults to Chrome.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • browserConfigs

      UpdateCanaryRequest.Builder browserConfigs(BrowserConfig... browserConfigs)

      A structure that specifies the browser type to use for a canary run. CloudWatch Synthetics supports running canaries on both CHROME and FIREFOX browsers.

      If not specified, browserConfigs defaults to Chrome.

      Parameters:
      browserConfigs - A structure that specifies the browser type to use for a canary run. CloudWatch Synthetics supports running canaries on both CHROME and FIREFOX browsers.

      If not specified, browserConfigs defaults to Chrome.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • browserConfigs

      UpdateCanaryRequest.Builder browserConfigs(Consumer<BrowserConfig.Builder>... browserConfigs)

      A structure that specifies the browser type to use for a canary run. CloudWatch Synthetics supports running canaries on both CHROME and FIREFOX browsers.

      If not specified, browserConfigs defaults to Chrome.

      This is a convenience method that creates an instance of the BrowserConfig.Builder avoiding the need to create one manually via BrowserConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to browserConfigs(List<BrowserConfig>).

      Parameters:
      browserConfigs - a consumer that will call methods on BrowserConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      UpdateCanaryRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdateCanaryRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.