1. Docs
  2. Reference
  3. API
  4. pulumi_vault
  5. tokenauth

tokenauth

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-vault repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-vault repo.

class pulumi_vault.tokenauth.AuthBackendRole(resource_name, opts=None, allowed_policies=None, bound_cidrs=None, disallowed_policies=None, explicit_max_ttl=None, orphan=None, path_suffix=None, period=None, renewable=None, role_name=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, __name__=None, __opts__=None)

Manages Token auth backend role in a Vault server. See the Vault documentation for more information.

import pulumi
import pulumi_vault as vault

example = vault.tokenauth.AuthBackendRole("example",
    allowed_policies=[
        "dev",
        "test",
    ],
    disallowed_policies=["default"],
    explicit_max_ttl="115200",
    orphan=True,
    path_suffix="path-suffix",
    period="86400",
    renewable=True,
    role_name="my-role")
Parameters

  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • allowed_policies (pulumi.Input[list]) – List of allowed policies for given role.

  • bound_cidrs (pulumi.Input[list]) – If set, a list of CIDRs valid as the source address for login requests. This value is also encoded into any resulting token.

  • disallowed_policies (pulumi.Input[list]) – List of disallowed policies for given role.

  • explicit_max_ttl (pulumi.Input[str]) – If set, the token will have an explicit max TTL set upon it.

  • orphan (pulumi.Input[bool]) – If true, tokens created against this policy will be orphan tokens.

  • path_suffix (pulumi.Input[str]) – Tokens created against this role will have the given suffix as part of their path in addition to the role name.

  • period (pulumi.Input[str]) – 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.

  • renewable (pulumi.Input[bool]) – Wether to disable the ability of the token to be renewed past its initial TTL.

  • role_name (pulumi.Input[str]) – The name of the role.

  • token_bound_cidrs (pulumi.Input[list]) – 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 (pulumi.Input[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 (pulumi.Input[float]) – The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.

  • token_no_default_policy (pulumi.Input[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 (pulumi.Input[float]) – The period, if any, in number of seconds to set on the token.

  • token_period (pulumi.Input[float]) – 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 (pulumi.Input[list]) – Generated Token’s Policies

  • token_ttl (pulumi.Input[float]) – The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.

  • token_type (pulumi.Input[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.

allowed_policies: pulumi.Output[list] = None

List of allowed policies for given role.

bound_cidrs: pulumi.Output[list] = None

If set, a list of CIDRs valid as the source address for login requests. This value is also encoded into any resulting token.

disallowed_policies: pulumi.Output[list] = None

List of disallowed policies for given role.

explicit_max_ttl: pulumi.Output[str] = None

If set, the token will have an explicit max TTL set upon it.

orphan: pulumi.Output[bool] = None

If true, tokens created against this policy will be orphan tokens.

path_suffix: pulumi.Output[str] = None

Tokens created against this role will have the given suffix as part of their path in addition to the role name.

period: pulumi.Output[str] = None

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.

renewable: pulumi.Output[bool] = None

Wether to disable the ability of the token to be renewed past its initial TTL.

role_name: pulumi.Output[str] = None

The name of the role.

token_bound_cidrs: pulumi.Output[list] = None

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: pulumi.Output[float] = None

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: pulumi.Output[float] = None

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

token_no_default_policy: pulumi.Output[bool] = None

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: pulumi.Output[float] = None

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

token_period: pulumi.Output[float] = None

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: pulumi.Output[list] = None

Generated Token’s Policies

token_ttl: pulumi.Output[float] = None

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

token_type: pulumi.Output[str] = None

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.

static get(resource_name, id, opts=None, allowed_policies=None, bound_cidrs=None, disallowed_policies=None, explicit_max_ttl=None, orphan=None, path_suffix=None, period=None, renewable=None, role_name=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)

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

Parameters

  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • allowed_policies (pulumi.Input[list]) – List of allowed policies for given role.

  • bound_cidrs (pulumi.Input[list]) – If set, a list of CIDRs valid as the source address for login requests. This value is also encoded into any resulting token.

  • disallowed_policies (pulumi.Input[list]) – List of disallowed policies for given role.

  • explicit_max_ttl (pulumi.Input[str]) – If set, the token will have an explicit max TTL set upon it.

  • orphan (pulumi.Input[bool]) – If true, tokens created against this policy will be orphan tokens.

  • path_suffix (pulumi.Input[str]) – Tokens created against this role will have the given suffix as part of their path in addition to the role name.

  • period (pulumi.Input[str]) – 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.

  • renewable (pulumi.Input[bool]) – Wether to disable the ability of the token to be renewed past its initial TTL.

  • role_name (pulumi.Input[str]) – The name of the role.

  • token_bound_cidrs (pulumi.Input[list]) – 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 (pulumi.Input[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 (pulumi.Input[float]) – The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.

  • token_no_default_policy (pulumi.Input[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 (pulumi.Input[float]) –

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

  • token_period (pulumi.Input[float]) – 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 (pulumi.Input[list]) – Generated Token’s Policies

  • token_ttl (pulumi.Input[float]) – The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.

  • token_type (pulumi.Input[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.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str