Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Adds a grant to a key to specify who can use the key and under what conditions. Grants are alternate permission mechanisms to key policies.
For more information about grants, see Grants in the AWS Key Management Service Developer Guide.
See: AWS API Reference for CreateGrant.
- createGrant :: Text -> Text -> CreateGrant
- data CreateGrant
- cgRetiringPrincipal :: Lens' CreateGrant (Maybe Text)
- cgGrantTokens :: Lens' CreateGrant [Text]
- cgConstraints :: Lens' CreateGrant (Maybe GrantConstraints)
- cgName :: Lens' CreateGrant (Maybe Text)
- cgOperations :: Lens' CreateGrant [GrantOperation]
- cgKeyId :: Lens' CreateGrant Text
- cgGranteePrincipal :: Lens' CreateGrant Text
- createGrantResponse :: Int -> CreateGrantResponse
- data CreateGrantResponse
- cgrsGrantId :: Lens' CreateGrantResponse (Maybe Text)
- cgrsGrantToken :: Lens' CreateGrantResponse (Maybe Text)
- cgrsResponseStatus :: Lens' CreateGrantResponse Int
Creating a Request
Creates a value of CreateGrant
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data CreateGrant Source
See: createGrant
smart constructor.
Request Lenses
cgRetiringPrincipal :: Lens' CreateGrant (Maybe Text) Source
The principal that is given permission to retire the grant by using RetireGrant operation.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
cgGrantTokens :: Lens' CreateGrant [Text] Source
A list of grant tokens.
For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.
cgConstraints :: Lens' CreateGrant (Maybe GrantConstraints) Source
The conditions under which the operations permitted by the grant are allowed.
You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
cgName :: Lens' CreateGrant (Maybe Text) Source
A friendly name for identifying the grant. Use this value to prevent unintended creation of duplicate grants when retrying this request.
When this value is absent, all CreateGrant
requests result in a new
grant with a unique GrantId
even if all the supplied parameters are
identical. This can result in unintended duplicates when you retry the
CreateGrant
request.
When this value is present, you can retry a CreateGrant
request with
identical parameters; if the grant already exists, the original
GrantId
is returned without creating a new grant. Note that the
returned grant token is unique with every CreateGrant
request, even
when a duplicate GrantId
is returned. All grant tokens obtained in
this way can be used interchangeably.
cgOperations :: Lens' CreateGrant [GrantOperation] Source
A list of operations that the grant permits. The list can contain any combination of one or more of the following values:
- Decrypt
- Encrypt
- GenerateDataKey
- GenerateDataKeyWithoutPlaintext
- ReEncryptFrom
- ReEncryptTo
- CreateGrant
- RetireGrant
cgKeyId :: Lens' CreateGrant Text Source
The unique identifier for the customer master key (CMK) that the grant applies to.
To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:
- Globally unique key ID: 12345678-1234-1234-1234-123456789012
- Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012
cgGranteePrincipal :: Lens' CreateGrant Text Source
The principal that is given permission to perform the operations that the grant permits.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
Destructuring the Response
Creates a value of CreateGrantResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data CreateGrantResponse Source
See: createGrantResponse
smart constructor.
Response Lenses
cgrsGrantId :: Lens' CreateGrantResponse (Maybe Text) Source
The unique identifier for the grant.
You can use the GrantId
in a subsequent RetireGrant or RevokeGrant
operation.
cgrsGrantToken :: Lens' CreateGrantResponse (Maybe Text) Source
The grant token.
For more information about using grant tokens, see Grant Tokens in the AWS Key Management Service Developer Guide.
cgrsResponseStatus :: Lens' CreateGrantResponse Int Source
The response status code.