Skip to content

Latest commit

 

History

History
1565 lines (985 loc) · 63.9 KB

samlAuthBackendRole.go.md

File metadata and controls

1565 lines (985 loc) · 63.9 KB

samlAuthBackendRole Submodule

Constructs

SamlAuthBackendRole

Represents a {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/saml_auth_backend_role vault_saml_auth_backend_role}.

Initializers

import "github.com/cdktf/cdktf-provider-vault-go/vault/v13/samlauthbackendrole"

samlauthbackendrole.NewSamlAuthBackendRole(scope Construct, id *string, config SamlAuthBackendRoleConfig) SamlAuthBackendRole
Name Type Description
scope github.com/aws/constructs-go/constructs/v10.Construct The scope in which to define this construct.
id *string The scoped construct ID.
config SamlAuthBackendRoleConfig No description.

scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.


idRequired
  • Type: *string

The scoped construct ID.

Must be unique amongst siblings in the same scope


configRequired

Methods

Name Description
ToString Returns a string representation of this construct.
AddOverride No description.
OverrideLogicalId Overrides the auto-generated logical ID with a specific ID.
ResetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform No description.
ToMetadata No description.
ToTerraform Adds this resource to the terraform JSON output.
AddMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
HasResourceMove No description.
ImportFrom No description.
InterpolationForAttribute No description.
MoveFromId Move the resource corresponding to "id" to this resource.
MoveTo Moves this resource to the target resource given by moveTarget.
MoveToId Moves this resource to the resource corresponding to "id".
ResetBoundAttributes No description.
ResetBoundAttributesType No description.
ResetBoundSubjects No description.
ResetBoundSubjectsType No description.
ResetGroupsAttribute No description.
ResetId No description.
ResetNamespace No description.
ResetTokenBoundCidrs No description.
ResetTokenExplicitMaxTtl No description.
ResetTokenMaxTtl No description.
ResetTokenNoDefaultPolicy No description.
ResetTokenNumUses No description.
ResetTokenPeriod No description.
ResetTokenPolicies No description.
ResetTokenTtl No description.
ResetTokenType No description.

ToString
func ToString() *string

Returns a string representation of this construct.

AddOverride
func AddOverride(path *string, value interface{})
pathRequired
  • Type: *string

valueRequired
  • Type: interface{}

OverrideLogicalId
func OverrideLogicalId(newLogicalId *string)

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired
  • Type: *string

The new logical ID to use for this stack element.


ResetOverrideLogicalId
func ResetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

ToHclTerraform
func ToHclTerraform() interface{}
ToMetadata
func ToMetadata() interface{}
ToTerraform
func ToTerraform() interface{}

Adds this resource to the terraform JSON output.

AddMoveTarget
func AddMoveTarget(moveTarget *string)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTargetRequired
  • Type: *string

The string move target that will correspond to this resource.


GetAnyMapAttribute
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
terraformAttributeRequired
  • Type: *string

GetBooleanAttribute
func GetBooleanAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string

GetBooleanMapAttribute
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
terraformAttributeRequired
  • Type: *string

GetListAttribute
func GetListAttribute(terraformAttribute *string) *[]*string
terraformAttributeRequired
  • Type: *string

GetNumberAttribute
func GetNumberAttribute(terraformAttribute *string) *f64
terraformAttributeRequired
  • Type: *string

GetNumberListAttribute
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
terraformAttributeRequired
  • Type: *string

GetNumberMapAttribute
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
terraformAttributeRequired
  • Type: *string

GetStringAttribute
func GetStringAttribute(terraformAttribute *string) *string
terraformAttributeRequired
  • Type: *string

GetStringMapAttribute
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
terraformAttributeRequired
  • Type: *string

HasResourceMove
func HasResourceMove() interface{}
ImportFrom
func ImportFrom(id *string, provider TerraformProvider)
idRequired
  • Type: *string

providerOptional
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

InterpolationForAttribute
func InterpolationForAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string

MoveFromId
func MoveFromId(id *string)

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: *string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".


MoveTo
func MoveTo(moveTarget *string, index interface{})

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: *string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.


indexOptional
  • Type: interface{}

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.


MoveToId
func MoveToId(id *string)

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: *string

Full id of resource to move to, e.g. "aws_s3_bucket.example".


ResetBoundAttributes
func ResetBoundAttributes()
ResetBoundAttributesType
func ResetBoundAttributesType()
ResetBoundSubjects
func ResetBoundSubjects()
ResetBoundSubjectsType
func ResetBoundSubjectsType()
ResetGroupsAttribute
func ResetGroupsAttribute()
ResetId
func ResetId()
ResetNamespace
func ResetNamespace()
ResetTokenBoundCidrs
func ResetTokenBoundCidrs()
ResetTokenExplicitMaxTtl
func ResetTokenExplicitMaxTtl()
ResetTokenMaxTtl
func ResetTokenMaxTtl()
ResetTokenNoDefaultPolicy
func ResetTokenNoDefaultPolicy()
ResetTokenNumUses
func ResetTokenNumUses()
ResetTokenPeriod
func ResetTokenPeriod()
ResetTokenPolicies
func ResetTokenPolicies()
ResetTokenTtl
func ResetTokenTtl()
ResetTokenType
func ResetTokenType()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformResource No description.
GenerateConfigForImport Generates CDKTF code for importing a SamlAuthBackendRole resource upon running "cdktf plan ".

IsConstruct
import "github.com/cdktf/cdktf-provider-vault-go/vault/v13/samlauthbackendrole"

samlauthbackendrole.SamlAuthBackendRole_IsConstruct(x interface{}) *bool

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: interface{}

Any object.


IsTerraformElement
import "github.com/cdktf/cdktf-provider-vault-go/vault/v13/samlauthbackendrole"

samlauthbackendrole.SamlAuthBackendRole_IsTerraformElement(x interface{}) *bool
xRequired
  • Type: interface{}

IsTerraformResource
import "github.com/cdktf/cdktf-provider-vault-go/vault/v13/samlauthbackendrole"

samlauthbackendrole.SamlAuthBackendRole_IsTerraformResource(x interface{}) *bool
xRequired
  • Type: interface{}

GenerateConfigForImport
import "github.com/cdktf/cdktf-provider-vault-go/vault/v13/samlauthbackendrole"

samlauthbackendrole.SamlAuthBackendRole_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

Generates CDKTF code for importing a SamlAuthBackendRole resource upon running "cdktf plan ".

scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.


importToIdRequired
  • Type: *string

The construct id used in the generated config for the SamlAuthBackendRole to import.


importFromIdRequired
  • Type: *string

The id of the existing SamlAuthBackendRole that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/saml_auth_backend_role#import import section} in the documentation of this resource for the id to use


providerOptional
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

? Optional instance of the provider where the SamlAuthBackendRole to import is found.


Properties

Name Type Description
Node github.com/aws/constructs-go/constructs/v10.Node The tree node.
CdktfStack github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack No description.
Fqn *string No description.
FriendlyUniqueId *string No description.
TerraformMetaArguments *map[string]interface{} No description.
TerraformResourceType *string No description.
TerraformGeneratorMetadata github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata No description.
Connection interface{} No description.
Count interface{} No description.
DependsOn *[]*string No description.
ForEach github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator No description.
Lifecycle github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle No description.
Provider github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider No description.
Provisioners *[]interface{} No description.
BoundAttributesInput *map[string]*string No description.
BoundAttributesTypeInput *string No description.
BoundSubjectsInput *[]*string No description.
BoundSubjectsTypeInput *string No description.
GroupsAttributeInput *string No description.
IdInput *string No description.
NameInput *string No description.
NamespaceInput *string No description.
PathInput *string No description.
TokenBoundCidrsInput *[]*string No description.
TokenExplicitMaxTtlInput *f64 No description.
TokenMaxTtlInput *f64 No description.
TokenNoDefaultPolicyInput interface{} No description.
TokenNumUsesInput *f64 No description.
TokenPeriodInput *f64 No description.
TokenPoliciesInput *[]*string No description.
TokenTtlInput *f64 No description.
TokenTypeInput *string No description.
BoundAttributes *map[string]*string No description.
BoundAttributesType *string No description.
BoundSubjects *[]*string No description.
BoundSubjectsType *string No description.
GroupsAttribute *string No description.
Id *string No description.
Name *string No description.
Namespace *string No description.
Path *string No description.
TokenBoundCidrs *[]*string No description.
TokenExplicitMaxTtl *f64 No description.
TokenMaxTtl *f64 No description.
TokenNoDefaultPolicy interface{} No description.
TokenNumUses *f64 No description.
TokenPeriod *f64 No description.
TokenPolicies *[]*string No description.
TokenTtl *f64 No description.
TokenType *string No description.

NodeRequired
func Node() Node
  • Type: github.com/aws/constructs-go/constructs/v10.Node

The tree node.


CdktfStackRequired
func CdktfStack() TerraformStack
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack

FqnRequired
func Fqn() *string
  • Type: *string

FriendlyUniqueIdRequired
func FriendlyUniqueId() *string
  • Type: *string

TerraformMetaArgumentsRequired
func TerraformMetaArguments() *map[string]interface{}
  • Type: *map[string]interface{}

TerraformResourceTypeRequired
func TerraformResourceType() *string
  • Type: *string

TerraformGeneratorMetadataOptional
func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata

ConnectionOptional
func Connection() interface{}
  • Type: interface{}

CountOptional
func Count() interface{}
  • Type: interface{}

DependsOnOptional
func DependsOn() *[]*string
  • Type: *[]*string

ForEachOptional
func ForEach() ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator

LifecycleOptional
func Lifecycle() TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle

ProviderOptional
func Provider() TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

ProvisionersOptional
func Provisioners() *[]interface{}
  • Type: *[]interface{}

BoundAttributesInputOptional
func BoundAttributesInput() *map[string]*string
  • Type: *map[string]*string

BoundAttributesTypeInputOptional
func BoundAttributesTypeInput() *string
  • Type: *string

BoundSubjectsInputOptional
func BoundSubjectsInput() *[]*string
  • Type: *[]*string

BoundSubjectsTypeInputOptional
func BoundSubjectsTypeInput() *string
  • Type: *string

GroupsAttributeInputOptional
func GroupsAttributeInput() *string
  • Type: *string

IdInputOptional
func IdInput() *string
  • Type: *string

NameInputOptional
func NameInput() *string
  • Type: *string

NamespaceInputOptional
func NamespaceInput() *string
  • Type: *string

PathInputOptional
func PathInput() *string
  • Type: *string

TokenBoundCidrsInputOptional
func TokenBoundCidrsInput() *[]*string
  • Type: *[]*string

TokenExplicitMaxTtlInputOptional
func TokenExplicitMaxTtlInput() *f64
  • Type: *f64

TokenMaxTtlInputOptional
func TokenMaxTtlInput() *f64
  • Type: *f64

TokenNoDefaultPolicyInputOptional
func TokenNoDefaultPolicyInput() interface{}
  • Type: interface{}

TokenNumUsesInputOptional
func TokenNumUsesInput() *f64
  • Type: *f64

TokenPeriodInputOptional
func TokenPeriodInput() *f64
  • Type: *f64

TokenPoliciesInputOptional
func TokenPoliciesInput() *[]*string
  • Type: *[]*string

TokenTtlInputOptional
func TokenTtlInput() *f64
  • Type: *f64

TokenTypeInputOptional
func TokenTypeInput() *string
  • Type: *string

BoundAttributesRequired
func BoundAttributes() *map[string]*string
  • Type: *map[string]*string

BoundAttributesTypeRequired
func BoundAttributesType() *string
  • Type: *string

BoundSubjectsRequired
func BoundSubjects() *[]*string
  • Type: *[]*string

BoundSubjectsTypeRequired
func BoundSubjectsType() *string
  • Type: *string

GroupsAttributeRequired
func GroupsAttribute() *string
  • Type: *string

IdRequired
func Id() *string
  • Type: *string

NameRequired
func Name() *string
  • Type: *string

NamespaceRequired
func Namespace() *string
  • Type: *string

PathRequired
func Path() *string
  • Type: *string

TokenBoundCidrsRequired
func TokenBoundCidrs() *[]*string
  • Type: *[]*string

TokenExplicitMaxTtlRequired
func TokenExplicitMaxTtl() *f64
  • Type: *f64

TokenMaxTtlRequired
func TokenMaxTtl() *f64
  • Type: *f64

TokenNoDefaultPolicyRequired
func TokenNoDefaultPolicy() interface{}
  • Type: interface{}

TokenNumUsesRequired
func TokenNumUses() *f64
  • Type: *f64

TokenPeriodRequired
func TokenPeriod() *f64
  • Type: *f64

TokenPoliciesRequired
func TokenPolicies() *[]*string
  • Type: *[]*string

TokenTtlRequired
func TokenTtl() *f64
  • Type: *f64

TokenTypeRequired
func TokenType() *string
  • Type: *string

Constants

Name Type Description
TfResourceType *string No description.

TfResourceTypeRequired
func TfResourceType() *string
  • Type: *string

Structs

SamlAuthBackendRoleConfig

Initializer

import "github.com/cdktf/cdktf-provider-vault-go/vault/v13/samlauthbackendrole"

&samlauthbackendrole.SamlAuthBackendRoleConfig {
	Connection: interface{},
	Count: interface{},
	DependsOn: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable,
	ForEach: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator,
	Lifecycle: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle,
	Provider: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider,
	Provisioners: *[]interface{},
	Name: *string,
	Path: *string,
	BoundAttributes: *map[string]*string,
	BoundAttributesType: *string,
	BoundSubjects: *[]*string,
	BoundSubjectsType: *string,
	GroupsAttribute: *string,
	Id: *string,
	Namespace: *string,
	TokenBoundCidrs: *[]*string,
	TokenExplicitMaxTtl: *f64,
	TokenMaxTtl: *f64,
	TokenNoDefaultPolicy: interface{},
	TokenNumUses: *f64,
	TokenPeriod: *f64,
	TokenPolicies: *[]*string,
	TokenTtl: *f64,
	TokenType: *string,
}

Properties

Name Type Description
Connection interface{} No description.
Count interface{} No description.
DependsOn *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable No description.
ForEach github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator No description.
Lifecycle github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle No description.
Provider github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider No description.
Provisioners *[]interface{} No description.
Name *string Unique name of the role.
Path *string Path where SAML Auth engine is mounted.
BoundAttributes *map[string]*string Mapping of attribute names to values that are expected to exist in the SAML assertion.
BoundAttributesType *string The type of matching assertion to perform on bound_attributes.
BoundSubjects *[]*string The subject being asserted for SAML authentication.
BoundSubjectsType *string The type of matching assertion to perform on bound_subjects.
GroupsAttribute *string The attribute to use to identify the set of groups to which the user belongs.
Id *string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/saml_auth_backend_role#id SamlAuthBackendRole#id}.
Namespace *string Target namespace. (requires Enterprise).
TokenBoundCidrs *[]*string Specifies the blocks of IP addresses which are allowed to use the generated token.
TokenExplicitMaxTtl *f64 Generated Token's Explicit Maximum TTL in seconds.
TokenMaxTtl *f64 The maximum lifetime of the generated token.
TokenNoDefaultPolicy interface{} If true, the 'default' policy will not automatically be added to generated tokens.
TokenNumUses *f64 The maximum number of times a token may be used, a value of zero means unlimited.
TokenPeriod *f64 Generated Token's Period.
TokenPolicies *[]*string Generated Token's Policies.
TokenTtl *f64 The initial ttl of the token to generate in seconds.
TokenType *string The type of token to generate, service or batch.

ConnectionOptional
Connection interface{}
  • Type: interface{}

CountOptional
Count interface{}
  • Type: interface{}

DependsOnOptional
DependsOn *[]ITerraformDependable
  • Type: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable

ForEachOptional
ForEach ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator

LifecycleOptional
Lifecycle TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle

ProviderOptional
Provider TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

ProvisionersOptional
Provisioners *[]interface{}
  • Type: *[]interface{}

NameRequired
Name *string
  • Type: *string

Unique name of the role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/saml_auth_backend_role#name SamlAuthBackendRole#name}


PathRequired
Path *string
  • Type: *string

Path where SAML Auth engine is mounted.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/saml_auth_backend_role#path SamlAuthBackendRole#path}


BoundAttributesOptional
BoundAttributes *map[string]*string
  • Type: *map[string]*string

Mapping of attribute names to values that are expected to exist in the SAML assertion.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/saml_auth_backend_role#bound_attributes SamlAuthBackendRole#bound_attributes}


BoundAttributesTypeOptional
BoundAttributesType *string
  • Type: *string

The type of matching assertion to perform on bound_attributes.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/saml_auth_backend_role#bound_attributes_type SamlAuthBackendRole#bound_attributes_type}


BoundSubjectsOptional
BoundSubjects *[]*string
  • Type: *[]*string

The subject being asserted for SAML authentication.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/saml_auth_backend_role#bound_subjects SamlAuthBackendRole#bound_subjects}


BoundSubjectsTypeOptional
BoundSubjectsType *string
  • Type: *string

The type of matching assertion to perform on bound_subjects.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/saml_auth_backend_role#bound_subjects_type SamlAuthBackendRole#bound_subjects_type}


GroupsAttributeOptional
GroupsAttribute *string
  • Type: *string

The attribute to use to identify the set of groups to which the user belongs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/saml_auth_backend_role#groups_attribute SamlAuthBackendRole#groups_attribute}


IdOptional
Id *string
  • Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/saml_auth_backend_role#id SamlAuthBackendRole#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.


NamespaceOptional
Namespace *string
  • Type: *string

Target namespace. (requires Enterprise).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/saml_auth_backend_role#namespace SamlAuthBackendRole#namespace}


TokenBoundCidrsOptional
TokenBoundCidrs *[]*string
  • Type: *[]*string

Specifies the blocks of IP addresses which are allowed to use the generated token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/saml_auth_backend_role#token_bound_cidrs SamlAuthBackendRole#token_bound_cidrs}


TokenExplicitMaxTtlOptional
TokenExplicitMaxTtl *f64
  • Type: *f64

Generated Token's Explicit Maximum TTL in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/saml_auth_backend_role#token_explicit_max_ttl SamlAuthBackendRole#token_explicit_max_ttl}


TokenMaxTtlOptional
TokenMaxTtl *f64
  • Type: *f64

The maximum lifetime of the generated token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/saml_auth_backend_role#token_max_ttl SamlAuthBackendRole#token_max_ttl}


TokenNoDefaultPolicyOptional
TokenNoDefaultPolicy interface{}
  • Type: interface{}

If true, the 'default' policy will not automatically be added to generated tokens.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/saml_auth_backend_role#token_no_default_policy SamlAuthBackendRole#token_no_default_policy}


TokenNumUsesOptional
TokenNumUses *f64
  • Type: *f64

The maximum number of times a token may be used, a value of zero means unlimited.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/saml_auth_backend_role#token_num_uses SamlAuthBackendRole#token_num_uses}


TokenPeriodOptional
TokenPeriod *f64
  • Type: *f64

Generated Token's Period.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/saml_auth_backend_role#token_period SamlAuthBackendRole#token_period}


TokenPoliciesOptional
TokenPolicies *[]*string
  • Type: *[]*string

Generated Token's Policies.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/saml_auth_backend_role#token_policies SamlAuthBackendRole#token_policies}


TokenTtlOptional
TokenTtl *f64
  • Type: *f64

The initial ttl of the token to generate in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/saml_auth_backend_role#token_ttl SamlAuthBackendRole#token_ttl}


TokenTypeOptional
TokenType *string
  • Type: *string

The type of token to generate, service or batch.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/saml_auth_backend_role#token_type SamlAuthBackendRole#token_type}