Interface StartDomainExportRequest.Builder

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

  • Method Details

    • clientToken

      StartDomainExportRequest.Builder clientToken(String clientToken)

      Providing a ClientToken makes the call to StartDomainExport API idempotent, meaning that multiple identical calls have the same effect as one single call. A client token is valid for 8 hours after the first request that uses it is completed. After 8 hours, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 8 hours, or the result might not be idempotent. If you submit a request with the same client token but a change in other parameters within the 8-hour idempotency window, a ConflictException will be returned.

      Parameters:
      clientToken - Providing a ClientToken makes the call to StartDomainExport API idempotent, meaning that multiple identical calls have the same effect as one single call. A client token is valid for 8 hours after the first request that uses it is completed. After 8 hours, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 8 hours, or the result might not be idempotent. If you submit a request with the same client token but a change in other parameters within the 8-hour idempotency window, a ConflictException will be returned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • domainName

      StartDomainExportRequest.Builder domainName(String domainName)

      The name of the domain to export.

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

    • s3Bucket

      StartDomainExportRequest.Builder s3Bucket(String s3Bucket)

      The name of the S3 bucket where the domain data will be exported.

      Parameters:
      s3Bucket - The name of the S3 bucket where the domain data will be exported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • s3KeyPrefix

      StartDomainExportRequest.Builder s3KeyPrefix(String s3KeyPrefix)

      The prefix string to be used to generate the S3 object keys for export artifacts.

      Parameters:
      s3KeyPrefix - The prefix string to be used to generate the S3 object keys for export artifacts.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • s3SseAlgorithm

      StartDomainExportRequest.Builder s3SseAlgorithm(String s3SseAlgorithm)

      The server-side encryption algorithm to use for the exported data in S3. Valid values are: AES256 (SSE-S3) and KMS (SSE-KMS). If not specified, bucket's default encryption will apply.

      Parameters:
      s3SseAlgorithm - The server-side encryption algorithm to use for the exported data in S3. Valid values are: AES256 (SSE-S3) and KMS (SSE-KMS). If not specified, bucket's default encryption will apply.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • s3SseAlgorithm

      StartDomainExportRequest.Builder s3SseAlgorithm(S3SseAlgorithm s3SseAlgorithm)

      The server-side encryption algorithm to use for the exported data in S3. Valid values are: AES256 (SSE-S3) and KMS (SSE-KMS). If not specified, bucket's default encryption will apply.

      Parameters:
      s3SseAlgorithm - The server-side encryption algorithm to use for the exported data in S3. Valid values are: AES256 (SSE-S3) and KMS (SSE-KMS). If not specified, bucket's default encryption will apply.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • s3SseKmsKeyId

      StartDomainExportRequest.Builder s3SseKmsKeyId(String s3SseKmsKeyId)

      The KMS key ID to use for server-side encryption with AWS KMS-managed keys (SSE-KMS). This parameter is only expected with KMS as the S3 SSE algorithm.

      Parameters:
      s3SseKmsKeyId - The KMS key ID to use for server-side encryption with AWS KMS-managed keys (SSE-KMS). This parameter is only expected with KMS as the S3 SSE algorithm.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • s3BucketOwner

      StartDomainExportRequest.Builder s3BucketOwner(String s3BucketOwner)

      The ID of the AWS account that owns the bucket the export will be stored in.

      Parameters:
      s3BucketOwner - The ID of the AWS account that owns the bucket the export will be stored in.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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