#include <STSAssumeRoleCredentialsProvider.h>
Inheritance diagram for Aws::Auth::STSAssumeRoleCredentialsProvider:
Public Member Functions | |
| STSAssumeRoleCredentialsProvider (const Aws::String &roleArn, const Aws::String &sessionName=Aws::String(), const Aws::String &externalId=Aws::String(), int loadFrequency=DEFAULT_CREDS_LOAD_FREQ_SECONDS, const std::shared_ptr< Aws::STS::STSClient > &stsClient=nullptr) | |
| AWSCredentials | GetAWSCredentials () override |
| Public Member Functions inherited from Aws::Auth::AWSCredentialsProvider | |
| AWSCredentialsProvider () | |
| virtual | ~AWSCredentialsProvider ()=default |
Additional Inherited Members | |
| Protected Member Functions inherited from Aws::Auth::AWSCredentialsProvider | |
| virtual bool | IsTimeToRefresh (long reloadFrequency) |
| virtual void | Reload () |
| Protected Attributes inherited from Aws::Auth::AWSCredentialsProvider | |
| Aws::Utils::Threading::ReaderWriterLock | m_reloadLock |
Detailed Description
Credentials provider for STS Assume Role
Definition at line 32 of file STSAssumeRoleCredentialsProvider.h.
Constructor & Destructor Documentation
◆ STSAssumeRoleCredentialsProvider()
| Aws::Auth::STSAssumeRoleCredentialsProvider::STSAssumeRoleCredentialsProvider | ( | const Aws::String & | roleArn, |
| const Aws::String & | sessionName = Aws::String(), |
||
| const Aws::String & | externalId = Aws::String(), |
||
| int | loadFrequency = DEFAULT_CREDS_LOAD_FREQ_SECONDS, |
||
| const std::shared_ptr< Aws::STS::STSClient > & | stsClient = nullptr |
||
| ) |
Initializes credentials provider with roleArn - required, this is the arn for the role you want to assume. sessionName - if not specified, a unique session name will be generated for you. externalId - if not specified, it will not be sent to STS. loadFrequency, defaults to 15 minutes. stsClient, sts client implementation to use.
For more information, see: http://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html
Member Function Documentation
◆ GetAWSCredentials()
|
overridevirtual |
The core of the credential provider interface. Override this method to control how credentials are retrieved.
Implements Aws::Auth::AWSCredentialsProvider.
The documentation for this class was generated from the following file:
- aws-cpp-sdk-identity-management/include/aws/identity-management/auth/STSAssumeRoleCredentialsProvider.h
