pub struct CreateDeliveryStreamFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to CreateDeliveryStream.
Creates a Firehose stream.
By default, you can create up to 5,000 Firehose streams per Amazon Web Services Region.
This is an asynchronous operation that immediately returns. The initial status of the Firehose stream is CREATING. After the Firehose stream is created, its status is ACTIVE and it now accepts data. If the Firehose stream creation fails, the status transitions to CREATING_FAILED. Attempts to send data to a delivery stream that is not in the ACTIVE state cause an exception. To check the state of a Firehose stream, use DescribeDeliveryStream.
If the status of a Firehose stream is CREATING_FAILED, this status doesn't change, and you can't invoke CreateDeliveryStream again on it. However, you can invoke the DeleteDeliveryStream operation to delete it.
A Firehose stream can be configured to receive records directly from providers using PutRecord or PutRecordBatch, or it can be configured to use an existing Kinesis stream as its source. To specify a Kinesis data stream as input, set the DeliveryStreamType parameter to KinesisStreamAsSource, and provide the Kinesis stream Amazon Resource Name (ARN) and role ARN in the KinesisStreamSourceConfiguration parameter.
To create a Firehose stream with server-side encryption (SSE) enabled, include DeliveryStreamEncryptionConfigurationInput in your request. This is optional. You can also invoke StartDeliveryStreamEncryption to turn on SSE for an existing Firehose stream that doesn't have SSE enabled.
A Firehose stream is configured with a single destination, such as Amazon Simple Storage Service (Amazon S3), Amazon Redshift, Amazon OpenSearch Service, Amazon OpenSearch Serverless, Splunk, and any custom HTTP endpoint or HTTP endpoints owned by or supported by third-party service providers, including Datadog, Dynatrace, LogicMonitor, MongoDB, New Relic, and Sumo Logic. You must specify only one of the following destination configuration parameters: ExtendedS3DestinationConfiguration, S3DestinationConfiguration, ElasticsearchDestinationConfiguration, RedshiftDestinationConfiguration, or SplunkDestinationConfiguration.
When you specify S3DestinationConfiguration, you can also provide the following optional values: BufferingHints, EncryptionConfiguration, and CompressionFormat. By default, if no BufferingHints value is provided, Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. BufferingHints is a hint, so there are some cases where the service cannot adhere to these conditions strictly. For example, record boundaries might be such that the size is a little over or under the configured buffering size. By default, no encryption is performed. We strongly recommend that you enable encryption to ensure secure data storage in Amazon S3.
A few notes about Amazon Redshift as a destination:
-
An Amazon Redshift destination requires an S3 bucket as intermediate location. Firehose first delivers data to Amazon S3 and then uses
COPYsyntax to load data into an Amazon Redshift table. This is specified in theRedshiftDestinationConfiguration.S3Configurationparameter. -
The compression formats
SNAPPYorZIPcannot be specified inRedshiftDestinationConfiguration.S3Configurationbecause the Amazon RedshiftCOPYoperation that reads from the S3 bucket doesn't support these compression formats. -
We strongly recommend that you use the user name and password you provide exclusively with Firehose, and that the permissions for the account are restricted for Amazon Redshift
INSERTpermissions.
Firehose assumes the IAM role that is configured as part of the destination. The role should allow the Firehose principal to assume the role, and the role should have permissions that allow the service to deliver the data. For more information, see Grant Firehose Access to an Amazon S3 Destination in the Amazon Firehose Developer Guide.
Implementations§
Source§impl CreateDeliveryStreamFluentBuilder
impl CreateDeliveryStreamFluentBuilder
Sourcepub fn as_input(&self) -> &CreateDeliveryStreamInputBuilder
pub fn as_input(&self) -> &CreateDeliveryStreamInputBuilder
Access the CreateDeliveryStream as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateDeliveryStreamOutput, SdkError<CreateDeliveryStreamError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateDeliveryStreamOutput, SdkError<CreateDeliveryStreamError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<CreateDeliveryStreamOutput, CreateDeliveryStreamError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateDeliveryStreamOutput, CreateDeliveryStreamError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn delivery_stream_name(self, input: impl Into<String>) -> Self
pub fn delivery_stream_name(self, input: impl Into<String>) -> Self
The name of the Firehose stream. This name must be unique per Amazon Web Services account in the same Amazon Web Services Region. If the Firehose streams are in different accounts or different Regions, you can have multiple Firehose streams with the same name.
Sourcepub fn set_delivery_stream_name(self, input: Option<String>) -> Self
pub fn set_delivery_stream_name(self, input: Option<String>) -> Self
The name of the Firehose stream. This name must be unique per Amazon Web Services account in the same Amazon Web Services Region. If the Firehose streams are in different accounts or different Regions, you can have multiple Firehose streams with the same name.
Sourcepub fn get_delivery_stream_name(&self) -> &Option<String>
pub fn get_delivery_stream_name(&self) -> &Option<String>
The name of the Firehose stream. This name must be unique per Amazon Web Services account in the same Amazon Web Services Region. If the Firehose streams are in different accounts or different Regions, you can have multiple Firehose streams with the same name.
Sourcepub fn delivery_stream_type(self, input: DeliveryStreamType) -> Self
pub fn delivery_stream_type(self, input: DeliveryStreamType) -> Self
The Firehose stream type. This parameter can be one of the following values:
-
DirectPut: Provider applications access the Firehose stream directly. -
KinesisStreamAsSource: The Firehose stream uses a Kinesis data stream as a source.
Sourcepub fn set_delivery_stream_type(self, input: Option<DeliveryStreamType>) -> Self
pub fn set_delivery_stream_type(self, input: Option<DeliveryStreamType>) -> Self
The Firehose stream type. This parameter can be one of the following values:
-
DirectPut: Provider applications access the Firehose stream directly. -
KinesisStreamAsSource: The Firehose stream uses a Kinesis data stream as a source.
Sourcepub fn get_delivery_stream_type(&self) -> &Option<DeliveryStreamType>
pub fn get_delivery_stream_type(&self) -> &Option<DeliveryStreamType>
The Firehose stream type. This parameter can be one of the following values:
-
DirectPut: Provider applications access the Firehose stream directly. -
KinesisStreamAsSource: The Firehose stream uses a Kinesis data stream as a source.
Sourcepub fn direct_put_source_configuration(
self,
input: DirectPutSourceConfiguration,
) -> Self
pub fn direct_put_source_configuration( self, input: DirectPutSourceConfiguration, ) -> Self
The structure that configures parameters such as ThroughputHintInMBs for a stream configured with Direct PUT as a source.
Sourcepub fn set_direct_put_source_configuration(
self,
input: Option<DirectPutSourceConfiguration>,
) -> Self
pub fn set_direct_put_source_configuration( self, input: Option<DirectPutSourceConfiguration>, ) -> Self
The structure that configures parameters such as ThroughputHintInMBs for a stream configured with Direct PUT as a source.
Sourcepub fn get_direct_put_source_configuration(
&self,
) -> &Option<DirectPutSourceConfiguration>
pub fn get_direct_put_source_configuration( &self, ) -> &Option<DirectPutSourceConfiguration>
The structure that configures parameters such as ThroughputHintInMBs for a stream configured with Direct PUT as a source.
Sourcepub fn kinesis_stream_source_configuration(
self,
input: KinesisStreamSourceConfiguration,
) -> Self
pub fn kinesis_stream_source_configuration( self, input: KinesisStreamSourceConfiguration, ) -> Self
When a Kinesis data stream is used as the source for the Firehose stream, a KinesisStreamSourceConfiguration containing the Kinesis data stream Amazon Resource Name (ARN) and the role ARN for the source stream.
Sourcepub fn set_kinesis_stream_source_configuration(
self,
input: Option<KinesisStreamSourceConfiguration>,
) -> Self
pub fn set_kinesis_stream_source_configuration( self, input: Option<KinesisStreamSourceConfiguration>, ) -> Self
When a Kinesis data stream is used as the source for the Firehose stream, a KinesisStreamSourceConfiguration containing the Kinesis data stream Amazon Resource Name (ARN) and the role ARN for the source stream.
Sourcepub fn get_kinesis_stream_source_configuration(
&self,
) -> &Option<KinesisStreamSourceConfiguration>
pub fn get_kinesis_stream_source_configuration( &self, ) -> &Option<KinesisStreamSourceConfiguration>
When a Kinesis data stream is used as the source for the Firehose stream, a KinesisStreamSourceConfiguration containing the Kinesis data stream Amazon Resource Name (ARN) and the role ARN for the source stream.
Sourcepub fn delivery_stream_encryption_configuration_input(
self,
input: DeliveryStreamEncryptionConfigurationInput,
) -> Self
pub fn delivery_stream_encryption_configuration_input( self, input: DeliveryStreamEncryptionConfigurationInput, ) -> Self
Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed for Server-Side Encryption (SSE).
Sourcepub fn set_delivery_stream_encryption_configuration_input(
self,
input: Option<DeliveryStreamEncryptionConfigurationInput>,
) -> Self
pub fn set_delivery_stream_encryption_configuration_input( self, input: Option<DeliveryStreamEncryptionConfigurationInput>, ) -> Self
Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed for Server-Side Encryption (SSE).
Sourcepub fn get_delivery_stream_encryption_configuration_input(
&self,
) -> &Option<DeliveryStreamEncryptionConfigurationInput>
pub fn get_delivery_stream_encryption_configuration_input( &self, ) -> &Option<DeliveryStreamEncryptionConfigurationInput>
Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed for Server-Side Encryption (SSE).
Sourcepub fn s3_destination_configuration(
self,
input: S3DestinationConfiguration,
) -> Self
👎Deprecated
pub fn s3_destination_configuration( self, input: S3DestinationConfiguration, ) -> Self
\[Deprecated\] The destination in Amazon S3. You can specify only one destination.
Sourcepub fn set_s3_destination_configuration(
self,
input: Option<S3DestinationConfiguration>,
) -> Self
👎Deprecated
pub fn set_s3_destination_configuration( self, input: Option<S3DestinationConfiguration>, ) -> Self
\[Deprecated\] The destination in Amazon S3. You can specify only one destination.
Sourcepub fn get_s3_destination_configuration(
&self,
) -> &Option<S3DestinationConfiguration>
👎Deprecated
pub fn get_s3_destination_configuration( &self, ) -> &Option<S3DestinationConfiguration>
\[Deprecated\] The destination in Amazon S3. You can specify only one destination.
Sourcepub fn extended_s3_destination_configuration(
self,
input: ExtendedS3DestinationConfiguration,
) -> Self
pub fn extended_s3_destination_configuration( self, input: ExtendedS3DestinationConfiguration, ) -> Self
The destination in Amazon S3. You can specify only one destination.
Sourcepub fn set_extended_s3_destination_configuration(
self,
input: Option<ExtendedS3DestinationConfiguration>,
) -> Self
pub fn set_extended_s3_destination_configuration( self, input: Option<ExtendedS3DestinationConfiguration>, ) -> Self
The destination in Amazon S3. You can specify only one destination.
Sourcepub fn get_extended_s3_destination_configuration(
&self,
) -> &Option<ExtendedS3DestinationConfiguration>
pub fn get_extended_s3_destination_configuration( &self, ) -> &Option<ExtendedS3DestinationConfiguration>
The destination in Amazon S3. You can specify only one destination.
Sourcepub fn redshift_destination_configuration(
self,
input: RedshiftDestinationConfiguration,
) -> Self
pub fn redshift_destination_configuration( self, input: RedshiftDestinationConfiguration, ) -> Self
The destination in Amazon Redshift. You can specify only one destination.
Sourcepub fn set_redshift_destination_configuration(
self,
input: Option<RedshiftDestinationConfiguration>,
) -> Self
pub fn set_redshift_destination_configuration( self, input: Option<RedshiftDestinationConfiguration>, ) -> Self
The destination in Amazon Redshift. You can specify only one destination.
Sourcepub fn get_redshift_destination_configuration(
&self,
) -> &Option<RedshiftDestinationConfiguration>
pub fn get_redshift_destination_configuration( &self, ) -> &Option<RedshiftDestinationConfiguration>
The destination in Amazon Redshift. You can specify only one destination.
Sourcepub fn elasticsearch_destination_configuration(
self,
input: ElasticsearchDestinationConfiguration,
) -> Self
pub fn elasticsearch_destination_configuration( self, input: ElasticsearchDestinationConfiguration, ) -> Self
The destination in Amazon OpenSearch Service. You can specify only one destination.
Sourcepub fn set_elasticsearch_destination_configuration(
self,
input: Option<ElasticsearchDestinationConfiguration>,
) -> Self
pub fn set_elasticsearch_destination_configuration( self, input: Option<ElasticsearchDestinationConfiguration>, ) -> Self
The destination in Amazon OpenSearch Service. You can specify only one destination.
Sourcepub fn get_elasticsearch_destination_configuration(
&self,
) -> &Option<ElasticsearchDestinationConfiguration>
pub fn get_elasticsearch_destination_configuration( &self, ) -> &Option<ElasticsearchDestinationConfiguration>
The destination in Amazon OpenSearch Service. You can specify only one destination.
Sourcepub fn amazonopensearchservice_destination_configuration(
self,
input: AmazonopensearchserviceDestinationConfiguration,
) -> Self
pub fn amazonopensearchservice_destination_configuration( self, input: AmazonopensearchserviceDestinationConfiguration, ) -> Self
The destination in Amazon OpenSearch Service. You can specify only one destination.
Sourcepub fn set_amazonopensearchservice_destination_configuration(
self,
input: Option<AmazonopensearchserviceDestinationConfiguration>,
) -> Self
pub fn set_amazonopensearchservice_destination_configuration( self, input: Option<AmazonopensearchserviceDestinationConfiguration>, ) -> Self
The destination in Amazon OpenSearch Service. You can specify only one destination.
Sourcepub fn get_amazonopensearchservice_destination_configuration(
&self,
) -> &Option<AmazonopensearchserviceDestinationConfiguration>
pub fn get_amazonopensearchservice_destination_configuration( &self, ) -> &Option<AmazonopensearchserviceDestinationConfiguration>
The destination in Amazon OpenSearch Service. You can specify only one destination.
Sourcepub fn splunk_destination_configuration(
self,
input: SplunkDestinationConfiguration,
) -> Self
pub fn splunk_destination_configuration( self, input: SplunkDestinationConfiguration, ) -> Self
The destination in Splunk. You can specify only one destination.
Sourcepub fn set_splunk_destination_configuration(
self,
input: Option<SplunkDestinationConfiguration>,
) -> Self
pub fn set_splunk_destination_configuration( self, input: Option<SplunkDestinationConfiguration>, ) -> Self
The destination in Splunk. You can specify only one destination.
Sourcepub fn get_splunk_destination_configuration(
&self,
) -> &Option<SplunkDestinationConfiguration>
pub fn get_splunk_destination_configuration( &self, ) -> &Option<SplunkDestinationConfiguration>
The destination in Splunk. You can specify only one destination.
Sourcepub fn http_endpoint_destination_configuration(
self,
input: HttpEndpointDestinationConfiguration,
) -> Self
pub fn http_endpoint_destination_configuration( self, input: HttpEndpointDestinationConfiguration, ) -> Self
Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination. You can specify only one destination.
Sourcepub fn set_http_endpoint_destination_configuration(
self,
input: Option<HttpEndpointDestinationConfiguration>,
) -> Self
pub fn set_http_endpoint_destination_configuration( self, input: Option<HttpEndpointDestinationConfiguration>, ) -> Self
Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination. You can specify only one destination.
Sourcepub fn get_http_endpoint_destination_configuration(
&self,
) -> &Option<HttpEndpointDestinationConfiguration>
pub fn get_http_endpoint_destination_configuration( &self, ) -> &Option<HttpEndpointDestinationConfiguration>
Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination. You can specify only one destination.
Appends an item to Tags.
To override the contents of this collection use set_tags.
A set of tags to assign to the Firehose stream. A tag is a key-value pair that you can define and assign to Amazon Web Services resources. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the Firehose stream. For more information about tags, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
You can specify up to 50 tags when creating a Firehose stream.
If you specify tags in the CreateDeliveryStream action, Amazon Data Firehose performs an additional authorization on the firehose:TagDeliveryStream action to verify if users have permissions to create tags. If you do not provide this permission, requests to create new Firehose streams with IAM resource tags will fail with an AccessDeniedException such as following.
AccessDeniedException
User: arn:aws:sts::x:assumed-role/x/x is not authorized to perform: firehose:TagDeliveryStream on resource: arn:aws:firehose:us-east-1:x:deliverystream/x with an explicit deny in an identity-based policy.
For an example IAM policy, see Tag example.
A set of tags to assign to the Firehose stream. A tag is a key-value pair that you can define and assign to Amazon Web Services resources. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the Firehose stream. For more information about tags, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
You can specify up to 50 tags when creating a Firehose stream.
If you specify tags in the CreateDeliveryStream action, Amazon Data Firehose performs an additional authorization on the firehose:TagDeliveryStream action to verify if users have permissions to create tags. If you do not provide this permission, requests to create new Firehose streams with IAM resource tags will fail with an AccessDeniedException such as following.
AccessDeniedException
User: arn:aws:sts::x:assumed-role/x/x is not authorized to perform: firehose:TagDeliveryStream on resource: arn:aws:firehose:us-east-1:x:deliverystream/x with an explicit deny in an identity-based policy.
For an example IAM policy, see Tag example.
A set of tags to assign to the Firehose stream. A tag is a key-value pair that you can define and assign to Amazon Web Services resources. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the Firehose stream. For more information about tags, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
You can specify up to 50 tags when creating a Firehose stream.
If you specify tags in the CreateDeliveryStream action, Amazon Data Firehose performs an additional authorization on the firehose:TagDeliveryStream action to verify if users have permissions to create tags. If you do not provide this permission, requests to create new Firehose streams with IAM resource tags will fail with an AccessDeniedException such as following.
AccessDeniedException
User: arn:aws:sts::x:assumed-role/x/x is not authorized to perform: firehose:TagDeliveryStream on resource: arn:aws:firehose:us-east-1:x:deliverystream/x with an explicit deny in an identity-based policy.
For an example IAM policy, see Tag example.
Sourcepub fn amazon_open_search_serverless_destination_configuration(
self,
input: AmazonOpenSearchServerlessDestinationConfiguration,
) -> Self
pub fn amazon_open_search_serverless_destination_configuration( self, input: AmazonOpenSearchServerlessDestinationConfiguration, ) -> Self
The destination in the Serverless offering for Amazon OpenSearch Service. You can specify only one destination.
Sourcepub fn set_amazon_open_search_serverless_destination_configuration(
self,
input: Option<AmazonOpenSearchServerlessDestinationConfiguration>,
) -> Self
pub fn set_amazon_open_search_serverless_destination_configuration( self, input: Option<AmazonOpenSearchServerlessDestinationConfiguration>, ) -> Self
The destination in the Serverless offering for Amazon OpenSearch Service. You can specify only one destination.
Sourcepub fn get_amazon_open_search_serverless_destination_configuration(
&self,
) -> &Option<AmazonOpenSearchServerlessDestinationConfiguration>
pub fn get_amazon_open_search_serverless_destination_configuration( &self, ) -> &Option<AmazonOpenSearchServerlessDestinationConfiguration>
The destination in the Serverless offering for Amazon OpenSearch Service. You can specify only one destination.
Sourcepub fn msk_source_configuration(self, input: MskSourceConfiguration) -> Self
pub fn msk_source_configuration(self, input: MskSourceConfiguration) -> Self
The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.
Sourcepub fn set_msk_source_configuration(
self,
input: Option<MskSourceConfiguration>,
) -> Self
pub fn set_msk_source_configuration( self, input: Option<MskSourceConfiguration>, ) -> Self
The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.
Sourcepub fn get_msk_source_configuration(&self) -> &Option<MskSourceConfiguration>
pub fn get_msk_source_configuration(&self) -> &Option<MskSourceConfiguration>
The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.
Sourcepub fn snowflake_destination_configuration(
self,
input: SnowflakeDestinationConfiguration,
) -> Self
pub fn snowflake_destination_configuration( self, input: SnowflakeDestinationConfiguration, ) -> Self
Configure Snowflake destination
Sourcepub fn set_snowflake_destination_configuration(
self,
input: Option<SnowflakeDestinationConfiguration>,
) -> Self
pub fn set_snowflake_destination_configuration( self, input: Option<SnowflakeDestinationConfiguration>, ) -> Self
Configure Snowflake destination
Sourcepub fn get_snowflake_destination_configuration(
&self,
) -> &Option<SnowflakeDestinationConfiguration>
pub fn get_snowflake_destination_configuration( &self, ) -> &Option<SnowflakeDestinationConfiguration>
Configure Snowflake destination
Sourcepub fn iceberg_destination_configuration(
self,
input: IcebergDestinationConfiguration,
) -> Self
pub fn iceberg_destination_configuration( self, input: IcebergDestinationConfiguration, ) -> Self
Configure Apache Iceberg Tables destination.
Sourcepub fn set_iceberg_destination_configuration(
self,
input: Option<IcebergDestinationConfiguration>,
) -> Self
pub fn set_iceberg_destination_configuration( self, input: Option<IcebergDestinationConfiguration>, ) -> Self
Configure Apache Iceberg Tables destination.
Sourcepub fn get_iceberg_destination_configuration(
&self,
) -> &Option<IcebergDestinationConfiguration>
pub fn get_iceberg_destination_configuration( &self, ) -> &Option<IcebergDestinationConfiguration>
Configure Apache Iceberg Tables destination.
Sourcepub fn database_source_configuration(
self,
input: DatabaseSourceConfiguration,
) -> Self
pub fn database_source_configuration( self, input: DatabaseSourceConfiguration, ) -> Self
The top level object for configuring streams with database as a source.
Amazon Data Firehose is in preview release and is subject to change.
Sourcepub fn set_database_source_configuration(
self,
input: Option<DatabaseSourceConfiguration>,
) -> Self
pub fn set_database_source_configuration( self, input: Option<DatabaseSourceConfiguration>, ) -> Self
The top level object for configuring streams with database as a source.
Amazon Data Firehose is in preview release and is subject to change.
Sourcepub fn get_database_source_configuration(
&self,
) -> &Option<DatabaseSourceConfiguration>
pub fn get_database_source_configuration( &self, ) -> &Option<DatabaseSourceConfiguration>
The top level object for configuring streams with database as a source.
Amazon Data Firehose is in preview release and is subject to change.
Trait Implementations§
Source§impl Clone for CreateDeliveryStreamFluentBuilder
impl Clone for CreateDeliveryStreamFluentBuilder
Source§fn clone(&self) -> CreateDeliveryStreamFluentBuilder
fn clone(&self) -> CreateDeliveryStreamFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for CreateDeliveryStreamFluentBuilder
impl !RefUnwindSafe for CreateDeliveryStreamFluentBuilder
impl Send for CreateDeliveryStreamFluentBuilder
impl Sync for CreateDeliveryStreamFluentBuilder
impl Unpin for CreateDeliveryStreamFluentBuilder
impl !UnwindSafe for CreateDeliveryStreamFluentBuilder
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);