Package software.amazon.awssdk.services.qldb.model

Interface ExportJournalToS3Request.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ExportJournalToS3Request.Builder,ExportJournalToS3Request>, QldbRequest.Builder, SdkBuilder<ExportJournalToS3Request.Builder,ExportJournalToS3Request>, SdkPojo, SdkRequest.Builder
Enclosing class:
ExportJournalToS3Request
public static interface ExportJournalToS3Request.Builder extends QldbRequest.Builder, SdkPojo, CopyableBuilder<ExportJournalToS3Request.Builder,ExportJournalToS3Request>

  • Method Details

    • name

      ExportJournalToS3Request.Builder name(String name)

      The name of the ledger.

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

    • inclusiveStartTime

      ExportJournalToS3Request.Builder inclusiveStartTime(Instant inclusiveStartTime)

      The inclusive start date and time for the range of journal contents to export.

      The InclusiveStartTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.

      The InclusiveStartTime must be before ExclusiveEndTime.

      If you provide an InclusiveStartTime that is before the ledger's CreationDateTime, Amazon QLDB defaults it to the ledger's CreationDateTime.

      Parameters:
      inclusiveStartTime - The inclusive start date and time for the range of journal contents to export.

      The InclusiveStartTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.

      The InclusiveStartTime must be before ExclusiveEndTime.

      If you provide an InclusiveStartTime that is before the ledger's CreationDateTime, Amazon QLDB defaults it to the ledger's CreationDateTime.

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

    • exclusiveEndTime

      ExportJournalToS3Request.Builder exclusiveEndTime(Instant exclusiveEndTime)

      The exclusive end date and time for the range of journal contents to export.

      The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.

      The ExclusiveEndTime must be less than or equal to the current UTC date and time.

      Parameters:
      exclusiveEndTime - The exclusive end date and time for the range of journal contents to export.

      The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.

      The ExclusiveEndTime must be less than or equal to the current UTC date and time.

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

    • s3ExportConfiguration

      ExportJournalToS3Request.Builder s3ExportConfiguration(S3ExportConfiguration s3ExportConfiguration)

      The configuration settings of the Amazon S3 bucket destination for your export request.

      Parameters:
      s3ExportConfiguration - The configuration settings of the Amazon S3 bucket destination for your export request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • s3ExportConfiguration

      default ExportJournalToS3Request.Builder s3ExportConfiguration(Consumer<S3ExportConfiguration.Builder> s3ExportConfiguration)

      The configuration settings of the Amazon S3 bucket destination for your export request.

      This is a convenience method that creates an instance of the S3ExportConfiguration.Builder avoiding the need to create one manually via S3ExportConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to s3ExportConfiguration(S3ExportConfiguration).

      Parameters:
      s3ExportConfiguration - a consumer that will call methods on S3ExportConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • roleArn

      ExportJournalToS3Request.Builder roleArn(String roleArn)

      The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the following:

      • Write objects into your Amazon S3 bucket.

      • (Optional) Use your customer managed key in Key Management Service (KMS) for server-side encryption of your exported data.

      To pass a role to QLDB when requesting a journal export, you must have permissions to perform the iam:PassRole action on the IAM role resource. This is required for all journal export requests.

      Parameters:
      roleArn - The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the following:

      • Write objects into your Amazon S3 bucket.

      • (Optional) Use your customer managed key in Key Management Service (KMS) for server-side encryption of your exported data.

      To pass a role to QLDB when requesting a journal export, you must have permissions to perform the iam:PassRole action on the IAM role resource. This is required for all journal export requests.

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

    • outputFormat

      ExportJournalToS3Request.Builder outputFormat(String outputFormat)

      The output format of your exported journal data. A journal export job can write the data objects in either the text or binary representation of Amazon Ion format, or in JSON Lines text format.

      Default: ION_TEXT

      In JSON Lines format, each journal block in an exported data object is a valid JSON object that is delimited by a newline. You can use this format to directly integrate JSON exports with analytics tools such as Amazon Athena and Glue because these services can parse newline-delimited JSON automatically.

      Parameters:
      outputFormat - The output format of your exported journal data. A journal export job can write the data objects in either the text or binary representation of Amazon Ion format, or in JSON Lines text format.

      Default: ION_TEXT

      In JSON Lines format, each journal block in an exported data object is a valid JSON object that is delimited by a newline. You can use this format to directly integrate JSON exports with analytics tools such as Amazon Athena and Glue because these services can parse newline-delimited JSON automatically.

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

    • outputFormat

      ExportJournalToS3Request.Builder outputFormat(OutputFormat outputFormat)

      The output format of your exported journal data. A journal export job can write the data objects in either the text or binary representation of Amazon Ion format, or in JSON Lines text format.

      Default: ION_TEXT

      In JSON Lines format, each journal block in an exported data object is a valid JSON object that is delimited by a newline. You can use this format to directly integrate JSON exports with analytics tools such as Amazon Athena and Glue because these services can parse newline-delimited JSON automatically.

      Parameters:
      outputFormat - The output format of your exported journal data. A journal export job can write the data objects in either the text or binary representation of Amazon Ion format, or in JSON Lines text format.

      Default: ION_TEXT

      In JSON Lines format, each journal block in an exported data object is a valid JSON object that is delimited by a newline. You can use this format to directly integrate JSON exports with analytics tools such as Amazon Athena and Glue because these services can parse newline-delimited JSON automatically.

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

    • overrideConfiguration

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

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