kvsecretv2

package
v13.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 20, 2024 License: MPL-2.0 Imports: 7 Imported by: 0

README

vault_kv_secret_v2

Refer to the Terraform Registry for docs: vault_kv_secret_v2.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func KvSecretV2_GenerateConfigForImport 

func KvSecretV2_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource

Generates CDKTF code for importing a KvSecretV2 resource upon running "cdktf plan <stack-name>".

func KvSecretV2_IsConstruct 

func KvSecretV2_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.

Returns: true if `x` is an object created from a class which extends `Construct`.

func KvSecretV2_IsTerraformElement 

func KvSecretV2_IsTerraformElement(x interface{}) *bool

Experimental.

func KvSecretV2_IsTerraformResource 

func KvSecretV2_IsTerraformResource(x interface{}) *bool

Experimental.

func KvSecretV2_TfResourceType 

func KvSecretV2_TfResourceType() *string

func NewKvSecretV2CustomMetadataOutputReference_Override 

func NewKvSecretV2CustomMetadataOutputReference_Override(k KvSecretV2CustomMetadataOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string)

func NewKvSecretV2_Override 

func NewKvSecretV2_Override(k KvSecretV2, scope constructs.Construct, id *string, config *KvSecretV2Config)

Create a new {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/kv_secret_v2 vault_kv_secret_v2} Resource.

Types

type KvSecretV2 

type KvSecretV2 interface {
	cdktf.TerraformResource
	Cas() *float64
	SetCas(val *float64)
	CasInput() *float64
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	// Experimental.
	Connection() interface{}
	// Experimental.
	SetConnection(val interface{})
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Count() interface{}
	// Experimental.
	SetCount(val interface{})
	CustomMetadata() KvSecretV2CustomMetadataOutputReference
	CustomMetadataInput() *KvSecretV2CustomMetadata
	Data() cdktf.StringMap
	DataJson() *string
	SetDataJson(val *string)
	DataJsonInput() *string
	DeleteAllVersions() interface{}
	SetDeleteAllVersions(val interface{})
	DeleteAllVersionsInput() interface{}
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(val *[]*string)
	DisableRead() interface{}
	SetDisableRead(val interface{})
	DisableReadInput() interface{}
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	Id() *string
	SetId(val *string)
	IdInput() *string
	// Experimental.
	Lifecycle() *cdktf.TerraformResourceLifecycle
	// Experimental.
	SetLifecycle(val *cdktf.TerraformResourceLifecycle)
	Metadata() cdktf.StringMap
	Mount() *string
	SetMount(val *string)
	MountInput() *string
	Name() *string
	SetName(val *string)
	NameInput() *string
	Namespace() *string
	SetNamespace(val *string)
	NamespaceInput() *string
	// The tree node.
	Node() constructs.Node
	Options() *map[string]*string
	SetOptions(val *map[string]*string)
	OptionsInput() *map[string]*string
	Path() *string
	// Experimental.
	Provider() cdktf.TerraformProvider
	// Experimental.
	SetProvider(val cdktf.TerraformProvider)
	// Experimental.
	Provisioners() *[]interface{}
	// Experimental.
	SetProvisioners(val *[]interface{})
	// Experimental.
	RawOverrides() interface{}
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformMetaArguments() *map[string]interface{}
	// Experimental.
	TerraformResourceType() *string
	// Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
	// Experimental.
	AddMoveTarget(moveTarget *string)
	// Experimental.
	AddOverride(path *string, value interface{})
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	HasResourceMove() interface{}
	// Experimental.
	ImportFrom(id *string, provider cdktf.TerraformProvider)
	// Experimental.
	InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
	// 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.
	// Experimental.
	MoveFromId(id *string)
	// Moves this resource to the target resource given by moveTarget.
	// Experimental.
	MoveTo(moveTarget *string, index interface{})
	// Moves this resource to the resource corresponding to "id".
	// Experimental.
	MoveToId(id *string)
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	PutCustomMetadata(value *KvSecretV2CustomMetadata)
	ResetCas()
	ResetCustomMetadata()
	ResetDeleteAllVersions()
	ResetDisableRead()
	ResetId()
	ResetNamespace()
	ResetOptions()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	SynthesizeAttributes() *map[string]interface{}
	SynthesizeHclAttributes() *map[string]interface{}
	// Experimental.
	ToHclTerraform() interface{}
	// Experimental.
	ToMetadata() interface{}
	// Returns a string representation of this construct.
	ToString() *string
	// Adds this resource to the terraform JSON output.
	// Experimental.
	ToTerraform() interface{}
}

Represents a {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/kv_secret_v2 vault_kv_secret_v2}.

func NewKvSecretV2 

func NewKvSecretV2(scope constructs.Construct, id *string, config *KvSecretV2Config) KvSecretV2

Create a new {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/kv_secret_v2 vault_kv_secret_v2} Resource.

type KvSecretV2Config 

type KvSecretV2Config struct {
	// Experimental.
	Connection interface{} `field:"optional" json:"connection" yaml:"connection"`
	// Experimental.
	Count interface{} `field:"optional" json:"count" yaml:"count"`
	// Experimental.
	DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"`
	// Experimental.
	ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"`
	// Experimental.
	Lifecycle *cdktf.TerraformResourceLifecycle `field:"optional" json:"lifecycle" yaml:"lifecycle"`
	// Experimental.
	Provider cdktf.TerraformProvider `field:"optional" json:"provider" yaml:"provider"`
	// Experimental.
	Provisioners *[]interface{} `field:"optional" json:"provisioners" yaml:"provisioners"`
	// JSON-encoded secret data to write.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/kv_secret_v2#data_json KvSecretV2#data_json}
	DataJson *string `field:"required" json:"dataJson" yaml:"dataJson"`
	// Path where KV-V2 engine is mounted.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/kv_secret_v2#mount KvSecretV2#mount}
	Mount *string `field:"required" json:"mount" yaml:"mount"`
	// Full name of the secret.
	//
	// For a nested secret, the name is the nested path excluding the mount and data prefix. For example, for a secret at 'kvv2/data/foo/bar/baz', the name is 'foo/bar/baz'
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/kv_secret_v2#name KvSecretV2#name}
	Name *string `field:"required" json:"name" yaml:"name"`
	// This flag is required if cas_required is set to true on either the secret or the engine's config.
	//
	// In order for a write to be successful, cas must be set to the current version of the secret.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/kv_secret_v2#cas KvSecretV2#cas}
	Cas *float64 `field:"optional" json:"cas" yaml:"cas"`
	// custom_metadata block.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/kv_secret_v2#custom_metadata KvSecretV2#custom_metadata}
	CustomMetadata *KvSecretV2CustomMetadata `field:"optional" json:"customMetadata" yaml:"customMetadata"`
	// If set to true, permanently deletes all versions for the specified key.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/kv_secret_v2#delete_all_versions KvSecretV2#delete_all_versions}
	DeleteAllVersions interface{} `field:"optional" json:"deleteAllVersions" yaml:"deleteAllVersions"`
	// If set to true, disables reading secret from Vault; note: drift won't be detected.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/kv_secret_v2#disable_read KvSecretV2#disable_read}
	DisableRead interface{} `field:"optional" json:"disableRead" yaml:"disableRead"`
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/kv_secret_v2#id KvSecretV2#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.
	Id *string `field:"optional" json:"id" yaml:"id"`
	// Target namespace. (requires Enterprise).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/kv_secret_v2#namespace KvSecretV2#namespace}
	Namespace *string `field:"optional" json:"namespace" yaml:"namespace"`
	// An object that holds option settings.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/kv_secret_v2#options KvSecretV2#options}
	Options *map[string]*string `field:"optional" json:"options" yaml:"options"`
}

type KvSecretV2CustomMetadata 

type KvSecretV2CustomMetadata struct {
	// If true, all keys will require the cas parameter to be set on all write requests.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/kv_secret_v2#cas_required KvSecretV2#cas_required}
	CasRequired interface{} `field:"optional" json:"casRequired" yaml:"casRequired"`
	// A map of arbitrary string to string valued user-provided metadata meant to describe the secret.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/kv_secret_v2#data KvSecretV2#data}
	Data *map[string]*string `field:"optional" json:"data" yaml:"data"`
	// If set, specifies the length of time before a version is deleted.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/kv_secret_v2#delete_version_after KvSecretV2#delete_version_after}
	DeleteVersionAfter *float64 `field:"optional" json:"deleteVersionAfter" yaml:"deleteVersionAfter"`
	// The number of versions to keep per key.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/kv_secret_v2#max_versions KvSecretV2#max_versions}
	MaxVersions *float64 `field:"optional" json:"maxVersions" yaml:"maxVersions"`
}

type KvSecretV2CustomMetadataOutputReference 

type KvSecretV2CustomMetadataOutputReference interface {
	cdktf.ComplexObject
	CasRequired() interface{}
	SetCasRequired(val interface{})
	CasRequiredInput() interface{}
	// the index of the complex object in a list.
	// Experimental.
	ComplexObjectIndex() interface{}
	// Experimental.
	SetComplexObjectIndex(val interface{})
	// set to true if this item is from inside a set and needs tolist() for accessing it set to "0" for single list items.
	// Experimental.
	ComplexObjectIsFromSet() *bool
	// Experimental.
	SetComplexObjectIsFromSet(val *bool)
	// The creation stack of this resolvable which will be appended to errors thrown during resolution.
	//
	// If this returns an empty array the stack will not be attached.
	// Experimental.
	CreationStack() *[]*string
	Data() *map[string]*string
	SetData(val *map[string]*string)
	DataInput() *map[string]*string
	DeleteVersionAfter() *float64
	SetDeleteVersionAfter(val *float64)
	DeleteVersionAfterInput() *float64
	// Experimental.
	Fqn() *string
	InternalValue() *KvSecretV2CustomMetadata
	SetInternalValue(val *KvSecretV2CustomMetadata)
	MaxVersions() *float64
	SetMaxVersions(val *float64)
	MaxVersionsInput() *float64
	// Experimental.
	TerraformAttribute() *string
	// Experimental.
	SetTerraformAttribute(val *string)
	// Experimental.
	TerraformResource() cdktf.IInterpolatingParent
	// Experimental.
	SetTerraformResource(val cdktf.IInterpolatingParent)
	// Experimental.
	ComputeFqn() *string
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	InterpolationAsList() cdktf.IResolvable
	// Experimental.
	InterpolationForAttribute(property *string) cdktf.IResolvable
	ResetCasRequired()
	ResetData()
	ResetDeleteVersionAfter()
	ResetMaxVersions()
	// Produce the Token's value at resolution time.
	// Experimental.
	Resolve(_context cdktf.IResolveContext) interface{}
	// Return a string representation of this resolvable object.
	//
	// Returns a reversible string representation.
	// Experimental.
	ToString() *string
}

func NewKvSecretV2CustomMetadataOutputReference 

func NewKvSecretV2CustomMetadataOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string) KvSecretV2CustomMetadataOutputReference

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.