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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb

Overview

Note:

When making an API call, you may pass ExportJournalToS3Request data as a hash:

{
  name: "LedgerName", # required
  inclusive_start_time: Time.now, # required
  exclusive_end_time: Time.now, # required
  s3_export_configuration: { # required
    bucket: "S3Bucket", # required
    prefix: "S3Prefix", # required
    encryption_configuration: { # required
      object_encryption_type: "SSE_KMS", # required, accepts SSE_KMS, SSE_S3, NO_ENCRYPTION
      kms_key_arn: "Arn",
    },
  },
  role_arn: "Arn", # required
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#exclusive_end_timeTime

The exclusive end date and time for the range of journal contents that you want 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)


377
378
379
380
381
382
383
384
385
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 377

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

#inclusive_start_timeTime

The inclusive start date and time for the range of journal contents that you want 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)


377
378
379
380
381
382
383
384
385
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 377

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

#nameString

The name of the ledger.

Returns:

  • (String)


377
378
379
380
381
382
383
384
385
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 377

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

#role_arnString

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 master key (CMK) in AWS Key Management Service (AWS KMS) for server-side encryption of your exported data.

Returns:

  • (String)


377
378
379
380
381
382
383
384
385
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 377

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

#s3_export_configurationTypes::S3ExportConfiguration

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



377
378
379
380
381
382
383
384
385
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 377

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