Skip to content

Latest commit

 

History

History
1544 lines (972 loc) · 52.4 KB

token.go.md

File metadata and controls

1544 lines (972 loc) · 52.4 KB
Raw

token Submodule

Constructs

Token

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

Initializers 

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

token.NewToken(scope Construct, id *string, config TokenConfig) Token
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 TokenConfig 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

configOptional

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".
ResetDisplayName No description.
ResetExplicitMaxTtl No description.
ResetId No description.
ResetMetadata No description.
ResetNamespace No description.
ResetNoDefaultPolicy No description.
ResetNoParent No description.
ResetNumUses No description.
ResetPeriod No description.
ResetPolicies No description.
ResetRenewable No description.
ResetRenewIncrement No description.
ResetRenewMinLease No description.
ResetRoleName No description.
ResetTtl No description.
ResetWrappingTtl 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".

ResetDisplayName 
func ResetDisplayName()
ResetExplicitMaxTtl 
func ResetExplicitMaxTtl()
ResetId 
func ResetId()
ResetMetadata 
func ResetMetadata()
ResetNamespace 
func ResetNamespace()
ResetNoDefaultPolicy 
func ResetNoDefaultPolicy()
ResetNoParent 
func ResetNoParent()
ResetNumUses 
func ResetNumUses()
ResetPeriod 
func ResetPeriod()
ResetPolicies 
func ResetPolicies()
ResetRenewable 
func ResetRenewable()
ResetRenewIncrement 
func ResetRenewIncrement()
ResetRenewMinLease 
func ResetRenewMinLease()
ResetRoleName 
func ResetRoleName()
ResetTtl 
func ResetTtl()
ResetWrappingTtl 
func ResetWrappingTtl()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformResource No description.
GenerateConfigForImport Generates CDKTF code for importing a Token resource upon running "cdktf plan ".
IsConstruct 
import "github.com/cdktf/cdktf-provider-vault-go/vault/v13/token"

token.Token_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/token"

token.Token_IsTerraformElement(x interface{}) *bool
xRequired
  • Type: interface{}
IsTerraformResource 
import "github.com/cdktf/cdktf-provider-vault-go/vault/v13/token"

token.Token_IsTerraformResource(x interface{}) *bool
xRequired
  • Type: interface{}
GenerateConfigForImport 
import "github.com/cdktf/cdktf-provider-vault-go/vault/v13/token"

token.Token_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

Generates CDKTF code for importing a Token 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 Token to import.

importFromIdRequired
  • Type: *string

The id of the existing Token that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/token#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 Token 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.
ClientToken *string No description.
LeaseDuration *f64 No description.
LeaseStarted *string No description.
WrappedToken *string No description.
WrappingAccessor *string No description.
DisplayNameInput *string No description.
ExplicitMaxTtlInput *string No description.
IdInput *string No description.
MetadataInput *map[string]*string No description.
NamespaceInput *string No description.
NoDefaultPolicyInput interface{} No description.
NoParentInput interface{} No description.
NumUsesInput *f64 No description.
PeriodInput *string No description.
PoliciesInput *[]*string No description.
RenewableInput interface{} No description.
RenewIncrementInput *f64 No description.
RenewMinLeaseInput *f64 No description.
RoleNameInput *string No description.
TtlInput *string No description.
WrappingTtlInput *string No description.
DisplayName *string No description.
ExplicitMaxTtl *string No description.
Id *string No description.
Metadata *map[string]*string No description.
Namespace *string No description.
NoDefaultPolicy interface{} No description.
NoParent interface{} No description.
NumUses *f64 No description.
Period *string No description.
Policies *[]*string No description.
Renewable interface{} No description.
RenewIncrement *f64 No description.
RenewMinLease *f64 No description.
RoleName *string No description.
Ttl *string No description.
WrappingTtl *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{}
ClientTokenRequired 
func ClientToken() *string
  • Type: *string
LeaseDurationRequired 
func LeaseDuration() *f64
  • Type: *f64
LeaseStartedRequired 
func LeaseStarted() *string
  • Type: *string
WrappedTokenRequired 
func WrappedToken() *string
  • Type: *string
WrappingAccessorRequired 
func WrappingAccessor() *string
  • Type: *string
DisplayNameInputOptional 
func DisplayNameInput() *string
  • Type: *string
ExplicitMaxTtlInputOptional 
func ExplicitMaxTtlInput() *string
  • Type: *string
IdInputOptional 
func IdInput() *string
  • Type: *string
MetadataInputOptional 
func MetadataInput() *map[string]*string
  • Type: *map[string]*string
NamespaceInputOptional 
func NamespaceInput() *string
  • Type: *string
NoDefaultPolicyInputOptional 
func NoDefaultPolicyInput() interface{}
  • Type: interface{}
NoParentInputOptional 
func NoParentInput() interface{}
  • Type: interface{}
NumUsesInputOptional 
func NumUsesInput() *f64
  • Type: *f64
PeriodInputOptional 
func PeriodInput() *string
  • Type: *string
PoliciesInputOptional 
func PoliciesInput() *[]*string
  • Type: *[]*string
RenewableInputOptional 
func RenewableInput() interface{}
  • Type: interface{}
RenewIncrementInputOptional 
func RenewIncrementInput() *f64
  • Type: *f64
RenewMinLeaseInputOptional 
func RenewMinLeaseInput() *f64
  • Type: *f64
RoleNameInputOptional 
func RoleNameInput() *string
  • Type: *string
TtlInputOptional 
func TtlInput() *string
  • Type: *string
WrappingTtlInputOptional 
func WrappingTtlInput() *string
  • Type: *string
DisplayNameRequired 
func DisplayName() *string
  • Type: *string
ExplicitMaxTtlRequired 
func ExplicitMaxTtl() *string
  • Type: *string
IdRequired 
func Id() *string
  • Type: *string
MetadataRequired 
func Metadata() *map[string]*string
  • Type: *map[string]*string
NamespaceRequired 
func Namespace() *string
  • Type: *string
NoDefaultPolicyRequired 
func NoDefaultPolicy() interface{}
  • Type: interface{}
NoParentRequired 
func NoParent() interface{}
  • Type: interface{}
NumUsesRequired 
func NumUses() *f64
  • Type: *f64
PeriodRequired 
func Period() *string
  • Type: *string
PoliciesRequired 
func Policies() *[]*string
  • Type: *[]*string
RenewableRequired 
func Renewable() interface{}
  • Type: interface{}
RenewIncrementRequired 
func RenewIncrement() *f64
  • Type: *f64
RenewMinLeaseRequired 
func RenewMinLease() *f64
  • Type: *f64
RoleNameRequired 
func RoleName() *string
  • Type: *string
TtlRequired 
func Ttl() *string
  • Type: *string
WrappingTtlRequired 
func WrappingTtl() *string
  • Type: *string

Constants

Name Type Description
TfResourceType *string No description.
TfResourceTypeRequired 
func TfResourceType() *string
  • Type: *string

Structs

TokenConfig

Initializer 

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

&token.TokenConfig {
	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{},
	DisplayName: *string,
	ExplicitMaxTtl: *string,
	Id: *string,
	Metadata: *map[string]*string,
	Namespace: *string,
	NoDefaultPolicy: interface{},
	NoParent: interface{},
	NumUses: *f64,
	Period: *string,
	Policies: *[]*string,
	Renewable: interface{},
	RenewIncrement: *f64,
	RenewMinLease: *f64,
	RoleName: *string,
	Ttl: *string,
	WrappingTtl: *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.
DisplayName *string The display name of the token.
ExplicitMaxTtl *string The explicit max TTL of the token.
Id *string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/token#id Token#id}.
Metadata *map[string]*string Metadata to be associated with the token.
Namespace *string Target namespace. (requires Enterprise).
NoDefaultPolicy interface{} Flag to disable the default policy.
NoParent interface{} Flag to create a token without parent.
NumUses *f64 The number of allowed uses of the token.
Period *string The period of the token.
Policies *[]*string List of policies.
Renewable interface{} Flag to allow the token to be renewed.
RenewIncrement *f64 The renew increment.
RenewMinLease *f64 The minimum lease to renew token.
RoleName *string The token role name.
Ttl *string The TTL period of the token.
WrappingTtl *string The TTL period of the wrapped token.
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{}
DisplayNameOptional 
DisplayName *string
  • Type: *string

The display name of the token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/token#display_name Token#display_name}

ExplicitMaxTtlOptional 
ExplicitMaxTtl *string
  • Type: *string

The explicit max TTL of the token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/token#explicit_max_ttl Token#explicit_max_ttl}

IdOptional 
Id *string
  • Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/token#id Token#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.

MetadataOptional 
Metadata *map[string]*string
  • Type: *map[string]*string

Metadata to be associated with the token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/token#metadata Token#metadata}

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/token#namespace Token#namespace}

NoDefaultPolicyOptional 
NoDefaultPolicy interface{}
  • Type: interface{}

Flag to disable the default policy.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/token#no_default_policy Token#no_default_policy}

NoParentOptional 
NoParent interface{}
  • Type: interface{}

Flag to create a token without parent.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/token#no_parent Token#no_parent}

NumUsesOptional 
NumUses *f64
  • Type: *f64

The number of allowed uses of the token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/token#num_uses Token#num_uses}

PeriodOptional 
Period *string
  • Type: *string

The period of the token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/token#period Token#period}

PoliciesOptional 
Policies *[]*string
  • Type: *[]*string

List of policies.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/token#policies Token#policies}

RenewableOptional 
Renewable interface{}
  • Type: interface{}

Flag to allow the token to be renewed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/token#renewable Token#renewable}

RenewIncrementOptional 
RenewIncrement *f64
  • Type: *f64

The renew increment.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/token#renew_increment Token#renew_increment}

RenewMinLeaseOptional 
RenewMinLease *f64
  • Type: *f64

The minimum lease to renew token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/token#renew_min_lease Token#renew_min_lease}

RoleNameOptional 
RoleName *string
  • Type: *string

The token role name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/token#role_name Token#role_name}

TtlOptional 
Ttl *string
  • Type: *string

The TTL period of the token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/token#ttl Token#ttl}

WrappingTtlOptional 
WrappingTtl *string
  • Type: *string

The TTL period of the wrapped token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/token#wrapping_ttl Token#wrapping_ttl}