vault.kubernetes.AuthBackendRole
Explore with Pulumi AI
Manages an Kubernetes auth backend role in a Vault server. See the Vault documentation for more information.
Example Usage
using System.Collections.Generic;
using Pulumi;
using Vault = Pulumi.Vault;
return await Deployment.RunAsync(() =>
{
var kubernetes = new Vault.AuthBackend("kubernetes", new()
{
Type = "kubernetes",
});
var example = new Vault.Kubernetes.AuthBackendRole("example", new()
{
Backend = kubernetes.Path,
RoleName = "example-role",
BoundServiceAccountNames = new[]
{
"example",
},
BoundServiceAccountNamespaces = new[]
{
"example",
},
TokenTtl = 3600,
TokenPolicies = new[]
{
"default",
"dev",
"prod",
},
Audience = "vault",
});
});
package main
import (
"github.com/pulumi/pulumi-vault/sdk/v5/go/vault"
"github.com/pulumi/pulumi-vault/sdk/v5/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
})
}
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.kubernetes.AuthBackendRole;
import com.pulumi.vault.kubernetes.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 kubernetes = new AuthBackend("kubernetes", AuthBackendArgs.builder()
.type("kubernetes")
.build());
var example = new AuthBackendRole("example", AuthBackendRoleArgs.builder()
.backend(kubernetes.path())
.roleName("example-role")
.boundServiceAccountNames("example")
.boundServiceAccountNamespaces("example")
.tokenTtl(3600)
.tokenPolicies(
"default",
"dev",
"prod")
.audience("vault")
.build());
}
}
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",
});
resources:
kubernetes:
type: vault:AuthBackend
properties:
type: kubernetes
example:
type: vault:kubernetes:AuthBackendRole
properties:
backend: ${kubernetes.path}
roleName: example-role
boundServiceAccountNames:
- example
boundServiceAccountNamespaces:
- example
tokenTtl: 3600
tokenPolicies:
- default
- dev
- prod
audience: vault
Create AuthBackendRole Resource
new AuthBackendRole(name: string, args: AuthBackendRoleArgs, opts?: CustomResourceOptions);
@overload
def AuthBackendRole(resource_name: str,
opts: Optional[ResourceOptions] = None,
alias_name_source: Optional[str] = None,
audience: Optional[str] = None,
backend: Optional[str] = None,
bound_service_account_names: Optional[Sequence[str]] = None,
bound_service_account_namespaces: Optional[Sequence[str]] = None,
namespace: Optional[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)
@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)
public AuthBackendRole(String name, AuthBackendRoleArgs args)
public AuthBackendRole(String name, AuthBackendRoleArgs args, CustomResourceOptions options)
type: vault:kubernetes:AuthBackendRole
properties: # The arguments to resource properties.
options: # 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.
- 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.
- name String
- The unique name of the resource.
- args AuthBackendRoleArgs
- The arguments to resource properties.
- options 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:
- Bound
Service List<string>Account Names 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 List<string>Account Namespaces 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 string Name of the role.
- Alias
Name stringSource Configures how identity aliases are generated. Valid choices are:
serviceaccount_uid
,serviceaccount_name
. (vault-1.9+)- Audience string
Audience claim to verify in the JWT.
- Backend string
Unique name of the kubernetes backend to configure.
- Namespace 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.- Token
Bound List<string>Cidrs 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 intMax Ttl If set, will encode an explicit max TTL onto the token in number of seconds. This is a hard cap even if
token_ttl
andtoken_max_ttl
would otherwise allow a renewal.- Token
Max intTtl The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- Token
No boolDefault Policy 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 intUses The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.
- 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 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.
- Token
Ttl int The initial ttl of the token to generate in seconds
- Token
Type string The type of token that should be generated. Can be
service
,batch
, ordefault
to use the mount's tuned default (which unless changed will beservice
tokens). For token store roles, there are two additional possibilities:default-service
anddefault-batch
which specify the type to return unless the client requests a different type at generation time.
- Bound
Service []stringAccount Names 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 []stringAccount Namespaces 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 string Name of the role.
- Alias
Name stringSource Configures how identity aliases are generated. Valid choices are:
serviceaccount_uid
,serviceaccount_name
. (vault-1.9+)- Audience string
Audience claim to verify in the JWT.
- Backend string
Unique name of the kubernetes backend to configure.
- Namespace 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.- Token
Bound []stringCidrs 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 intMax Ttl If set, will encode an explicit max TTL onto the token in number of seconds. This is a hard cap even if
token_ttl
andtoken_max_ttl
would otherwise allow a renewal.- Token
Max intTtl The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- Token
No boolDefault Policy 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 intUses The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.
- 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 []string 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 initial ttl of the token to generate in seconds
- Token
Type string The type of token that should be generated. Can be
service
,batch
, ordefault
to use the mount's tuned default (which unless changed will beservice
tokens). For token store roles, there are two additional possibilities:default-service
anddefault-batch
which specify the type to return unless the client requests a different type at generation time.
- bound
Service List<String>Account Names 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 List<String>Account Namespaces 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 String Name of the role.
- alias
Name StringSource Configures how identity aliases are generated. Valid choices are:
serviceaccount_uid
,serviceaccount_name
. (vault-1.9+)- audience String
Audience claim to verify in the JWT.
- backend String
Unique name of the kubernetes backend to configure.
- namespace 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.- token
Bound List<String>Cidrs 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 IntegerMax Ttl If set, will encode an explicit max TTL onto the token in number of seconds. This is a hard cap even if
token_ttl
andtoken_max_ttl
would otherwise allow a renewal.- token
Max IntegerTtl The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token
No BooleanDefault Policy 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 IntegerUses The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.
- token
Period Integer 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 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.
- token
Ttl Integer The initial ttl of the token to generate in seconds
- token
Type String The type of token that should be generated. Can be
service
,batch
, ordefault
to use the mount's tuned default (which unless changed will beservice
tokens). For token store roles, there are two additional possibilities:default-service
anddefault-batch
which specify the type to return unless the client requests a different type at generation time.
- bound
Service string[]Account Names 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 string[]Account Namespaces 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 string Name of the role.
- alias
Name stringSource Configures how identity aliases are generated. Valid choices are:
serviceaccount_uid
,serviceaccount_name
. (vault-1.9+)- audience string
Audience claim to verify in the JWT.
- backend string
Unique name of the kubernetes backend to configure.
- namespace 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.- token
Bound string[]Cidrs 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 numberMax Ttl If set, will encode an explicit max TTL onto the token in number of seconds. This is a hard cap even if
token_ttl
andtoken_max_ttl
would otherwise allow a renewal.- token
Max numberTtl The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token
No booleanDefault Policy 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 numberUses The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.
- token
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.
- token
Policies string[] 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 number The initial ttl of the token to generate in seconds
- token
Type string The type of token that should be generated. Can be
service
,batch
, ordefault
to use the mount's tuned default (which unless changed will beservice
tokens). For token store roles, there are two additional possibilities:default-service
anddefault-batch
which specify the type to return unless the client requests a different type at generation time.
- bound_
service_ Sequence[str]account_ names 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_ Sequence[str]account_ namespaces 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.
- alias_
name_ strsource Configures how identity aliases are generated. Valid choices are:
serviceaccount_uid
,serviceaccount_name
. (vault-1.9+)- audience str
Audience claim to verify in the JWT.
- backend str
Unique name of the kubernetes backend to configure.
- namespace str
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.- token_
bound_ Sequence[str]cidrs 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_ intmax_ ttl If set, will encode an explicit max TTL onto the token in number of seconds. This is a hard cap even if
token_ttl
andtoken_max_ttl
would otherwise allow a renewal.- token_
max_ intttl The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token_
no_ booldefault_ policy 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_ intuses The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.
- 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 initial ttl of the token to generate in seconds
- token_
type str The type of token that should be generated. Can be
service
,batch
, ordefault
to use the mount's tuned default (which unless changed will beservice
tokens). For token store roles, there are two additional possibilities:default-service
anddefault-batch
which specify the type to return unless the client requests a different type at generation time.
- bound
Service List<String>Account Names 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 List<String>Account Namespaces 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 String Name of the role.
- alias
Name StringSource Configures how identity aliases are generated. Valid choices are:
serviceaccount_uid
,serviceaccount_name
. (vault-1.9+)- audience String
Audience claim to verify in the JWT.
- backend String
Unique name of the kubernetes backend to configure.
- namespace 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.- token
Bound List<String>Cidrs 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 NumberMax Ttl If set, will encode an explicit max TTL onto the token in number of seconds. This is a hard cap even if
token_ttl
andtoken_max_ttl
would otherwise allow a renewal.- token
Max NumberTtl The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token
No BooleanDefault Policy 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 NumberUses The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.
- token
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.
- token
Policies 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.
- token
Ttl Number The initial ttl of the token to generate in seconds
- token
Type String The type of token that should be generated. Can be
service
,batch
, ordefault
to use the mount's tuned default (which unless changed will beservice
tokens). For token store roles, there are two additional possibilities:default-service
anddefault-batch
which specify the type to return unless the client requests a different type at generation time.
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 string
The provider-assigned unique ID for this managed resource.
- id str
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
Look up 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,
alias_name_source: Optional[str] = None,
audience: Optional[str] = None,
backend: Optional[str] = None,
bound_service_account_names: Optional[Sequence[str]] = None,
bound_service_account_namespaces: Optional[Sequence[str]] = None,
namespace: Optional[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) -> 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)
public static AuthBackendRole get(String name, Output<String> id, AuthBackendRoleState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- 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.
- 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.
- Alias
Name stringSource Configures how identity aliases are generated. Valid choices are:
serviceaccount_uid
,serviceaccount_name
. (vault-1.9+)- Audience string
Audience claim to verify in the JWT.
- Backend string
Unique name of the kubernetes backend to configure.
- Bound
Service List<string>Account Names 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 List<string>Account Namespaces 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 "*".- Namespace 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.- Role
Name string Name of the role.
- Token
Bound List<string>Cidrs 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 intMax Ttl If set, will encode an explicit max TTL onto the token in number of seconds. This is a hard cap even if
token_ttl
andtoken_max_ttl
would otherwise allow a renewal.- Token
Max intTtl The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- Token
No boolDefault Policy 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 intUses The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.
- 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 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.
- Token
Ttl int The initial ttl of the token to generate in seconds
- Token
Type string The type of token that should be generated. Can be
service
,batch
, ordefault
to use the mount's tuned default (which unless changed will beservice
tokens). For token store roles, there are two additional possibilities:default-service
anddefault-batch
which specify the type to return unless the client requests a different type at generation time.
- Alias
Name stringSource Configures how identity aliases are generated. Valid choices are:
serviceaccount_uid
,serviceaccount_name
. (vault-1.9+)- Audience string
Audience claim to verify in the JWT.
- Backend string
Unique name of the kubernetes backend to configure.
- Bound
Service []stringAccount Names 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 []stringAccount Namespaces 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 "*".- Namespace 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.- Role
Name string Name of the role.
- Token
Bound []stringCidrs 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 intMax Ttl If set, will encode an explicit max TTL onto the token in number of seconds. This is a hard cap even if
token_ttl
andtoken_max_ttl
would otherwise allow a renewal.- Token
Max intTtl The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- Token
No boolDefault Policy 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 intUses The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.
- 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 []string 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 initial ttl of the token to generate in seconds
- Token
Type string The type of token that should be generated. Can be
service
,batch
, ordefault
to use the mount's tuned default (which unless changed will beservice
tokens). For token store roles, there are two additional possibilities:default-service
anddefault-batch
which specify the type to return unless the client requests a different type at generation time.
- alias
Name StringSource Configures how identity aliases are generated. Valid choices are:
serviceaccount_uid
,serviceaccount_name
. (vault-1.9+)- audience String
Audience claim to verify in the JWT.
- backend String
Unique name of the kubernetes backend to configure.
- bound
Service List<String>Account Names 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 List<String>Account Namespaces 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 "*".- namespace 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.- role
Name String Name of the role.
- token
Bound List<String>Cidrs 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 IntegerMax Ttl If set, will encode an explicit max TTL onto the token in number of seconds. This is a hard cap even if
token_ttl
andtoken_max_ttl
would otherwise allow a renewal.- token
Max IntegerTtl The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token
No BooleanDefault Policy 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 IntegerUses The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.
- token
Period Integer 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 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.
- token
Ttl Integer The initial ttl of the token to generate in seconds
- token
Type String The type of token that should be generated. Can be
service
,batch
, ordefault
to use the mount's tuned default (which unless changed will beservice
tokens). For token store roles, there are two additional possibilities:default-service
anddefault-batch
which specify the type to return unless the client requests a different type at generation time.
- alias
Name stringSource Configures how identity aliases are generated. Valid choices are:
serviceaccount_uid
,serviceaccount_name
. (vault-1.9+)- audience string
Audience claim to verify in the JWT.
- backend string
Unique name of the kubernetes backend to configure.
- bound
Service string[]Account Names 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 string[]Account Namespaces 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 "*".- namespace 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.- role
Name string Name of the role.
- token
Bound string[]Cidrs 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 numberMax Ttl If set, will encode an explicit max TTL onto the token in number of seconds. This is a hard cap even if
token_ttl
andtoken_max_ttl
would otherwise allow a renewal.- token
Max numberTtl The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token
No booleanDefault Policy 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 numberUses The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.
- token
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.
- token
Policies string[] 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 number The initial ttl of the token to generate in seconds
- token
Type string The type of token that should be generated. Can be
service
,batch
, ordefault
to use the mount's tuned default (which unless changed will beservice
tokens). For token store roles, there are two additional possibilities:default-service
anddefault-batch
which specify the type to return unless the client requests a different type at generation time.
- alias_
name_ strsource Configures how identity aliases are generated. Valid choices are:
serviceaccount_uid
,serviceaccount_name
. (vault-1.9+)- audience str
Audience claim to verify in the JWT.
- backend str
Unique name of the kubernetes backend to configure.
- bound_
service_ Sequence[str]account_ names 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_ Sequence[str]account_ namespaces 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 "*".- namespace str
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.- role_
name str Name of the role.
- token_
bound_ Sequence[str]cidrs 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_ intmax_ ttl If set, will encode an explicit max TTL onto the token in number of seconds. This is a hard cap even if
token_ttl
andtoken_max_ttl
would otherwise allow a renewal.- token_
max_ intttl The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token_
no_ booldefault_ policy 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_ intuses The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.
- 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 initial ttl of the token to generate in seconds
- token_
type str The type of token that should be generated. Can be
service
,batch
, ordefault
to use the mount's tuned default (which unless changed will beservice
tokens). For token store roles, there are two additional possibilities:default-service
anddefault-batch
which specify the type to return unless the client requests a different type at generation time.
- alias
Name StringSource Configures how identity aliases are generated. Valid choices are:
serviceaccount_uid
,serviceaccount_name
. (vault-1.9+)- audience String
Audience claim to verify in the JWT.
- backend String
Unique name of the kubernetes backend to configure.
- bound
Service List<String>Account Names 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 List<String>Account Namespaces 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 "*".- namespace 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.- role
Name String Name of the role.
- token
Bound List<String>Cidrs 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 NumberMax Ttl If set, will encode an explicit max TTL onto the token in number of seconds. This is a hard cap even if
token_ttl
andtoken_max_ttl
would otherwise allow a renewal.- token
Max NumberTtl The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token
No BooleanDefault Policy 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 NumberUses The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.
- token
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.
- token
Policies 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.
- token
Ttl Number The initial ttl of the token to generate in seconds
- token
Type String The type of token that should be generated. Can be
service
,batch
, ordefault
to use the mount's tuned default (which unless changed will beservice
tokens). For token store roles, there are two additional possibilities:default-service
anddefault-batch
which specify the type to return unless the client requests a different type at generation time.
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
- Vault pulumi/pulumi-vault
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
vault
Terraform Provider.