Interface Canary.Builder

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

  • Method Details

    • id

      Canary.Builder id(String id)

      The unique ID of this canary.

      Parameters:
      id - The unique ID of this canary.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      Canary.Builder name(String name)

      The name of the canary.

      Parameters:
      name - The name of the canary.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • code

      Canary.Builder code(CanaryCodeOutput code)
      Sets the value of the Code property for this object.
      Parameters:
      code - The new value for the Code property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • code

      default Canary.Builder code(Consumer<CanaryCodeOutput.Builder> code)
      Sets the value of the Code property for this object. This is a convenience method that creates an instance of the CanaryCodeOutput.Builder avoiding the need to create one manually via CanaryCodeOutput.builder().

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

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

    • executionRoleArn

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

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

    • schedule

      Canary.Builder schedule(CanaryScheduleOutput 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 Canary.Builder schedule(Consumer<CanaryScheduleOutput.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 CanaryScheduleOutput.Builder avoiding the need to create one manually via CanaryScheduleOutput.builder().

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

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

    • runConfig

      Canary.Builder runConfig(CanaryRunConfigOutput runConfig)
      Sets the value of the RunConfig property for this object.
      Parameters:
      runConfig - The new value for the RunConfig property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • runConfig

      default Canary.Builder runConfig(Consumer<CanaryRunConfigOutput.Builder> runConfig)
      Sets the value of the RunConfig property for this object. This is a convenience method that creates an instance of the CanaryRunConfigOutput.Builder avoiding the need to create one manually via CanaryRunConfigOutput.builder().

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

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

    • successRetentionPeriodInDays

      Canary.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

      Canary.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.

    • status

      Canary.Builder status(CanaryStatus status)

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

      Parameters:
      status - A structure that contains information about the canary's status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      default Canary.Builder status(Consumer<CanaryStatus.Builder> status)

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

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

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

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

    • timeline

      Canary.Builder timeline(CanaryTimeline timeline)

      A structure that contains information about when the canary was created, modified, and most recently run.

      Parameters:
      timeline - A structure that contains information about when the canary was created, modified, and most recently run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timeline

      default Canary.Builder timeline(Consumer<CanaryTimeline.Builder> timeline)

      A structure that contains information about when the canary was created, modified, and most recently run.

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

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

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

    • artifactS3Location

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

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

    • engineArn

      Canary.Builder engineArn(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.

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

    • runtimeVersion

      Canary.Builder runtimeVersion(String runtimeVersion)

      Specifies the runtime version to use for the canary. For more information about runtime versions, see Canary Runtime Versions.

      Parameters:
      runtimeVersion - Specifies the runtime version to use for the canary. 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.

    • vpcConfig

      Canary.Builder vpcConfig(VpcConfigOutput vpcConfig)
      Sets the value of the VpcConfig property for this object.
      Parameters:
      vpcConfig - The new value for the VpcConfig property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcConfig

      default Canary.Builder vpcConfig(Consumer<VpcConfigOutput.Builder> vpcConfig)
      Sets the value of the VpcConfig property for this object. This is a convenience method that creates an instance of the VpcConfigOutput.Builder avoiding the need to create one manually via VpcConfigOutput.builder().

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

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

    • visualReference

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

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

    • visualReference

      default Canary.Builder visualReference(Consumer<VisualReferenceOutput.Builder> 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.

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

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

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

    • provisionedResourceCleanup

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

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

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

    • provisionedResourceCleanup

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

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

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

    • browserConfigs

      Canary.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

      Canary.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

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

    • engineConfigs

      Canary.Builder engineConfigs(Collection<EngineConfig> engineConfigs)

      A list of engine configurations for the canary, one for each browser type that the canary is configured to run on.

      All runtime versions syn-nodejs-puppeteer-11.0 and above, and syn-nodejs-playwright-3.0 and above, use engineConfigs only. You can no longer use engineArn in these versions.

      Runtime versions older than syn-nodejs-puppeteer-11.0 and syn-nodejs-playwright-3.0 continue to support engineArn to ensure backward compatibility.

      Parameters:
      engineConfigs - A list of engine configurations for the canary, one for each browser type that the canary is configured to run on.

      All runtime versions syn-nodejs-puppeteer-11.0 and above, and syn-nodejs-playwright-3.0 and above, use engineConfigs only. You can no longer use engineArn in these versions.

      Runtime versions older than syn-nodejs-puppeteer-11.0 and syn-nodejs-playwright-3.0 continue to support engineArn to ensure backward compatibility.

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

    • engineConfigs

      Canary.Builder engineConfigs(EngineConfig... engineConfigs)

      A list of engine configurations for the canary, one for each browser type that the canary is configured to run on.

      All runtime versions syn-nodejs-puppeteer-11.0 and above, and syn-nodejs-playwright-3.0 and above, use engineConfigs only. You can no longer use engineArn in these versions.

      Runtime versions older than syn-nodejs-puppeteer-11.0 and syn-nodejs-playwright-3.0 continue to support engineArn to ensure backward compatibility.

      Parameters:
      engineConfigs - A list of engine configurations for the canary, one for each browser type that the canary is configured to run on.

      All runtime versions syn-nodejs-puppeteer-11.0 and above, and syn-nodejs-playwright-3.0 and above, use engineConfigs only. You can no longer use engineArn in these versions.

      Runtime versions older than syn-nodejs-puppeteer-11.0 and syn-nodejs-playwright-3.0 continue to support engineArn to ensure backward compatibility.

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

    • engineConfigs

      Canary.Builder engineConfigs(Consumer<EngineConfig.Builder>... engineConfigs)

      A list of engine configurations for the canary, one for each browser type that the canary is configured to run on.

      All runtime versions syn-nodejs-puppeteer-11.0 and above, and syn-nodejs-playwright-3.0 and above, use engineConfigs only. You can no longer use engineArn in these versions.

      Runtime versions older than syn-nodejs-puppeteer-11.0 and syn-nodejs-playwright-3.0 continue to support engineArn to ensure backward compatibility.

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

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

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

    • visualReferences

      Canary.Builder visualReferences(Collection<VisualReferenceOutput> 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.

      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.

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

    • visualReferences

      Canary.Builder visualReferences(VisualReferenceOutput... 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.

      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.

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

    • visualReferences

      Canary.Builder visualReferences(Consumer<VisualReferenceOutput.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.

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

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

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

    • tags

      Canary.Builder tags(Map<String,String> tags)

      The list of key-value pairs that are associated with the canary.

      Parameters:
      tags - The list of key-value pairs that are associated with the canary.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • artifactConfig

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

      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 Canary.Builder artifactConfig(Consumer<ArtifactConfigOutput.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 ArtifactConfigOutput.Builder avoiding the need to create one manually via ArtifactConfigOutput.builder().

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

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

    • dryRunConfig

      Canary.Builder dryRunConfig(DryRunConfigOutput dryRunConfig)

      Returns the dry run configurations for a canary.

      Parameters:
      dryRunConfig - Returns the dry run configurations for a canary.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dryRunConfig

      default Canary.Builder dryRunConfig(Consumer<DryRunConfigOutput.Builder> dryRunConfig)

      Returns the dry run configurations for a canary.

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

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

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