#[non_exhaustive]pub struct AmazonopensearchserviceDestinationConfiguration {Show 14 fields
pub role_arn: String,
pub domain_arn: Option<String>,
pub cluster_endpoint: Option<String>,
pub index_name: String,
pub type_name: Option<String>,
pub index_rotation_period: Option<AmazonopensearchserviceIndexRotationPeriod>,
pub buffering_hints: Option<AmazonopensearchserviceBufferingHints>,
pub retry_options: Option<AmazonopensearchserviceRetryOptions>,
pub s3_backup_mode: Option<AmazonopensearchserviceS3BackupMode>,
pub s3_configuration: Option<S3DestinationConfiguration>,
pub processing_configuration: Option<ProcessingConfiguration>,
pub cloud_watch_logging_options: Option<CloudWatchLoggingOptions>,
pub vpc_configuration: Option<VpcConfiguration>,
pub document_id_options: Option<DocumentIdOptions>,
}Expand description
Describes the configuration of a destination in Amazon OpenSearch Service
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: StringThe Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.
domain_arn: Option<String>The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN.
cluster_endpoint: Option<String>The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.
index_name: StringThe ElasticsearAmazon OpenSearch Service index name.
type_name: Option<String>The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Firehose returns an error during run time.
index_rotation_period: Option<AmazonopensearchserviceIndexRotationPeriod>The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data.
buffering_hints: Option<AmazonopensearchserviceBufferingHints>The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
retry_options: Option<AmazonopensearchserviceRetryOptions>The retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).
s3_backup_mode: Option<AmazonopensearchserviceS3BackupMode>Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.
s3_configuration: Option<S3DestinationConfiguration>Describes the configuration of a destination in Amazon S3.
processing_configuration: Option<ProcessingConfiguration>Describes a data processing configuration.
cloud_watch_logging_options: Option<CloudWatchLoggingOptions>Describes the Amazon CloudWatch logging options for your Firehose stream.
vpc_configuration: Option<VpcConfiguration>The details of the VPC of the Amazon OpenSearch or Amazon OpenSearch Serverless destination.
document_id_options: Option<DocumentIdOptions>Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
Implementations§
Source§impl AmazonopensearchserviceDestinationConfiguration
impl AmazonopensearchserviceDestinationConfiguration
Sourcepub fn role_arn(&self) -> &str
pub fn role_arn(&self) -> &str
The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.
Sourcepub fn domain_arn(&self) -> Option<&str>
pub fn domain_arn(&self) -> Option<&str>
The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN.
Sourcepub fn cluster_endpoint(&self) -> Option<&str>
pub fn cluster_endpoint(&self) -> Option<&str>
The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.
Sourcepub fn index_name(&self) -> &str
pub fn index_name(&self) -> &str
The ElasticsearAmazon OpenSearch Service index name.
Sourcepub fn type_name(&self) -> Option<&str>
pub fn type_name(&self) -> Option<&str>
The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Firehose returns an error during run time.
Sourcepub fn index_rotation_period(
&self,
) -> Option<&AmazonopensearchserviceIndexRotationPeriod>
pub fn index_rotation_period( &self, ) -> Option<&AmazonopensearchserviceIndexRotationPeriod>
The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data.
Sourcepub fn buffering_hints(&self) -> Option<&AmazonopensearchserviceBufferingHints>
pub fn buffering_hints(&self) -> Option<&AmazonopensearchserviceBufferingHints>
The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
Sourcepub fn retry_options(&self) -> Option<&AmazonopensearchserviceRetryOptions>
pub fn retry_options(&self) -> Option<&AmazonopensearchserviceRetryOptions>
The retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).
Sourcepub fn s3_backup_mode(&self) -> Option<&AmazonopensearchserviceS3BackupMode>
pub fn s3_backup_mode(&self) -> Option<&AmazonopensearchserviceS3BackupMode>
Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.
Sourcepub fn s3_configuration(&self) -> Option<&S3DestinationConfiguration>
pub fn s3_configuration(&self) -> Option<&S3DestinationConfiguration>
Describes the configuration of a destination in Amazon S3.
Sourcepub fn processing_configuration(&self) -> Option<&ProcessingConfiguration>
pub fn processing_configuration(&self) -> Option<&ProcessingConfiguration>
Describes a data processing configuration.
Sourcepub fn cloud_watch_logging_options(&self) -> Option<&CloudWatchLoggingOptions>
pub fn cloud_watch_logging_options(&self) -> Option<&CloudWatchLoggingOptions>
Describes the Amazon CloudWatch logging options for your Firehose stream.
Sourcepub fn vpc_configuration(&self) -> Option<&VpcConfiguration>
pub fn vpc_configuration(&self) -> Option<&VpcConfiguration>
The details of the VPC of the Amazon OpenSearch or Amazon OpenSearch Serverless destination.
Sourcepub fn document_id_options(&self) -> Option<&DocumentIdOptions>
pub fn document_id_options(&self) -> Option<&DocumentIdOptions>
Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
Source§impl AmazonopensearchserviceDestinationConfiguration
impl AmazonopensearchserviceDestinationConfiguration
Sourcepub fn builder() -> AmazonopensearchserviceDestinationConfigurationBuilder
pub fn builder() -> AmazonopensearchserviceDestinationConfigurationBuilder
Creates a new builder-style object to manufacture AmazonopensearchserviceDestinationConfiguration.
Trait Implementations§
Source§impl Clone for AmazonopensearchserviceDestinationConfiguration
impl Clone for AmazonopensearchserviceDestinationConfiguration
Source§fn clone(&self) -> AmazonopensearchserviceDestinationConfiguration
fn clone(&self) -> AmazonopensearchserviceDestinationConfiguration
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl PartialEq for AmazonopensearchserviceDestinationConfiguration
impl PartialEq for AmazonopensearchserviceDestinationConfiguration
Source§fn eq(&self, other: &AmazonopensearchserviceDestinationConfiguration) -> bool
fn eq(&self, other: &AmazonopensearchserviceDestinationConfiguration) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for AmazonopensearchserviceDestinationConfiguration
Auto Trait Implementations§
impl Freeze for AmazonopensearchserviceDestinationConfiguration
impl RefUnwindSafe for AmazonopensearchserviceDestinationConfiguration
impl Send for AmazonopensearchserviceDestinationConfiguration
impl Sync for AmazonopensearchserviceDestinationConfiguration
impl Unpin for AmazonopensearchserviceDestinationConfiguration
impl UnwindSafe for AmazonopensearchserviceDestinationConfiguration
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);