Struct aws_sdk_sts::types::builders::CredentialsBuilder
source · #[non_exhaustive]pub struct CredentialsBuilder { /* private fields */ }
Expand description
A builder for Credentials
.
Implementations§
source§impl CredentialsBuilder
impl CredentialsBuilder
sourcepub fn access_key_id(self, input: impl Into<String>) -> Self
pub fn access_key_id(self, input: impl Into<String>) -> Self
The access key ID that identifies the temporary security credentials.
This field is required.sourcepub fn set_access_key_id(self, input: Option<String>) -> Self
pub fn set_access_key_id(self, input: Option<String>) -> Self
The access key ID that identifies the temporary security credentials.
sourcepub fn get_access_key_id(&self) -> &Option<String>
pub fn get_access_key_id(&self) -> &Option<String>
The access key ID that identifies the temporary security credentials.
sourcepub fn secret_access_key(self, input: impl Into<String>) -> Self
pub fn secret_access_key(self, input: impl Into<String>) -> Self
The secret access key that can be used to sign requests.
This field is required.sourcepub fn set_secret_access_key(self, input: Option<String>) -> Self
pub fn set_secret_access_key(self, input: Option<String>) -> Self
The secret access key that can be used to sign requests.
sourcepub fn get_secret_access_key(&self) -> &Option<String>
pub fn get_secret_access_key(&self) -> &Option<String>
The secret access key that can be used to sign requests.
sourcepub fn session_token(self, input: impl Into<String>) -> Self
pub fn session_token(self, input: impl Into<String>) -> Self
The token that users must pass to the service API to use the temporary credentials.
This field is required.sourcepub fn set_session_token(self, input: Option<String>) -> Self
pub fn set_session_token(self, input: Option<String>) -> Self
The token that users must pass to the service API to use the temporary credentials.
sourcepub fn get_session_token(&self) -> &Option<String>
pub fn get_session_token(&self) -> &Option<String>
The token that users must pass to the service API to use the temporary credentials.
sourcepub fn expiration(self, input: DateTime) -> Self
pub fn expiration(self, input: DateTime) -> Self
The date on which the current credentials expire.
This field is required.sourcepub fn set_expiration(self, input: Option<DateTime>) -> Self
pub fn set_expiration(self, input: Option<DateTime>) -> Self
The date on which the current credentials expire.
sourcepub fn get_expiration(&self) -> &Option<DateTime>
pub fn get_expiration(&self) -> &Option<DateTime>
The date on which the current credentials expire.
sourcepub fn build(self) -> Result<Credentials, BuildError>
pub fn build(self) -> Result<Credentials, BuildError>
Consumes the builder and constructs a Credentials
.
This method will fail if any of the following fields are not set:
Trait Implementations§
source§impl Clone for CredentialsBuilder
impl Clone for CredentialsBuilder
source§fn clone(&self) -> CredentialsBuilder
fn clone(&self) -> CredentialsBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for CredentialsBuilder
impl Debug for CredentialsBuilder
source§impl Default for CredentialsBuilder
impl Default for CredentialsBuilder
source§fn default() -> CredentialsBuilder
fn default() -> CredentialsBuilder
source§impl PartialEq for CredentialsBuilder
impl PartialEq for CredentialsBuilder
source§fn eq(&self, other: &CredentialsBuilder) -> bool
fn eq(&self, other: &CredentialsBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for CredentialsBuilder
Auto Trait Implementations§
impl Freeze for CredentialsBuilder
impl RefUnwindSafe for CredentialsBuilder
impl Send for CredentialsBuilder
impl Sync for CredentialsBuilder
impl Unpin for CredentialsBuilder
impl UnwindSafe for CredentialsBuilder
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§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§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 more§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
§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();
§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
§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();
§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
§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();
§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
§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();
§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.§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);