R: Create/Update/Retrieve/Delete Encryption Key

create_kms_key {aws.kms}

R Documentation

Create/Update/Retrieve/Delete Encryption Key

Description

Create/update/retrieve/delete a KMS encryption key

Usage

create_kms_key(
  description = NULL,
  origin = c("AWS_KMS", "EXTERNAL"),
  usage = "ENCRYPT_DECRYPT",
  ...
)

update_kms_key(key, description, ...)

get_kms_key(key, ...)

delete_kms_key(key, delay = 7, ...)

undelete_kms_key(key, ...)

Arguments

`description`	Optionally, a character string describing the key. This can be updated later using `update_kms_key`. An alias for the key, which can be used in lieu of the KeyId in subsequent calls can be set with `create_kms_alias`.
`origin`	A character string specifying the origin. Default is “AWS_KMS”. If “EXTERNAL”, use `put_kms_material` to add a key created using other infrastructure. See https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html for details.
`usage`	Ignored.
`...`	Additional arguments passed to `kmsHTTP`.
`key`	A character string specifying a key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with “alias/”.
`delay`	An integer specifying a number of delays to wait before deleting key. Minimum 7 and maximum 30.

Value

create_kms_key and get_kms_key return a list of class “aws_kms_key”. delete_kms_key and undelete_kms_key return a logical.

Examples

## Not run: 
  # create key
  k <- create_kms_key(description = "example")
  
  # get key
  get_kms_key(k)
  
  # delete in 30 days
  delete_kms_key(k, delay = 30)

## End(Not run)