pub struct CreateEventSubscriptionFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to CreateEventSubscription.
Creates an Amazon DocumentDB event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the Amazon SNS console.
You can specify the type of source (SourceType) that you want to be notified of. You can also provide a list of Amazon DocumentDB sources (SourceIds) that trigger the events, and you can provide a list of event categories (EventCategories) for events that you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.
If you specify both the SourceType and SourceIds (such as SourceType = db-instance and SourceIdentifier = myDBInstance1), you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Amazon DocumentDB sources. If you do not specify either the SourceType or the SourceIdentifier, you are notified of events generated from all Amazon DocumentDB sources belonging to your customer account.
Implementations§
Source§impl CreateEventSubscriptionFluentBuilder
impl CreateEventSubscriptionFluentBuilder
Sourcepub fn as_input(&self) -> &CreateEventSubscriptionInputBuilder
pub fn as_input(&self) -> &CreateEventSubscriptionInputBuilder
Access the CreateEventSubscription as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateEventSubscriptionOutput, SdkError<CreateEventSubscriptionError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateEventSubscriptionOutput, SdkError<CreateEventSubscriptionError, 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<CreateEventSubscriptionOutput, CreateEventSubscriptionError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateEventSubscriptionOutput, CreateEventSubscriptionError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn subscription_name(self, input: impl Into<String>) -> Self
pub fn subscription_name(self, input: impl Into<String>) -> Self
The name of the subscription.
Constraints: The name must be fewer than 255 characters.
Sourcepub fn set_subscription_name(self, input: Option<String>) -> Self
pub fn set_subscription_name(self, input: Option<String>) -> Self
The name of the subscription.
Constraints: The name must be fewer than 255 characters.
Sourcepub fn get_subscription_name(&self) -> &Option<String>
pub fn get_subscription_name(&self) -> &Option<String>
The name of the subscription.
Constraints: The name must be fewer than 255 characters.
Sourcepub fn sns_topic_arn(self, input: impl Into<String>) -> Self
pub fn sns_topic_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the SNS topic created for event notification. Amazon SNS creates the ARN when you create a topic and subscribe to it.
Sourcepub fn set_sns_topic_arn(self, input: Option<String>) -> Self
pub fn set_sns_topic_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the SNS topic created for event notification. Amazon SNS creates the ARN when you create a topic and subscribe to it.
Sourcepub fn get_sns_topic_arn(&self) -> &Option<String>
pub fn get_sns_topic_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the SNS topic created for event notification. Amazon SNS creates the ARN when you create a topic and subscribe to it.
Sourcepub fn source_type(self, input: impl Into<String>) -> Self
pub fn source_type(self, input: impl Into<String>) -> Self
The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, you would set this parameter to db-instance. If this value is not specified, all events are returned.
Valid values: db-instance, db-cluster, db-parameter-group, db-security-group, db-cluster-snapshot
Sourcepub fn set_source_type(self, input: Option<String>) -> Self
pub fn set_source_type(self, input: Option<String>) -> Self
The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, you would set this parameter to db-instance. If this value is not specified, all events are returned.
Valid values: db-instance, db-cluster, db-parameter-group, db-security-group, db-cluster-snapshot
Sourcepub fn get_source_type(&self) -> &Option<String>
pub fn get_source_type(&self) -> &Option<String>
The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, you would set this parameter to db-instance. If this value is not specified, all events are returned.
Valid values: db-instance, db-cluster, db-parameter-group, db-security-group, db-cluster-snapshot
Sourcepub fn event_categories(self, input: impl Into<String>) -> Self
pub fn event_categories(self, input: impl Into<String>) -> Self
Appends an item to EventCategories.
To override the contents of this collection use set_event_categories.
A list of event categories for a SourceType that you want to subscribe to.
Sourcepub fn set_event_categories(self, input: Option<Vec<String>>) -> Self
pub fn set_event_categories(self, input: Option<Vec<String>>) -> Self
A list of event categories for a SourceType that you want to subscribe to.
Sourcepub fn get_event_categories(&self) -> &Option<Vec<String>>
pub fn get_event_categories(&self) -> &Option<Vec<String>>
A list of event categories for a SourceType that you want to subscribe to.
Sourcepub fn source_ids(self, input: impl Into<String>) -> Self
pub fn source_ids(self, input: impl Into<String>) -> Self
Appends an item to SourceIds.
To override the contents of this collection use set_source_ids.
The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
Constraints:
-
If
SourceIdsare provided,SourceTypemust also be provided. -
If the source type is an instance, a
DBInstanceIdentifiermust be provided. -
If the source type is a security group, a
DBSecurityGroupNamemust be provided. -
If the source type is a parameter group, a
DBParameterGroupNamemust be provided. -
If the source type is a snapshot, a
DBSnapshotIdentifiermust be provided.
Sourcepub fn set_source_ids(self, input: Option<Vec<String>>) -> Self
pub fn set_source_ids(self, input: Option<Vec<String>>) -> Self
The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
Constraints:
-
If
SourceIdsare provided,SourceTypemust also be provided. -
If the source type is an instance, a
DBInstanceIdentifiermust be provided. -
If the source type is a security group, a
DBSecurityGroupNamemust be provided. -
If the source type is a parameter group, a
DBParameterGroupNamemust be provided. -
If the source type is a snapshot, a
DBSnapshotIdentifiermust be provided.
Sourcepub fn get_source_ids(&self) -> &Option<Vec<String>>
pub fn get_source_ids(&self) -> &Option<Vec<String>>
The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
Constraints:
-
If
SourceIdsare provided,SourceTypemust also be provided. -
If the source type is an instance, a
DBInstanceIdentifiermust be provided. -
If the source type is a security group, a
DBSecurityGroupNamemust be provided. -
If the source type is a parameter group, a
DBParameterGroupNamemust be provided. -
If the source type is a snapshot, a
DBSnapshotIdentifiermust be provided.
Sourcepub fn enabled(self, input: bool) -> Self
pub fn enabled(self, input: bool) -> Self
A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
Sourcepub fn set_enabled(self, input: Option<bool>) -> Self
pub fn set_enabled(self, input: Option<bool>) -> Self
A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
Sourcepub fn get_enabled(&self) -> &Option<bool>
pub fn get_enabled(&self) -> &Option<bool>
A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
Appends an item to Tags.
To override the contents of this collection use set_tags.
The tags to be assigned to the event subscription.
The tags to be assigned to the event subscription.
The tags to be assigned to the event subscription.
Trait Implementations§
Source§impl Clone for CreateEventSubscriptionFluentBuilder
impl Clone for CreateEventSubscriptionFluentBuilder
Source§fn clone(&self) -> CreateEventSubscriptionFluentBuilder
fn clone(&self) -> CreateEventSubscriptionFluentBuilder
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 CreateEventSubscriptionFluentBuilder
impl !RefUnwindSafe for CreateEventSubscriptionFluentBuilder
impl Send for CreateEventSubscriptionFluentBuilder
impl Sync for CreateEventSubscriptionFluentBuilder
impl Unpin for CreateEventSubscriptionFluentBuilder
impl !UnwindSafe for CreateEventSubscriptionFluentBuilder
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);