Package-level declarations

Types

Link copied to clipboard
class Audit : KotlinCustomResource
Link copied to clipboard
data class AuditArgs(val description: Output<String>? = null, val local: Output<Boolean>? = null, val namespace: Output<String>? = null, val options: Output<Map<String, String>>? = null, val path: Output<String>? = null, val type: Output<String>? = null) : ConvertibleToJava<AuditArgs>
Link copied to clipboard

Builder for AuditArgs.

Link copied to clipboard
object AuditMapper : ResourceMapper<Audit>
Link copied to clipboard
class AuditRequestHeader : KotlinCustomResource

Manages additional request headers that appear in audited requests.

Link copied to clipboard
data class AuditRequestHeaderArgs(val hmac: Output<Boolean>? = null, val name: Output<String>? = null, val namespace: Output<String>? = null) : ConvertibleToJava<AuditRequestHeaderArgs>

Manages additional request headers that appear in audited requests.

Link copied to clipboard
Link copied to clipboard

Builder for Audit.

Link copied to clipboard
class AuthBackend : KotlinCustomResource

Auth methods can be imported using the path, e.g.

Link copied to clipboard
data class AuthBackendArgs(val description: Output<String>? = null, val disableRemount: Output<Boolean>? = null, val identityTokenKey: Output<String>? = null, val local: Output<Boolean>? = null, val namespace: Output<String>? = null, val path: Output<String>? = null, val tune: Output<AuthBackendTuneArgs>? = null, val type: Output<String>? = null) : ConvertibleToJava<AuthBackendArgs>

Auth methods can be imported using the path, e.g.

Link copied to clipboard
Link copied to clipboard
object AuthBackendMapper : ResourceMapper<AuthBackend>
Link copied to clipboard
Link copied to clipboard
class CertAuthBackendRole : KotlinCustomResource

Provides a resource to create a role in an Cert auth backend within Vault.

Link copied to clipboard
data class CertAuthBackendRoleArgs(val allowedCommonNames: Output<List<String>>? = null, val allowedDnsSans: Output<List<String>>? = null, val allowedEmailSans: Output<List<String>>? = null, val allowedNames: Output<List<String>>? = null, val allowedOrganizationalUnits: Output<List<String>>? = null, val allowedUriSans: Output<List<String>>? = null, val backend: Output<String>? = null, val certificate: Output<String>? = null, val displayName: Output<String>? = null, val name: Output<String>? = null, val namespace: Output<String>? = null, val ocspCaCertificates: Output<String>? = null, val ocspEnabled: Output<Boolean>? = null, val ocspFailOpen: Output<Boolean>? = null, val ocspQueryAllServers: Output<Boolean>? = null, val ocspServersOverrides: Output<List<String>>? = null, val requiredExtensions: Output<List<String>>? = null, val tokenBoundCidrs: Output<List<String>>? = null, val tokenExplicitMaxTtl: Output<Int>? = null, val tokenMaxTtl: Output<Int>? = null, val tokenNoDefaultPolicy: Output<Boolean>? = null, val tokenNumUses: Output<Int>? = null, val tokenPeriod: Output<Int>? = null, val tokenPolicies: Output<List<String>>? = null, val tokenTtl: Output<Int>? = null, val tokenType: Output<String>? = null) : ConvertibleToJava<CertAuthBackendRoleArgs>

Provides a resource to create a role in an Cert auth backend within Vault.

Link copied to clipboard
Link copied to clipboard
class EgpPolicy : KotlinCustomResource

Provides a resource to manage Endpoint Governing Policy (EGP) via Sentinel. Note this feature is available only with Vault Enterprise.

Link copied to clipboard
data class EgpPolicyArgs(val enforcementLevel: Output<String>? = null, val name: Output<String>? = null, val namespace: Output<String>? = null, val paths: Output<List<String>>? = null, val policy: Output<String>? = null) : ConvertibleToJava<EgpPolicyArgs>

Provides a resource to manage Endpoint Governing Policy (EGP) via Sentinel. Note this feature is available only with Vault Enterprise.

Link copied to clipboard
Link copied to clipboard
object EgpPolicyMapper : ResourceMapper<EgpPolicy>
Link copied to clipboard
Link copied to clipboard
class MfaDuo : KotlinCustomResource

Provides a resource to manage Duo MFA. Note this feature is available only with Vault Enterprise.

Link copied to clipboard
data class MfaDuoArgs(val apiHostname: Output<String>? = null, val integrationKey: Output<String>? = null, val mountAccessor: Output<String>? = null, val name: Output<String>? = null, val namespace: Output<String>? = null, val pushInfo: Output<String>? = null, val secretKey: Output<String>? = null, val usernameFormat: Output<String>? = null) : ConvertibleToJava<MfaDuoArgs>

Provides a resource to manage Duo MFA. Note this feature is available only with Vault Enterprise.

Link copied to clipboard

Builder for MfaDuoArgs.

Link copied to clipboard
object MfaDuoMapper : ResourceMapper<MfaDuo>
Link copied to clipboard

Builder for MfaDuo.

Link copied to clipboard
class MfaOkta : KotlinCustomResource

Provides a resource to manage Okta MFA. Note this feature is available only with Vault Enterprise.

Link copied to clipboard
data class MfaOktaArgs(val apiToken: Output<String>? = null, val baseUrl: Output<String>? = null, val mountAccessor: Output<String>? = null, val name: Output<String>? = null, val namespace: Output<String>? = null, val orgName: Output<String>? = null, val primaryEmail: Output<Boolean>? = null, val usernameFormat: Output<String>? = null) : ConvertibleToJava<MfaOktaArgs>

Provides a resource to manage Okta MFA. Note this feature is available only with Vault Enterprise.

Link copied to clipboard
Link copied to clipboard
object MfaOktaMapper : ResourceMapper<MfaOkta>
Link copied to clipboard
Link copied to clipboard
class MfaPingid : KotlinCustomResource

Provides a resource to manage PingID MFA. Note this feature is available only with Vault Enterprise.

Link copied to clipboard
data class MfaPingidArgs(val mountAccessor: Output<String>? = null, val name: Output<String>? = null, val namespace: Output<String>? = null, val settingsFileBase64: Output<String>? = null, val usernameFormat: Output<String>? = null) : ConvertibleToJava<MfaPingidArgs>

Provides a resource to manage PingID MFA. Note this feature is available only with Vault Enterprise.

Link copied to clipboard
Link copied to clipboard
object MfaPingidMapper : ResourceMapper<MfaPingid>
Link copied to clipboard
Link copied to clipboard
class MfaTotp : KotlinCustomResource

Provides a resource to manage TOTP MFA. Note this feature is available only with Vault Enterprise.

Link copied to clipboard
data class MfaTotpArgs(val algorithm: Output<String>? = null, val digits: Output<Int>? = null, val issuer: Output<String>? = null, val keySize: Output<Int>? = null, val name: Output<String>? = null, val namespace: Output<String>? = null, val period: Output<Int>? = null, val qrSize: Output<Int>? = null, val skew: Output<Int>? = null) : ConvertibleToJava<MfaTotpArgs>

Provides a resource to manage TOTP MFA. Note this feature is available only with Vault Enterprise.

Link copied to clipboard
Link copied to clipboard
object MfaTotpMapper : ResourceMapper<MfaTotp>
Link copied to clipboard
Link copied to clipboard
class Mount : KotlinCustomResource

This resource enables a new secrets engine at the given path.

Link copied to clipboard
data class MountArgs(val allowedManagedKeys: Output<List<String>>? = null, val allowedResponseHeaders: Output<List<String>>? = null, val auditNonHmacRequestKeys: Output<List<String>>? = null, val auditNonHmacResponseKeys: Output<List<String>>? = null, val defaultLeaseTtlSeconds: Output<Int>? = null, val delegatedAuthAccessors: Output<List<String>>? = null, val description: Output<String>? = null, val externalEntropyAccess: Output<Boolean>? = null, val identityTokenKey: Output<String>? = null, val listingVisibility: Output<String>? = null, val local: Output<Boolean>? = null, val maxLeaseTtlSeconds: Output<Int>? = null, val namespace: Output<String>? = null, val options: Output<Map<String, String>>? = null, val passthroughRequestHeaders: Output<List<String>>? = null, val path: Output<String>? = null, val pluginVersion: Output<String>? = null, val sealWrap: Output<Boolean>? = null, val type: Output<String>? = null) : ConvertibleToJava<MountArgs>

This resource enables a new secrets engine at the given path.

Link copied to clipboard

Builder for MountArgs.

Link copied to clipboard
object MountMapper : ResourceMapper<Mount>
Link copied to clipboard

Builder for Mount.

Link copied to clipboard
class Namespace : KotlinCustomResource

Namespaces can be imported using its name as accessor id

Link copied to clipboard
data class NamespaceArgs(val customMetadata: Output<Map<String, String>>? = null, val namespace: Output<String>? = null, val path: Output<String>? = null, val pathFq: Output<String>? = null) : ConvertibleToJava<NamespaceArgs>

Namespaces can be imported using its name as accessor id

Link copied to clipboard
Link copied to clipboard
object NamespaceMapper : ResourceMapper<Namespace>
Link copied to clipboard
Link copied to clipboard
class NomadSecretBackend : KotlinCustomResource
Link copied to clipboard
data class NomadSecretBackendArgs(val address: Output<String>? = null, val backend: Output<String>? = null, val caCert: Output<String>? = null, val clientCert: Output<String>? = null, val clientKey: Output<String>? = null, val defaultLeaseTtlSeconds: Output<Int>? = null, val description: Output<String>? = null, val disableRemount: Output<Boolean>? = null, val local: Output<Boolean>? = null, val maxLeaseTtlSeconds: Output<Int>? = null, val maxTokenNameLength: Output<Int>? = null, val maxTtl: Output<Int>? = null, val namespace: Output<String>? = null, val token: Output<String>? = null, val ttl: Output<Int>? = null) : ConvertibleToJava<NomadSecretBackendArgs>
Link copied to clipboard
Link copied to clipboard
class NomadSecretRole : KotlinCustomResource
Link copied to clipboard
data class NomadSecretRoleArgs(val backend: Output<String>? = null, val global: Output<Boolean>? = null, val namespace: Output<String>? = null, val policies: Output<List<String>>? = null, val role: Output<String>? = null, val type: Output<String>? = null) : ConvertibleToJava<NomadSecretRoleArgs>
Link copied to clipboard
object NomadSecretRoleMapper : ResourceMapper<NomadSecretRole>
Link copied to clipboard
class PasswordPolicy : KotlinCustomResource

Provides a resource to manage Password Policies Note this feature is available only Vault 1.5+

Link copied to clipboard
data class PasswordPolicyArgs(val name: Output<String>? = null, val namespace: Output<String>? = null, val policy: Output<String>? = null) : ConvertibleToJava<PasswordPolicyArgs>

Provides a resource to manage Password Policies Note this feature is available only Vault 1.5+

Link copied to clipboard
Link copied to clipboard
object PasswordPolicyMapper : ResourceMapper<PasswordPolicy>
Link copied to clipboard
class Plugin : KotlinCustomResource
Link copied to clipboard
data class PluginArgs(val args: Output<List<String>>? = null, val command: Output<String>? = null, val envs: Output<List<String>>? = null, val name: Output<String>? = null, val ociImage: Output<String>? = null, val runtime: Output<String>? = null, val sha256: Output<String>? = null, val type: Output<String>? = null, val version: Output<String>? = null) : ConvertibleToJava<PluginArgs>
Link copied to clipboard

Builder for PluginArgs.

Link copied to clipboard
object PluginMapper : ResourceMapper<Plugin>
Link copied to clipboard
class PluginPinnedVersion : KotlinCustomResource
Link copied to clipboard
data class PluginPinnedVersionArgs(val name: Output<String>? = null, val type: Output<String>? = null, val version: Output<String>? = null) : ConvertibleToJava<PluginPinnedVersionArgs>
Link copied to clipboard
Link copied to clipboard

Builder for Plugin.

Link copied to clipboard
class Policy : KotlinCustomResource

Policies can be imported using the name, e.g.

Link copied to clipboard
data class PolicyArgs(val name: Output<String>? = null, val namespace: Output<String>? = null, val policy: Output<String>? = null) : ConvertibleToJava<PolicyArgs>

Policies can be imported using the name, e.g.

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
data class ProviderArgs(val addAddressToEnv: Output<String>? = null, val address: Output<String>? = null, val authLogin: Output<ProviderAuthLoginArgs>? = null, val authLoginAws: Output<ProviderAuthLoginAwsArgs>? = null, val authLoginAzure: Output<ProviderAuthLoginAzureArgs>? = null, val authLoginCert: Output<ProviderAuthLoginCertArgs>? = null, val authLoginGcp: Output<ProviderAuthLoginGcpArgs>? = null, val authLoginJwt: Output<ProviderAuthLoginJwtArgs>? = null, val authLoginKerberos: Output<ProviderAuthLoginKerberosArgs>? = null, val authLoginOci: Output<ProviderAuthLoginOciArgs>? = null, val authLoginOidc: Output<ProviderAuthLoginOidcArgs>? = null, val authLoginRadius: Output<ProviderAuthLoginRadiusArgs>? = null, val authLoginTokenFile: Output<ProviderAuthLoginTokenFileArgs>? = null, val authLoginUserpass: Output<ProviderAuthLoginUserpassArgs>? = null, val caCertDir: Output<String>? = null, val caCertFile: Output<String>? = null, val clientAuth: Output<ProviderClientAuthArgs>? = null, val headers: Output<List<ProviderHeaderArgs>>? = null, val maxLeaseTtlSeconds: Output<Int>? = null, val maxRetries: Output<Int>? = null, val maxRetriesCcc: Output<Int>? = null, val namespace: Output<String>? = null, val setNamespaceFromToken: Output<Boolean>? = null, val skipChildToken: Output<Boolean>? = null, val skipGetVaultVersion: Output<Boolean>? = null, val skipTlsVerify: Output<Boolean>? = null, val tlsServerName: Output<String>? = null, val token: Output<String>? = null, val tokenName: Output<String>? = null, val vaultVersionOverride: Output<String>? = null) : ConvertibleToJava<ProviderArgs>

The provider type for the vault package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

Link copied to clipboard
Link copied to clipboard
class QuotaLeaseCount : KotlinCustomResource

Manage lease count quotas which enforce the number of leases that can be created. A lease count quota can be created at the root level or defined on a namespace or mount by specifying a path when creating the quota. See Vault's Documentation for more information. Note this feature is available only with Vault Enterprise.

Link copied to clipboard
data class QuotaLeaseCountArgs(val inheritable: Output<Boolean>? = null, val maxLeases: Output<Int>? = null, val name: Output<String>? = null, val namespace: Output<String>? = null, val path: Output<String>? = null, val role: Output<String>? = null) : ConvertibleToJava<QuotaLeaseCountArgs>

Manage lease count quotas which enforce the number of leases that can be created. A lease count quota can be created at the root level or defined on a namespace or mount by specifying a path when creating the quota. See Vault's Documentation for more information. Note this feature is available only with Vault Enterprise.

Link copied to clipboard
object QuotaLeaseCountMapper : ResourceMapper<QuotaLeaseCount>
Link copied to clipboard
class QuotaRateLimit : KotlinCustomResource

Manage rate limit quotas which enforce API rate limiting using a token bucket algorithm. A rate limit quota can be created at the root level or defined on a namespace or mount by specifying a path when creating the quota. See Vault's Documentation for more information.

Link copied to clipboard
data class QuotaRateLimitArgs(val blockInterval: Output<Int>? = null, val inheritable: Output<Boolean>? = null, val interval: Output<Int>? = null, val name: Output<String>? = null, val namespace: Output<String>? = null, val path: Output<String>? = null, val rate: Output<Double>? = null, val role: Output<String>? = null) : ConvertibleToJava<QuotaRateLimitArgs>

Manage rate limit quotas which enforce API rate limiting using a token bucket algorithm. A rate limit quota can be created at the root level or defined on a namespace or mount by specifying a path when creating the quota. See Vault's Documentation for more information.

Link copied to clipboard
Link copied to clipboard
object QuotaRateLimitMapper : ResourceMapper<QuotaRateLimit>
Link copied to clipboard
class RaftAutopilot : KotlinCustomResource

Autopilot enables automated workflows for managing Raft clusters. The current feature set includes 3 main features: Server Stabilization, Dead Server Cleanup and State API. These three features are introduced in Vault 1.7.

Link copied to clipboard
data class RaftAutopilotArgs(val cleanupDeadServers: Output<Boolean>? = null, val deadServerLastContactThreshold: Output<String>? = null, val disableUpgradeMigration: Output<Boolean>? = null, val lastContactThreshold: Output<String>? = null, val maxTrailingLogs: Output<Int>? = null, val minQuorum: Output<Int>? = null, val namespace: Output<String>? = null, val serverStabilizationTime: Output<String>? = null) : ConvertibleToJava<RaftAutopilotArgs>

Autopilot enables automated workflows for managing Raft clusters. The current feature set includes 3 main features: Server Stabilization, Dead Server Cleanup and State API. These three features are introduced in Vault 1.7.

Link copied to clipboard
Link copied to clipboard
object RaftAutopilotMapper : ResourceMapper<RaftAutopilot>
Link copied to clipboard
Link copied to clipboard
class RaftSnapshotAgentConfig : KotlinCustomResource
Link copied to clipboard
data class RaftSnapshotAgentConfigArgs(val awsAccessKeyId: Output<String>? = null, val awsS3Bucket: Output<String>? = null, val awsS3DisableTls: Output<Boolean>? = null, val awsS3EnableKms: Output<Boolean>? = null, val awsS3Endpoint: Output<String>? = null, val awsS3ForcePathStyle: Output<Boolean>? = null, val awsS3KmsKey: Output<String>? = null, val awsS3Region: Output<String>? = null, val awsS3ServerSideEncryption: Output<Boolean>? = null, val awsSecretAccessKey: Output<String>? = null, val awsSessionToken: Output<String>? = null, val azureAccountKey: Output<String>? = null, val azureAccountName: Output<String>? = null, val azureBlobEnvironment: Output<String>? = null, val azureContainerName: Output<String>? = null, val azureEndpoint: Output<String>? = null, val filePrefix: Output<String>? = null, val googleDisableTls: Output<Boolean>? = null, val googleEndpoint: Output<String>? = null, val googleGcsBucket: Output<String>? = null, val googleServiceAccountKey: Output<String>? = null, val intervalSeconds: Output<Int>? = null, val localMaxSpace: Output<Int>? = null, val name: Output<String>? = null, val namespace: Output<String>? = null, val pathPrefix: Output<String>? = null, val retain: Output<Int>? = null, val storageType: Output<String>? = null) : ConvertibleToJava<RaftSnapshotAgentConfigArgs>
Link copied to clipboard
Link copied to clipboard
class RgpPolicy : KotlinCustomResource

Provides a resource to manage Role Governing Policy (RGP) via Sentinel. Note this feature is available only with Vault Enterprise.

Link copied to clipboard
data class RgpPolicyArgs(val enforcementLevel: Output<String>? = null, val name: Output<String>? = null, val namespace: Output<String>? = null, val policy: Output<String>? = null) : ConvertibleToJava<RgpPolicyArgs>

Provides a resource to manage Role Governing Policy (RGP) via Sentinel. Note this feature is available only with Vault Enterprise.

Link copied to clipboard
Link copied to clipboard
object RgpPolicyMapper : ResourceMapper<RgpPolicy>
Link copied to clipboard
Link copied to clipboard
class Token : KotlinCustomResource
Link copied to clipboard
data class TokenArgs(val displayName: Output<String>? = null, val explicitMaxTtl: Output<String>? = null, val metadata: Output<Map<String, String>>? = null, val namespace: Output<String>? = null, val noDefaultPolicy: Output<Boolean>? = null, val noParent: Output<Boolean>? = null, val numUses: Output<Int>? = null, val period: Output<String>? = null, val policies: Output<List<String>>? = null, val renewIncrement: Output<Int>? = null, val renewMinLease: Output<Int>? = null, val renewable: Output<Boolean>? = null, val roleName: Output<String>? = null, val ttl: Output<String>? = null, val wrappingTtl: Output<String>? = null) : ConvertibleToJava<TokenArgs>
Link copied to clipboard

Builder for TokenArgs.

Link copied to clipboard
object TokenMapper : ResourceMapper<Token>
Link copied to clipboard

Builder for Token.

Link copied to clipboard
Link copied to clipboard
class VaultProvider : KotlinProviderResource

The provider type for the vault package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

Link copied to clipboard
object VaultProviderMapper : ResourceMapper<VaultProvider>
Link copied to clipboard

Functions

Link copied to clipboard
fun audit(name: String): Audit
suspend fun audit(name: String, block: suspend AuditResourceBuilder.() -> Unit): Audit
Link copied to clipboard
suspend fun authBackend(name: String, block: suspend AuthBackendResourceBuilder.() -> Unit): AuthBackend
Link copied to clipboard
suspend fun egpPolicy(name: String, block: suspend EgpPolicyResourceBuilder.() -> Unit): EgpPolicy
Link copied to clipboard
fun mfaDuo(name: String): MfaDuo
suspend fun mfaDuo(name: String, block: suspend MfaDuoResourceBuilder.() -> Unit): MfaDuo
Link copied to clipboard
fun mfaOkta(name: String): MfaOkta
suspend fun mfaOkta(name: String, block: suspend MfaOktaResourceBuilder.() -> Unit): MfaOkta
Link copied to clipboard
suspend fun mfaPingid(name: String, block: suspend MfaPingidResourceBuilder.() -> Unit): MfaPingid
Link copied to clipboard
fun mfaTotp(name: String): MfaTotp
suspend fun mfaTotp(name: String, block: suspend MfaTotpResourceBuilder.() -> Unit): MfaTotp
Link copied to clipboard
fun mount(name: String): Mount
suspend fun mount(name: String, block: suspend MountResourceBuilder.() -> Unit): Mount
Link copied to clipboard
suspend fun namespace(name: String, block: suspend NamespaceResourceBuilder.() -> Unit): Namespace
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun plugin(name: String): Plugin
suspend fun plugin(name: String, block: suspend PluginResourceBuilder.() -> Unit): Plugin
Link copied to clipboard
fun policy(name: String): Policy
suspend fun policy(name: String, block: suspend PolicyResourceBuilder.() -> Unit): Policy
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
suspend fun rgpPolicy(name: String, block: suspend RgpPolicyResourceBuilder.() -> Unit): RgpPolicy
Link copied to clipboard
fun token(name: String): Token
suspend fun token(name: String, block: suspend TokenResourceBuilder.() -> Unit): Token
Link copied to clipboard