AWS SDK for C++  1.9.158
AWS SDK for C++
Public Member Functions | List of all members
Aws::IoT::Model::AuthorizerDescription Class Reference

#include <AuthorizerDescription.h>

Public Member Functions

 AuthorizerDescription ()
 
 AuthorizerDescription (Aws::Utils::Json::JsonView jsonValue)
 
AuthorizerDescriptionoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetAuthorizerName () const
 
bool AuthorizerNameHasBeenSet () const
 
void SetAuthorizerName (const Aws::String &value)
 
void SetAuthorizerName (Aws::String &&value)
 
void SetAuthorizerName (const char *value)
 
AuthorizerDescriptionWithAuthorizerName (const Aws::String &value)
 
AuthorizerDescriptionWithAuthorizerName (Aws::String &&value)
 
AuthorizerDescriptionWithAuthorizerName (const char *value)
 
const Aws::StringGetAuthorizerArn () const
 
bool AuthorizerArnHasBeenSet () const
 
void SetAuthorizerArn (const Aws::String &value)
 
void SetAuthorizerArn (Aws::String &&value)
 
void SetAuthorizerArn (const char *value)
 
AuthorizerDescriptionWithAuthorizerArn (const Aws::String &value)
 
AuthorizerDescriptionWithAuthorizerArn (Aws::String &&value)
 
AuthorizerDescriptionWithAuthorizerArn (const char *value)
 
const Aws::StringGetAuthorizerFunctionArn () const
 
bool AuthorizerFunctionArnHasBeenSet () const
 
void SetAuthorizerFunctionArn (const Aws::String &value)
 
void SetAuthorizerFunctionArn (Aws::String &&value)
 
void SetAuthorizerFunctionArn (const char *value)
 
AuthorizerDescriptionWithAuthorizerFunctionArn (const Aws::String &value)
 
AuthorizerDescriptionWithAuthorizerFunctionArn (Aws::String &&value)
 
AuthorizerDescriptionWithAuthorizerFunctionArn (const char *value)
 
const Aws::StringGetTokenKeyName () const
 
bool TokenKeyNameHasBeenSet () const
 
void SetTokenKeyName (const Aws::String &value)
 
void SetTokenKeyName (Aws::String &&value)
 
void SetTokenKeyName (const char *value)
 
AuthorizerDescriptionWithTokenKeyName (const Aws::String &value)
 
AuthorizerDescriptionWithTokenKeyName (Aws::String &&value)
 
AuthorizerDescriptionWithTokenKeyName (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetTokenSigningPublicKeys () const
 
bool TokenSigningPublicKeysHasBeenSet () const
 
void SetTokenSigningPublicKeys (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetTokenSigningPublicKeys (Aws::Map< Aws::String, Aws::String > &&value)
 
AuthorizerDescriptionWithTokenSigningPublicKeys (const Aws::Map< Aws::String, Aws::String > &value)
 
AuthorizerDescriptionWithTokenSigningPublicKeys (Aws::Map< Aws::String, Aws::String > &&value)
 
AuthorizerDescriptionAddTokenSigningPublicKeys (const Aws::String &key, const Aws::String &value)
 
AuthorizerDescriptionAddTokenSigningPublicKeys (Aws::String &&key, const Aws::String &value)
 
AuthorizerDescriptionAddTokenSigningPublicKeys (const Aws::String &key, Aws::String &&value)
 
AuthorizerDescriptionAddTokenSigningPublicKeys (Aws::String &&key, Aws::String &&value)
 
AuthorizerDescriptionAddTokenSigningPublicKeys (const char *key, Aws::String &&value)
 
AuthorizerDescriptionAddTokenSigningPublicKeys (Aws::String &&key, const char *value)
 
AuthorizerDescriptionAddTokenSigningPublicKeys (const char *key, const char *value)
 
const AuthorizerStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const AuthorizerStatus &value)
 
void SetStatus (AuthorizerStatus &&value)
 
AuthorizerDescriptionWithStatus (const AuthorizerStatus &value)
 
AuthorizerDescriptionWithStatus (AuthorizerStatus &&value)
 
const Aws::Utils::DateTimeGetCreationDate () const
 
bool CreationDateHasBeenSet () const
 
void SetCreationDate (const Aws::Utils::DateTime &value)
 
void SetCreationDate (Aws::Utils::DateTime &&value)
 
AuthorizerDescriptionWithCreationDate (const Aws::Utils::DateTime &value)
 
AuthorizerDescriptionWithCreationDate (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetLastModifiedDate () const
 
bool LastModifiedDateHasBeenSet () const
 
void SetLastModifiedDate (const Aws::Utils::DateTime &value)
 
void SetLastModifiedDate (Aws::Utils::DateTime &&value)
 
AuthorizerDescriptionWithLastModifiedDate (const Aws::Utils::DateTime &value)
 
AuthorizerDescriptionWithLastModifiedDate (Aws::Utils::DateTime &&value)
 
bool GetSigningDisabled () const
 
bool SigningDisabledHasBeenSet () const
 
void SetSigningDisabled (bool value)
 
AuthorizerDescriptionWithSigningDisabled (bool value)
 

Detailed Description

The authorizer description.

See Also:

AWS API Reference

Definition at line 34 of file AuthorizerDescription.h.

Constructor & Destructor Documentation

◆ AuthorizerDescription() [1/2]

Aws::IoT::Model::AuthorizerDescription::AuthorizerDescription ( )

◆ AuthorizerDescription() [2/2]

Aws::IoT::Model::AuthorizerDescription::AuthorizerDescription ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddTokenSigningPublicKeys() [1/7]

AuthorizerDescription& Aws::IoT::Model::AuthorizerDescription::AddTokenSigningPublicKeys ( Aws::String &&  key,
Aws::String &&  value 
)
inline

The public keys used to validate the token signature returned by your custom authentication service.

Definition at line 265 of file AuthorizerDescription.h.

◆ AddTokenSigningPublicKeys() [2/7]

AuthorizerDescription& Aws::IoT::Model::AuthorizerDescription::AddTokenSigningPublicKeys ( Aws::String &&  key,
const Aws::String value 
)
inline

The public keys used to validate the token signature returned by your custom authentication service.

Definition at line 253 of file AuthorizerDescription.h.

◆ AddTokenSigningPublicKeys() [3/7]

AuthorizerDescription& Aws::IoT::Model::AuthorizerDescription::AddTokenSigningPublicKeys ( Aws::String &&  key,
const char *  value 
)
inline

The public keys used to validate the token signature returned by your custom authentication service.

Definition at line 277 of file AuthorizerDescription.h.

◆ AddTokenSigningPublicKeys() [4/7]

AuthorizerDescription& Aws::IoT::Model::AuthorizerDescription::AddTokenSigningPublicKeys ( const Aws::String key,
Aws::String &&  value 
)
inline

The public keys used to validate the token signature returned by your custom authentication service.

Definition at line 259 of file AuthorizerDescription.h.

◆ AddTokenSigningPublicKeys() [5/7]

AuthorizerDescription& Aws::IoT::Model::AuthorizerDescription::AddTokenSigningPublicKeys ( const Aws::String key,
const Aws::String value 
)
inline

The public keys used to validate the token signature returned by your custom authentication service.

Definition at line 247 of file AuthorizerDescription.h.

◆ AddTokenSigningPublicKeys() [6/7]

AuthorizerDescription& Aws::IoT::Model::AuthorizerDescription::AddTokenSigningPublicKeys ( const char *  key,
Aws::String &&  value 
)
inline

The public keys used to validate the token signature returned by your custom authentication service.

Definition at line 271 of file AuthorizerDescription.h.

◆ AddTokenSigningPublicKeys() [7/7]

AuthorizerDescription& Aws::IoT::Model::AuthorizerDescription::AddTokenSigningPublicKeys ( const char *  key,
const char *  value 
)
inline

The public keys used to validate the token signature returned by your custom authentication service.

Definition at line 283 of file AuthorizerDescription.h.

◆ AuthorizerArnHasBeenSet()

bool Aws::IoT::Model::AuthorizerDescription::AuthorizerArnHasBeenSet ( ) const
inline

The authorizer ARN.

Definition at line 92 of file AuthorizerDescription.h.

◆ AuthorizerFunctionArnHasBeenSet()

bool Aws::IoT::Model::AuthorizerDescription::AuthorizerFunctionArnHasBeenSet ( ) const
inline

The authorizer's Lambda function ARN.

Definition at line 133 of file AuthorizerDescription.h.

◆ AuthorizerNameHasBeenSet()

bool Aws::IoT::Model::AuthorizerDescription::AuthorizerNameHasBeenSet ( ) const
inline

The authorizer name.

Definition at line 51 of file AuthorizerDescription.h.

◆ CreationDateHasBeenSet()

bool Aws::IoT::Model::AuthorizerDescription::CreationDateHasBeenSet ( ) const
inline

The UNIX timestamp of when the authorizer was created.

Definition at line 325 of file AuthorizerDescription.h.

◆ GetAuthorizerArn()

const Aws::String& Aws::IoT::Model::AuthorizerDescription::GetAuthorizerArn ( ) const
inline

The authorizer ARN.

Definition at line 87 of file AuthorizerDescription.h.

◆ GetAuthorizerFunctionArn()

const Aws::String& Aws::IoT::Model::AuthorizerDescription::GetAuthorizerFunctionArn ( ) const
inline

The authorizer's Lambda function ARN.

Definition at line 128 of file AuthorizerDescription.h.

◆ GetAuthorizerName()

const Aws::String& Aws::IoT::Model::AuthorizerDescription::GetAuthorizerName ( ) const
inline

The authorizer name.

Definition at line 46 of file AuthorizerDescription.h.

◆ GetCreationDate()

const Aws::Utils::DateTime& Aws::IoT::Model::AuthorizerDescription::GetCreationDate ( ) const
inline

The UNIX timestamp of when the authorizer was created.

Definition at line 320 of file AuthorizerDescription.h.

◆ GetLastModifiedDate()

const Aws::Utils::DateTime& Aws::IoT::Model::AuthorizerDescription::GetLastModifiedDate ( ) const
inline

The UNIX timestamp of when the authorizer was last updated.

Definition at line 351 of file AuthorizerDescription.h.

◆ GetSigningDisabled()

bool Aws::IoT::Model::AuthorizerDescription::GetSigningDisabled ( ) const
inline

Specifies whether IoT validates the token signature in an authorization request.

Definition at line 383 of file AuthorizerDescription.h.

◆ GetStatus()

const AuthorizerStatus& Aws::IoT::Model::AuthorizerDescription::GetStatus ( ) const
inline

The status of the authorizer.

Definition at line 289 of file AuthorizerDescription.h.

◆ GetTokenKeyName()

const Aws::String& Aws::IoT::Model::AuthorizerDescription::GetTokenKeyName ( ) const
inline

The key used to extract the token from the HTTP headers.

Definition at line 169 of file AuthorizerDescription.h.

◆ GetTokenSigningPublicKeys()

const Aws::Map<Aws::String, Aws::String>& Aws::IoT::Model::AuthorizerDescription::GetTokenSigningPublicKeys ( ) const
inline

The public keys used to validate the token signature returned by your custom authentication service.

Definition at line 211 of file AuthorizerDescription.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::IoT::Model::AuthorizerDescription::Jsonize ( ) const

◆ LastModifiedDateHasBeenSet()

bool Aws::IoT::Model::AuthorizerDescription::LastModifiedDateHasBeenSet ( ) const
inline

The UNIX timestamp of when the authorizer was last updated.

Definition at line 356 of file AuthorizerDescription.h.

◆ operator=()

AuthorizerDescription& Aws::IoT::Model::AuthorizerDescription::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetAuthorizerArn() [1/3]

void Aws::IoT::Model::AuthorizerDescription::SetAuthorizerArn ( Aws::String &&  value)
inline

The authorizer ARN.

Definition at line 102 of file AuthorizerDescription.h.

◆ SetAuthorizerArn() [2/3]

void Aws::IoT::Model::AuthorizerDescription::SetAuthorizerArn ( const Aws::String value)
inline

The authorizer ARN.

Definition at line 97 of file AuthorizerDescription.h.

◆ SetAuthorizerArn() [3/3]

void Aws::IoT::Model::AuthorizerDescription::SetAuthorizerArn ( const char *  value)
inline

The authorizer ARN.

Definition at line 107 of file AuthorizerDescription.h.

◆ SetAuthorizerFunctionArn() [1/3]

void Aws::IoT::Model::AuthorizerDescription::SetAuthorizerFunctionArn ( Aws::String &&  value)
inline

The authorizer's Lambda function ARN.

Definition at line 143 of file AuthorizerDescription.h.

◆ SetAuthorizerFunctionArn() [2/3]

void Aws::IoT::Model::AuthorizerDescription::SetAuthorizerFunctionArn ( const Aws::String value)
inline

The authorizer's Lambda function ARN.

Definition at line 138 of file AuthorizerDescription.h.

◆ SetAuthorizerFunctionArn() [3/3]

void Aws::IoT::Model::AuthorizerDescription::SetAuthorizerFunctionArn ( const char *  value)
inline

The authorizer's Lambda function ARN.

Definition at line 148 of file AuthorizerDescription.h.

◆ SetAuthorizerName() [1/3]

void Aws::IoT::Model::AuthorizerDescription::SetAuthorizerName ( Aws::String &&  value)
inline

The authorizer name.

Definition at line 61 of file AuthorizerDescription.h.

◆ SetAuthorizerName() [2/3]

void Aws::IoT::Model::AuthorizerDescription::SetAuthorizerName ( const Aws::String value)
inline

The authorizer name.

Definition at line 56 of file AuthorizerDescription.h.

◆ SetAuthorizerName() [3/3]

void Aws::IoT::Model::AuthorizerDescription::SetAuthorizerName ( const char *  value)
inline

The authorizer name.

Definition at line 66 of file AuthorizerDescription.h.

◆ SetCreationDate() [1/2]

void Aws::IoT::Model::AuthorizerDescription::SetCreationDate ( Aws::Utils::DateTime &&  value)
inline

The UNIX timestamp of when the authorizer was created.

Definition at line 335 of file AuthorizerDescription.h.

◆ SetCreationDate() [2/2]

void Aws::IoT::Model::AuthorizerDescription::SetCreationDate ( const Aws::Utils::DateTime value)
inline

The UNIX timestamp of when the authorizer was created.

Definition at line 330 of file AuthorizerDescription.h.

◆ SetLastModifiedDate() [1/2]

void Aws::IoT::Model::AuthorizerDescription::SetLastModifiedDate ( Aws::Utils::DateTime &&  value)
inline

The UNIX timestamp of when the authorizer was last updated.

Definition at line 366 of file AuthorizerDescription.h.

◆ SetLastModifiedDate() [2/2]

void Aws::IoT::Model::AuthorizerDescription::SetLastModifiedDate ( const Aws::Utils::DateTime value)
inline

The UNIX timestamp of when the authorizer was last updated.

Definition at line 361 of file AuthorizerDescription.h.

◆ SetSigningDisabled()

void Aws::IoT::Model::AuthorizerDescription::SetSigningDisabled ( bool  value)
inline

Specifies whether IoT validates the token signature in an authorization request.

Definition at line 395 of file AuthorizerDescription.h.

◆ SetStatus() [1/2]

void Aws::IoT::Model::AuthorizerDescription::SetStatus ( AuthorizerStatus &&  value)
inline

The status of the authorizer.

Definition at line 304 of file AuthorizerDescription.h.

◆ SetStatus() [2/2]

void Aws::IoT::Model::AuthorizerDescription::SetStatus ( const AuthorizerStatus value)
inline

The status of the authorizer.

Definition at line 299 of file AuthorizerDescription.h.

◆ SetTokenKeyName() [1/3]

void Aws::IoT::Model::AuthorizerDescription::SetTokenKeyName ( Aws::String &&  value)
inline

The key used to extract the token from the HTTP headers.

Definition at line 184 of file AuthorizerDescription.h.

◆ SetTokenKeyName() [2/3]

void Aws::IoT::Model::AuthorizerDescription::SetTokenKeyName ( const Aws::String value)
inline

The key used to extract the token from the HTTP headers.

Definition at line 179 of file AuthorizerDescription.h.

◆ SetTokenKeyName() [3/3]

void Aws::IoT::Model::AuthorizerDescription::SetTokenKeyName ( const char *  value)
inline

The key used to extract the token from the HTTP headers.

Definition at line 189 of file AuthorizerDescription.h.

◆ SetTokenSigningPublicKeys() [1/2]

void Aws::IoT::Model::AuthorizerDescription::SetTokenSigningPublicKeys ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The public keys used to validate the token signature returned by your custom authentication service.

Definition at line 229 of file AuthorizerDescription.h.

◆ SetTokenSigningPublicKeys() [2/2]

void Aws::IoT::Model::AuthorizerDescription::SetTokenSigningPublicKeys ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

The public keys used to validate the token signature returned by your custom authentication service.

Definition at line 223 of file AuthorizerDescription.h.

◆ SigningDisabledHasBeenSet()

bool Aws::IoT::Model::AuthorizerDescription::SigningDisabledHasBeenSet ( ) const
inline

Specifies whether IoT validates the token signature in an authorization request.

Definition at line 389 of file AuthorizerDescription.h.

◆ StatusHasBeenSet()

bool Aws::IoT::Model::AuthorizerDescription::StatusHasBeenSet ( ) const
inline

The status of the authorizer.

Definition at line 294 of file AuthorizerDescription.h.

◆ TokenKeyNameHasBeenSet()

bool Aws::IoT::Model::AuthorizerDescription::TokenKeyNameHasBeenSet ( ) const
inline

The key used to extract the token from the HTTP headers.

Definition at line 174 of file AuthorizerDescription.h.

◆ TokenSigningPublicKeysHasBeenSet()

bool Aws::IoT::Model::AuthorizerDescription::TokenSigningPublicKeysHasBeenSet ( ) const
inline

The public keys used to validate the token signature returned by your custom authentication service.

Definition at line 217 of file AuthorizerDescription.h.

◆ WithAuthorizerArn() [1/3]

AuthorizerDescription& Aws::IoT::Model::AuthorizerDescription::WithAuthorizerArn ( Aws::String &&  value)
inline

The authorizer ARN.

Definition at line 117 of file AuthorizerDescription.h.

◆ WithAuthorizerArn() [2/3]

AuthorizerDescription& Aws::IoT::Model::AuthorizerDescription::WithAuthorizerArn ( const Aws::String value)
inline

The authorizer ARN.

Definition at line 112 of file AuthorizerDescription.h.

◆ WithAuthorizerArn() [3/3]

AuthorizerDescription& Aws::IoT::Model::AuthorizerDescription::WithAuthorizerArn ( const char *  value)
inline

The authorizer ARN.

Definition at line 122 of file AuthorizerDescription.h.

◆ WithAuthorizerFunctionArn() [1/3]

AuthorizerDescription& Aws::IoT::Model::AuthorizerDescription::WithAuthorizerFunctionArn ( Aws::String &&  value)
inline

The authorizer's Lambda function ARN.

Definition at line 158 of file AuthorizerDescription.h.

◆ WithAuthorizerFunctionArn() [2/3]

AuthorizerDescription& Aws::IoT::Model::AuthorizerDescription::WithAuthorizerFunctionArn ( const Aws::String value)
inline

The authorizer's Lambda function ARN.

Definition at line 153 of file AuthorizerDescription.h.

◆ WithAuthorizerFunctionArn() [3/3]

AuthorizerDescription& Aws::IoT::Model::AuthorizerDescription::WithAuthorizerFunctionArn ( const char *  value)
inline

The authorizer's Lambda function ARN.

Definition at line 163 of file AuthorizerDescription.h.

◆ WithAuthorizerName() [1/3]

AuthorizerDescription& Aws::IoT::Model::AuthorizerDescription::WithAuthorizerName ( Aws::String &&  value)
inline

The authorizer name.

Definition at line 76 of file AuthorizerDescription.h.

◆ WithAuthorizerName() [2/3]

AuthorizerDescription& Aws::IoT::Model::AuthorizerDescription::WithAuthorizerName ( const Aws::String value)
inline

The authorizer name.

Definition at line 71 of file AuthorizerDescription.h.

◆ WithAuthorizerName() [3/3]

AuthorizerDescription& Aws::IoT::Model::AuthorizerDescription::WithAuthorizerName ( const char *  value)
inline

The authorizer name.

Definition at line 81 of file AuthorizerDescription.h.

◆ WithCreationDate() [1/2]

AuthorizerDescription& Aws::IoT::Model::AuthorizerDescription::WithCreationDate ( Aws::Utils::DateTime &&  value)
inline

The UNIX timestamp of when the authorizer was created.

Definition at line 345 of file AuthorizerDescription.h.

◆ WithCreationDate() [2/2]

AuthorizerDescription& Aws::IoT::Model::AuthorizerDescription::WithCreationDate ( const Aws::Utils::DateTime value)
inline

The UNIX timestamp of when the authorizer was created.

Definition at line 340 of file AuthorizerDescription.h.

◆ WithLastModifiedDate() [1/2]

AuthorizerDescription& Aws::IoT::Model::AuthorizerDescription::WithLastModifiedDate ( Aws::Utils::DateTime &&  value)
inline

The UNIX timestamp of when the authorizer was last updated.

Definition at line 376 of file AuthorizerDescription.h.

◆ WithLastModifiedDate() [2/2]

AuthorizerDescription& Aws::IoT::Model::AuthorizerDescription::WithLastModifiedDate ( const Aws::Utils::DateTime value)
inline

The UNIX timestamp of when the authorizer was last updated.

Definition at line 371 of file AuthorizerDescription.h.

◆ WithSigningDisabled()

AuthorizerDescription& Aws::IoT::Model::AuthorizerDescription::WithSigningDisabled ( bool  value)
inline

Specifies whether IoT validates the token signature in an authorization request.

Definition at line 401 of file AuthorizerDescription.h.

◆ WithStatus() [1/2]

AuthorizerDescription& Aws::IoT::Model::AuthorizerDescription::WithStatus ( AuthorizerStatus &&  value)
inline

The status of the authorizer.

Definition at line 314 of file AuthorizerDescription.h.

◆ WithStatus() [2/2]

AuthorizerDescription& Aws::IoT::Model::AuthorizerDescription::WithStatus ( const AuthorizerStatus value)
inline

The status of the authorizer.

Definition at line 309 of file AuthorizerDescription.h.

◆ WithTokenKeyName() [1/3]

AuthorizerDescription& Aws::IoT::Model::AuthorizerDescription::WithTokenKeyName ( Aws::String &&  value)
inline

The key used to extract the token from the HTTP headers.

Definition at line 199 of file AuthorizerDescription.h.

◆ WithTokenKeyName() [2/3]

AuthorizerDescription& Aws::IoT::Model::AuthorizerDescription::WithTokenKeyName ( const Aws::String value)
inline

The key used to extract the token from the HTTP headers.

Definition at line 194 of file AuthorizerDescription.h.

◆ WithTokenKeyName() [3/3]

AuthorizerDescription& Aws::IoT::Model::AuthorizerDescription::WithTokenKeyName ( const char *  value)
inline

The key used to extract the token from the HTTP headers.

Definition at line 204 of file AuthorizerDescription.h.

◆ WithTokenSigningPublicKeys() [1/2]

AuthorizerDescription& Aws::IoT::Model::AuthorizerDescription::WithTokenSigningPublicKeys ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The public keys used to validate the token signature returned by your custom authentication service.

Definition at line 241 of file AuthorizerDescription.h.

◆ WithTokenSigningPublicKeys() [2/2]

AuthorizerDescription& Aws::IoT::Model::AuthorizerDescription::WithTokenSigningPublicKeys ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

The public keys used to validate the token signature returned by your custom authentication service.

Definition at line 235 of file AuthorizerDescription.h.


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