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 Summary

Modifier and Type	Method and Description
ExportJournalToS3Request.Builder	exclusiveEndTime(Instant exclusiveEndTime) The exclusive end date and time for the range of journal contents to export.
ExportJournalToS3Request.Builder	inclusiveStartTime(Instant inclusiveStartTime) The inclusive start date and time for the range of journal contents to export.
ExportJournalToS3Request.Builder	name(String name) The name of the ledger.
ExportJournalToS3Request.Builder	outputFormat(OutputFormat outputFormat) The output format of your exported journal data.
ExportJournalToS3Request.Builder	outputFormat(String outputFormat) The output format of your exported journal data.
ExportJournalToS3Request.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
ExportJournalToS3Request.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
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:
default ExportJournalToS3Request.Builder	s3ExportConfiguration(Consumer<S3ExportConfiguration.Builder> s3ExportConfiguration) The configuration settings of the Amazon S3 bucket destination for your export request.
ExportJournalToS3Request.Builder	s3ExportConfiguration(S3ExportConfiguration s3ExportConfiguration) The configuration settings of the Amazon S3 bucket destination for your export request.

Methods inherited from interface software.amazon.awssdk.services.qldb.model.QldbRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

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:

s3ExportConfiguration(S3ExportConfiguration)

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 Simple Storage Service (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 Simple Storage Service (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. If this parameter is not specified, the exported data defaults to ION_TEXT format.

Parameters:

outputFormat - The output format of your exported journal data. If this parameter is not specified, the exported data defaults to ION_TEXT format.

Returns:

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

See Also:

OutputFormat, OutputFormat

outputFormat

ExportJournalToS3Request.Builder outputFormat(OutputFormat outputFormat)

The output format of your exported journal data. If this parameter is not specified, the exported data defaults to ION_TEXT format.

Parameters:

outputFormat - The output format of your exported journal data. If this parameter is not specified, the exported data defaults to ION_TEXT format.

Returns:

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

See Also:

OutputFormat, OutputFormat

overrideConfiguration

ExportJournalToS3Request.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

ExportJournalToS3Request.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder