Aws::Client::ClientConfiguration::CredentialProviderConfiguration Struct Reference

#include <ClientConfiguration.h>

Classes

struct  LoginProviderConfig

 

struct  STSCredentialsCredentialProviderConfiguration

 

Public Attributes

Aws::String profile

 

Aws::String region

 

bool allowSystemProxy = false

 

struct { 

 

   long   metadataServiceNumAttempts = 1 

 

   long   metadataServiceTimeout = 1 

 

   std::shared_ptr< RetryStrategy >   imdsRetryStrategy 

 

   bool   disableImdsV1 

 

   bool   disableImds 

 

} imdsConfig 

 

struct Aws::Client::ClientConfiguration::CredentialProviderConfiguration::STSCredentialsCredentialProviderConfiguration stsCredentialsProviderConfig

 

struct Aws::Client::ClientConfiguration::CredentialProviderConfiguration::LoginProviderConfig loginCredentialProviderConfig

 

Detailed Description

Configuration structure for credential providers in the AWS SDK. This structure allows passing configuration options to credential providers such as profile name and client configuration for HTTP requests made by credential providers that need to make network calls (e.g., InstanceProfileCredentialsProvider).

Definition at line 532 of file ClientConfiguration.h.

Member Data Documentation

allowSystemProxy

bool Aws::Client::ClientConfiguration::CredentialProviderConfiguration::allowSystemProxy = false

Allow CRT-based credential providers to honor HTTP_PROXY / HTTPS_PROXY / NO_PROXY environment variables when fetching credentials. Off by default to mirror ClientConfiguration::allowSystemProxy and avoid silently routing credential traffic through an unintended proxy.

Definition at line 548 of file ClientConfiguration.h.

disableImds

bool Aws::Client::ClientConfiguration::CredentialProviderConfiguration::disableImds

Definition at line 569 of file ClientConfiguration.h.

disableImdsV1

bool Aws::Client::ClientConfiguration::CredentialProviderConfiguration::disableImdsV1

Definition at line 568 of file ClientConfiguration.h.

[struct]

struct { ... } Aws::Client::ClientConfiguration::CredentialProviderConfiguration::imdsConfig

IMDS configuration settings

imdsRetryStrategy

std::shared_ptr<RetryStrategy> Aws::Client::ClientConfiguration::CredentialProviderConfiguration::imdsRetryStrategy

Retry Strategy for IMDS

Definition at line 567 of file ClientConfiguration.h.

loginCredentialProviderConfig

struct Aws::Client::ClientConfiguration::CredentialProviderConfiguration::LoginProviderConfig Aws::Client::ClientConfiguration::CredentialProviderConfiguration::loginCredentialProviderConfig

metadataServiceNumAttempts

long Aws::Client::ClientConfiguration::CredentialProviderConfiguration::metadataServiceNumAttempts = 1

Number of total attempts to make when retrieving data from IMDS. Default 1.

Definition at line 557 of file ClientConfiguration.h.

metadataServiceTimeout

long Aws::Client::ClientConfiguration::CredentialProviderConfiguration::metadataServiceTimeout = 1

Timeout in seconds when retrieving data from IMDS. Default 1.

Definition at line 562 of file ClientConfiguration.h.

profile

Aws::String Aws::Client::ClientConfiguration::CredentialProviderConfiguration::profile

AWS profile name to use for credentials.

Definition at line 536 of file ClientConfiguration.h.

region

Aws::String Aws::Client::ClientConfiguration::CredentialProviderConfiguration::region

Region to use for calls

Definition at line 541 of file ClientConfiguration.h.

stsCredentialsProviderConfig

struct Aws::Client::ClientConfiguration::CredentialProviderConfiguration::STSCredentialsCredentialProviderConfiguration Aws::Client::ClientConfiguration::CredentialProviderConfiguration::stsCredentialsProviderConfig

---

The documentation for this struct was generated from the following file:

• src/aws-cpp-sdk-core/include/aws/core/client/ClientConfiguration.h