AWS SDK for C++  1.8.76
AWS SDK for C++
Public Member Functions | List of all members
Aws::ElasticsearchService::Model::CognitoOptions Class Reference

#include <CognitoOptions.h>

Public Member Functions

 CognitoOptions ()
 
 CognitoOptions (Aws::Utils::Json::JsonView jsonValue)
 
CognitoOptionsoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
bool GetEnabled () const
 
bool EnabledHasBeenSet () const
 
void SetEnabled (bool value)
 
CognitoOptionsWithEnabled (bool value)
 
const Aws::StringGetUserPoolId () const
 
bool UserPoolIdHasBeenSet () const
 
void SetUserPoolId (const Aws::String &value)
 
void SetUserPoolId (Aws::String &&value)
 
void SetUserPoolId (const char *value)
 
CognitoOptionsWithUserPoolId (const Aws::String &value)
 
CognitoOptionsWithUserPoolId (Aws::String &&value)
 
CognitoOptionsWithUserPoolId (const char *value)
 
const Aws::StringGetIdentityPoolId () const
 
bool IdentityPoolIdHasBeenSet () const
 
void SetIdentityPoolId (const Aws::String &value)
 
void SetIdentityPoolId (Aws::String &&value)
 
void SetIdentityPoolId (const char *value)
 
CognitoOptionsWithIdentityPoolId (const Aws::String &value)
 
CognitoOptionsWithIdentityPoolId (Aws::String &&value)
 
CognitoOptionsWithIdentityPoolId (const char *value)
 
const Aws::StringGetRoleArn () const
 
bool RoleArnHasBeenSet () const
 
void SetRoleArn (const Aws::String &value)
 
void SetRoleArn (Aws::String &&value)
 
void SetRoleArn (const char *value)
 
CognitoOptionsWithRoleArn (const Aws::String &value)
 
CognitoOptionsWithRoleArn (Aws::String &&value)
 
CognitoOptionsWithRoleArn (const char *value)
 

Detailed Description

Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.

See Also:

AWS API Reference

Definition at line 35 of file CognitoOptions.h.

Constructor & Destructor Documentation

◆ CognitoOptions() [1/2]

Aws::ElasticsearchService::Model::CognitoOptions::CognitoOptions ( )

◆ CognitoOptions() [2/2]

Aws::ElasticsearchService::Model::CognitoOptions::CognitoOptions ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ EnabledHasBeenSet()

bool Aws::ElasticsearchService::Model::CognitoOptions::EnabledHasBeenSet ( ) const
inline

Specifies the option to enable Cognito for Kibana authentication.

Definition at line 52 of file CognitoOptions.h.

◆ GetEnabled()

bool Aws::ElasticsearchService::Model::CognitoOptions::GetEnabled ( ) const
inline

Specifies the option to enable Cognito for Kibana authentication.

Definition at line 47 of file CognitoOptions.h.

◆ GetIdentityPoolId()

const Aws::String& Aws::ElasticsearchService::Model::CognitoOptions::GetIdentityPoolId ( ) const
inline

Specifies the Cognito identity pool ID for Kibana authentication.

Definition at line 109 of file CognitoOptions.h.

◆ GetRoleArn()

const Aws::String& Aws::ElasticsearchService::Model::CognitoOptions::GetRoleArn ( ) const
inline

Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.

Definition at line 151 of file CognitoOptions.h.

◆ GetUserPoolId()

const Aws::String& Aws::ElasticsearchService::Model::CognitoOptions::GetUserPoolId ( ) const
inline

Specifies the Cognito user pool ID for Kibana authentication.

Definition at line 68 of file CognitoOptions.h.

◆ IdentityPoolIdHasBeenSet()

bool Aws::ElasticsearchService::Model::CognitoOptions::IdentityPoolIdHasBeenSet ( ) const
inline

Specifies the Cognito identity pool ID for Kibana authentication.

Definition at line 114 of file CognitoOptions.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::ElasticsearchService::Model::CognitoOptions::Jsonize ( ) const

◆ operator=()

CognitoOptions& Aws::ElasticsearchService::Model::CognitoOptions::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ RoleArnHasBeenSet()

bool Aws::ElasticsearchService::Model::CognitoOptions::RoleArnHasBeenSet ( ) const
inline

Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.

Definition at line 157 of file CognitoOptions.h.

◆ SetEnabled()

void Aws::ElasticsearchService::Model::CognitoOptions::SetEnabled ( bool  value)
inline

Specifies the option to enable Cognito for Kibana authentication.

Definition at line 57 of file CognitoOptions.h.

◆ SetIdentityPoolId() [1/3]

void Aws::ElasticsearchService::Model::CognitoOptions::SetIdentityPoolId ( const Aws::String value)
inline

Specifies the Cognito identity pool ID for Kibana authentication.

Definition at line 119 of file CognitoOptions.h.

◆ SetIdentityPoolId() [2/3]

void Aws::ElasticsearchService::Model::CognitoOptions::SetIdentityPoolId ( Aws::String &&  value)
inline

Specifies the Cognito identity pool ID for Kibana authentication.

Definition at line 124 of file CognitoOptions.h.

◆ SetIdentityPoolId() [3/3]

void Aws::ElasticsearchService::Model::CognitoOptions::SetIdentityPoolId ( const char *  value)
inline

Specifies the Cognito identity pool ID for Kibana authentication.

Definition at line 129 of file CognitoOptions.h.

◆ SetRoleArn() [1/3]

void Aws::ElasticsearchService::Model::CognitoOptions::SetRoleArn ( const Aws::String value)
inline

Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.

Definition at line 163 of file CognitoOptions.h.

◆ SetRoleArn() [2/3]

void Aws::ElasticsearchService::Model::CognitoOptions::SetRoleArn ( Aws::String &&  value)
inline

Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.

Definition at line 169 of file CognitoOptions.h.

◆ SetRoleArn() [3/3]

void Aws::ElasticsearchService::Model::CognitoOptions::SetRoleArn ( const char *  value)
inline

Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.

Definition at line 175 of file CognitoOptions.h.

◆ SetUserPoolId() [1/3]

void Aws::ElasticsearchService::Model::CognitoOptions::SetUserPoolId ( const Aws::String value)
inline

Specifies the Cognito user pool ID for Kibana authentication.

Definition at line 78 of file CognitoOptions.h.

◆ SetUserPoolId() [2/3]

void Aws::ElasticsearchService::Model::CognitoOptions::SetUserPoolId ( Aws::String &&  value)
inline

Specifies the Cognito user pool ID for Kibana authentication.

Definition at line 83 of file CognitoOptions.h.

◆ SetUserPoolId() [3/3]

void Aws::ElasticsearchService::Model::CognitoOptions::SetUserPoolId ( const char *  value)
inline

Specifies the Cognito user pool ID for Kibana authentication.

Definition at line 88 of file CognitoOptions.h.

◆ UserPoolIdHasBeenSet()

bool Aws::ElasticsearchService::Model::CognitoOptions::UserPoolIdHasBeenSet ( ) const
inline

Specifies the Cognito user pool ID for Kibana authentication.

Definition at line 73 of file CognitoOptions.h.

◆ WithEnabled()

CognitoOptions& Aws::ElasticsearchService::Model::CognitoOptions::WithEnabled ( bool  value)
inline

Specifies the option to enable Cognito for Kibana authentication.

Definition at line 62 of file CognitoOptions.h.

◆ WithIdentityPoolId() [1/3]

CognitoOptions& Aws::ElasticsearchService::Model::CognitoOptions::WithIdentityPoolId ( const Aws::String value)
inline

Specifies the Cognito identity pool ID for Kibana authentication.

Definition at line 134 of file CognitoOptions.h.

◆ WithIdentityPoolId() [2/3]

CognitoOptions& Aws::ElasticsearchService::Model::CognitoOptions::WithIdentityPoolId ( Aws::String &&  value)
inline

Specifies the Cognito identity pool ID for Kibana authentication.

Definition at line 139 of file CognitoOptions.h.

◆ WithIdentityPoolId() [3/3]

CognitoOptions& Aws::ElasticsearchService::Model::CognitoOptions::WithIdentityPoolId ( const char *  value)
inline

Specifies the Cognito identity pool ID for Kibana authentication.

Definition at line 144 of file CognitoOptions.h.

◆ WithRoleArn() [1/3]

CognitoOptions& Aws::ElasticsearchService::Model::CognitoOptions::WithRoleArn ( const Aws::String value)
inline

Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.

Definition at line 181 of file CognitoOptions.h.

◆ WithRoleArn() [2/3]

CognitoOptions& Aws::ElasticsearchService::Model::CognitoOptions::WithRoleArn ( Aws::String &&  value)
inline

Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.

Definition at line 187 of file CognitoOptions.h.

◆ WithRoleArn() [3/3]

CognitoOptions& Aws::ElasticsearchService::Model::CognitoOptions::WithRoleArn ( const char *  value)
inline

Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.

Definition at line 193 of file CognitoOptions.h.

◆ WithUserPoolId() [1/3]

CognitoOptions& Aws::ElasticsearchService::Model::CognitoOptions::WithUserPoolId ( const Aws::String value)
inline

Specifies the Cognito user pool ID for Kibana authentication.

Definition at line 93 of file CognitoOptions.h.

◆ WithUserPoolId() [2/3]

CognitoOptions& Aws::ElasticsearchService::Model::CognitoOptions::WithUserPoolId ( Aws::String &&  value)
inline

Specifies the Cognito user pool ID for Kibana authentication.

Definition at line 98 of file CognitoOptions.h.

◆ WithUserPoolId() [3/3]

CognitoOptions& Aws::ElasticsearchService::Model::CognitoOptions::WithUserPoolId ( const char *  value)
inline

Specifies the Cognito user pool ID for Kibana authentication.

Definition at line 103 of file CognitoOptions.h.


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