Class: Aws::QLDB::Types::ExportJournalToS3Request

Inherits:

Struct

• Object
• Struct
• Aws::QLDB::Types::ExportJournalToS3Request

Includes:

Structure

Defined in:

lib/aws-sdk-qldb/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #exclusive_end_time ⇒ Time

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

• #inclusive_start_time ⇒ Time

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

• #name ⇒ String

  The name of the ledger.

• #output_format ⇒ String

  The output format of your exported journal data.

• #role_arn ⇒ String

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

• #s3_export_configuration ⇒ Types::S3ExportConfiguration

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

Instance Attribute Details

#exclusive_end_time ⇒ Time

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:

• (Time)

# File 'lib/aws-sdk-qldb/types.rb', line 431

class ExportJournalToS3Request < Struct.new(
  :name,
  :inclusive_start_time,
  :exclusive_end_time,
  :s3_export_configuration,
  :role_arn,
  :output_format)
  SENSITIVE = []
  include Aws::Structure
end

#inclusive_start_time ⇒ Time

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:

• (Time)

# File 'lib/aws-sdk-qldb/types.rb', line 431

class ExportJournalToS3Request < Struct.new(
  :name,
  :inclusive_start_time,
  :exclusive_end_time,
  :s3_export_configuration,
  :role_arn,
  :output_format)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the ledger.

Returns:

• (String)

# File 'lib/aws-sdk-qldb/types.rb', line 431

class ExportJournalToS3Request < Struct.new(
  :name,
  :inclusive_start_time,
  :exclusive_end_time,
  :s3_export_configuration,
  :role_arn,
  :output_format)
  SENSITIVE = []
  include Aws::Structure
end

#output_format ⇒ String

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.

[1]: docs.aws.amazon.com/qldb/latest/developerguide/ion.html [2]: jsonlines.org/

Returns:

• (String)

# File 'lib/aws-sdk-qldb/types.rb', line 431

class ExportJournalToS3Request < Struct.new(
  :name,
  :inclusive_start_time,
  :exclusive_end_time,
  :s3_export_configuration,
  :role_arn,
  :output_format)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

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:

• (String)

# File 'lib/aws-sdk-qldb/types.rb', line 431

class ExportJournalToS3Request < Struct.new(
  :name,
  :inclusive_start_time,
  :exclusive_end_time,
  :s3_export_configuration,
  :role_arn,
  :output_format)
  SENSITIVE = []
  include Aws::Structure
end

#s3_export_configuration ⇒ Types::S3ExportConfiguration

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

Returns:

• (Types::S3ExportConfiguration)

# File 'lib/aws-sdk-qldb/types.rb', line 431

class ExportJournalToS3Request < Struct.new(
  :name,
  :inclusive_start_time,
  :exclusive_end_time,
  :s3_export_configuration,
  :role_arn,
  :output_format)
  SENSITIVE = []
  include Aws::Structure
end