Struct aws_config::sts::AssumeRoleProviderBuilder

pub struct AssumeRoleProviderBuilder { /* fields omitted */ }

A builder for AssumeRoleProvider.

Construct one through AssumeRoleProvider::builder.

Implementations

impl AssumeRoleProviderBuilder

pub fn new(role: impl Into<String>) -> Self

Start a new assume role builder for the given role.

The role argument should take the form an Amazon Resource Name (ARN) like

arn:aws:iam::123456789012:role/example

pub fn external_id(self, id: impl Into<String>) -> Self

Set a unique identifier that might be required when you assume a role in another account.

If the administrator of the account to which the role belongs provided you with an external ID, then provide that value in this parameter. The value can be any string, such as a passphrase or account number.

pub fn session_name(self, name: impl Into<String>) -> Self

Set an identifier for the assumed role session.

Use the role session name to uniquely identify a session when the same role is assumed by different principals or for different reasons. In cross-account scenarios, the role session name is visible to, and can be logged by the account that owns the role. The role session name is also used in the ARN of the assumed role principal.

pub fn region(self, region: Region) -> Self

Set the region to assume the role in.

This dictates which STS endpoint the AssumeRole action is invoked on.

pub fn connection(self, conn: impl SmithyConnector) -> Self

Set the backing connection to use when talking to STS.

If the rustls or nativetls features are enabled, this field is optional and a default backing connection will be provided.

pub fn build(
    self,
    provider: impl Into<SharedCredentialsProvider>
) -> AssumeRoleProvider

Build a credentials provider for this role authorized by the given provider.