Package-level declarations

Types

Link copied to clipboard
class Alias : KotlinCustomResource

Provides an alias for a KMS customer master key. AWS Console enforces 1-to-1 mapping between aliases & keys, but API (hence this provider too) allows you to create as many aliases as the account limits allow you.

Link copied to clipboard
data class AliasArgs(val name: Output<String>? = null, val namePrefix: Output<String>? = null, val targetKeyId: Output<String>? = null) : ConvertibleToJava<AliasArgs>

Provides an alias for a KMS customer master key. AWS Console enforces 1-to-1 mapping between aliases & keys, but API (hence this provider too) allows you to create as many aliases as the account limits allow you.

Link copied to clipboard

Builder for AliasArgs.

Link copied to clipboard
object AliasMapper : ResourceMapper<Alias>
Link copied to clipboard

Builder for Alias.

Link copied to clipboard
class Ciphertext : KotlinCustomResource

The KMS ciphertext resource allows you to encrypt plaintext into ciphertext by using an AWS KMS customer master key. The value returned by this resource is stable across every apply. For a changing ciphertext value each apply, see the aws.kms.Ciphertext data source.

Link copied to clipboard
data class CiphertextArgs(val context: Output<Map<String, String>>? = null, val keyId: Output<String>? = null, val plaintext: Output<String>? = null) : ConvertibleToJava<CiphertextArgs>

The KMS ciphertext resource allows you to encrypt plaintext into ciphertext by using an AWS KMS customer master key. The value returned by this resource is stable across every apply. For a changing ciphertext value each apply, see the aws.kms.Ciphertext data source.

Link copied to clipboard
Link copied to clipboard
object CiphertextMapper : ResourceMapper<Ciphertext>
Link copied to clipboard
Link copied to clipboard
class CustomKeyStore : KotlinCustomResource

Resource for managing an AWS KMS (Key Management) Custom Key Store.

Link copied to clipboard
data class CustomKeyStoreArgs(val cloudHsmClusterId: Output<String>? = null, val customKeyStoreName: Output<String>? = null, val customKeyStoreType: Output<String>? = null, val keyStorePassword: Output<String>? = null, val trustAnchorCertificate: Output<String>? = null, val xksProxyAuthenticationCredential: Output<CustomKeyStoreXksProxyAuthenticationCredentialArgs>? = null, val xksProxyConnectivity: Output<String>? = null, val xksProxyUriEndpoint: Output<String>? = null, val xksProxyUriPath: Output<String>? = null, val xksProxyVpcEndpointServiceName: Output<String>? = null) : ConvertibleToJava<CustomKeyStoreArgs>

Resource for managing an AWS KMS (Key Management) Custom Key Store.

Link copied to clipboard
Link copied to clipboard
object CustomKeyStoreMapper : ResourceMapper<CustomKeyStore>
Link copied to clipboard
class ExternalKey : KotlinCustomResource

Manages a single-Region or multi-Region primary KMS key that uses external key material. To instead manage a single-Region or multi-Region primary KMS key where AWS automatically generates and potentially rotates key material, see the aws.kms.Key resource.

Link copied to clipboard
data class ExternalKeyArgs(val bypassPolicyLockoutSafetyCheck: Output<Boolean>? = null, val deletionWindowInDays: Output<Int>? = null, val description: Output<String>? = null, val enabled: Output<Boolean>? = null, val keyMaterialBase64: Output<String>? = null, val multiRegion: Output<Boolean>? = null, val policy: Output<String>? = null, val tags: Output<Map<String, String>>? = null, val validTo: Output<String>? = null) : ConvertibleToJava<ExternalKeyArgs>

Manages a single-Region or multi-Region primary KMS key that uses external key material. To instead manage a single-Region or multi-Region primary KMS key where AWS automatically generates and potentially rotates key material, see the aws.kms.Key resource.

Link copied to clipboard
Link copied to clipboard
object ExternalKeyMapper : ResourceMapper<ExternalKey>
Link copied to clipboard
Link copied to clipboard
class Grant : KotlinCustomResource

Provides a resource-based access control mechanism for a KMS customer master key.

Link copied to clipboard
data class GrantArgs(val constraints: Output<List<GrantConstraintArgs>>? = null, val grantCreationTokens: Output<List<String>>? = null, val granteePrincipal: Output<String>? = null, val keyId: Output<String>? = null, val name: Output<String>? = null, val operations: Output<List<String>>? = null, val retireOnDelete: Output<Boolean>? = null, val retiringPrincipal: Output<String>? = null) : ConvertibleToJava<GrantArgs>

Provides a resource-based access control mechanism for a KMS customer master key.

Link copied to clipboard

Builder for GrantArgs.

Link copied to clipboard
object GrantMapper : ResourceMapper<Grant>
Link copied to clipboard

Builder for Grant.

Link copied to clipboard
class Key : KotlinCustomResource

Manages a single-Region or multi-Region primary KMS key.

Link copied to clipboard
data class KeyArgs(val bypassPolicyLockoutSafetyCheck: Output<Boolean>? = null, val customKeyStoreId: Output<String>? = null, val customerMasterKeySpec: Output<String>? = null, val deletionWindowInDays: Output<Int>? = null, val description: Output<String>? = null, val enableKeyRotation: Output<Boolean>? = null, val isEnabled: Output<Boolean>? = null, val keyUsage: Output<String>? = null, val multiRegion: Output<Boolean>? = null, val policy: Output<String>? = null, val rotationPeriodInDays: Output<Int>? = null, val tags: Output<Map<String, String>>? = null, val xksKeyId: Output<String>? = null) : ConvertibleToJava<KeyArgs>

Manages a single-Region or multi-Region primary KMS key.

Link copied to clipboard

Builder for KeyArgs.

Link copied to clipboard
object KeyMapper : ResourceMapper<Key>
Link copied to clipboard
class KeyPolicy : KotlinCustomResource

Attaches a policy to a KMS Key.

Link copied to clipboard
data class KeyPolicyArgs(val bypassPolicyLockoutSafetyCheck: Output<Boolean>? = null, val keyId: Output<String>? = null, val policy: Output<String>? = null) : ConvertibleToJava<KeyPolicyArgs>

Attaches a policy to a KMS Key.

Link copied to clipboard
Link copied to clipboard
object KeyPolicyMapper : ResourceMapper<KeyPolicy>
Link copied to clipboard
Link copied to clipboard

Builder for Key.

Link copied to clipboard
Link copied to clipboard
class ReplicaExternalKey : KotlinCustomResource

Manages a KMS multi-Region replica key that uses external key material. See the AWS KMS Developer Guide for more information on importing key material into multi-Region keys.

Link copied to clipboard
data class ReplicaExternalKeyArgs(val bypassPolicyLockoutSafetyCheck: Output<Boolean>? = null, val deletionWindowInDays: Output<Int>? = null, val description: Output<String>? = null, val enabled: Output<Boolean>? = null, val keyMaterialBase64: Output<String>? = null, val policy: Output<String>? = null, val primaryKeyArn: Output<String>? = null, val tags: Output<Map<String, String>>? = null, val validTo: Output<String>? = null) : ConvertibleToJava<ReplicaExternalKeyArgs>

Manages a KMS multi-Region replica key that uses external key material. See the AWS KMS Developer Guide for more information on importing key material into multi-Region keys.

Link copied to clipboard
Link copied to clipboard
class ReplicaKey : KotlinCustomResource

Manages a KMS multi-Region replica key.

Link copied to clipboard
data class ReplicaKeyArgs(val bypassPolicyLockoutSafetyCheck: Output<Boolean>? = null, val deletionWindowInDays: Output<Int>? = null, val description: Output<String>? = null, val enabled: Output<Boolean>? = null, val policy: Output<String>? = null, val primaryKeyArn: Output<String>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<ReplicaKeyArgs>

Manages a KMS multi-Region replica key.

Link copied to clipboard
Link copied to clipboard
object ReplicaKeyMapper : ResourceMapper<ReplicaKey>
Link copied to clipboard

Functions

Link copied to clipboard
fun alias(name: String): Alias
suspend fun alias(name: String, block: suspend AliasResourceBuilder.() -> Unit): Alias
Link copied to clipboard
suspend fun ciphertext(name: String, block: suspend CiphertextResourceBuilder.() -> Unit): Ciphertext
Link copied to clipboard
Link copied to clipboard
suspend fun externalKey(name: String, block: suspend ExternalKeyResourceBuilder.() -> Unit): ExternalKey
Link copied to clipboard
fun grant(name: String): Grant
suspend fun grant(name: String, block: suspend GrantResourceBuilder.() -> Unit): Grant
Link copied to clipboard
fun key(name: String): Key
suspend fun key(name: String, block: suspend KeyResourceBuilder.() -> Unit): Key
Link copied to clipboard
suspend fun keyPolicy(name: String, block: suspend KeyPolicyResourceBuilder.() -> Unit): KeyPolicy
Link copied to clipboard
suspend fun replicaKey(name: String, block: suspend ReplicaKeyResourceBuilder.() -> Unit): ReplicaKey