Interface StartMailboxExportJobRequest.Builder

  • Method Details

    • clientToken

      StartMailboxExportJobRequest.Builder clientToken(String clientToken)

      The idempotency token for the client request.

      Parameters:
      clientToken - The idempotency token for the client request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • organizationId

      StartMailboxExportJobRequest.Builder organizationId(String organizationId)

      The identifier associated with the organization.

      Parameters:
      organizationId - The identifier associated with the organization.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • entityId

      The identifier of the user or resource associated with the mailbox.

      The identifier can accept UserId or ResourceId, Username or Resourcename, or email. The following identity formats are available:

      • Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789 , or S-1-1-12-1234567890-123456789-123456789-1234

      • Email address: entity@domain.tld

      • Entity name: entity

      Parameters:
      entityId - The identifier of the user or resource associated with the mailbox.

      The identifier can accept UserId or ResourceId, Username or Resourcename, or email. The following identity formats are available:

      • Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789 , or S-1-1-12-1234567890-123456789-123456789-1234

      • Email address: entity@domain.tld

      • Entity name: entity

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

      StartMailboxExportJobRequest.Builder description(String description)

      The mailbox export job description.

      Parameters:
      description - The mailbox export job description.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • roleArn

      The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3 bucket.

      Parameters:
      roleArn - The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3 bucket.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • kmsKeyArn

      The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.

      Parameters:
      kmsKeyArn - The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • s3BucketName

      StartMailboxExportJobRequest.Builder s3BucketName(String s3BucketName)

      The name of the S3 bucket.

      Parameters:
      s3BucketName - The name of the S3 bucket.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • s3Prefix

      The S3 bucket prefix.

      Parameters:
      s3Prefix - The S3 bucket prefix.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • overrideConfiguration

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

      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.