amazonka-iam-1.4.5: Amazon Identity and Access Management SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.IAM.CreateSAMLProvider

Contents

Description

Creates an IAM resource that describes an identity provider (IdP) that supports SAML 2.0.

The SAML provider resource that you create with this operation can be used as a principal in an IAM role's trust policy to enable federated users who sign-in using the SAML IdP to assume the role. You can create an IAM role that supports Web-based single sign-on (SSO) to the AWS Management Console or one that supports API access to AWS.

When you create the SAML provider resource, you upload an a SAML metadata document that you get from your IdP and that includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that the IdP sends. You must generate the metadata document using the identity management software that is used as your organization's IdP.

For more information, see Enabling SAML 2.0 Federated Users to Access the AWS Management Console and About SAML 2.0-based Federation in the IAM User Guide .

Synopsis

Creating a Request

createSAMLProvider #

Creates a value of CreateSAMLProvider with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • csamlpSAMLMetadataDocument - An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP. For more information, see About SAML 2.0-based Federation in the IAM User Guide
  • csamlpName - The name of the provider to create. The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

data CreateSAMLProvider #

See: createSAMLProvider smart constructor.

Instances

Eq CreateSAMLProvider # 
Data CreateSAMLProvider # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateSAMLProvider -> c CreateSAMLProvider #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateSAMLProvider #

toConstr :: CreateSAMLProvider -> Constr #

dataTypeOf :: CreateSAMLProvider -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateSAMLProvider) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateSAMLProvider) #

gmapT :: (forall b. Data b => b -> b) -> CreateSAMLProvider -> CreateSAMLProvider #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateSAMLProvider -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateSAMLProvider -> r #

gmapQ :: (forall d. Data d => d -> u) -> CreateSAMLProvider -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateSAMLProvider -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateSAMLProvider -> m CreateSAMLProvider #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateSAMLProvider -> m CreateSAMLProvider #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateSAMLProvider -> m CreateSAMLProvider #

Read CreateSAMLProvider # 
Show CreateSAMLProvider # 
Generic CreateSAMLProvider # 
Hashable CreateSAMLProvider # 
NFData CreateSAMLProvider # 

Methods

rnf :: CreateSAMLProvider -> () #

AWSRequest CreateSAMLProvider # 
ToQuery CreateSAMLProvider # 
ToPath CreateSAMLProvider # 
ToHeaders CreateSAMLProvider # 
type Rep CreateSAMLProvider # 
type Rep CreateSAMLProvider = D1 (MetaData "CreateSAMLProvider" "Network.AWS.IAM.CreateSAMLProvider" "amazonka-iam-1.4.5-1ijrgQyRuWgA7Tx0390Dx2" False) (C1 (MetaCons "CreateSAMLProvider'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_csamlpSAMLMetadataDocument") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_csamlpName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs CreateSAMLProvider # 

Request Lenses

csamlpSAMLMetadataDocument :: Lens' CreateSAMLProvider Text #

An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP. For more information, see About SAML 2.0-based Federation in the IAM User Guide

csamlpName :: Lens' CreateSAMLProvider Text #

The name of the provider to create. The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Destructuring the Response

createSAMLProviderResponse #

Creates a value of CreateSAMLProviderResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data CreateSAMLProviderResponse #

Contains the response to a successful CreateSAMLProvider request.

See: createSAMLProviderResponse smart constructor.

Instances

Eq CreateSAMLProviderResponse # 
Data CreateSAMLProviderResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateSAMLProviderResponse -> c CreateSAMLProviderResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateSAMLProviderResponse #

toConstr :: CreateSAMLProviderResponse -> Constr #

dataTypeOf :: CreateSAMLProviderResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateSAMLProviderResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateSAMLProviderResponse) #

gmapT :: (forall b. Data b => b -> b) -> CreateSAMLProviderResponse -> CreateSAMLProviderResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateSAMLProviderResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateSAMLProviderResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> CreateSAMLProviderResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateSAMLProviderResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateSAMLProviderResponse -> m CreateSAMLProviderResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateSAMLProviderResponse -> m CreateSAMLProviderResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateSAMLProviderResponse -> m CreateSAMLProviderResponse #

Read CreateSAMLProviderResponse # 
Show CreateSAMLProviderResponse # 
Generic CreateSAMLProviderResponse # 
NFData CreateSAMLProviderResponse # 
type Rep CreateSAMLProviderResponse # 
type Rep CreateSAMLProviderResponse = D1 (MetaData "CreateSAMLProviderResponse" "Network.AWS.IAM.CreateSAMLProvider" "amazonka-iam-1.4.5-1ijrgQyRuWgA7Tx0390Dx2" False) (C1 (MetaCons "CreateSAMLProviderResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_csamlprsSAMLProviderARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_csamlprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

csamlprsSAMLProviderARN :: Lens' CreateSAMLProviderResponse (Maybe Text) #

The Amazon Resource Name (ARN) of the new SAML provider resource in IAM.