Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Creates a new role for your AWS account. For more information about roles, go to IAM Roles . For information about limitations on role names and the number of roles you can create, go to Limitations on IAM Entities in the IAM User Guide .
Synopsis
- createRole :: Text -> Text -> CreateRole
- data CreateRole
- crMaxSessionDuration :: Lens' CreateRole (Maybe Natural)
- crPath :: Lens' CreateRole (Maybe Text)
- crDescription :: Lens' CreateRole (Maybe Text)
- crRoleName :: Lens' CreateRole Text
- crAssumeRolePolicyDocument :: Lens' CreateRole Text
- createRoleResponse :: Int -> Role -> CreateRoleResponse
- data CreateRoleResponse
- crrsResponseStatus :: Lens' CreateRoleResponse Int
- crrsRole :: Lens' CreateRoleResponse Role
Creating a Request
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 theDurationSeconds
API parameter or theduration-seconds
CLI parameter to request a longer session. TheMaxSessionDuration
setting determines the maximum duration that can be requested using theDurationSeconds
parameter. If users don't specify a value for theDurationSeconds
parameter, their security credentials are valid for one hour by default. This applies when you use theAssumeRole*
API operations or theassume-role*
CLI operations but does not apply when you use those operations to create a console URL. For more information, see Using IAM Roles in the IAM User Guide .crPath
- The path to the role. For more information about paths, see IAM Identifiers in the IAM User Guide . This parameter is optional. If it is not included, it defaults to a slash (). This parameter allows (per its <http:wikipedia.orgwikiregex regex pattern> ) 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 regex pattern ) 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 regex pattern 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)
data CreateRole Source #
See: createRole
smart constructor.
Instances
Request Lenses
crMaxSessionDuration :: Lens' CreateRole (Maybe Natural) Source #
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 Using IAM Roles in the IAM User Guide .
crPath :: Lens' CreateRole (Maybe Text) Source #
The path to the role. For more information about paths, see IAM Identifiers in the IAM User Guide . This parameter is optional. If it is not included, it defaults to a slash (). This parameter allows (per its <http:wikipedia.orgwikiregex regex pattern> ) 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 :: Lens' CreateRole (Maybe Text) Source #
A description of the role.
crRoleName :: Lens' CreateRole Text Source #
The name of the role to create. This parameter allows (per its regex pattern ) 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 :: Lens' CreateRole Text Source #
The trust relationship policy document that grants an entity permission to assume the role. The regex pattern 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)
Destructuring the Response
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.
data CreateRoleResponse Source #
Contains the response to a successful CreateRole
request.
See: createRoleResponse
smart constructor.
Instances
Response Lenses
crrsResponseStatus :: Lens' CreateRoleResponse Int Source #
- - | The response status code.