{-# LANGUAGE DeriveDataTypeable #-} {-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE TypeFamilies #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Network.AWS.IAM.CreateRole -- Copyright : (c) 2013-2018 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Creates a new role for your AWS account. For more information about roles, go to . For information about limitations on role names and the number of roles you can create, go to in the /IAM User Guide/ . -- -- module Network.AWS.IAM.CreateRole ( -- * Creating a Request createRole , CreateRole -- * Request Lenses , crMaxSessionDuration , crPath , crDescription , crRoleName , crAssumeRolePolicyDocument -- * Destructuring the Response , createRoleResponse , CreateRoleResponse -- * Response Lenses , crrsResponseStatus , crrsRole ) where import Network.AWS.IAM.Types import Network.AWS.IAM.Types.Product import Network.AWS.Lens import Network.AWS.Prelude import Network.AWS.Request import Network.AWS.Response -- | /See:/ 'createRole' smart constructor. data CreateRole = CreateRole' { _crMaxSessionDuration :: !(Maybe Nat) , _crPath :: !(Maybe Text) , _crDescription :: !(Maybe Text) , _crRoleName :: !Text , _crAssumeRolePolicyDocument :: !Text } deriving (Eq, Read, Show, Data, Typeable, Generic) -- | Creates a value of 'CreateRole' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- -- * 'crMaxSessionDuration' - The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default maximum of one hour is applied. This setting can have a value from 1 hour to 12 hours. Anyone who assumes the role from the AWS CLI or API can use the @DurationSeconds@ API parameter or the @duration-seconds@ CLI parameter to request a longer session. The @MaxSessionDuration@ setting determines the maximum duration that can be requested using the @DurationSeconds@ parameter. If users don't specify a value for the @DurationSeconds@ parameter, their security credentials are valid for one hour by default. This applies when you use the @AssumeRole*@ API operations or the @assume-role*@ CLI operations but does not apply when you use those operations to create a console URL. For more information, see in the /IAM User Guide/ . -- -- * 'crPath' - The path to the role. For more information about paths, see in the /IAM User Guide/ . This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (per its ) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters. -- -- * 'crDescription' - A description of the role. -- -- * 'crRoleName' - The name of the role to create. This parameter allows (per its ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- Role names are not distinguished by case. For example, you cannot create roles named both "PRODROLE" and "prodrole". -- -- * 'crAssumeRolePolicyDocument' - The trust relationship policy document that grants an entity permission to assume the role. The used to validate this parameter is a string of characters consisting of the following: * Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range * The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF) * The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D) createRole :: Text -- ^ 'crRoleName' -> Text -- ^ 'crAssumeRolePolicyDocument' -> CreateRole createRole pRoleName_ pAssumeRolePolicyDocument_ = CreateRole' { _crMaxSessionDuration = Nothing , _crPath = Nothing , _crDescription = Nothing , _crRoleName = pRoleName_ , _crAssumeRolePolicyDocument = pAssumeRolePolicyDocument_ } -- | The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default maximum of one hour is applied. This setting can have a value from 1 hour to 12 hours. Anyone who assumes the role from the AWS CLI or API can use the @DurationSeconds@ API parameter or the @duration-seconds@ CLI parameter to request a longer session. The @MaxSessionDuration@ setting determines the maximum duration that can be requested using the @DurationSeconds@ parameter. If users don't specify a value for the @DurationSeconds@ parameter, their security credentials are valid for one hour by default. This applies when you use the @AssumeRole*@ API operations or the @assume-role*@ CLI operations but does not apply when you use those operations to create a console URL. For more information, see in the /IAM User Guide/ . crMaxSessionDuration :: Lens' CreateRole (Maybe Natural) crMaxSessionDuration = lens _crMaxSessionDuration (\ s a -> s{_crMaxSessionDuration = a}) . mapping _Nat -- | The path to the role. For more information about paths, see in the /IAM User Guide/ . This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (per its ) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters. crPath :: Lens' CreateRole (Maybe Text) crPath = lens _crPath (\ s a -> s{_crPath = a}) -- | A description of the role. crDescription :: Lens' CreateRole (Maybe Text) crDescription = lens _crDescription (\ s a -> s{_crDescription = a}) -- | The name of the role to create. This parameter allows (per its ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- Role names are not distinguished by case. For example, you cannot create roles named both "PRODROLE" and "prodrole". crRoleName :: Lens' CreateRole Text crRoleName = lens _crRoleName (\ s a -> s{_crRoleName = a}) -- | The trust relationship policy document that grants an entity permission to assume the role. The used to validate this parameter is a string of characters consisting of the following: * Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range * The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF) * The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D) crAssumeRolePolicyDocument :: Lens' CreateRole Text crAssumeRolePolicyDocument = lens _crAssumeRolePolicyDocument (\ s a -> s{_crAssumeRolePolicyDocument = a}) instance AWSRequest CreateRole where type Rs CreateRole = CreateRoleResponse request = postQuery iam response = receiveXMLWrapper "CreateRoleResult" (\ s h x -> CreateRoleResponse' <$> (pure (fromEnum s)) <*> (x .@ "Role")) instance Hashable CreateRole where instance NFData CreateRole where instance ToHeaders CreateRole where toHeaders = const mempty instance ToPath CreateRole where toPath = const "/" instance ToQuery CreateRole where toQuery CreateRole'{..} = mconcat ["Action" =: ("CreateRole" :: ByteString), "Version" =: ("2010-05-08" :: ByteString), "MaxSessionDuration" =: _crMaxSessionDuration, "Path" =: _crPath, "Description" =: _crDescription, "RoleName" =: _crRoleName, "AssumeRolePolicyDocument" =: _crAssumeRolePolicyDocument] -- | Contains the response to a successful 'CreateRole' request. -- -- -- -- /See:/ 'createRoleResponse' smart constructor. data CreateRoleResponse = CreateRoleResponse' { _crrsResponseStatus :: !Int , _crrsRole :: !Role } deriving (Eq, Read, Show, Data, Typeable, Generic) -- | Creates a value of 'CreateRoleResponse' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- -- * 'crrsResponseStatus' - -- | The response status code. -- -- * 'crrsRole' - A structure containing details about the new role. createRoleResponse :: Int -- ^ 'crrsResponseStatus' -> Role -- ^ 'crrsRole' -> CreateRoleResponse createRoleResponse pResponseStatus_ pRole_ = CreateRoleResponse' {_crrsResponseStatus = pResponseStatus_, _crrsRole = pRole_} -- | -- | The response status code. crrsResponseStatus :: Lens' CreateRoleResponse Int crrsResponseStatus = lens _crrsResponseStatus (\ s a -> s{_crrsResponseStatus = a}) -- | A structure containing details about the new role. crrsRole :: Lens' CreateRoleResponse Role crrsRole = lens _crrsRole (\ s a -> s{_crrsRole = a}) instance NFData CreateRoleResponse where