Class AuthBackendRole

Manages an AppRole auth backend role in a Vault server. 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,
        RoleName = "test-role",
        TokenPolicies = 
        {
            "default",
            "dev",
            "prod",
        },
    });
}

}

Inheritance

System.Object

Resource

CustomResource

AuthBackendRole

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 AuthBackendRole : CustomResource

Constructors

AuthBackendRole(String, AuthBackendRoleArgs, CustomResourceOptions)

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

Declaration

public AuthBackendRole(string name, AuthBackendRoleArgs args, CustomResourceOptions options = null)

Parameters

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

Properties

Backend

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

Declaration

public Output<string> Backend { get; }

Property Value

Type	Description
Output<System.String>

BindSecretId

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

Declaration

public Output<bool?> BindSecretId { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

BoundCidrLists

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

Declaration

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

Property Value

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

Period

If set, indicates that the token generated using this role should never expire. The token should be renewed within the duration specified by this value. At each renewal, the token's TTL will be set to the value of this field. Specified in seconds.

Declaration

public Output<int?> Period { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

Policies

An array of strings specifying the policies to be set on tokens issued using this role.

Declaration

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

Property Value

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

RoleId

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

Declaration

public Output<string> RoleId { get; }

Property Value

Type	Description
Output<System.String>

RoleName

The name of the role.

Declaration

public Output<string> RoleName { get; }

Property Value

Type	Description
Output<System.String>

SecretIdBoundCidrs

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

Declaration

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

Property Value

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

SecretIdNumUses

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.

Declaration

public Output<int?> SecretIdNumUses { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

SecretIdTtl

The number of seconds after which any SecretID expires.

Declaration

public Output<int?> SecretIdTtl { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

TokenBoundCidrs

List of CIDR blocks; if set, specifies blocks of IP addresses which can authenticate successfully, and ties the resulting token to these blocks as well.

Declaration

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

Property Value

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

TokenExplicitMaxTtl

If set, will encode an explicit max TTL onto the token in number of seconds. This is a hard cap even if token_ttl and token_max_ttl would otherwise allow a renewal.

Declaration

public Output<int?> TokenExplicitMaxTtl { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

TokenMaxTtl

The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.

Declaration

public Output<int?> TokenMaxTtl { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

TokenNoDefaultPolicy

If set, the default policy will not be set on generated tokens; otherwise it will be added to the policies set in token_policies.

Declaration

public Output<bool?> TokenNoDefaultPolicy { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

TokenNumUses

The period, if any, in number of seconds to set on the token.

Declaration

public Output<int?> TokenNumUses { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

TokenPeriod

If set, indicates that the token generated using this role should never expire. The token should be renewed within the duration specified by this value. At each renewal, the token's TTL will be set to the value of this field. Specified in seconds.

Declaration

public Output<int?> TokenPeriod { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

TokenPolicies

List of policies to encode onto generated tokens. Depending on the auth method, this list may be supplemented by user/group/other values.

Declaration

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

Property Value

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

TokenTtl

The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.

Declaration

public Output<int?> TokenTtl { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

TokenType

The type of token that should be generated. Can be service, batch, or default to use the mount's tuned default (which unless changed will be service tokens). For token store roles, there are two additional possibilities: default-service and default-batch which specify the type to return unless the client requests a different type at generation time.

Declaration

public Output<string> TokenType { get; }

Property Value

Type	Description
Output<System.String>

Methods

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

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

Declaration

public static AuthBackendRole Get(string name, Input<string> id, AuthBackendRoleState 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.
AuthBackendRoleState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
AuthBackendRole