Amazonka.ElasticSearch.Types.CognitoOptions

Documentation

data CognitoOptions

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

See: newCognitoOptions smart constructor.

Constructors

CognitoOptions'

Fields

• enabled :: Maybe Bool

  Specifies the option to enable Cognito for Kibana authentication.

• identityPoolId :: Maybe Text

  Specifies the Cognito identity pool ID for Kibana authentication.

• roleArn :: Maybe Text

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

• userPoolId :: Maybe Text

  Specifies the Cognito user pool ID for Kibana authentication.

Instances

FromJSON CognitoOptions

Defined in Amazonka.ElasticSearch.Types.CognitoOptions

Methods

parseJSON :: Value -> Parser CognitoOptions

parseJSONList :: Value -> Parser [CognitoOptions]

ToJSON CognitoOptions

Defined in Amazonka.ElasticSearch.Types.CognitoOptions

Methods

toJSON :: CognitoOptions -> Value

toEncoding :: CognitoOptions -> Encoding

toJSONList :: [CognitoOptions] -> Value

toEncodingList :: [CognitoOptions] -> Encoding

Generic CognitoOptions

Defined in Amazonka.ElasticSearch.Types.CognitoOptions

Associated Types

type Rep CognitoOptions :: Type -> Type

Methods

from :: CognitoOptions -> Rep CognitoOptions x

to :: Rep CognitoOptions x -> CognitoOptions

Read CognitoOptions

Defined in Amazonka.ElasticSearch.Types.CognitoOptions

Methods

readsPrec :: Int -> ReadS CognitoOptions

readList :: ReadS [CognitoOptions]

readPrec :: ReadPrec CognitoOptions

readListPrec :: ReadPrec [CognitoOptions]

Show CognitoOptions

Defined in Amazonka.ElasticSearch.Types.CognitoOptions

Methods

showsPrec :: Int -> CognitoOptions -> ShowS

show :: CognitoOptions -> String

showList :: [CognitoOptions] -> ShowS

NFData CognitoOptions

Defined in Amazonka.ElasticSearch.Types.CognitoOptions

Methods

rnf :: CognitoOptions -> ()

Eq CognitoOptions

Defined in Amazonka.ElasticSearch.Types.CognitoOptions

Methods

(==) :: CognitoOptions -> CognitoOptions -> Bool

(/=) :: CognitoOptions -> CognitoOptions -> Bool

Hashable CognitoOptions

Defined in Amazonka.ElasticSearch.Types.CognitoOptions

Methods

hashWithSalt :: Int -> CognitoOptions -> Int

hash :: CognitoOptions -> Int

type Rep CognitoOptions

Defined in Amazonka.ElasticSearch.Types.CognitoOptions

type Rep CognitoOptions = D1 ('MetaData "CognitoOptions" "Amazonka.ElasticSearch.Types.CognitoOptions" "amazonka-elasticsearch-2.0-BmZjovliTfgJWgrJ3fCf5z" 'False) (C1 ('MetaCons "CognitoOptions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "identityPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "userPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newCognitoOptions :: CognitoOptions

Create a value of CognitoOptions with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:enabled:CognitoOptions', cognitoOptions_enabled - Specifies the option to enable Cognito for Kibana authentication.

$sel:identityPoolId:CognitoOptions', cognitoOptions_identityPoolId - Specifies the Cognito identity pool ID for Kibana authentication.

$sel:roleArn:CognitoOptions', cognitoOptions_roleArn - Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.

$sel:userPoolId:CognitoOptions', cognitoOptions_userPoolId - Specifies the Cognito user pool ID for Kibana authentication.

cognitoOptions_enabled :: Lens' CognitoOptions (Maybe Bool)

Specifies the option to enable Cognito for Kibana authentication.

cognitoOptions_identityPoolId :: Lens' CognitoOptions (Maybe Text)

Specifies the Cognito identity pool ID for Kibana authentication.

cognitoOptions_roleArn :: Lens' CognitoOptions (Maybe Text)

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

cognitoOptions_userPoolId :: Lens' CognitoOptions (Maybe Text)

Specifies the Cognito user pool ID for Kibana authentication.