Interface StartCanaryDryRunRequest.Builder

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

  • Method Details

    • name

      StartCanaryDryRunRequest.Builder name(String name)

      The name of the canary that you want to dry run. To find canary names, use DescribeCanaries.

      Parameters:
      name - The name of the canary that you want to dry run. To find canary names, use DescribeCanaries.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • code

      StartCanaryDryRunRequest.Builder code(CanaryCodeInput 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 StartCanaryDryRunRequest.Builder code(Consumer<CanaryCodeInput.Builder> code)
      Sets the value of the Code property for this object. 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:

    • runtimeVersion

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

    • runConfig

      StartCanaryDryRunRequest.Builder runConfig(CanaryRunConfigInput 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 StartCanaryDryRunRequest.Builder runConfig(Consumer<CanaryRunConfigInput.Builder> runConfig)
      Sets the value of the RunConfig property for this object. 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:

    • vpcConfig

      StartCanaryDryRunRequest.Builder vpcConfig(VpcConfigInput 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 StartCanaryDryRunRequest.Builder vpcConfig(Consumer<VpcConfigInput.Builder> vpcConfig)
      Sets the value of the VpcConfig property for this object. 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:

    • executionRoleArn

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

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

    • successRetentionPeriodInDays

      StartCanaryDryRunRequest.Builder successRetentionPeriodInDays(Integer successRetentionPeriodInDays)

      The number of days to retain data about successful runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

      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. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

      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

      StartCanaryDryRunRequest.Builder failureRetentionPeriodInDays(Integer failureRetentionPeriodInDays)

      The number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

      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. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

      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.

    • visualReference

      StartCanaryDryRunRequest.Builder visualReference(VisualReferenceInput visualReference)
      Sets the value of the VisualReference property for this object.
      Parameters:
      visualReference - The new value for the VisualReference property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • visualReference

      default StartCanaryDryRunRequest.Builder visualReference(Consumer<VisualReferenceInput.Builder> visualReference)
      Sets the value of the VisualReference property for this object. 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

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

      StartCanaryDryRunRequest.Builder artifactConfig(ArtifactConfigInput artifactConfig)
      Sets the value of the ArtifactConfig property for this object.
      Parameters:
      artifactConfig - The new value for the ArtifactConfig property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • artifactConfig

      default StartCanaryDryRunRequest.Builder artifactConfig(Consumer<ArtifactConfigInput.Builder> artifactConfig)
      Sets the value of the ArtifactConfig property for this object. 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

      StartCanaryDryRunRequest.Builder provisionedResourceCleanup(String provisionedResourceCleanup)

      Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted. If you omit this parameter, the default of AUTOMATIC is used, which means that 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 you omit this parameter, the default of AUTOMATIC is used, which means that 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

      StartCanaryDryRunRequest.Builder provisionedResourceCleanup(ProvisionedResourceCleanupSetting provisionedResourceCleanup)

      Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted. If you omit this parameter, the default of AUTOMATIC is used, which means that 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 you omit this parameter, the default of AUTOMATIC is used, which means that 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:

    • overrideConfiguration

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

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