pulumi-vault-kotlin/com.pulumi.vault.appRole.kotlin/AuthBackendRole

AuthBackendRole

class AuthBackendRole : KotlinCustomResource

Manages an AppRole auth backend role in a Vault server. See the [Vault

documentation](https://www.vaultproject.io/docs/auth/approle) for more information.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";
const approle = new vault.AuthBackend("approle", {type: "approle"});
const example = new vault.approle.AuthBackendRole("example", {
    backend: approle.path,
    roleName: "test-role",
    tokenPolicies: [
        "default",
        "dev",
        "prod",
    ],
});

import pulumi
import pulumi_vault as vault
approle = vault.AuthBackend("approle", type="approle")
example = vault.app_role.AuthBackendRole("example",
    backend=approle.path,
    role_name="test-role",
    token_policies=[
        "default",
        "dev",
        "prod",
    ])

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vault = Pulumi.Vault;
return await Deployment.RunAsync(() =>
{
    var approle = new Vault.AuthBackend("approle", new()
    {
        Type = "approle",
    });
    var example = new Vault.AppRole.AuthBackendRole("example", new()
    {
        Backend = approle.Path,
        RoleName = "test-role",
        TokenPolicies = new[]
        {
            "default",
            "dev",
            "prod",
        },
    });
});

package main
import (
	"github.com/pulumi/pulumi-vault/sdk/v6/go/vault"
	"github.com/pulumi/pulumi-vault/sdk/v6/go/vault/approle"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		approle, err := vault.NewAuthBackend(ctx, "approle", &vault.AuthBackendArgs{
			Type: pulumi.String("approle"),
		})
		if err != nil {
			return err
		}
		_, err = approle.NewAuthBackendRole(ctx, "example", &approle.AuthBackendRoleArgs{
			Backend:  approle.Path,
			RoleName: pulumi.String("test-role"),
			TokenPolicies: pulumi.StringArray{
				pulumi.String("default"),
				pulumi.String("dev"),
				pulumi.String("prod"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vault.AuthBackend;
import com.pulumi.vault.AuthBackendArgs;
import com.pulumi.vault.appRole.AuthBackendRole;
import com.pulumi.vault.appRole.AuthBackendRoleArgs;
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 approle = new AuthBackend("approle", AuthBackendArgs.builder()
            .type("approle")
            .build());
        var example = new AuthBackendRole("example", AuthBackendRoleArgs.builder()
            .backend(approle.path())
            .roleName("test-role")
            .tokenPolicies(
                "default",
                "dev",
                "prod")
            .build());
    }
}

resources:
  approle:
    type: vault:AuthBackend
    properties:
      type: approle
  example:
    type: vault:appRole:AuthBackendRole
    properties:
      backend: ${approle.path}
      roleName: test-role
      tokenPolicies:
        - default
        - dev
        - prod

Import

AppRole authentication backend roles can be imported using the path, e.g.

$ pulumi import vault:appRole/authBackendRole:AuthBackendRole example auth/approle/role/test-role

Properties

backend

val backend: Output<String>?

The unique name of the auth backend to configure. Defaults to approle.

bindSecretId

val bindSecretId: Output<Boolean>?

Whether or not to require secret_id to be presented when logging in using this AppRole. Defaults to true.

val id: Output<String>

namespace

val namespace: Output<String>?

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. Available only for Vault Enterprise.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

roleId

val roleId: Output<String>

The RoleID of this role. If not specified, one will be auto-generated.

roleName

val roleName: Output<String>

The name of the role.

secretIdBoundCidrs

val secretIdBoundCidrs: Output<List<String>>?

If set, specifies blocks of IP addresses which can perform the login operation.

secretIdNumUses

val secretIdNumUses: Output<Int>?

The number of times any particular SecretID can be used to fetch a token from this AppRole, after which the SecretID will expire. A value of zero will allow unlimited uses.

secretIdTtl

val secretIdTtl: Output<Int>?

The number of seconds after which any SecretID expires.

tokenBoundCidrs