com.pulumi.vault.ldap.kotlin.AuthBackendUser.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-vault-kotlin Show documentation
Show all versions of pulumi-vault-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.vault.ldap.kotlin
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
/**
* Builder for [AuthBackendUser].
*/
@PulumiTagMarker
public class AuthBackendUserResourceBuilder internal constructor() {
public var name: String? = null
public var args: AuthBackendUserArgs = AuthBackendUserArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend AuthBackendUserArgsBuilder.() -> Unit) {
val builder = AuthBackendUserArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): AuthBackendUser {
val builtJavaResource = com.pulumi.vault.ldap.AuthBackendUser(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return AuthBackendUser(builtJavaResource)
}
}
/**
* Provides a resource to create a user in an [LDAP auth backend within Vault](https://www.vaultproject.io/docs/auth/ldap.html).
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as vault from "@pulumi/vault";
* const ldap = new vault.ldap.AuthBackend("ldap", {
* path: "ldap",
* url: "ldaps://dc-01.example.org",
* userdn: "OU=Users,OU=Accounts,DC=example,DC=org",
* userattr: "sAMAccountName",
* upndomain: "EXAMPLE.ORG",
* discoverdn: false,
* groupdn: "OU=Groups,DC=example,DC=org",
* groupfilter: "(&(objectClass=group)(member:1.2.840.113556.1.4.1941:={{.UserDN}}))",
* });
* const user = new vault.ldap.AuthBackendUser("user", {
* username: "test-user",
* policies: [
* "dba",
* "sysops",
* ],
* backend: ldap.path,
* });
* ```
* ```python
* import pulumi
* import pulumi_vault as vault
* ldap = vault.ldap.AuthBackend("ldap",
* path="ldap",
* url="ldaps://dc-01.example.org",
* userdn="OU=Users,OU=Accounts,DC=example,DC=org",
* userattr="sAMAccountName",
* upndomain="EXAMPLE.ORG",
* discoverdn=False,
* groupdn="OU=Groups,DC=example,DC=org",
* groupfilter="(&(objectClass=group)(member:1.2.840.113556.1.4.1941:={{.UserDN}}))")
* user = vault.ldap.AuthBackendUser("user",
* username="test-user",
* policies=[
* "dba",
* "sysops",
* ],
* backend=ldap.path)
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Vault = Pulumi.Vault;
* return await Deployment.RunAsync(() =>
* {
* var ldap = new Vault.Ldap.AuthBackend("ldap", new()
* {
* Path = "ldap",
* Url = "ldaps://dc-01.example.org",
* Userdn = "OU=Users,OU=Accounts,DC=example,DC=org",
* Userattr = "sAMAccountName",
* Upndomain = "EXAMPLE.ORG",
* Discoverdn = false,
* Groupdn = "OU=Groups,DC=example,DC=org",
* Groupfilter = "(&(objectClass=group)(member:1.2.840.113556.1.4.1941:={{.UserDN}}))",
* });
* var user = new Vault.Ldap.AuthBackendUser("user", new()
* {
* Username = "test-user",
* Policies = new[]
* {
* "dba",
* "sysops",
* },
* Backend = ldap.Path,
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-vault/sdk/v6/go/vault/ldap"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* ldap, err := ldap.NewAuthBackend(ctx, "ldap", &ldap.AuthBackendArgs{
* Path: pulumi.String("ldap"),
* Url: pulumi.String("ldaps://dc-01.example.org"),
* Userdn: pulumi.String("OU=Users,OU=Accounts,DC=example,DC=org"),
* Userattr: pulumi.String("sAMAccountName"),
* Upndomain: pulumi.String("EXAMPLE.ORG"),
* Discoverdn: pulumi.Bool(false),
* Groupdn: pulumi.String("OU=Groups,DC=example,DC=org"),
* Groupfilter: pulumi.String("(&(objectClass=group)(member:1.2.840.113556.1.4.1941:={{.UserDN}}))"),
* })
* if err != nil {
* return err
* }
* _, err = ldap.NewAuthBackendUser(ctx, "user", &ldap.AuthBackendUserArgs{
* Username: pulumi.String("test-user"),
* Policies: pulumi.StringArray{
* pulumi.String("dba"),
* pulumi.String("sysops"),
* },
* Backend: ldap.Path,
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.vault.ldap.AuthBackend;
* import com.pulumi.vault.ldap.AuthBackendArgs;
* import com.pulumi.vault.ldap.AuthBackendUser;
* import com.pulumi.vault.ldap.AuthBackendUserArgs;
* import java.util.List;
* import java.util.ArrayList;
* import java.util.Map;
* import java.io.File;
* import java.nio.file.Files;
* import java.nio.file.Paths;
* public class App {
* public static void main(String[] args) {
* Pulumi.run(App::stack);
* }
* public static void stack(Context ctx) {
* var ldap = new AuthBackend("ldap", AuthBackendArgs.builder()
* .path("ldap")
* .url("ldaps://dc-01.example.org")
* .userdn("OU=Users,OU=Accounts,DC=example,DC=org")
* .userattr("sAMAccountName")
* .upndomain("EXAMPLE.ORG")
* .discoverdn(false)
* .groupdn("OU=Groups,DC=example,DC=org")
* .groupfilter("(&(objectClass=group)(member:1.2.840.113556.1.4.1941:={{.UserDN}}))")
* .build());
* var user = new AuthBackendUser("user", AuthBackendUserArgs.builder()
* .username("test-user")
* .policies(
* "dba",
* "sysops")
* .backend(ldap.path())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* ldap:
* type: vault:ldap:AuthBackend
* properties:
* path: ldap
* url: ldaps://dc-01.example.org
* userdn: OU=Users,OU=Accounts,DC=example,DC=org
* userattr: sAMAccountName
* upndomain: EXAMPLE.ORG
* discoverdn: false
* groupdn: OU=Groups,DC=example,DC=org
* groupfilter: (&(objectClass=group)(member:1.2.840.113556.1.4.1941:={{.UserDN}}))
* user:
* type: vault:ldap:AuthBackendUser
* properties:
* username: test-user
* policies:
* - dba
* - sysops
* backend: ${ldap.path}
* ```
*
* ## Import
* LDAP authentication backend users can be imported using the `path`, e.g.
* ```sh
* $ pulumi import vault:ldap/authBackendUser:AuthBackendUser foo auth/ldap/users/foo
* ```
*/
public class AuthBackendUser internal constructor(
override val javaResource: com.pulumi.vault.ldap.AuthBackendUser,
) : KotlinCustomResource(javaResource, AuthBackendUserMapper) {
/**
* Path to the authentication backend
* For more details on the usage of each argument consult the [Vault LDAP API documentation](https://www.vaultproject.io/api-docs/auth/ldap).
*/
public val backend: Output?
get() = javaResource.backend().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* Override LDAP groups which should be granted to user
*/
public val groups: Output>
get() = javaResource.groups().applyValue({ args0 -> args0.map({ args0 -> args0 }) })
/**
* The namespace to provision the resource in.
* The value should not contain leading or trailing forward slashes.
* The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
* *Available only for Vault Enterprise*.
*/
public val namespace: Output?
get() = javaResource.namespace().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* Policies which should be granted to user
*/
public val policies: Output>
get() = javaResource.policies().applyValue({ args0 -> args0.map({ args0 -> args0 }) })
/**
* The LDAP username
*/
public val username: Output
get() = javaResource.username().applyValue({ args0 -> args0 })
}
public object AuthBackendUserMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.vault.ldap.AuthBackendUser::class == javaResource::class
override fun map(javaResource: Resource): AuthBackendUser = AuthBackendUser(
javaResource as
com.pulumi.vault.ldap.AuthBackendUser,
)
}
/**
* @see [AuthBackendUser].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [AuthBackendUser].
*/
public suspend fun authBackendUser(
name: String,
block: suspend AuthBackendUserResourceBuilder.() -> Unit,
): AuthBackendUser {
val builder = AuthBackendUserResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [AuthBackendUser].
* @param name The _unique_ name of the resulting resource.
*/
public fun authBackendUser(name: String): AuthBackendUser {
val builder = AuthBackendUserResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy