Interface DeleteCanaryRequest.Builder

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

  • Method Details

    • name

      DeleteCanaryRequest.Builder name(String name)

      The name of the canary that you want to delete. To find the names of your canaries, use DescribeCanaries.

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

    • deleteLambda

      DeleteCanaryRequest.Builder deleteLambda(Boolean deleteLambda)

      Specifies whether to also delete the Lambda functions and layers used by this canary. The default is false.

      Your setting for this parameter is used only if the canary doesn't have AUTOMATIC for its ProvisionedResourceCleanup field. If that field is set to AUTOMATIC, then the Lambda functions and layers will be deleted when this canary is deleted.

      Type: Boolean

      Parameters:
      deleteLambda - Specifies whether to also delete the Lambda functions and layers used by this canary. The default is false.

      Your setting for this parameter is used only if the canary doesn't have AUTOMATIC for its ProvisionedResourceCleanup field. If that field is set to AUTOMATIC, then the Lambda functions and layers will be deleted when this canary is deleted.

      Type: Boolean

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

    • overrideConfiguration

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

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