pub struct StartFlowCaptureFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to StartFlowCapture
.
Begins capturing the flows in a firewall, according to the filters you define. Captures are similar, but not identical to snapshots. Capture operations provide visibility into flows that are not closed and are tracked by a firewall's flow table. Unlike snapshots, captures are a time-boxed view.
A flow is network traffic that is monitored by a firewall, either by stateful or stateless rules. For traffic to be considered part of a flow, it must share Destination, DestinationPort, Direction, Protocol, Source, and SourcePort.
To avoid encountering operation limits, you should avoid starting captures with broad filters, like wide IP ranges. Instead, we recommend you define more specific criteria with FlowFilters
, like narrow IP ranges, ports, or protocols.
Implementations§
Source§impl StartFlowCaptureFluentBuilder
impl StartFlowCaptureFluentBuilder
Sourcepub fn as_input(&self) -> &StartFlowCaptureInputBuilder
pub fn as_input(&self) -> &StartFlowCaptureInputBuilder
Access the StartFlowCapture as a reference.
Sourcepub async fn send(
self,
) -> Result<StartFlowCaptureOutput, SdkError<StartFlowCaptureError, HttpResponse>>
pub async fn send( self, ) -> Result<StartFlowCaptureOutput, SdkError<StartFlowCaptureError, 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<StartFlowCaptureOutput, StartFlowCaptureError, Self>
pub fn customize( self, ) -> CustomizableOperation<StartFlowCaptureOutput, StartFlowCaptureError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn firewall_arn(self, input: impl Into<String>) -> Self
pub fn firewall_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the firewall.
Sourcepub fn set_firewall_arn(self, input: Option<String>) -> Self
pub fn set_firewall_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the firewall.
Sourcepub fn get_firewall_arn(&self) -> &Option<String>
pub fn get_firewall_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the firewall.
Sourcepub fn availability_zone(self, input: impl Into<String>) -> Self
pub fn availability_zone(self, input: impl Into<String>) -> Self
The ID of the Availability Zone where the firewall is located. For example, us-east-2a
.
Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.
Sourcepub fn set_availability_zone(self, input: Option<String>) -> Self
pub fn set_availability_zone(self, input: Option<String>) -> Self
The ID of the Availability Zone where the firewall is located. For example, us-east-2a
.
Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.
Sourcepub fn get_availability_zone(&self) -> &Option<String>
pub fn get_availability_zone(&self) -> &Option<String>
The ID of the Availability Zone where the firewall is located. For example, us-east-2a
.
Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.
Sourcepub fn vpc_endpoint_association_arn(self, input: impl Into<String>) -> Self
pub fn vpc_endpoint_association_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of a VPC endpoint association.
Sourcepub fn set_vpc_endpoint_association_arn(self, input: Option<String>) -> Self
pub fn set_vpc_endpoint_association_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of a VPC endpoint association.
Sourcepub fn get_vpc_endpoint_association_arn(&self) -> &Option<String>
pub fn get_vpc_endpoint_association_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of a VPC endpoint association.
Sourcepub fn vpc_endpoint_id(self, input: impl Into<String>) -> Self
pub fn vpc_endpoint_id(self, input: impl Into<String>) -> Self
A unique identifier for the primary endpoint associated with a firewall.
Sourcepub fn set_vpc_endpoint_id(self, input: Option<String>) -> Self
pub fn set_vpc_endpoint_id(self, input: Option<String>) -> Self
A unique identifier for the primary endpoint associated with a firewall.
Sourcepub fn get_vpc_endpoint_id(&self) -> &Option<String>
pub fn get_vpc_endpoint_id(&self) -> &Option<String>
A unique identifier for the primary endpoint associated with a firewall.
Sourcepub fn minimum_flow_age_in_seconds(self, input: i32) -> Self
pub fn minimum_flow_age_in_seconds(self, input: i32) -> Self
The reqested FlowOperation
ignores flows with an age (in seconds) lower than MinimumFlowAgeInSeconds
. You provide this for start commands.
We recommend setting this value to at least 1 minute (60 seconds) to reduce chance of capturing flows that are not yet established.
Sourcepub fn set_minimum_flow_age_in_seconds(self, input: Option<i32>) -> Self
pub fn set_minimum_flow_age_in_seconds(self, input: Option<i32>) -> Self
The reqested FlowOperation
ignores flows with an age (in seconds) lower than MinimumFlowAgeInSeconds
. You provide this for start commands.
We recommend setting this value to at least 1 minute (60 seconds) to reduce chance of capturing flows that are not yet established.
Sourcepub fn get_minimum_flow_age_in_seconds(&self) -> &Option<i32>
pub fn get_minimum_flow_age_in_seconds(&self) -> &Option<i32>
The reqested FlowOperation
ignores flows with an age (in seconds) lower than MinimumFlowAgeInSeconds
. You provide this for start commands.
We recommend setting this value to at least 1 minute (60 seconds) to reduce chance of capturing flows that are not yet established.
Sourcepub fn flow_filters(self, input: FlowFilter) -> Self
pub fn flow_filters(self, input: FlowFilter) -> Self
Appends an item to FlowFilters
.
To override the contents of this collection use set_flow_filters
.
Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.
Sourcepub fn set_flow_filters(self, input: Option<Vec<FlowFilter>>) -> Self
pub fn set_flow_filters(self, input: Option<Vec<FlowFilter>>) -> Self
Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.
Sourcepub fn get_flow_filters(&self) -> &Option<Vec<FlowFilter>>
pub fn get_flow_filters(&self) -> &Option<Vec<FlowFilter>>
Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.
Trait Implementations§
Source§impl Clone for StartFlowCaptureFluentBuilder
impl Clone for StartFlowCaptureFluentBuilder
Source§fn clone(&self) -> StartFlowCaptureFluentBuilder
fn clone(&self) -> StartFlowCaptureFluentBuilder
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 StartFlowCaptureFluentBuilder
impl !RefUnwindSafe for StartFlowCaptureFluentBuilder
impl Send for StartFlowCaptureFluentBuilder
impl Sync for StartFlowCaptureFluentBuilder
impl Unpin for StartFlowCaptureFluentBuilder
impl !UnwindSafe for StartFlowCaptureFluentBuilder
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);