Package-level declarations

Types

Link copied to clipboard
class Alias : KotlinCustomResource

Create an alias for the master key (CMK).

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

Create an alias for the master key (CMK).

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 ApplicationAccessPoint : KotlinCustomResource

Provides a KMS Application Access Point resource. An application access point (AAP) is used to implement fine-grained access control for Key Management Service (KMS) resources. An application can access a KMS instance only after an AAP is created for the application. . For information about KMS Application Access Point and how to use it, see What is Application Access Point.

Link copied to clipboard
data class ApplicationAccessPointArgs(val applicationAccessPointName: Output<String>? = null, val description: Output<String>? = null, val policies: Output<List<String>>? = null) : ConvertibleToJava<ApplicationAccessPointArgs>

Provides a KMS Application Access Point resource. An application access point (AAP) is used to implement fine-grained access control for Key Management Service (KMS) resources. An application can access a KMS instance only after an AAP is created for the application. . For information about KMS Application Access Point and how to use it, see What is Application Access Point.

Link copied to clipboard
Link copied to clipboard
class Ciphertext : KotlinCustomResource
Link copied to clipboard
data class CiphertextArgs(val encryptionContext: Output<Map<String, String>>? = null, val keyId: Output<String>? = null, val plaintext: Output<String>? = null) : ConvertibleToJava<CiphertextArgs>
Link copied to clipboard
Link copied to clipboard
object CiphertextMapper : ResourceMapper<Ciphertext>
Link copied to clipboard
Link copied to clipboard
class ClientKey : KotlinCustomResource

Provides a KMS Client Key resource. Client key (of Application Access Point). For information about KMS Client Key and how to use it, see What is Client Key.

Link copied to clipboard
data class ClientKeyArgs(val aapName: Output<String>? = null, val notAfter: Output<String>? = null, val notBefore: Output<String>? = null, val password: Output<String>? = null, val privateKeyDataFile: Output<String>? = null) : ConvertibleToJava<ClientKeyArgs>

Provides a KMS Client Key resource. Client key (of Application Access Point). For information about KMS Client Key and how to use it, see What is Client Key.

Link copied to clipboard
Link copied to clipboard
object ClientKeyMapper : ResourceMapper<ClientKey>
Link copied to clipboard
Link copied to clipboard
class Instance : KotlinCustomResource

KMS Instance can be imported using the id, e.g.

Link copied to clipboard
data class InstanceArgs(val bindVpcs: Output<List<InstanceBindVpcArgs>>? = null, val keyNum: Output<Int>? = null, val productVersion: Output<String>? = null, val renewPeriod: Output<Int>? = null, val renewStatus: Output<String>? = null, val secretNum: Output<Int>? = null, val spec: Output<Int>? = null, val vpcId: Output<String>? = null, val vpcNum: Output<Int>? = null, val vswitchIds: Output<List<String>>? = null, val zoneIds: Output<List<String>>? = null) : ConvertibleToJava<InstanceArgs>

KMS Instance can be imported using the id, e.g.

Link copied to clipboard
Link copied to clipboard
object InstanceMapper : ResourceMapper<Instance>
Link copied to clipboard
Link copied to clipboard
class Key : KotlinCustomResource

A kms key can help user to protect data security in the transmission process. For information about Alikms Key and how to use it, see What is Resource Alikms Key.

Link copied to clipboard
data class KeyArgs(val automaticRotation: Output<String>? = null, val deletionWindowInDays: Output<Int>? = null, val description: Output<String>? = null, val dkmsInstanceId: Output<String>? = null, val isEnabled: Output<Boolean>? = null, val keySpec: Output<String>? = null, val keyState: Output<String>? = null, val keyUsage: Output<String>? = null, val origin: Output<String>? = null, val pendingWindowInDays: Output<Int>? = null, val protectionLevel: Output<String>? = null, val rotationInterval: Output<String>? = null, val status: Output<String>? = null, val tags: Output<Map<String, Any>>? = null) : ConvertibleToJava<KeyArgs>

A kms key can help user to protect data security in the transmission process. For information about Alikms Key and how to use it, see What is Resource Alikms Key.

Link copied to clipboard

Builder for KeyArgs.

Link copied to clipboard
object KeyMapper : ResourceMapper<Key>
Link copied to clipboard

Builder for Key.

Link copied to clipboard
class KeyVersion : KotlinCustomResource

Provides a Alikms Key Version resource. For information about Alikms Key Version and how to use it, see What is Resource Alikms Key Version.

Link copied to clipboard
data class KeyVersionArgs(val keyId: Output<String>? = null) : ConvertibleToJava<KeyVersionArgs>

Provides a Alikms Key Version resource. For information about Alikms Key Version and how to use it, see What is Resource Alikms Key Version.

Link copied to clipboard
Link copied to clipboard
object KeyVersionMapper : ResourceMapper<KeyVersion>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class NetworkRule : KotlinCustomResource

Provides a KMS Network Rule resource. Network rules that can be bound by Application Access Point's policies. For information about KMS Network Rule and how to use it, see What is Network Rule.

Link copied to clipboard
data class NetworkRuleArgs(val description: Output<String>? = null, val networkRuleName: Output<String>? = null, val sourcePrivateIps: Output<List<String>>? = null) : ConvertibleToJava<NetworkRuleArgs>

Provides a KMS Network Rule resource. Network rules that can be bound by Application Access Point's policies. For information about KMS Network Rule and how to use it, see What is Network Rule.

Link copied to clipboard
Link copied to clipboard
object NetworkRuleMapper : ResourceMapper<NetworkRule>
Link copied to clipboard
Link copied to clipboard
class Policy : KotlinCustomResource

Provides a KMS Policy resource. Permission policies which can be bound to the Application Access Points. For information about KMS Policy and how to use it, see What is Policy.

Link copied to clipboard
data class PolicyArgs(val accessControlRules: Output<String>? = null, val description: Output<String>? = null, val kmsInstanceId: Output<String>? = null, val permissions: Output<List<String>>? = null, val policyName: Output<String>? = null, val resources: Output<List<String>>? = null) : ConvertibleToJava<PolicyArgs>

Provides a KMS Policy resource. Permission policies which can be bound to the Application Access Points. For information about KMS Policy and how to use it, see What is Policy.

Link copied to clipboard

Builder for PolicyArgs.

Link copied to clipboard
object PolicyMapper : ResourceMapper<Policy>
Link copied to clipboard

Builder for Policy.

Link copied to clipboard
class Secret : KotlinCustomResource

This resouce used to create a secret and store its initial version.

Link copied to clipboard
data class SecretArgs(val description: Output<String>? = null, val dkmsInstanceId: Output<String>? = null, val enableAutomaticRotation: Output<Boolean>? = null, val encryptionKeyId: Output<String>? = null, val extendedConfig: Output<String>? = null, val forceDeleteWithoutRecovery: Output<Boolean>? = null, val recoveryWindowInDays: Output<Int>? = null, val rotationInterval: Output<String>? = null, val secretData: Output<String>? = null, val secretDataType: Output<String>? = null, val secretName: Output<String>? = null, val secretType: Output<String>? = null, val tags: Output<Map<String, Any>>? = null, val versionId: Output<String>? = null, val versionStages: Output<List<String>>? = null) : ConvertibleToJava<SecretArgs>

This resouce used to create a secret and store its initial version.

Link copied to clipboard

Builder for SecretArgs.

Link copied to clipboard
object SecretMapper : ResourceMapper<Secret>
Link copied to clipboard

Builder for Secret.

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
suspend fun clientKey(name: String, block: suspend ClientKeyResourceBuilder.() -> Unit): ClientKey
Link copied to clipboard
suspend fun instance(name: String, block: suspend InstanceResourceBuilder.() -> Unit): Instance
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 keyVersion(name: String, block: suspend KeyVersionResourceBuilder.() -> Unit): KeyVersion
Link copied to clipboard
suspend fun networkRule(name: String, block: suspend NetworkRuleResourceBuilder.() -> Unit): NetworkRule
Link copied to clipboard
fun policy(name: String): Policy
suspend fun policy(name: String, block: suspend PolicyResourceBuilder.() -> Unit): Policy
Link copied to clipboard
fun secret(name: String): Secret
suspend fun secret(name: String, block: suspend SecretResourceBuilder.() -> Unit): Secret