Struct aws_sdk_sts::operation::assume_role_with_web_identity::builders::AssumeRoleWithWebIdentityOutputBuilder
source · #[non_exhaustive]pub struct AssumeRoleWithWebIdentityOutputBuilder { /* private fields */ }
Expand description
A builder for AssumeRoleWithWebIdentityOutput
.
Implementations§
source§impl AssumeRoleWithWebIdentityOutputBuilder
impl AssumeRoleWithWebIdentityOutputBuilder
sourcepub fn credentials(self, input: Credentials) -> Self
pub fn credentials(self, input: Credentials) -> Self
The temporary security credentials, which include an access key ID, a secret access key, and a security token.
The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.
sourcepub fn set_credentials(self, input: Option<Credentials>) -> Self
pub fn set_credentials(self, input: Option<Credentials>) -> Self
The temporary security credentials, which include an access key ID, a secret access key, and a security token.
The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.
sourcepub fn get_credentials(&self) -> &Option<Credentials>
pub fn get_credentials(&self) -> &Option<Credentials>
The temporary security credentials, which include an access key ID, a secret access key, and a security token.
The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.
sourcepub fn subject_from_web_identity_token(self, input: impl Into<String>) -> Self
pub fn subject_from_web_identity_token(self, input: impl Into<String>) -> Self
The unique user identifier that is returned by the identity provider. This identifier is associated with the WebIdentityToken
that was submitted with the AssumeRoleWithWebIdentity
call. The identifier is typically unique to the user and the application that acquired the WebIdentityToken
(pairwise identifier). For OpenID Connect ID tokens, this field contains the value returned by the identity provider as the token's sub
(Subject) claim.
sourcepub fn set_subject_from_web_identity_token(self, input: Option<String>) -> Self
pub fn set_subject_from_web_identity_token(self, input: Option<String>) -> Self
The unique user identifier that is returned by the identity provider. This identifier is associated with the WebIdentityToken
that was submitted with the AssumeRoleWithWebIdentity
call. The identifier is typically unique to the user and the application that acquired the WebIdentityToken
(pairwise identifier). For OpenID Connect ID tokens, this field contains the value returned by the identity provider as the token's sub
(Subject) claim.
sourcepub fn get_subject_from_web_identity_token(&self) -> &Option<String>
pub fn get_subject_from_web_identity_token(&self) -> &Option<String>
The unique user identifier that is returned by the identity provider. This identifier is associated with the WebIdentityToken
that was submitted with the AssumeRoleWithWebIdentity
call. The identifier is typically unique to the user and the application that acquired the WebIdentityToken
(pairwise identifier). For OpenID Connect ID tokens, this field contains the value returned by the identity provider as the token's sub
(Subject) claim.
sourcepub fn assumed_role_user(self, input: AssumedRoleUser) -> Self
pub fn assumed_role_user(self, input: AssumedRoleUser) -> Self
The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include the RoleSessionName
that you specified when you called AssumeRole
.
sourcepub fn set_assumed_role_user(self, input: Option<AssumedRoleUser>) -> Self
pub fn set_assumed_role_user(self, input: Option<AssumedRoleUser>) -> Self
The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include the RoleSessionName
that you specified when you called AssumeRole
.
sourcepub fn get_assumed_role_user(&self) -> &Option<AssumedRoleUser>
pub fn get_assumed_role_user(&self) -> &Option<AssumedRoleUser>
The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include the RoleSessionName
that you specified when you called AssumeRole
.
sourcepub fn packed_policy_size(self, input: i32) -> Self
pub fn packed_policy_size(self, input: i32) -> Self
A percentage value that indicates the packed size of the session policies and session tags combined passed in the request. The request fails if the packed size is greater than 100 percent, which means the policies and tags exceeded the allowed space.
sourcepub fn set_packed_policy_size(self, input: Option<i32>) -> Self
pub fn set_packed_policy_size(self, input: Option<i32>) -> Self
A percentage value that indicates the packed size of the session policies and session tags combined passed in the request. The request fails if the packed size is greater than 100 percent, which means the policies and tags exceeded the allowed space.
sourcepub fn get_packed_policy_size(&self) -> &Option<i32>
pub fn get_packed_policy_size(&self) -> &Option<i32>
A percentage value that indicates the packed size of the session policies and session tags combined passed in the request. The request fails if the packed size is greater than 100 percent, which means the policies and tags exceeded the allowed space.
sourcepub fn provider(self, input: impl Into<String>) -> Self
pub fn provider(self, input: impl Into<String>) -> Self
The issuing authority of the web identity token presented. For OpenID Connect ID tokens, this contains the value of the iss
field. For OAuth 2.0 access tokens, this contains the value of the ProviderId
parameter that was passed in the AssumeRoleWithWebIdentity
request.
sourcepub fn set_provider(self, input: Option<String>) -> Self
pub fn set_provider(self, input: Option<String>) -> Self
The issuing authority of the web identity token presented. For OpenID Connect ID tokens, this contains the value of the iss
field. For OAuth 2.0 access tokens, this contains the value of the ProviderId
parameter that was passed in the AssumeRoleWithWebIdentity
request.
sourcepub fn get_provider(&self) -> &Option<String>
pub fn get_provider(&self) -> &Option<String>
The issuing authority of the web identity token presented. For OpenID Connect ID tokens, this contains the value of the iss
field. For OAuth 2.0 access tokens, this contains the value of the ProviderId
parameter that was passed in the AssumeRoleWithWebIdentity
request.
sourcepub fn audience(self, input: impl Into<String>) -> Self
pub fn audience(self, input: impl Into<String>) -> Self
The intended audience (also known as client ID) of the web identity token. This is traditionally the client identifier issued to the application that requested the web identity token.
sourcepub fn set_audience(self, input: Option<String>) -> Self
pub fn set_audience(self, input: Option<String>) -> Self
The intended audience (also known as client ID) of the web identity token. This is traditionally the client identifier issued to the application that requested the web identity token.
sourcepub fn get_audience(&self) -> &Option<String>
pub fn get_audience(&self) -> &Option<String>
The intended audience (also known as client ID) of the web identity token. This is traditionally the client identifier issued to the application that requested the web identity token.
sourcepub fn source_identity(self, input: impl Into<String>) -> Self
pub fn source_identity(self, input: impl Into<String>) -> Self
The value of the source identity that is returned in the JSON web token (JWT) from the identity provider.
You can require users to set a source identity value when they assume a role. You do this by using the sts:SourceIdentity
condition key in a role trust policy. That way, actions that are taken with the role are associated with that user. After the source identity is set, the value cannot be changed. It is present in the request for all actions that are taken by the role and persists across chained role sessions. You can configure your identity provider to use an attribute associated with your users, like user name or email, as the source identity when calling AssumeRoleWithWebIdentity
. You do this by adding a claim to the JSON web token. To learn more about OIDC tokens and claims, see Using Tokens with User Pools in the Amazon Cognito Developer Guide. For more information about using source identity, see Monitor and control actions taken with assumed roles in the IAM User Guide.
The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-
sourcepub fn set_source_identity(self, input: Option<String>) -> Self
pub fn set_source_identity(self, input: Option<String>) -> Self
The value of the source identity that is returned in the JSON web token (JWT) from the identity provider.
You can require users to set a source identity value when they assume a role. You do this by using the sts:SourceIdentity
condition key in a role trust policy. That way, actions that are taken with the role are associated with that user. After the source identity is set, the value cannot be changed. It is present in the request for all actions that are taken by the role and persists across chained role sessions. You can configure your identity provider to use an attribute associated with your users, like user name or email, as the source identity when calling AssumeRoleWithWebIdentity
. You do this by adding a claim to the JSON web token. To learn more about OIDC tokens and claims, see Using Tokens with User Pools in the Amazon Cognito Developer Guide. For more information about using source identity, see Monitor and control actions taken with assumed roles in the IAM User Guide.
The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-
sourcepub fn get_source_identity(&self) -> &Option<String>
pub fn get_source_identity(&self) -> &Option<String>
The value of the source identity that is returned in the JSON web token (JWT) from the identity provider.
You can require users to set a source identity value when they assume a role. You do this by using the sts:SourceIdentity
condition key in a role trust policy. That way, actions that are taken with the role are associated with that user. After the source identity is set, the value cannot be changed. It is present in the request for all actions that are taken by the role and persists across chained role sessions. You can configure your identity provider to use an attribute associated with your users, like user name or email, as the source identity when calling AssumeRoleWithWebIdentity
. You do this by adding a claim to the JSON web token. To learn more about OIDC tokens and claims, see Using Tokens with User Pools in the Amazon Cognito Developer Guide. For more information about using source identity, see Monitor and control actions taken with assumed roles in the IAM User Guide.
The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-
sourcepub fn build(self) -> AssumeRoleWithWebIdentityOutput
pub fn build(self) -> AssumeRoleWithWebIdentityOutput
Consumes the builder and constructs a AssumeRoleWithWebIdentityOutput
.
Trait Implementations§
source§impl Clone for AssumeRoleWithWebIdentityOutputBuilder
impl Clone for AssumeRoleWithWebIdentityOutputBuilder
source§fn clone(&self) -> AssumeRoleWithWebIdentityOutputBuilder
fn clone(&self) -> AssumeRoleWithWebIdentityOutputBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Default for AssumeRoleWithWebIdentityOutputBuilder
impl Default for AssumeRoleWithWebIdentityOutputBuilder
source§fn default() -> AssumeRoleWithWebIdentityOutputBuilder
fn default() -> AssumeRoleWithWebIdentityOutputBuilder
source§impl PartialEq for AssumeRoleWithWebIdentityOutputBuilder
impl PartialEq for AssumeRoleWithWebIdentityOutputBuilder
source§fn eq(&self, other: &AssumeRoleWithWebIdentityOutputBuilder) -> bool
fn eq(&self, other: &AssumeRoleWithWebIdentityOutputBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for AssumeRoleWithWebIdentityOutputBuilder
Auto Trait Implementations§
impl Freeze for AssumeRoleWithWebIdentityOutputBuilder
impl RefUnwindSafe for AssumeRoleWithWebIdentityOutputBuilder
impl Send for AssumeRoleWithWebIdentityOutputBuilder
impl Sync for AssumeRoleWithWebIdentityOutputBuilder
impl Unpin for AssumeRoleWithWebIdentityOutputBuilder
impl UnwindSafe for AssumeRoleWithWebIdentityOutputBuilder
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);