pub struct AssumeRoleProvider { /* private fields */ }
Expand description
Credentials provider that uses credentials provided by another provider to assume a role through the AWS Security Token Service (STS).
When asked to provide credentials, this provider will first invoke the inner credentials provider to get AWS credentials for STS. Then, it will call STS to get assumed credentials for the desired role.
§Examples
Create an AssumeRoleProvider explicitly set to us-east-2 that utilizes the default credentials chain.
use aws_config::sts::AssumeRoleProvider;
use aws_types::region::Region;
let provider = AssumeRoleProvider::builder("arn:aws:iam::123456789012:role/demo")
.region(Region::from_static("us-east-2"))
.session_name("testAR")
.build().await;
}
Create an AssumeRoleProvider from an explicitly configured base configuration.
use aws_config::sts::AssumeRoleProvider;
use aws_types::region::Region;
let conf = aws_config::from_env().use_fips(true).load().await;
let provider = AssumeRoleProvider::builder("arn:aws:iam::123456789012:role/demo")
.configure(&conf)
.session_name("testAR")
.build().await;
}
Create an AssumeroleProvider that sources credentials from a provider credential provider:
use aws_config::sts::AssumeRoleProvider;
use aws_types::region::Region;
use aws_config::environment::EnvironmentVariableCredentialsProvider;
let provider = AssumeRoleProvider::builder("arn:aws:iam::123456789012:role/demo")
.session_name("test-assume-role-session")
// only consider environment variables, explicitly.
.build_from_provider(EnvironmentVariableCredentialsProvider::new()).await;
}
Implementations§
Source§impl AssumeRoleProvider
impl AssumeRoleProvider
Sourcepub fn builder(role: impl Into<String>) -> AssumeRoleProviderBuilder
pub fn builder(role: impl Into<String>) -> AssumeRoleProviderBuilder
Build a new role-assuming provider for the given role.
The role
argument should take the form an Amazon Resource Name (ARN) like
arn:aws:iam::123456789012:role/example
Trait Implementations§
Source§impl Debug for AssumeRoleProvider
impl Debug for AssumeRoleProvider
Source§impl ProvideCredentials for AssumeRoleProvider
impl ProvideCredentials for AssumeRoleProvider
Source§fn provide_credentials<'a>(&'a self) -> ProvideCredentials<'_>where
Self: 'a,
fn provide_credentials<'a>(&'a self) -> ProvideCredentials<'_>where
Self: 'a,
Returns a future that provides credentials.
Source§fn fallback_on_interrupt(&self) -> Option<Credentials>
fn fallback_on_interrupt(&self) -> Option<Credentials>
Returns fallback credentials. Read more
Auto Trait Implementations§
impl Freeze for AssumeRoleProvider
impl !RefUnwindSafe for AssumeRoleProvider
impl Send for AssumeRoleProvider
impl Sync for AssumeRoleProvider
impl Unpin for AssumeRoleProvider
impl !UnwindSafe for AssumeRoleProvider
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
Mutably borrows from an owned value. Read more
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>
Converts
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>
Converts
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 moreCreates a shared type from an unshared type.