pulumi-vault-kotlin/com.pulumi.vault.kubernetes.kotlin/KubernetesFunctions/getAuthBackendRole

getAuthBackendRole

suspend fun getAuthBackendRole(argument: GetAuthBackendRolePlainArgs): GetAuthBackendRoleResult

Reads the Role of an Kubernetes from a Vault server. See the [Vault

  • documentation](https://www.vaultproject.io/api-docs/auth/kubernetes#read-role) for more information.

Return

A collection of values returned by getAuthBackendRole.

Parameters

argument

A collection of arguments for invoking getAuthBackendRole.

suspend fun getAuthBackendRole(audience: String? = null, backend: String? = null, namespace: String? = null, roleName: String, tokenBoundCidrs: List<String>? = null, tokenExplicitMaxTtl: Int? = null, tokenMaxTtl: Int? = null, tokenNoDefaultPolicy: Boolean? = null, tokenNumUses: Int? = null, tokenPeriod: Int? = null, tokenPolicies: List<String>? = null, tokenTtl: Int? = null, tokenType: String? = null): GetAuthBackendRoleResult

Return

A collection of values returned by getAuthBackendRole.

Parameters

audience

Audience claim to verify in the JWT.

backend

The unique name for the Kubernetes backend the role to retrieve Role attributes for resides in. Defaults to "kubernetes".

namespace

The namespace of the target resource. 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.

roleName

The name of the role to retrieve the Role attributes for.

tokenBoundCidrs

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

tokenExplicitMaxTtl

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

tokenMaxTtl

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

tokenNoDefaultPolicy

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

tokenNumUses

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

tokenPeriod

(Optional) 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 of policies to encode onto generated tokens. Depending on the auth method, this list may be supplemented by user/group/other values.

tokenTtl

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

tokenType

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

See also

.

suspend fun getAuthBackendRole(argument: suspend GetAuthBackendRolePlainArgsBuilder.() -> Unit): GetAuthBackendRoleResult

Return

A collection of values returned by getAuthBackendRole.

Parameters

argument

Builder for com.pulumi.vault.kubernetes.kotlin.inputs.GetAuthBackendRolePlainArgs.

See also

.