Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.OpenSearch.Types.CognitoOptions

Description

Synopsis

Documentation

data CognitoOptions Source #

Container for the parameters required to enable Cognito authentication for an OpenSearch Service domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

See: newCognitoOptions smart constructor.

Constructors

CognitoOptions'

Fields

enabled :: Maybe Bool
Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.
identityPoolId :: Maybe Text
The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
roleArn :: Maybe Text
The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.
userPoolId :: Maybe Text
The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

Instances

Instances details

FromJSON CognitoOptions Source #
Instance details Defined in Amazonka.OpenSearch.Types.CognitoOptions Methods parseJSON :: Value -> Parser CognitoOptions # parseJSONList :: Value -> Parser [CognitoOptions] #
ToJSON CognitoOptions Source #
Instance details Defined in Amazonka.OpenSearch.Types.CognitoOptions Methods toJSON :: CognitoOptions -> Value # toEncoding :: CognitoOptions -> Encoding # toJSONList :: [CognitoOptions] -> Value # toEncodingList :: [CognitoOptions] -> Encoding #
Generic CognitoOptions Source #
Instance details Defined in Amazonka.OpenSearch.Types.CognitoOptions Associated Types type Rep CognitoOptions :: Type -> Type # Methods from :: CognitoOptions -> Rep CognitoOptions x # to :: Rep CognitoOptions x -> CognitoOptions #
Read CognitoOptions Source #
Instance details Defined in Amazonka.OpenSearch.Types.CognitoOptions Methods readsPrec :: Int -> ReadS CognitoOptions # readList :: ReadS [CognitoOptions] # readPrec :: ReadPrec CognitoOptions # readListPrec :: ReadPrec [CognitoOptions] #
Show CognitoOptions Source #
Instance details Defined in Amazonka.OpenSearch.Types.CognitoOptions Methods showsPrec :: Int -> CognitoOptions -> ShowS # show :: CognitoOptions -> String # showList :: [CognitoOptions] -> ShowS #
NFData CognitoOptions Source #
Instance details Defined in Amazonka.OpenSearch.Types.CognitoOptions Methods rnf :: CognitoOptions -> () #
Eq CognitoOptions Source #
Instance details Defined in Amazonka.OpenSearch.Types.CognitoOptions Methods (==) :: CognitoOptions -> CognitoOptions -> Bool # (/=) :: CognitoOptions -> CognitoOptions -> Bool #
Hashable CognitoOptions Source #
Instance details Defined in Amazonka.OpenSearch.Types.CognitoOptions Methods hashWithSalt :: Int -> CognitoOptions -> Int # hash :: CognitoOptions -> Int #
type Rep CognitoOptions Source #
Instance details Defined in Amazonka.OpenSearch.Types.CognitoOptions type Rep CognitoOptions = D1 ('MetaData "CognitoOptions" "Amazonka.OpenSearch.Types.CognitoOptions" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" '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 Source #

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 - Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.

$sel:identityPoolId:CognitoOptions', cognitoOptions_identityPoolId - The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

$sel:roleArn:CognitoOptions', cognitoOptions_roleArn - The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.

$sel:userPoolId:CognitoOptions', cognitoOptions_userPoolId - The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

cognitoOptions_enabled :: Lens' CognitoOptions (Maybe Bool) Source #

Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.

cognitoOptions_identityPoolId :: Lens' CognitoOptions (Maybe Text) Source #

The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

cognitoOptions_roleArn :: Lens' CognitoOptions (Maybe Text) Source #

The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.

cognitoOptions_userPoolId :: Lens' CognitoOptions (Maybe Text) Source #

The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.