Key

class Key : KotlinCustomResource

The AWS::KMS::Key resource specifies an AWS KMS key in AWS Key Management Service (AWS KMS). Authorized users can use the AWS KMS key to encrypt and decrypt small amounts of data (up to 4096 bytes), but they are more commonly used to generate data keys. You can also use AWS KMS keys to encrypt data stored in AWS services that are integrated with AWS KMS or within their applications.

Properties

Link copied to clipboard
val arn: Output<String>
Link copied to clipboard

Skips ("bypasses") the key policy lockout safety check. The default value is false.

Link copied to clipboard
val description: Output<String>?

A description of the AWS KMS key. Use a description that helps you to distinguish this AWS KMS key from others in the account, such as its intended use.

Link copied to clipboard
val enabled: Output<Boolean>?

Specifies whether the AWS KMS key is enabled. Disabled AWS KMS keys cannot be used in cryptographic operations.

Link copied to clipboard

Enables automatic rotation of the key material for the specified AWS KMS key. By default, automation key rotation is not enabled.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val keyId: Output<String>
Link copied to clipboard
val keyPolicy: Output<Any>?

The key policy that authorizes use of the AWS KMS key. The key policy must observe the following rules.

Link copied to clipboard
val keySpec: Output<KeySpec>?

Specifies the type of AWS KMS key to create. The default value is SYMMETRIC_DEFAULT. This property is required only for asymmetric AWS KMS keys. You can't change the KeySpec value after the AWS KMS key is created.

Link copied to clipboard
val keyUsage: Output<KeyUsage>?

Determines the cryptographic operations for which you can use the AWS KMS key. The default value is ENCRYPT_DECRYPT. This property is required only for asymmetric AWS KMS keys. You can't change the KeyUsage value after the AWS KMS key is created.

Link copied to clipboard
val multiRegion: Output<Boolean>?

Specifies whether the AWS KMS key should be Multi-Region. You can't change the MultiRegion value after the AWS KMS key is created.

Link copied to clipboard
val origin: Output<KeyOrigin>?

The source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The default is AWS_KMS, which means that AWS KMS creates the key material.

Link copied to clipboard
val pendingWindowInDays: Output<Int>?

Specifies the number of days in the waiting period before AWS KMS deletes an AWS KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val tags: Output<List<KeyTag>>?

An array of key-value pairs to apply to this resource.

Link copied to clipboard
val urn: Output<String>