Struct aws_config::sts::AssumeRoleProvider

pub struct AssumeRoleProvider { /* private fields */ }

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

impl AssumeRoleProvider

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

impl Debug for AssumeRoleProvider

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl ProvideCredentials for AssumeRoleProvider

fn provide_credentials<'a>(&'a self) -> ProvideCredentials<'_>

where Self: 'a,

Returns a future that provides credentials.

fn fallback_on_interrupt(&self) -> Option<Credentials>

Returns fallback credentials.