pub struct CreateArchiveFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to CreateArchive.
Creates an archive of events with the specified settings. When you create an archive, incoming events might not immediately start being sent to the archive. Allow a short period of time for changes to take effect. If you do not specify a pattern to filter events sent to the archive, all events are sent to the archive except replayed events. Replayed events are not sent to an archive.
If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a customer managed key for any archives for the event bus as well.
For more information, see Encrypting archives in the Amazon EventBridge User Guide.
Implementations§
Source§impl CreateArchiveFluentBuilder
impl CreateArchiveFluentBuilder
Sourcepub fn as_input(&self) -> &CreateArchiveInputBuilder
pub fn as_input(&self) -> &CreateArchiveInputBuilder
Access the CreateArchive as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateArchiveOutput, SdkError<CreateArchiveError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateArchiveOutput, SdkError<CreateArchiveError, 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<CreateArchiveOutput, CreateArchiveError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateArchiveOutput, CreateArchiveError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn archive_name(self, input: impl Into<String>) -> Self
pub fn archive_name(self, input: impl Into<String>) -> Self
The name for the archive to create.
Sourcepub fn set_archive_name(self, input: Option<String>) -> Self
pub fn set_archive_name(self, input: Option<String>) -> Self
The name for the archive to create.
Sourcepub fn get_archive_name(&self) -> &Option<String>
pub fn get_archive_name(&self) -> &Option<String>
The name for the archive to create.
Sourcepub fn event_source_arn(self, input: impl Into<String>) -> Self
pub fn event_source_arn(self, input: impl Into<String>) -> Self
The ARN of the event bus that sends events to the archive.
Sourcepub fn set_event_source_arn(self, input: Option<String>) -> Self
pub fn set_event_source_arn(self, input: Option<String>) -> Self
The ARN of the event bus that sends events to the archive.
Sourcepub fn get_event_source_arn(&self) -> &Option<String>
pub fn get_event_source_arn(&self) -> &Option<String>
The ARN of the event bus that sends events to the archive.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A description for the archive.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A description for the archive.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A description for the archive.
Sourcepub fn event_pattern(self, input: impl Into<String>) -> Self
pub fn event_pattern(self, input: impl Into<String>) -> Self
An event pattern to use to filter events sent to the archive.
Sourcepub fn set_event_pattern(self, input: Option<String>) -> Self
pub fn set_event_pattern(self, input: Option<String>) -> Self
An event pattern to use to filter events sent to the archive.
Sourcepub fn get_event_pattern(&self) -> &Option<String>
pub fn get_event_pattern(&self) -> &Option<String>
An event pattern to use to filter events sent to the archive.
Sourcepub fn retention_days(self, input: i32) -> Self
pub fn retention_days(self, input: i32) -> Self
The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely
Sourcepub fn set_retention_days(self, input: Option<i32>) -> Self
pub fn set_retention_days(self, input: Option<i32>) -> Self
The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely
Sourcepub fn get_retention_days(&self) -> &Option<i32>
pub fn get_retention_days(&self) -> &Option<i32>
The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely
Sourcepub fn kms_key_identifier(self, input: impl Into<String>) -> Self
pub fn kms_key_identifier(self, input: impl Into<String>) -> Self
The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this archive. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.
If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt the archive.
For more information, see Identify and view keys in the Key Management Service Developer Guide.
If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a customer managed key for any archives for the event bus as well.
For more information, see Encrypting archives in the Amazon EventBridge User Guide.
Sourcepub fn set_kms_key_identifier(self, input: Option<String>) -> Self
pub fn set_kms_key_identifier(self, input: Option<String>) -> Self
The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this archive. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.
If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt the archive.
For more information, see Identify and view keys in the Key Management Service Developer Guide.
If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a customer managed key for any archives for the event bus as well.
For more information, see Encrypting archives in the Amazon EventBridge User Guide.
Sourcepub fn get_kms_key_identifier(&self) -> &Option<String>
pub fn get_kms_key_identifier(&self) -> &Option<String>
The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this archive. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.
If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt the archive.
For more information, see Identify and view keys in the Key Management Service Developer Guide.
If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a customer managed key for any archives for the event bus as well.
For more information, see Encrypting archives in the Amazon EventBridge User Guide.
Trait Implementations§
Source§impl Clone for CreateArchiveFluentBuilder
impl Clone for CreateArchiveFluentBuilder
Source§fn clone(&self) -> CreateArchiveFluentBuilder
fn clone(&self) -> CreateArchiveFluentBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for CreateArchiveFluentBuilder
impl !RefUnwindSafe for CreateArchiveFluentBuilder
impl Send for CreateArchiveFluentBuilder
impl Sync for CreateArchiveFluentBuilder
impl Unpin for CreateArchiveFluentBuilder
impl !UnwindSafe for CreateArchiveFluentBuilder
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);