pub struct UpdatePoolFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to UpdatePool
.
Updates the configuration of an existing pool. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn
, enable or disable self-managed opt-outs, enable or disable deletion protection, and enable or disable shared routes.
Implementations§
Source§impl UpdatePoolFluentBuilder
impl UpdatePoolFluentBuilder
Sourcepub fn as_input(&self) -> &UpdatePoolInputBuilder
pub fn as_input(&self) -> &UpdatePoolInputBuilder
Access the UpdatePool as a reference.
Sourcepub async fn send(
self,
) -> Result<UpdatePoolOutput, SdkError<UpdatePoolError, HttpResponse>>
pub async fn send( self, ) -> Result<UpdatePoolOutput, SdkError<UpdatePoolError, 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<UpdatePoolOutput, UpdatePoolError, Self>
pub fn customize( self, ) -> CustomizableOperation<UpdatePoolOutput, UpdatePoolError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn pool_id(self, input: impl Into<String>) -> Self
pub fn pool_id(self, input: impl Into<String>) -> Self
The unique identifier of the pool to update. Valid values are either the PoolId or PoolArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
Sourcepub fn set_pool_id(self, input: Option<String>) -> Self
pub fn set_pool_id(self, input: Option<String>) -> Self
The unique identifier of the pool to update. Valid values are either the PoolId or PoolArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
Sourcepub fn get_pool_id(&self) -> &Option<String>
pub fn get_pool_id(&self) -> &Option<String>
The unique identifier of the pool to update. Valid values are either the PoolId or PoolArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
Sourcepub fn two_way_enabled(self, input: bool) -> Self
pub fn two_way_enabled(self, input: bool) -> Self
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
Sourcepub fn set_two_way_enabled(self, input: Option<bool>) -> Self
pub fn set_two_way_enabled(self, input: Option<bool>) -> Self
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
Sourcepub fn get_two_way_enabled(&self) -> &Option<bool>
pub fn get_two_way_enabled(&self) -> &Option<bool>
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
Sourcepub fn two_way_channel_arn(self, input: impl Into<String>) -> Self
pub fn two_way_channel_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the two way channel.
Sourcepub fn set_two_way_channel_arn(self, input: Option<String>) -> Self
pub fn set_two_way_channel_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the two way channel.
Sourcepub fn get_two_way_channel_arn(&self) -> &Option<String>
pub fn get_two_way_channel_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the two way channel.
Sourcepub fn two_way_channel_role(self, input: impl Into<String>) -> Self
pub fn two_way_channel_role(self, input: impl Into<String>) -> Self
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
Sourcepub fn set_two_way_channel_role(self, input: Option<String>) -> Self
pub fn set_two_way_channel_role(self, input: Option<String>) -> Self
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
Sourcepub fn get_two_way_channel_role(&self) -> &Option<String>
pub fn get_two_way_channel_role(&self) -> &Option<String>
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
Sourcepub fn self_managed_opt_outs_enabled(self, input: bool) -> Self
pub fn self_managed_opt_outs_enabled(self, input: bool) -> Self
By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
Sourcepub fn set_self_managed_opt_outs_enabled(self, input: Option<bool>) -> Self
pub fn set_self_managed_opt_outs_enabled(self, input: Option<bool>) -> Self
By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
Sourcepub fn get_self_managed_opt_outs_enabled(&self) -> &Option<bool>
pub fn get_self_managed_opt_outs_enabled(&self) -> &Option<bool>
By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
Sourcepub fn opt_out_list_name(self, input: impl Into<String>) -> Self
pub fn opt_out_list_name(self, input: impl Into<String>) -> Self
The OptOutList to associate with the pool. Valid values are either OptOutListName or OptOutListArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
Sourcepub fn set_opt_out_list_name(self, input: Option<String>) -> Self
pub fn set_opt_out_list_name(self, input: Option<String>) -> Self
The OptOutList to associate with the pool. Valid values are either OptOutListName or OptOutListArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
Sourcepub fn get_opt_out_list_name(&self) -> &Option<String>
pub fn get_opt_out_list_name(&self) -> &Option<String>
The OptOutList to associate with the pool. Valid values are either OptOutListName or OptOutListArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
Indicates whether shared routes are enabled for the pool.
Indicates whether shared routes are enabled for the pool.
Indicates whether shared routes are enabled for the pool.
Sourcepub fn deletion_protection_enabled(self, input: bool) -> Self
pub fn deletion_protection_enabled(self, input: bool) -> Self
When set to true the pool can't be deleted.
Sourcepub fn set_deletion_protection_enabled(self, input: Option<bool>) -> Self
pub fn set_deletion_protection_enabled(self, input: Option<bool>) -> Self
When set to true the pool can't be deleted.
Sourcepub fn get_deletion_protection_enabled(&self) -> &Option<bool>
pub fn get_deletion_protection_enabled(&self) -> &Option<bool>
When set to true the pool can't be deleted.
Trait Implementations§
Source§impl Clone for UpdatePoolFluentBuilder
impl Clone for UpdatePoolFluentBuilder
Source§fn clone(&self) -> UpdatePoolFluentBuilder
fn clone(&self) -> UpdatePoolFluentBuilder
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 UpdatePoolFluentBuilder
impl !RefUnwindSafe for UpdatePoolFluentBuilder
impl Send for UpdatePoolFluentBuilder
impl Sync for UpdatePoolFluentBuilder
impl Unpin for UpdatePoolFluentBuilder
impl !UnwindSafe for UpdatePoolFluentBuilder
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);