pub struct CreatePortalFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CreatePortal
.
Creates a web portal.
Implementations§
Source§impl CreatePortalFluentBuilder
impl CreatePortalFluentBuilder
Sourcepub fn as_input(&self) -> &CreatePortalInputBuilder
pub fn as_input(&self) -> &CreatePortalInputBuilder
Access the CreatePortal as a reference.
Sourcepub async fn send(
self,
) -> Result<CreatePortalOutput, SdkError<CreatePortalError, HttpResponse>>
pub async fn send( self, ) -> Result<CreatePortalOutput, SdkError<CreatePortalError, 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<CreatePortalOutput, CreatePortalError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreatePortalOutput, CreatePortalError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn display_name(self, input: impl Into<String>) -> Self
pub fn display_name(self, input: impl Into<String>) -> Self
The name of the web portal. This is not visible to users who log into the web portal.
Sourcepub fn set_display_name(self, input: Option<String>) -> Self
pub fn set_display_name(self, input: Option<String>) -> Self
The name of the web portal. This is not visible to users who log into the web portal.
Sourcepub fn get_display_name(&self) -> &Option<String>
pub fn get_display_name(&self) -> &Option<String>
The name of the web portal. This is not visible to users who log into the web portal.
Appends an item to tags
.
To override the contents of this collection use set_tags
.
The tags to add to the web portal. A tag is a key-value pair.
The tags to add to the web portal. A tag is a key-value pair.
The tags to add to the web portal. A tag is a key-value pair.
Sourcepub fn customer_managed_key(self, input: impl Into<String>) -> Self
pub fn customer_managed_key(self, input: impl Into<String>) -> Self
The customer managed key of the web portal.
Sourcepub fn set_customer_managed_key(self, input: Option<String>) -> Self
pub fn set_customer_managed_key(self, input: Option<String>) -> Self
The customer managed key of the web portal.
Sourcepub fn get_customer_managed_key(&self) -> &Option<String>
pub fn get_customer_managed_key(&self) -> &Option<String>
The customer managed key of the web portal.
Sourcepub fn additional_encryption_context(
self,
k: impl Into<String>,
v: impl Into<String>,
) -> Self
pub fn additional_encryption_context( self, k: impl Into<String>, v: impl Into<String>, ) -> Self
Adds a key-value pair to additionalEncryptionContext
.
To override the contents of this collection use set_additional_encryption_context
.
The additional encryption context of the portal.
Sourcepub fn set_additional_encryption_context(
self,
input: Option<HashMap<String, String>>,
) -> Self
pub fn set_additional_encryption_context( self, input: Option<HashMap<String, String>>, ) -> Self
The additional encryption context of the portal.
Sourcepub fn get_additional_encryption_context(
&self,
) -> &Option<HashMap<String, String>>
pub fn get_additional_encryption_context( &self, ) -> &Option<HashMap<String, String>>
The additional encryption context of the portal.
Sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.
If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.
Sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.
If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.
Sourcepub fn get_client_token(&self) -> &Option<String>
pub fn get_client_token(&self) -> &Option<String>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.
If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.
Sourcepub fn authentication_type(self, input: AuthenticationType) -> Self
pub fn authentication_type(self, input: AuthenticationType) -> Self
The type of authentication integration points used when signing into the web portal. Defaults to Standard
.
Standard
web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider
to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.
IAM Identity Center
web portals are authenticated through IAM Identity Center. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.
Sourcepub fn set_authentication_type(self, input: Option<AuthenticationType>) -> Self
pub fn set_authentication_type(self, input: Option<AuthenticationType>) -> Self
The type of authentication integration points used when signing into the web portal. Defaults to Standard
.
Standard
web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider
to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.
IAM Identity Center
web portals are authenticated through IAM Identity Center. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.
Sourcepub fn get_authentication_type(&self) -> &Option<AuthenticationType>
pub fn get_authentication_type(&self) -> &Option<AuthenticationType>
The type of authentication integration points used when signing into the web portal. Defaults to Standard
.
Standard
web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider
to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.
IAM Identity Center
web portals are authenticated through IAM Identity Center. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.
Sourcepub fn instance_type(self, input: InstanceType) -> Self
pub fn instance_type(self, input: InstanceType) -> Self
The type and resources of the underlying instance.
Sourcepub fn set_instance_type(self, input: Option<InstanceType>) -> Self
pub fn set_instance_type(self, input: Option<InstanceType>) -> Self
The type and resources of the underlying instance.
Sourcepub fn get_instance_type(&self) -> &Option<InstanceType>
pub fn get_instance_type(&self) -> &Option<InstanceType>
The type and resources of the underlying instance.
Sourcepub fn max_concurrent_sessions(self, input: i32) -> Self
pub fn max_concurrent_sessions(self, input: i32) -> Self
The maximum number of concurrent sessions for the portal.
Sourcepub fn set_max_concurrent_sessions(self, input: Option<i32>) -> Self
pub fn set_max_concurrent_sessions(self, input: Option<i32>) -> Self
The maximum number of concurrent sessions for the portal.
Sourcepub fn get_max_concurrent_sessions(&self) -> &Option<i32>
pub fn get_max_concurrent_sessions(&self) -> &Option<i32>
The maximum number of concurrent sessions for the portal.
Trait Implementations§
Source§impl Clone for CreatePortalFluentBuilder
impl Clone for CreatePortalFluentBuilder
Source§fn clone(&self) -> CreatePortalFluentBuilder
fn clone(&self) -> CreatePortalFluentBuilder
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 CreatePortalFluentBuilder
impl !RefUnwindSafe for CreatePortalFluentBuilder
impl Send for CreatePortalFluentBuilder
impl Sync for CreatePortalFluentBuilder
impl Unpin for CreatePortalFluentBuilder
impl !UnwindSafe for CreatePortalFluentBuilder
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>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
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>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
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>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
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>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
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>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
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>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
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);