#[non_exhaustive]pub struct PipeTargetParameters {Show 13 fields
pub input_template: Option<String>,
pub lambda_function_parameters: Option<PipeTargetLambdaFunctionParameters>,
pub step_function_state_machine_parameters: Option<PipeTargetStateMachineParameters>,
pub kinesis_stream_parameters: Option<PipeTargetKinesisStreamParameters>,
pub ecs_task_parameters: Option<PipeTargetEcsTaskParameters>,
pub batch_job_parameters: Option<PipeTargetBatchJobParameters>,
pub sqs_queue_parameters: Option<PipeTargetSqsQueueParameters>,
pub http_parameters: Option<PipeTargetHttpParameters>,
pub redshift_data_parameters: Option<PipeTargetRedshiftDataParameters>,
pub sage_maker_pipeline_parameters: Option<PipeTargetSageMakerPipelineParameters>,
pub event_bridge_event_bus_parameters: Option<PipeTargetEventBridgeEventBusParameters>,
pub cloud_watch_logs_parameters: Option<PipeTargetCloudWatchLogsParameters>,
pub timestream_parameters: Option<PipeTargetTimestreamParameters>,
}
Expand description
The parameters required to set up a target for your pipe.
For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.
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.input_template: Option<String>
Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format.
To remove an input template, specify an empty string.
lambda_function_parameters: Option<PipeTargetLambdaFunctionParameters>
The parameters for using a Lambda function as a target.
step_function_state_machine_parameters: Option<PipeTargetStateMachineParameters>
The parameters for using a Step Functions state machine as a target.
kinesis_stream_parameters: Option<PipeTargetKinesisStreamParameters>
The parameters for using a Kinesis stream as a target.
ecs_task_parameters: Option<PipeTargetEcsTaskParameters>
The parameters for using an Amazon ECS task as a target.
batch_job_parameters: Option<PipeTargetBatchJobParameters>
The parameters for using an Batch job as a target.
sqs_queue_parameters: Option<PipeTargetSqsQueueParameters>
The parameters for using a Amazon SQS stream as a target.
http_parameters: Option<PipeTargetHttpParameters>
These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.
redshift_data_parameters: Option<PipeTargetRedshiftDataParameters>
These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement.
sage_maker_pipeline_parameters: Option<PipeTargetSageMakerPipelineParameters>
The parameters for using a SageMaker pipeline as a target.
event_bridge_event_bus_parameters: Option<PipeTargetEventBridgeEventBusParameters>
The parameters for using an EventBridge event bus as a target.
cloud_watch_logs_parameters: Option<PipeTargetCloudWatchLogsParameters>
The parameters for using an CloudWatch Logs log stream as a target.
timestream_parameters: Option<PipeTargetTimestreamParameters>
The parameters for using a Timestream for LiveAnalytics table as a target.
Implementations§
Source§impl PipeTargetParameters
impl PipeTargetParameters
Sourcepub fn input_template(&self) -> Option<&str>
pub fn input_template(&self) -> Option<&str>
Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format.
To remove an input template, specify an empty string.
Sourcepub fn lambda_function_parameters(
&self,
) -> Option<&PipeTargetLambdaFunctionParameters>
pub fn lambda_function_parameters( &self, ) -> Option<&PipeTargetLambdaFunctionParameters>
The parameters for using a Lambda function as a target.
Sourcepub fn step_function_state_machine_parameters(
&self,
) -> Option<&PipeTargetStateMachineParameters>
pub fn step_function_state_machine_parameters( &self, ) -> Option<&PipeTargetStateMachineParameters>
The parameters for using a Step Functions state machine as a target.
Sourcepub fn kinesis_stream_parameters(
&self,
) -> Option<&PipeTargetKinesisStreamParameters>
pub fn kinesis_stream_parameters( &self, ) -> Option<&PipeTargetKinesisStreamParameters>
The parameters for using a Kinesis stream as a target.
Sourcepub fn ecs_task_parameters(&self) -> Option<&PipeTargetEcsTaskParameters>
pub fn ecs_task_parameters(&self) -> Option<&PipeTargetEcsTaskParameters>
The parameters for using an Amazon ECS task as a target.
Sourcepub fn batch_job_parameters(&self) -> Option<&PipeTargetBatchJobParameters>
pub fn batch_job_parameters(&self) -> Option<&PipeTargetBatchJobParameters>
The parameters for using an Batch job as a target.
Sourcepub fn sqs_queue_parameters(&self) -> Option<&PipeTargetSqsQueueParameters>
pub fn sqs_queue_parameters(&self) -> Option<&PipeTargetSqsQueueParameters>
The parameters for using a Amazon SQS stream as a target.
Sourcepub fn http_parameters(&self) -> Option<&PipeTargetHttpParameters>
pub fn http_parameters(&self) -> Option<&PipeTargetHttpParameters>
These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.
Sourcepub fn redshift_data_parameters(
&self,
) -> Option<&PipeTargetRedshiftDataParameters>
pub fn redshift_data_parameters( &self, ) -> Option<&PipeTargetRedshiftDataParameters>
These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement.
Sourcepub fn sage_maker_pipeline_parameters(
&self,
) -> Option<&PipeTargetSageMakerPipelineParameters>
pub fn sage_maker_pipeline_parameters( &self, ) -> Option<&PipeTargetSageMakerPipelineParameters>
The parameters for using a SageMaker pipeline as a target.
Sourcepub fn event_bridge_event_bus_parameters(
&self,
) -> Option<&PipeTargetEventBridgeEventBusParameters>
pub fn event_bridge_event_bus_parameters( &self, ) -> Option<&PipeTargetEventBridgeEventBusParameters>
The parameters for using an EventBridge event bus as a target.
Sourcepub fn cloud_watch_logs_parameters(
&self,
) -> Option<&PipeTargetCloudWatchLogsParameters>
pub fn cloud_watch_logs_parameters( &self, ) -> Option<&PipeTargetCloudWatchLogsParameters>
The parameters for using an CloudWatch Logs log stream as a target.
Sourcepub fn timestream_parameters(&self) -> Option<&PipeTargetTimestreamParameters>
pub fn timestream_parameters(&self) -> Option<&PipeTargetTimestreamParameters>
The parameters for using a Timestream for LiveAnalytics table as a target.
Source§impl PipeTargetParameters
impl PipeTargetParameters
Sourcepub fn builder() -> PipeTargetParametersBuilder
pub fn builder() -> PipeTargetParametersBuilder
Creates a new builder-style object to manufacture PipeTargetParameters
.
Trait Implementations§
Source§impl Clone for PipeTargetParameters
impl Clone for PipeTargetParameters
Source§fn clone(&self) -> PipeTargetParameters
fn clone(&self) -> PipeTargetParameters
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for PipeTargetParameters
impl Debug for PipeTargetParameters
Source§impl PartialEq for PipeTargetParameters
impl PartialEq for PipeTargetParameters
impl StructuralPartialEq for PipeTargetParameters
Auto Trait Implementations§
impl Freeze for PipeTargetParameters
impl RefUnwindSafe for PipeTargetParameters
impl Send for PipeTargetParameters
impl Sync for PipeTargetParameters
impl Unpin for PipeTargetParameters
impl UnwindSafe for PipeTargetParameters
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);