Package software.amazon.awssdk.services.workmail.model

Interface StartMailboxExportJobRequest.Builder

    • Method Detail

      • 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

        StartMailboxExportJobRequest.Builder entityId​(String 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

        StartMailboxExportJobRequest.Builder roleArn​(String 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

        StartMailboxExportJobRequest.Builder kmsKeyArn​(String 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

        StartMailboxExportJobRequest.Builder s3Prefix​(String 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.