kms_disable_key_rotation: Disables automatic rotation of the key material for the...

Description Usage Arguments Details Request syntax Examples

View source: R/kms_operations.R

Description

Disables automatic rotation of the key material for the specified symmetric customer master key (CMK).

Usage

1

Arguments

KeyId

[required] Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.

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

You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. You cannot perform this operation on a CMK in a different AWS account.

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_rotation(
  KeyId = "string"
)

Examples

1
2
3
4
5
# The following example disables automatic annual rotation of the key
# material for the specified CMK.
svc$disable_key_rotation(
  KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab"
)

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