AuthBackendRole

Manages an Kubernetes 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 kubernetes = new Vault.AuthBackend("kubernetes", new Vault.AuthBackendArgs
        {
            Type = "kubernetes",
        });
        var example = new Vault.Kubernetes.AuthBackendRole("example", new Vault.Kubernetes.AuthBackendRoleArgs
        {
            Backend = kubernetes.Path,
            RoleName = "example-role",
            BoundServiceAccountNames = 
            {
                "example",
            },
            BoundServiceAccountNamespaces = 
            {
                "example",
            },
            TokenTtl = 3600,
            TokenPolicies = 
            {
                "default",
                "dev",
                "prod",
            },
            Audience = "vault",
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-vault/sdk/v4/go/vault"
	"github.com/pulumi/pulumi-vault/sdk/v4/go/vault/kubernetes"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		kubernetes, err := vault.NewAuthBackend(ctx, "kubernetes", &vault.AuthBackendArgs{
			Type: pulumi.String("kubernetes"),
		})
		if err != nil {
			return err
		}
		_, err = kubernetes.NewAuthBackendRole(ctx, "example", &kubernetes.AuthBackendRoleArgs{
			Backend:  kubernetes.Path,
			RoleName: pulumi.String("example-role"),
			BoundServiceAccountNames: pulumi.StringArray{
				pulumi.String("example"),
			},
			BoundServiceAccountNamespaces: pulumi.StringArray{
				pulumi.String("example"),
			},
			TokenTtl: pulumi.Int(3600),
			TokenPolicies: pulumi.StringArray{
				pulumi.String("default"),
				pulumi.String("dev"),
				pulumi.String("prod"),
			},
			Audience: pulumi.String("vault"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_vault as vault

kubernetes = vault.AuthBackend("kubernetes", type="kubernetes")
example = vault.kubernetes.AuthBackendRole("example",
    backend=kubernetes.path,
    role_name="example-role",
    bound_service_account_names=["example"],
    bound_service_account_namespaces=["example"],
    token_ttl=3600,
    token_policies=[
        "default",
        "dev",
        "prod",
    ],
    audience="vault")
import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";

const kubernetes = new vault.AuthBackend("kubernetes", {type: "kubernetes"});
const example = new vault.kubernetes.AuthBackendRole("example", {
    backend: kubernetes.path,
    roleName: "example-role",
    boundServiceAccountNames: ["example"],
    boundServiceAccountNamespaces: ["example"],
    tokenTtl: 3600,
    tokenPolicies: [
        "default",
        "dev",
        "prod",
    ],
    audience: "vault",
});

Create a AuthBackendRole Resource

new AuthBackendRole(name: string, args: AuthBackendRoleArgs, opts?: CustomResourceOptions);
@overload
def AuthBackendRole(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    audience: Optional[str] = None,
                    backend: Optional[str] = None,
                    bound_cidrs: Optional[Sequence[str]] = None,
                    bound_service_account_names: Optional[Sequence[str]] = None,
                    bound_service_account_namespaces: Optional[Sequence[str]] = None,
                    max_ttl: Optional[int] = None,
                    num_uses: Optional[int] = None,
                    period: Optional[int] = None,
                    policies: Optional[Sequence[str]] = None,
                    role_name: Optional[str] = None,
                    token_bound_cidrs: Optional[Sequence[str]] = None,
                    token_explicit_max_ttl: Optional[int] = None,
                    token_max_ttl: Optional[int] = None,
                    token_no_default_policy: Optional[bool] = None,
                    token_num_uses: Optional[int] = None,
                    token_period: Optional[int] = None,
                    token_policies: Optional[Sequence[str]] = None,
                    token_ttl: Optional[int] = None,
                    token_type: Optional[str] = None,
                    ttl: Optional[int] = None)
@overload
def AuthBackendRole(resource_name: str,
                    args: AuthBackendRoleArgs,
                    opts: Optional[ResourceOptions] = 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.
args AuthBackendRoleArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control 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 Architecture and Concepts docs.

Inputs

The AuthBackendRole resource accepts the following input properties:

BoundServiceAccountNames List<string>
List of service account names able to access this role. If set to ["*"] all names are allowed, both this and bound_service_account_namespaces can not be “*”.
BoundServiceAccountNamespaces List<string>
List of namespaces allowed to access this role. If set to ["*"] all namespaces are allowed, both this and bound_service_account_names can not be set to “*”.
RoleName string
Name of the role.
Audience string
Audience claim to verify in the JWT.
Backend string
Unique name of the kubernetes backend to configure.
BoundCidrs List<string>
If set, a list of CIDRs valid as the source address for login requests. This value is also encoded into any resulting token.

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

MaxTtl int
The maximum allowed lifetime of tokens issued using this role, provided as a number of seconds.

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

NumUses int
If set, puts a use-count limitation on the issued token.

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

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

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
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.
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.
Ttl int
The TTL period of tokens issued using this role, provided as a number of seconds.

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

BoundServiceAccountNames []string
List of service account names able to access this role. If set to ["*"] all names are allowed, both this and bound_service_account_namespaces can not be “*”.
BoundServiceAccountNamespaces []string
List of namespaces allowed to access this role. If set to ["*"] all namespaces are allowed, both this and bound_service_account_names can not be set to “*”.
RoleName string
Name of the role.
Audience string
Audience claim to verify in the JWT.
Backend string
Unique name of the kubernetes backend to configure.
BoundCidrs []string
If set, a list of CIDRs valid as the source address for login requests. This value is also encoded into any resulting token.

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

MaxTtl int
The maximum allowed lifetime of tokens issued using this role, provided as a number of seconds.

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

NumUses int
If set, puts a use-count limitation on the issued token.

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

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 []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

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
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.
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
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.
Ttl int
The TTL period of tokens issued using this role, provided as a number of seconds.

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

boundServiceAccountNames string[]
List of service account names able to access this role. If set to ["*"] all names are allowed, both this and bound_service_account_namespaces can not be “*”.
boundServiceAccountNamespaces string[]
List of namespaces allowed to access this role. If set to ["*"] all namespaces are allowed, both this and bound_service_account_names can not be set to “*”.
roleName string
Name of the role.
audience string
Audience claim to verify in the JWT.
backend string
Unique name of the kubernetes backend to configure.
boundCidrs string[]
If set, a list of CIDRs valid as the source address for login requests. This value is also encoded into any resulting token.

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

maxTtl number
The maximum allowed lifetime of tokens issued using this role, provided as a number of seconds.

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

numUses number
If set, puts a use-count limitation on the issued token.

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

period number
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 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

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
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.
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
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.
ttl number
The TTL period of tokens issued using this role, provided as a number of seconds.

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

bound_service_account_names Sequence[str]
List of service account names able to access this role. If set to ["*"] all names are allowed, both this and bound_service_account_namespaces can not be “*”.
bound_service_account_namespaces Sequence[str]
List of namespaces allowed to access this role. If set to ["*"] all namespaces are allowed, both this and bound_service_account_names can not be set to “*”.
role_name str
Name of the role.
audience str
Audience claim to verify in the JWT.
backend str
Unique name of the kubernetes backend to configure.
bound_cidrs Sequence[str]
If set, a list of CIDRs valid as the source address for login requests. This value is also encoded into any resulting token.

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

max_ttl int
The maximum allowed lifetime of tokens issued using this role, provided as a number of seconds.

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

num_uses int
If set, puts a use-count limitation on the issued token.

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

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 Sequence[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

token_bound_cidrs Sequence[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 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.
token_max_ttl int
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 int
The period, if any, in number of seconds to set on the token.
token_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.
token_policies Sequence[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 int
The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
token_type str
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.
ttl int
The TTL period of tokens issued using this role, provided as a number of seconds.

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

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
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        audience: Optional[str] = None,
        backend: Optional[str] = None,
        bound_cidrs: Optional[Sequence[str]] = None,
        bound_service_account_names: Optional[Sequence[str]] = None,
        bound_service_account_namespaces: Optional[Sequence[str]] = None,
        max_ttl: Optional[int] = None,
        num_uses: Optional[int] = None,
        period: Optional[int] = None,
        policies: Optional[Sequence[str]] = None,
        role_name: Optional[str] = None,
        token_bound_cidrs: Optional[Sequence[str]] = None,
        token_explicit_max_ttl: Optional[int] = None,
        token_max_ttl: Optional[int] = None,
        token_no_default_policy: Optional[bool] = None,
        token_num_uses: Optional[int] = None,
        token_period: Optional[int] = None,
        token_policies: Optional[Sequence[str]] = None,
        token_ttl: Optional[int] = None,
        token_type: Optional[str] = None,
        ttl: Optional[int] = None) -> AuthBackendRole
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:

Audience string
Audience claim to verify in the JWT.
Backend string
Unique name of the kubernetes backend to configure.
BoundCidrs List<string>
If set, a list of CIDRs valid as the source address for login requests. This value is also encoded into any resulting token.

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

BoundServiceAccountNames List<string>
List of service account names able to access this role. If set to ["*"] all names are allowed, both this and bound_service_account_namespaces can not be “*”.
BoundServiceAccountNamespaces List<string>
List of namespaces allowed to access this role. If set to ["*"] all namespaces are allowed, both this and bound_service_account_names can not be set to “*”.
MaxTtl int
The maximum allowed lifetime of tokens issued using this role, provided as a number of seconds.

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

NumUses int
If set, puts a use-count limitation on the issued token.

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

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

RoleName string
Name of the role.
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
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.
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.
Ttl int
The TTL period of tokens issued using this role, provided as a number of seconds.

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

Audience string
Audience claim to verify in the JWT.
Backend string
Unique name of the kubernetes backend to configure.
BoundCidrs []string
If set, a list of CIDRs valid as the source address for login requests. This value is also encoded into any resulting token.

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

BoundServiceAccountNames []string
List of service account names able to access this role. If set to ["*"] all names are allowed, both this and bound_service_account_namespaces can not be “*”.
BoundServiceAccountNamespaces []string
List of namespaces allowed to access this role. If set to ["*"] all namespaces are allowed, both this and bound_service_account_names can not be set to “*”.
MaxTtl int
The maximum allowed lifetime of tokens issued using this role, provided as a number of seconds.

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

NumUses int
If set, puts a use-count limitation on the issued token.

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

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 []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

RoleName string
Name of the role.
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
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.
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
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.
Ttl int
The TTL period of tokens issued using this role, provided as a number of seconds.

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

audience string
Audience claim to verify in the JWT.
backend string
Unique name of the kubernetes backend to configure.
boundCidrs string[]
If set, a list of CIDRs valid as the source address for login requests. This value is also encoded into any resulting token.

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

boundServiceAccountNames string[]
List of service account names able to access this role. If set to ["*"] all names are allowed, both this and bound_service_account_namespaces can not be “*”.
boundServiceAccountNamespaces string[]
List of namespaces allowed to access this role. If set to ["*"] all namespaces are allowed, both this and bound_service_account_names can not be set to “*”.
maxTtl number
The maximum allowed lifetime of tokens issued using this role, provided as a number of seconds.

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

numUses number
If set, puts a use-count limitation on the issued token.

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

period number
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 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

roleName string
Name of the role.
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
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.
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
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.
ttl number
The TTL period of tokens issued using this role, provided as a number of seconds.

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

audience str
Audience claim to verify in the JWT.
backend str
Unique name of the kubernetes backend to configure.
bound_cidrs Sequence[str]
If set, a list of CIDRs valid as the source address for login requests. This value is also encoded into any resulting token.

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

bound_service_account_names Sequence[str]
List of service account names able to access this role. If set to ["*"] all names are allowed, both this and bound_service_account_namespaces can not be “*”.
bound_service_account_namespaces Sequence[str]
List of namespaces allowed to access this role. If set to ["*"] all namespaces are allowed, both this and bound_service_account_names can not be set to “*”.
max_ttl int
The maximum allowed lifetime of tokens issued using this role, provided as a number of seconds.

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

num_uses int
If set, puts a use-count limitation on the issued token.

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

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 Sequence[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_name str
Name of the role.
token_bound_cidrs Sequence[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 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.
token_max_ttl int
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 int
The period, if any, in number of seconds to set on the token.
token_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.
token_policies Sequence[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 int
The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
token_type str
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.
ttl int
The TTL period of tokens issued using this role, provided as a number of seconds.

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

Import

Kubernetes auth backend role can be imported using the path, e.g.

 $ pulumi import vault:kubernetes/authBackendRole:AuthBackendRole foo auth/kubernetes/role/foo

Package Details

Repository
https://github.com/pulumi/pulumi-vault
License
Apache-2.0
Notes
This Pulumi package is based on the vault Terraform Provider.