Class AuthBackendLogin

Logs into Vault using the AppRole auth backend. See the Vault documentation for more information.

Example Usage

using Pulumi;
using Vault = Pulumi.Vault;

class MyStack : Stack
{
public MyStack()
{
    var approle = new Vault.AuthBackend("approle", new Vault.AuthBackendArgs
    {
        Type = "approle",
    });
    var example = new Vault.AppRole.AuthBackendRole("example", new Vault.AppRole.AuthBackendRoleArgs
    {
        Backend = approle.Path,
        Policies = 
        {
            "default",
            "dev",
            "prod",
        },
        RoleName = "test-role",
    });
    var id = new Vault.AppRole.AuthBackendRoleSecretID("id", new Vault.AppRole.AuthBackendRoleSecretIDArgs
    {
        Backend = approle.Path,
        RoleName = example.RoleName,
    });
    var login = new Vault.AppRole.AuthBackendLogin("login", new Vault.AppRole.AuthBackendLoginArgs
    {
        Backend = approle.Path,
        RoleId = example.RoleId,
        SecretId = id.SecretId,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

AuthBackendLogin

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Vault.AppRole

Assembly: Pulumi.Vault.dll

Syntax

public class AuthBackendLogin : CustomResource

Constructors

AuthBackendLogin(String, AuthBackendLoginArgs, CustomResourceOptions)

Create a AuthBackendLogin resource with the given unique name, arguments, and options.

Declaration

public AuthBackendLogin(string name, AuthBackendLoginArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
AuthBackendLoginArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Accessor

The accessor for the token.

Declaration

public Output<string> Accessor { get; }

Property Value

Type	Description
Output<System.String>

Backend

The unique path of the Vault backend to log in with.

Declaration

public Output<string> Backend { get; }

Property Value

Type	Description
Output<System.String>

ClientToken

The Vault token created.

Declaration

public Output<string> ClientToken { get; }

Property Value

Type	Description
Output<System.String>

LeaseDuration

How long the token is valid for, in seconds.

Declaration

public Output<int> LeaseDuration { get; }

Property Value

Type	Description
Output<System.Int32>

LeaseStarted

The date and time the lease started, in RFC 3339 format.

Declaration

public Output<string> LeaseStarted { get; }

Property Value

Type	Description
Output<System.String>

Metadata

The metadata associated with the token.

Declaration

public Output<ImmutableDictionary<string, string>> Metadata { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>

Policies

A list of policies applied to the token.

Declaration

public Output<ImmutableArray<string>> Policies { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

Renewable

Whether the token is renewable or not.

Declaration

public Output<bool> Renewable { get; }

Property Value

Type	Description
Output<System.Boolean>

RoleId

The ID of the role to log in with.

Declaration

public Output<string> RoleId { get; }

Property Value

Type	Description
Output<System.String>

SecretId

The secret ID of the role to log in with. Required unless bind_secret_id is set to false on the role.

Declaration

public Output<string> SecretId { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, AuthBackendLoginState, CustomResourceOptions)

Get an existing AuthBackendLogin resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static AuthBackendLogin Get(string name, Input<string> id, AuthBackendLoginState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
AuthBackendLoginState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
AuthBackendLogin