Struct aws_sdk_qldb::operation::export_journal_to_s3::ExportJournalToS3Input

#[non_exhaustive]
pub struct ExportJournalToS3Input {
    pub name: Option<String>,
    pub inclusive_start_time: Option<DateTime>,
    pub exclusive_end_time: Option<DateTime>,
    pub s3_export_configuration: Option<S3ExportConfiguration>,
    pub role_arn: Option<String>,
    pub output_format: Option<OutputFormat>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

The name of the ledger.

inclusive_start_time: Option<DateTime>

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.

exclusive_end_time: Option<DateTime>

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.

s3_export_configuration: Option<S3ExportConfiguration>

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

role_arn: Option<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.

output_format: Option<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.

Implementations

impl ExportJournalToS3Input

pub fn name(&self) -> Option<&str>

The name of the ledger.

pub fn inclusive_start_time(&self) -> Option<&DateTime>

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.

pub fn exclusive_end_time(&self) -> Option<&DateTime>

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.

pub fn s3_export_configuration(&self) -> Option<&S3ExportConfiguration>

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

pub fn role_arn(&self) -> Option<&str>

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.

pub fn output_format(&self) -> Option<&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.

impl ExportJournalToS3Input

pub fn builder() -> ExportJournalToS3InputBuilder

Creates a new builder-style object to manufacture ExportJournalToS3Input.

Trait Implementations

impl Clone for ExportJournalToS3Input

fn clone(&self) -> ExportJournalToS3Input

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ExportJournalToS3Input

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ExportJournalToS3Input

fn eq(&self, other: &ExportJournalToS3Input) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ExportJournalToS3Input