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",
            },
        });
    }

}

Coming soon!

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",
    ])

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",
    ],
});

Create a AuthBackendRole Resource

new AuthBackendRole(name: string, args: AuthBackendRoleArgs, opts?: CustomResourceOptions);

def AuthBackendRole(resource_name, opts=None, backend=None, bind_secret_id=None, bound_cidr_lists=None, period=None, policies=None, role_id=None, role_name=None, secret_id_bound_cidrs=None, secret_id_num_uses=None, secret_id_ttl=None, token_bound_cidrs=None, token_explicit_max_ttl=None, token_max_ttl=None, token_no_default_policy=None, token_num_uses=None, token_period=None, token_policies=None, token_ttl=None, token_type=None, __props__=None);

func NewAuthBackendRole(ctx *Context, name string, args AuthBackendRoleArgs, opts ...ResourceOption) (*AuthBackendRole, error)

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

name string: The unique name of the resource.
args AuthBackendRoleArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args AuthBackendRoleArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AuthBackendRoleArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

AuthBackendRole Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The AuthBackendRole resource accepts the following input properties:

RoleName string

The name of the role.

Backend string

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

BindSecretId bool

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

BoundCidrLists List<string>

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

Deprecated: use secret_id_bound_cidrs instead

Period int

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.

Deprecated: use token_period instead if you are running Vault >= 1.2

Policies List<string>

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

Deprecated: use token_policies instead if you are running Vault >= 1.2

RoleId string

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

SecretIdBoundCidrs List<string>

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

SecretIdNumUses 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 int

The number of seconds after which any SecretID expires.

TokenBoundCidrs List<string>

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.

TokenExplicitMaxTtl int

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.

TokenMaxTtl int

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

TokenNoDefaultPolicy bool

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

TokenNumUses int

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

TokenPeriod int

TokenPolicies List<string>

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

TokenTtl int

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

TokenType string

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.

RoleName string

The name of the role.

Backend string

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

BindSecretId bool

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

BoundCidrLists []string

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

Deprecated: use secret_id_bound_cidrs instead

Period int

Deprecated: use token_period instead if you are running Vault >= 1.2

Policies []string

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

Deprecated: use token_policies instead if you are running Vault >= 1.2

RoleId string

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

SecretIdBoundCidrs []string

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

SecretIdNumUses 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 int

The number of seconds after which any SecretID expires.

TokenBoundCidrs []string

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.

TokenExplicitMaxTtl int

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.

TokenMaxTtl int

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

TokenNoDefaultPolicy bool

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

TokenNumUses int

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

TokenPeriod int

TokenPolicies []string

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

TokenTtl int

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

TokenType string

roleName string

The name of the role.

backend string

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

bindSecretId boolean

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

boundCidrLists string[]

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

Deprecated: use secret_id_bound_cidrs instead

period number

Deprecated: use token_period instead if you are running Vault >= 1.2

policies string[]

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

Deprecated: use token_policies instead if you are running Vault >= 1.2

roleId string

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

secretIdBoundCidrs string[]

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

secretIdNumUses number

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 number

The number of seconds after which any SecretID expires.

tokenBoundCidrs string[]

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.

tokenExplicitMaxTtl number

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.

tokenMaxTtl number

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

tokenNoDefaultPolicy boolean

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

tokenNumUses number

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

tokenPeriod number

tokenPolicies string[]

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

tokenTtl number

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

tokenType string

role_name str

The name of the role.

backend str

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

bind_secret_id bool

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

bound_cidr_lists List[str]

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

Deprecated: use secret_id_bound_cidrs instead

period float

Deprecated: use token_period instead if you are running Vault >= 1.2

policies List[str]

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

Deprecated: use token_policies instead if you are running Vault >= 1.2

role_id str

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

secret_id_bound_cidrs List[str]

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

secret_id_num_uses float

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.

secret_id_ttl float

The number of seconds after which any SecretID expires.

token_bound_cidrs List[str]

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.

token_explicit_max_ttl float

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.

token_max_ttl float

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

token_no_default_policy bool

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

token_num_uses float

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

token_period float

token_policies List[str]

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

token_ttl float

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

token_type str

Outputs

All input properties are implicitly available as output properties. Additionally, the AuthBackendRole resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing AuthBackendRole Resource

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

public static get(name: string, id: Input<ID>, state?: AuthBackendRoleState, opts?: CustomResourceOptions): AuthBackendRole

static get(resource_name, id, opts=None, backend=None, bind_secret_id=None, bound_cidr_lists=None, period=None, policies=None, role_id=None, role_name=None, secret_id_bound_cidrs=None, secret_id_num_uses=None, secret_id_ttl=None, token_bound_cidrs=None, token_explicit_max_ttl=None, token_max_ttl=None, token_no_default_policy=None, token_num_uses=None, token_period=None, token_policies=None, token_ttl=None, token_type=None, __props__=None);

func GetAuthBackendRole(ctx *Context, name string, id IDInput, state *AuthBackendRoleState, opts ...ResourceOption) (*AuthBackendRole, error)

public static AuthBackendRole Get(string name, Input<string> id, AuthBackendRoleState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Backend string

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

BindSecretId bool

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

BoundCidrLists List<string>

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

Deprecated: use secret_id_bound_cidrs instead

Period int

Deprecated: use token_period instead if you are running Vault >= 1.2

Policies List<string>

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

Deprecated: use token_policies instead if you are running Vault >= 1.2

RoleId string

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

RoleName string

The name of the role.

SecretIdBoundCidrs List<string>

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

SecretIdNumUses 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 int

The number of seconds after which any SecretID expires.

TokenBoundCidrs List<string>

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.

TokenExplicitMaxTtl int

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.

TokenMaxTtl int

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

TokenNoDefaultPolicy bool

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

TokenNumUses int

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

TokenPeriod int

TokenPolicies List<string>

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

TokenTtl int

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

TokenType string

Backend string

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

BindSecretId bool

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

BoundCidrLists []string

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

Deprecated: use secret_id_bound_cidrs instead

Period int

Deprecated: use token_period instead if you are running Vault >= 1.2

Policies []string

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

Deprecated: use token_policies instead if you are running Vault >= 1.2

RoleId string

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

RoleName string

The name of the role.

SecretIdBoundCidrs []string

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

SecretIdNumUses 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 int

The number of seconds after which any SecretID expires.

TokenBoundCidrs []string

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.

TokenExplicitMaxTtl int

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.

TokenMaxTtl int

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

TokenNoDefaultPolicy bool

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

TokenNumUses int

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

TokenPeriod int

TokenPolicies []string

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

TokenTtl int

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

TokenType string

backend string

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

bindSecretId boolean

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

boundCidrLists string[]

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

Deprecated: use secret_id_bound_cidrs instead

period number

Deprecated: use token_period instead if you are running Vault >= 1.2

policies string[]

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

Deprecated: use token_policies instead if you are running Vault >= 1.2

roleId string

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

roleName string

The name of the role.

secretIdBoundCidrs string[]

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

secretIdNumUses number

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 number

The number of seconds after which any SecretID expires.

tokenBoundCidrs string[]

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.

tokenExplicitMaxTtl number

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.

tokenMaxTtl number

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

tokenNoDefaultPolicy boolean

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

tokenNumUses number

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

tokenPeriod number

tokenPolicies string[]

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

tokenTtl number

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

tokenType string

backend str

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

bind_secret_id bool

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

bound_cidr_lists List[str]

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

Deprecated: use secret_id_bound_cidrs instead

period float

Deprecated: use token_period instead if you are running Vault >= 1.2

policies List[str]

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

Deprecated: use token_policies instead if you are running Vault >= 1.2

role_id str

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

role_name str

The name of the role.

secret_id_bound_cidrs List[str]

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

secret_id_num_uses float

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.

secret_id_ttl float

The number of seconds after which any SecretID expires.

token_bound_cidrs List[str]

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.

token_explicit_max_ttl float

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.

token_max_ttl float