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.OpenSearchServerless.CreateSecurityConfig

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Specifies a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.

Synopsis

Creating a Request

data CreateSecurityConfig Source #

See: newCreateSecurityConfig smart constructor.

Constructors

CreateSecurityConfig'
Fields clientToken :: Maybe Text Unique, case-sensitive identifier to ensure idempotency of the request. description :: Maybe Text A description of the security configuration. samlOptions :: Maybe SamlConfigOptions Describes SAML options in in the form of a key-value map. name :: Text The name of the security configuration. type' :: SecurityConfigType The type of security configuration.

Instances

Instances details

ToJSON CreateSecurityConfig Source #
Instance details Defined in Amazonka.OpenSearchServerless.CreateSecurityConfig Methods toJSON :: CreateSecurityConfig -> Value # toEncoding :: CreateSecurityConfig -> Encoding # toJSONList :: [CreateSecurityConfig] -> Value # toEncodingList :: [CreateSecurityConfig] -> Encoding #
ToHeaders CreateSecurityConfig Source #
Instance details Defined in Amazonka.OpenSearchServerless.CreateSecurityConfig Methods toHeaders :: CreateSecurityConfig -> [Header] #
ToPath CreateSecurityConfig Source #
Instance details Defined in Amazonka.OpenSearchServerless.CreateSecurityConfig Methods toPath :: CreateSecurityConfig -> ByteString #
ToQuery CreateSecurityConfig Source #
Instance details Defined in Amazonka.OpenSearchServerless.CreateSecurityConfig Methods toQuery :: CreateSecurityConfig -> QueryString #
AWSRequest CreateSecurityConfig Source #
Instance details Defined in Amazonka.OpenSearchServerless.CreateSecurityConfig Associated Types type AWSResponse CreateSecurityConfig # Methods request :: (Service -> Service) -> CreateSecurityConfig -> Request CreateSecurityConfig # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateSecurityConfig -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateSecurityConfig))) #
Generic CreateSecurityConfig Source #
Instance details Defined in Amazonka.OpenSearchServerless.CreateSecurityConfig Associated Types type Rep CreateSecurityConfig :: Type -> Type # Methods from :: CreateSecurityConfig -> Rep CreateSecurityConfig x # to :: Rep CreateSecurityConfig x -> CreateSecurityConfig #
Read CreateSecurityConfig Source #
Instance details Defined in Amazonka.OpenSearchServerless.CreateSecurityConfig Methods readsPrec :: Int -> ReadS CreateSecurityConfig # readList :: ReadS [CreateSecurityConfig] # readPrec :: ReadPrec CreateSecurityConfig # readListPrec :: ReadPrec [CreateSecurityConfig] #
Show CreateSecurityConfig Source #
Instance details Defined in Amazonka.OpenSearchServerless.CreateSecurityConfig Methods showsPrec :: Int -> CreateSecurityConfig -> ShowS # show :: CreateSecurityConfig -> String # showList :: [CreateSecurityConfig] -> ShowS #
NFData CreateSecurityConfig Source #
Instance details Defined in Amazonka.OpenSearchServerless.CreateSecurityConfig Methods rnf :: CreateSecurityConfig -> () #
Eq CreateSecurityConfig Source #
Instance details Defined in Amazonka.OpenSearchServerless.CreateSecurityConfig Methods (==) :: CreateSecurityConfig -> CreateSecurityConfig -> Bool # (/=) :: CreateSecurityConfig -> CreateSecurityConfig -> Bool #
Hashable CreateSecurityConfig Source #
Instance details Defined in Amazonka.OpenSearchServerless.CreateSecurityConfig Methods hashWithSalt :: Int -> CreateSecurityConfig -> Int # hash :: CreateSecurityConfig -> Int #
type AWSResponse CreateSecurityConfig Source #
Instance details Defined in Amazonka.OpenSearchServerless.CreateSecurityConfig type AWSResponse CreateSecurityConfig = CreateSecurityConfigResponse
type Rep CreateSecurityConfig Source #
Instance details Defined in Amazonka.OpenSearchServerless.CreateSecurityConfig type Rep CreateSecurityConfig = D1 ('MetaData "CreateSecurityConfig" "Amazonka.OpenSearchServerless.CreateSecurityConfig" "amazonka-opensearchserverless-2.0-HnbMYszmsxrAMKjbvSoFws" 'False) (C1 ('MetaCons "CreateSecurityConfig'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "samlOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SamlConfigOptions)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SecurityConfigType)))))

newCreateSecurityConfig Source #

Arguments

:: Text	`CreateSecurityConfig`
-> SecurityConfigType	`CreateSecurityConfig`
-> CreateSecurityConfig

Create a value of CreateSecurityConfig 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:clientToken:CreateSecurityConfig', createSecurityConfig_clientToken - Unique, case-sensitive identifier to ensure idempotency of the request.

CreateSecurityConfig, createSecurityConfig_description - A description of the security configuration.

CreateSecurityConfig, createSecurityConfig_samlOptions - Describes SAML options in in the form of a key-value map.

CreateSecurityConfig, createSecurityConfig_name - The name of the security configuration.

CreateSecurityConfig, createSecurityConfig_type - The type of security configuration.

Request Lenses

createSecurityConfig_clientToken :: Lens' CreateSecurityConfig (Maybe Text) Source #

Unique, case-sensitive identifier to ensure idempotency of the request.

createSecurityConfig_description :: Lens' CreateSecurityConfig (Maybe Text) Source #

A description of the security configuration.

createSecurityConfig_samlOptions :: Lens' CreateSecurityConfig (Maybe SamlConfigOptions) Source #

Describes SAML options in in the form of a key-value map.

createSecurityConfig_name :: Lens' CreateSecurityConfig Text Source #

The name of the security configuration.

createSecurityConfig_type :: Lens' CreateSecurityConfig SecurityConfigType Source #

The type of security configuration.

Destructuring the Response

data CreateSecurityConfigResponse Source #

See: newCreateSecurityConfigResponse smart constructor.

Constructors

CreateSecurityConfigResponse'
Fields securityConfigDetail :: Maybe SecurityConfigDetail Details about the created security configuration. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateSecurityConfigResponse Source #
Instance details Defined in Amazonka.OpenSearchServerless.CreateSecurityConfig Associated Types type Rep CreateSecurityConfigResponse :: Type -> Type # Methods from :: CreateSecurityConfigResponse -> Rep CreateSecurityConfigResponse x # to :: Rep CreateSecurityConfigResponse x -> CreateSecurityConfigResponse #
Read CreateSecurityConfigResponse Source #
Instance details Defined in Amazonka.OpenSearchServerless.CreateSecurityConfig Methods readsPrec :: Int -> ReadS CreateSecurityConfigResponse # readList :: ReadS [CreateSecurityConfigResponse] # readPrec :: ReadPrec CreateSecurityConfigResponse # readListPrec :: ReadPrec [CreateSecurityConfigResponse] #
Show CreateSecurityConfigResponse Source #
Instance details Defined in Amazonka.OpenSearchServerless.CreateSecurityConfig Methods showsPrec :: Int -> CreateSecurityConfigResponse -> ShowS # show :: CreateSecurityConfigResponse -> String # showList :: [CreateSecurityConfigResponse] -> ShowS #
NFData CreateSecurityConfigResponse Source #
Instance details Defined in Amazonka.OpenSearchServerless.CreateSecurityConfig Methods rnf :: CreateSecurityConfigResponse -> () #
Eq CreateSecurityConfigResponse Source #
Instance details Defined in Amazonka.OpenSearchServerless.CreateSecurityConfig Methods (==) :: CreateSecurityConfigResponse -> CreateSecurityConfigResponse -> Bool # (/=) :: CreateSecurityConfigResponse -> CreateSecurityConfigResponse -> Bool #
type Rep CreateSecurityConfigResponse Source #
Instance details Defined in Amazonka.OpenSearchServerless.CreateSecurityConfig type Rep CreateSecurityConfigResponse = D1 ('MetaData "CreateSecurityConfigResponse" "Amazonka.OpenSearchServerless.CreateSecurityConfig" "amazonka-opensearchserverless-2.0-HnbMYszmsxrAMKjbvSoFws" 'False) (C1 ('MetaCons "CreateSecurityConfigResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "securityConfigDetail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SecurityConfigDetail)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateSecurityConfigResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateSecurityConfigResponse'`
-> CreateSecurityConfigResponse

Create a value of CreateSecurityConfigResponse 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:securityConfigDetail:CreateSecurityConfigResponse', createSecurityConfigResponse_securityConfigDetail - Details about the created security configuration.

$sel:httpStatus:CreateSecurityConfigResponse', createSecurityConfigResponse_httpStatus - The response's http status code.

Response Lenses

createSecurityConfigResponse_securityConfigDetail :: Lens' CreateSecurityConfigResponse (Maybe SecurityConfigDetail) Source #

Details about the created security configuration.

createSecurityConfigResponse_httpStatus :: Lens' CreateSecurityConfigResponse Int Source #

The response's http status code.