Copyright	(c) 2013-2021 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

Amazonka.KMS.CreateGrant

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Adds a grant to a KMS key.

A grant is a policy instrument that allows Amazon Web Services principals to use KMS keys in cryptographic operations. It also can allow them to view a KMS key (DescribeKey) and create and manage grants. When authorizing access to a KMS key, grants are considered along with key policies and IAM policies. Grants are often used for temporary permissions because you can create one, use its permissions, and delete it without changing your key policies or IAM policies.

For detailed information about grants, including grant terminology, see Using grants in the /Key Management Service Developer Guide/ . For examples of working with grants in several programming languages, see Programming grants.

The CreateGrant operation returns a GrantToken and a GrantId.

When you create, retire, or revoke a grant, there might be a brief delay, usually less than five minutes, until the grant is available throughout KMS. This state is known as eventual consistency. Once the grant has achieved eventual consistency, the grantee principal can use the permissions in the grant without identifying the grant.
However, to use the permissions in the grant immediately, use the GrantToken that CreateGrant returns. For details, see Using a grant token in the /Key Management Service Developer Guide/ .
The CreateGrant operation also returns a GrantId. You can use the GrantId and a key identifier to identify the grant in the RetireGrant and RevokeGrant operations. To find the grant ID, use the ListGrants or ListRetirableGrants operations.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key ARN in the value of the KeyId parameter.

Required permissions: kms:CreateGrant (key policy)

Related operations:

ListGrants
ListRetirableGrants
RetireGrant
RevokeGrant

Synopsis

data CreateGrant = CreateGrant' {
- retiringPrincipal :: Maybe Text
- grantTokens :: Maybe [Text]
- constraints :: Maybe GrantConstraints
- name :: Maybe Text
- keyId :: Text
- granteePrincipal :: Text
- operations :: [GrantOperation]
}
newCreateGrant :: Text -> Text -> CreateGrant
createGrant_retiringPrincipal :: Lens' CreateGrant (Maybe Text)
createGrant_grantTokens :: Lens' CreateGrant (Maybe [Text])
createGrant_constraints :: Lens' CreateGrant (Maybe GrantConstraints)
createGrant_name :: Lens' CreateGrant (Maybe Text)
createGrant_keyId :: Lens' CreateGrant Text
createGrant_granteePrincipal :: Lens' CreateGrant Text
createGrant_operations :: Lens' CreateGrant [GrantOperation]
data CreateGrantResponse = CreateGrantResponse' {
- grantId :: Maybe Text
- grantToken :: Maybe Text
- httpStatus :: Int
}
newCreateGrantResponse :: Int -> CreateGrantResponse
createGrantResponse_grantId :: Lens' CreateGrantResponse (Maybe Text)
createGrantResponse_grantToken :: Lens' CreateGrantResponse (Maybe Text)
createGrantResponse_httpStatus :: Lens' CreateGrantResponse Int

Creating a Request

data CreateGrant Source #

See: newCreateGrant smart constructor.

Constructors

CreateGrant'

Fields

retiringPrincipal :: Maybe Text
The principal that has permission to use the RetireGrant operation to retire the grant.
To specify the principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see Amazon Web Services Identity and Access Management (IAM) in the Example ARNs section of the /Amazon Web Services General Reference/.
The grant determines the retiring principal. Other principals might have permission to retire the grant or revoke the grant. For details, see RevokeGrant and Retiring and revoking grants in the Key Management Service Developer Guide.
grantTokens :: Maybe [Text]
A list of grant tokens.
Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.
constraints :: Maybe GrantConstraints
Specifies a grant constraint.
KMS supports the EncryptionContextEquals and EncryptionContextSubset grant constraints. Each constraint value can include up to 8 encryption context pairs. The encryption context value in each constraint cannot exceed 384 characters.
These grant constraints allow the permissions in the grant only when the encryption context in the request matches (EncryptionContextEquals) or includes (EncryptionContextSubset) the encryption context specified in this structure. For information about grant constraints, see Using grant constraints in the Key Management Service Developer Guide. For more information about encryption context, see Encryption Context in the /Key Management Service Developer Guide/ .
The encryption context grant constraints are supported only on operations that include an encryption context. You cannot use an encryption context grant constraint for cryptographic operations with asymmetric KMS keys or for management operations, such as DescribeKey or RetireGrant.
name :: Maybe Text
A friendly name for the grant. Use this value to prevent the 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 for the same grant ID can be used interchangeably.
keyId :: Text
Identifies the KMS key for the grant. The grant gives principals permission to use this KMS key.
Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.
For example:
- Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
granteePrincipal :: Text
The identity that gets the permissions specified in the grant.
To specify the principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see Amazon Web Services Identity and Access Management (IAM) in the Example ARNs section of the /Amazon Web Services General Reference/.
operations :: [GrantOperation]
A list of operations that the grant permits.
The operation must be supported on the KMS key. For example, you cannot create a grant for a symmetric KMS key that allows the Sign operation, or a grant for an asymmetric KMS key that allows the GenerateDataKey operation. If you try, KMS returns a ValidationError exception. For details, see Grant operations in the Key Management Service Developer Guide.

Instances

Instances details

Eq CreateGrant Source #
Instance details Defined in Amazonka.KMS.CreateGrant Methods (==) :: CreateGrant -> CreateGrant -> Bool # (/=) :: CreateGrant -> CreateGrant -> Bool #
Read CreateGrant Source #
Instance details Defined in Amazonka.KMS.CreateGrant Methods readsPrec :: Int -> ReadS CreateGrant # readList :: ReadS [CreateGrant] # readPrec :: ReadPrec CreateGrant # readListPrec :: ReadPrec [CreateGrant] #
Show CreateGrant Source #
Instance details Defined in Amazonka.KMS.CreateGrant Methods showsPrec :: Int -> CreateGrant -> ShowS # show :: CreateGrant -> String # showList :: [CreateGrant] -> ShowS #
Generic CreateGrant Source #
Instance details Defined in Amazonka.KMS.CreateGrant Associated Types type Rep CreateGrant :: Type -> Type # Methods from :: CreateGrant -> Rep CreateGrant x # to :: Rep CreateGrant x -> CreateGrant #
NFData CreateGrant Source #
Instance details Defined in Amazonka.KMS.CreateGrant Methods rnf :: CreateGrant -> () #
Hashable CreateGrant Source #
Instance details Defined in Amazonka.KMS.CreateGrant Methods hashWithSalt :: Int -> CreateGrant -> Int # hash :: CreateGrant -> Int #
ToJSON CreateGrant Source #
Instance details Defined in Amazonka.KMS.CreateGrant Methods toJSON :: CreateGrant -> Value # toEncoding :: CreateGrant -> Encoding # toJSONList :: [CreateGrant] -> Value # toEncodingList :: [CreateGrant] -> Encoding #
AWSRequest CreateGrant Source #
Instance details Defined in Amazonka.KMS.CreateGrant Associated Types type AWSResponse CreateGrant # Methods request :: CreateGrant -> Request CreateGrant # response :: MonadResource m => Logger -> Service -> Proxy CreateGrant -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateGrant))) #
ToHeaders CreateGrant Source #
Instance details Defined in Amazonka.KMS.CreateGrant Methods toHeaders :: CreateGrant -> [Header] #
ToPath CreateGrant Source #
Instance details Defined in Amazonka.KMS.CreateGrant Methods toPath :: CreateGrant -> ByteString #
ToQuery CreateGrant Source #
Instance details Defined in Amazonka.KMS.CreateGrant Methods toQuery :: CreateGrant -> QueryString #
type Rep CreateGrant Source #
Instance details Defined in Amazonka.KMS.CreateGrant type Rep CreateGrant = D1 ('MetaData "CreateGrant" "Amazonka.KMS.CreateGrant" "libZSservicesZSamazonka-kmsZSamazonka-kms" 'False) (C1 ('MetaCons "CreateGrant'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "retiringPrincipal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "grantTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "constraints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GrantConstraints)))) :: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "granteePrincipal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "operations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [GrantOperation])))))
type AWSResponse CreateGrant Source #
Instance details Defined in Amazonka.KMS.CreateGrant type AWSResponse CreateGrant = CreateGrantResponse

newCreateGrant Source #

Arguments

:: Text	`$sel:keyId:CreateGrant'`
-> Text	`$sel:granteePrincipal:CreateGrant'`
-> CreateGrant

Create a value of CreateGrant 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:retiringPrincipal:CreateGrant', createGrant_retiringPrincipal - The principal that has permission to use the RetireGrant operation to retire the grant.

To specify the principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see Amazon Web Services Identity and Access Management (IAM) in the Example ARNs section of the /Amazon Web Services General Reference/.

The grant determines the retiring principal. Other principals might have permission to retire the grant or revoke the grant. For details, see RevokeGrant and Retiring and revoking grants in the Key Management Service Developer Guide.

$sel:grantTokens:CreateGrant', createGrant_grantTokens - A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

$sel:constraints:CreateGrant', createGrant_constraints - Specifies a grant constraint.

KMS supports the EncryptionContextEquals and EncryptionContextSubset grant constraints. Each constraint value can include up to 8 encryption context pairs. The encryption context value in each constraint cannot exceed 384 characters.

These grant constraints allow the permissions in the grant only when the encryption context in the request matches (EncryptionContextEquals) or includes (EncryptionContextSubset) the encryption context specified in this structure. For information about grant constraints, see Using grant constraints in the Key Management Service Developer Guide. For more information about encryption context, see Encryption Context in the /Key Management Service Developer Guide/ .

The encryption context grant constraints are supported only on operations that include an encryption context. You cannot use an encryption context grant constraint for cryptographic operations with asymmetric KMS keys or for management operations, such as DescribeKey or RetireGrant.

$sel:name:CreateGrant', createGrant_name - A friendly name for the grant. Use this value to prevent the 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 for the same grant ID can be used interchangeably.

$sel:keyId:CreateGrant', createGrant_keyId - Identifies the KMS key for the grant. The grant gives principals permission to use this KMS key.

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.

For example:

Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

$sel:granteePrincipal:CreateGrant', createGrant_granteePrincipal - The identity that gets the permissions specified in the grant.

To specify the principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see Amazon Web Services Identity and Access Management (IAM) in the Example ARNs section of the /Amazon Web Services General Reference/.

$sel:operations:CreateGrant', createGrant_operations - A list of operations that the grant permits.

The operation must be supported on the KMS key. For example, you cannot create a grant for a symmetric KMS key that allows the Sign operation, or a grant for an asymmetric KMS key that allows the GenerateDataKey operation. If you try, KMS returns a ValidationError exception. For details, see Grant operations in the Key Management Service Developer Guide.

Request Lenses

createGrant_retiringPrincipal :: Lens' CreateGrant (Maybe Text) Source #

The principal that has permission to use the RetireGrant operation to retire the grant.

To specify the principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see Amazon Web Services Identity and Access Management (IAM) in the Example ARNs section of the /Amazon Web Services General Reference/.

The grant determines the retiring principal. Other principals might have permission to retire the grant or revoke the grant. For details, see RevokeGrant and Retiring and revoking grants in the Key Management Service Developer Guide.

createGrant_grantTokens :: Lens' CreateGrant (Maybe [Text]) Source #

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

createGrant_constraints :: Lens' CreateGrant (Maybe GrantConstraints) Source #

Specifies a grant constraint.

KMS supports the EncryptionContextEquals and EncryptionContextSubset grant constraints. Each constraint value can include up to 8 encryption context pairs. The encryption context value in each constraint cannot exceed 384 characters.

These grant constraints allow the permissions in the grant only when the encryption context in the request matches (EncryptionContextEquals) or includes (EncryptionContextSubset) the encryption context specified in this structure. For information about grant constraints, see Using grant constraints in the Key Management Service Developer Guide. For more information about encryption context, see Encryption Context in the /Key Management Service Developer Guide/ .

The encryption context grant constraints are supported only on operations that include an encryption context. You cannot use an encryption context grant constraint for cryptographic operations with asymmetric KMS keys or for management operations, such as DescribeKey or RetireGrant.

createGrant_name :: Lens' CreateGrant (Maybe Text) Source #

A friendly name for the grant. Use this value to prevent the 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 for the same grant ID can be used interchangeably.

createGrant_keyId :: Lens' CreateGrant Text Source #

Identifies the KMS key for the grant. The grant gives principals permission to use this KMS key.

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.

For example:

Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

createGrant_granteePrincipal :: Lens' CreateGrant Text Source #

The identity that gets the permissions specified in the grant.

To specify the principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see Amazon Web Services Identity and Access Management (IAM) in the Example ARNs section of the /Amazon Web Services General Reference/.

createGrant_operations :: Lens' CreateGrant [GrantOperation] Source #

A list of operations that the grant permits.

The operation must be supported on the KMS key. For example, you cannot create a grant for a symmetric KMS key that allows the Sign operation, or a grant for an asymmetric KMS key that allows the GenerateDataKey operation. If you try, KMS returns a ValidationError exception. For details, see Grant operations in the Key Management Service Developer Guide.

Destructuring the Response

data CreateGrantResponse Source #

See: newCreateGrantResponse smart constructor.

Constructors

CreateGrantResponse'

Fields

grantId :: Maybe Text
The unique identifier for the grant.
You can use the GrantId in a ListGrants, RetireGrant, or RevokeGrant operation.
grantToken :: Maybe Text
The grant token.
Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq CreateGrantResponse Source #
Instance details Defined in Amazonka.KMS.CreateGrant Methods (==) :: CreateGrantResponse -> CreateGrantResponse -> Bool # (/=) :: CreateGrantResponse -> CreateGrantResponse -> Bool #
Read CreateGrantResponse Source #
Instance details Defined in Amazonka.KMS.CreateGrant Methods readsPrec :: Int -> ReadS CreateGrantResponse # readList :: ReadS [CreateGrantResponse] # readPrec :: ReadPrec CreateGrantResponse # readListPrec :: ReadPrec [CreateGrantResponse] #
Show CreateGrantResponse Source #
Instance details Defined in Amazonka.KMS.CreateGrant Methods showsPrec :: Int -> CreateGrantResponse -> ShowS # show :: CreateGrantResponse -> String # showList :: [CreateGrantResponse] -> ShowS #
Generic CreateGrantResponse Source #
Instance details Defined in Amazonka.KMS.CreateGrant Associated Types type Rep CreateGrantResponse :: Type -> Type # Methods from :: CreateGrantResponse -> Rep CreateGrantResponse x # to :: Rep CreateGrantResponse x -> CreateGrantResponse #
NFData CreateGrantResponse Source #
Instance details Defined in Amazonka.KMS.CreateGrant Methods rnf :: CreateGrantResponse -> () #
type Rep CreateGrantResponse Source #
Instance details Defined in Amazonka.KMS.CreateGrant type Rep CreateGrantResponse = D1 ('MetaData "CreateGrantResponse" "Amazonka.KMS.CreateGrant" "libZSservicesZSamazonka-kmsZSamazonka-kms" 'False) (C1 ('MetaCons "CreateGrantResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "grantId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "grantToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateGrantResponse Source #

Arguments

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

Create a value of CreateGrantResponse 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:grantId:CreateGrantResponse', createGrantResponse_grantId - The unique identifier for the grant.

You can use the GrantId in a ListGrants, RetireGrant, or RevokeGrant operation.

$sel:grantToken:CreateGrantResponse', createGrantResponse_grantToken - The grant token.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

$sel:httpStatus:CreateGrantResponse', createGrantResponse_httpStatus - The response's http status code.

Response Lenses

createGrantResponse_grantId :: Lens' CreateGrantResponse (Maybe Text) Source #

The unique identifier for the grant.

You can use the GrantId in a ListGrants, RetireGrant, or RevokeGrant operation.

createGrantResponse_grantToken :: Lens' CreateGrantResponse (Maybe Text) Source #

The grant token.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

createGrantResponse_httpStatus :: Lens' CreateGrantResponse Int Source #

The response's http status code.