#[non_exhaustive]pub struct ExtendedS3DestinationConfiguration {Show 15 fields
pub role_arn: String,
pub bucket_arn: String,
pub prefix: Option<String>,
pub error_output_prefix: Option<String>,
pub buffering_hints: Option<BufferingHints>,
pub compression_format: Option<CompressionFormat>,
pub encryption_configuration: Option<EncryptionConfiguration>,
pub cloud_watch_logging_options: Option<CloudWatchLoggingOptions>,
pub processing_configuration: Option<ProcessingConfiguration>,
pub s3_backup_mode: Option<S3BackupMode>,
pub s3_backup_configuration: Option<S3DestinationConfiguration>,
pub data_format_conversion_configuration: Option<DataFormatConversionConfiguration>,
pub dynamic_partitioning_configuration: Option<DynamicPartitioningConfiguration>,
pub file_extension: Option<String>,
pub custom_time_zone: Option<String>,
}
Expand description
Describes the configuration of a destination in Amazon S3.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.role_arn: String
The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
bucket_arn: String
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
prefix: Option<String>
The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.
error_output_prefix: Option<String>
A prefix that Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.
buffering_hints: Option<BufferingHints>
The buffering option.
compression_format: Option<CompressionFormat>
The compression format. If no value is specified, the default is UNCOMPRESSED.
encryption_configuration: Option<EncryptionConfiguration>
The encryption configuration. If no value is specified, the default is no encryption.
cloud_watch_logging_options: Option<CloudWatchLoggingOptions>
The Amazon CloudWatch logging options for your Firehose stream.
processing_configuration: Option<ProcessingConfiguration>
The data processing configuration.
s3_backup_mode: Option<S3BackupMode>
The Amazon S3 backup mode. After you create a Firehose stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the Firehose stream to disable it.
s3_backup_configuration: Option<S3DestinationConfiguration>
The configuration for backup in Amazon S3.
data_format_conversion_configuration: Option<DataFormatConversionConfiguration>
The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.
dynamic_partitioning_configuration: Option<DynamicPartitioningConfiguration>
The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations.
file_extension: Option<String>
Specify a file extension. It will override the default file extension
custom_time_zone: Option<String>
The time zone you prefer. UTC is the default.
Implementations§
Source§impl ExtendedS3DestinationConfiguration
impl ExtendedS3DestinationConfiguration
Sourcepub fn role_arn(&self) -> &str
pub fn role_arn(&self) -> &str
The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
Sourcepub fn bucket_arn(&self) -> &str
pub fn bucket_arn(&self) -> &str
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
Sourcepub fn prefix(&self) -> Option<&str>
pub fn prefix(&self) -> Option<&str>
The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.
Sourcepub fn error_output_prefix(&self) -> Option<&str>
pub fn error_output_prefix(&self) -> Option<&str>
A prefix that Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.
Sourcepub fn buffering_hints(&self) -> Option<&BufferingHints>
pub fn buffering_hints(&self) -> Option<&BufferingHints>
The buffering option.
Sourcepub fn compression_format(&self) -> Option<&CompressionFormat>
pub fn compression_format(&self) -> Option<&CompressionFormat>
The compression format. If no value is specified, the default is UNCOMPRESSED.
Sourcepub fn encryption_configuration(&self) -> Option<&EncryptionConfiguration>
pub fn encryption_configuration(&self) -> Option<&EncryptionConfiguration>
The encryption configuration. If no value is specified, the default is no encryption.
Sourcepub fn cloud_watch_logging_options(&self) -> Option<&CloudWatchLoggingOptions>
pub fn cloud_watch_logging_options(&self) -> Option<&CloudWatchLoggingOptions>
The Amazon CloudWatch logging options for your Firehose stream.
Sourcepub fn processing_configuration(&self) -> Option<&ProcessingConfiguration>
pub fn processing_configuration(&self) -> Option<&ProcessingConfiguration>
The data processing configuration.
Sourcepub fn s3_backup_mode(&self) -> Option<&S3BackupMode>
pub fn s3_backup_mode(&self) -> Option<&S3BackupMode>
The Amazon S3 backup mode. After you create a Firehose stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the Firehose stream to disable it.
Sourcepub fn s3_backup_configuration(&self) -> Option<&S3DestinationConfiguration>
pub fn s3_backup_configuration(&self) -> Option<&S3DestinationConfiguration>
The configuration for backup in Amazon S3.
Sourcepub fn data_format_conversion_configuration(
&self,
) -> Option<&DataFormatConversionConfiguration>
pub fn data_format_conversion_configuration( &self, ) -> Option<&DataFormatConversionConfiguration>
The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.
Sourcepub fn dynamic_partitioning_configuration(
&self,
) -> Option<&DynamicPartitioningConfiguration>
pub fn dynamic_partitioning_configuration( &self, ) -> Option<&DynamicPartitioningConfiguration>
The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations.
Sourcepub fn file_extension(&self) -> Option<&str>
pub fn file_extension(&self) -> Option<&str>
Specify a file extension. It will override the default file extension
Sourcepub fn custom_time_zone(&self) -> Option<&str>
pub fn custom_time_zone(&self) -> Option<&str>
The time zone you prefer. UTC is the default.
Source§impl ExtendedS3DestinationConfiguration
impl ExtendedS3DestinationConfiguration
Sourcepub fn builder() -> ExtendedS3DestinationConfigurationBuilder
pub fn builder() -> ExtendedS3DestinationConfigurationBuilder
Creates a new builder-style object to manufacture ExtendedS3DestinationConfiguration
.
Trait Implementations§
Source§impl Clone for ExtendedS3DestinationConfiguration
impl Clone for ExtendedS3DestinationConfiguration
Source§fn clone(&self) -> ExtendedS3DestinationConfiguration
fn clone(&self) -> ExtendedS3DestinationConfiguration
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl PartialEq for ExtendedS3DestinationConfiguration
impl PartialEq for ExtendedS3DestinationConfiguration
Source§fn eq(&self, other: &ExtendedS3DestinationConfiguration) -> bool
fn eq(&self, other: &ExtendedS3DestinationConfiguration) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for ExtendedS3DestinationConfiguration
Auto Trait Implementations§
impl Freeze for ExtendedS3DestinationConfiguration
impl RefUnwindSafe for ExtendedS3DestinationConfiguration
impl Send for ExtendedS3DestinationConfiguration
impl Sync for ExtendedS3DestinationConfiguration
impl Unpin for ExtendedS3DestinationConfiguration
impl UnwindSafe for ExtendedS3DestinationConfiguration
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);