Public Member Functions | Public Attributes | List of all members
Aws::Auth::IotRoleConfig Struct Reference

Auth configuration needed to retrieve AWS credentials via the IoT service. More...

#include <service_credentials_provider.h>

Public Member Functions

 IotRoleConfig ()=default
 
 IotRoleConfig (const char *_cafile, const char *_certfile, const char *_keyfile, const char *_host, const char *_role, const char *_name, const int _connect_timeout_ms, const int _total_timeout_ms)
 

Public Attributes

Aws::String cafile
 Path to the Root CA for the endpoint. More...
 
Aws::String certfile
 Path to the certificate which identifies the device. More...
 
long connect_timeout_ms = 0
 Number of ms to wait before timing out when connecting to the endpoint. More...
 
Aws::String host
 Host name of the iot:CredentialProvider endpoint. More...
 
Aws::String keyfile
 Path to the related private key for the certificate. More...
 
Aws::String name
 Thing name for the device. More...
 
Aws::String role
 Name of the AWS IoT Role Alias for the device. More...
 
long total_timeout_ms = 0
 Total number of ms to wait for the entire connect/request/response transaction. More...
 

Detailed Description

Auth configuration needed to retrieve AWS credentials via the IoT service.

The AWS IoT service can be used to retrieve AWS service credentials. Please refer to https://docs.aws.amazon.com/iot/latest/developerguide/authorizing-direct-aws.html for more information.

All configuration elements needed to retrieve credentials are contained in this struct, which is used by the IotRoleCredentialsProvider to retrieve the actual credentials.

Definition at line 57 of file service_credentials_provider.h.

Constructor & Destructor Documentation

Aws::Auth::IotRoleConfig::IotRoleConfig ( )
default
Aws::Auth::IotRoleConfig::IotRoleConfig ( const char *  _cafile,
const char *  _certfile,
const char *  _keyfile,
const char *  _host,
const char *  _role,
const char *  _name,
const int  _connect_timeout_ms,
const int  _total_timeout_ms 
)
inline

Definition at line 61 of file service_credentials_provider.h.

Member Data Documentation

Aws::String Aws::Auth::IotRoleConfig::cafile

Path to the Root CA for the endpoint.

Definition at line 79 of file service_credentials_provider.h.

Aws::String Aws::Auth::IotRoleConfig::certfile

Path to the certificate which identifies the device.

Definition at line 81 of file service_credentials_provider.h.

long Aws::Auth::IotRoleConfig::connect_timeout_ms = 0

Number of ms to wait before timing out when connecting to the endpoint.

Definition at line 91 of file service_credentials_provider.h.

Aws::String Aws::Auth::IotRoleConfig::host

Host name of the iot:CredentialProvider endpoint.

Definition at line 85 of file service_credentials_provider.h.

Aws::String Aws::Auth::IotRoleConfig::keyfile

Path to the related private key for the certificate.

Definition at line 83 of file service_credentials_provider.h.

Aws::String Aws::Auth::IotRoleConfig::name

Thing name for the device.

Definition at line 89 of file service_credentials_provider.h.

Aws::String Aws::Auth::IotRoleConfig::role

Name of the AWS IoT Role Alias for the device.

Definition at line 87 of file service_credentials_provider.h.

long Aws::Auth::IotRoleConfig::total_timeout_ms = 0

Total number of ms to wait for the entire connect/request/response transaction.

Definition at line 93 of file service_credentials_provider.h.


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


aws_common
Author(s): AWS RoboMaker
autogenerated on Sat Mar 6 2021 03:11:38