kms_disable_key: Sets the state of a customer master key (CMK) to disabled,...

Description Usage Arguments Details Request syntax Examples

View source: R/kms_operations.R

Description

Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations. You cannot perform this operation on a CMK in a different AWS account.

Usage

1

Arguments

KeyId

[required] A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

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 CMK, use ListKeys or DescribeKey.

Details

For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide .

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Request syntax

1
2
3
svc$disable_key(
  KeyId = "string"
)

Examples

1
2
3
4
# The following example disables the specified CMK.
svc$disable_key(
  KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab"
)

paws.security.identity documentation built on Jan. 14, 2020, 5:08 p.m.