genericendpoint

README

vault_generic_endpoint

Refer to the Terraform Registory for docs: vault_generic_endpoint.

Documentation

Index

• func GenericEndpoint_IsConstruct(x interface{}) *bool
• func GenericEndpoint_IsTerraformElement(x interface{}) *bool
• func GenericEndpoint_IsTerraformResource(x interface{}) *bool
• func GenericEndpoint_TfResourceType() *string
• func NewGenericEndpoint_Override(g GenericEndpoint, scope constructs.Construct, id *string, ...)
• type GenericEndpoint
  • func NewGenericEndpoint(scope constructs.Construct, id *string, config *GenericEndpointConfig) GenericEndpoint
• type GenericEndpointConfig

Functions

func GenericEndpoint_IsConstruct

func GenericEndpoint_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 GenericEndpoint_IsTerraformElement

func GenericEndpoint_IsTerraformElement(x interface{}) *bool

Experimental.

func GenericEndpoint_IsTerraformResource

func GenericEndpoint_IsTerraformResource(x interface{}) *bool

Experimental.

func GenericEndpoint_TfResourceType

func GenericEndpoint_TfResourceType() *string

func NewGenericEndpoint_Override

func NewGenericEndpoint_Override(g GenericEndpoint, scope constructs.Construct, id *string, config *GenericEndpointConfig)

Create a new {@link https://registry.terraform.io/providers/hashicorp/vault/3.19.0/docs/resources/generic_endpoint vault_generic_endpoint} Resource.

Types

type GenericEndpoint

type GenericEndpoint interface {
	cdktf.TerraformResource
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	// Experimental.
	Connection() interface{}
	// Experimental.
	SetConnection(val interface{})
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Count() interface{}
	// Experimental.
	SetCount(val interface{})
	DataJson() *string
	SetDataJson(val *string)
	DataJsonInput() *string
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(val *[]*string)
	DisableDelete() interface{}
	SetDisableDelete(val interface{})
	DisableDeleteInput() interface{}
	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
	IgnoreAbsentFields() interface{}
	SetIgnoreAbsentFields(val interface{})
	IgnoreAbsentFieldsInput() interface{}
	// Experimental.
	Lifecycle() *cdktf.TerraformResourceLifecycle
	// Experimental.
	SetLifecycle(val *cdktf.TerraformResourceLifecycle)
	Namespace() *string
	SetNamespace(val *string)
	NamespaceInput() *string
	// The tree node.
	Node() constructs.Node
	Path() *string
	SetPath(val *string)
	PathInput() *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
	WriteData() cdktf.StringMap
	WriteDataJson() *string
	WriteFields() *[]*string
	SetWriteFields(val *[]*string)
	WriteFieldsInput() *[]*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.
	InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	ResetDisableDelete()
	ResetDisableRead()
	ResetId()
	ResetIgnoreAbsentFields()
	ResetNamespace()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetWriteFields()
	SynthesizeAttributes() *map[string]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/3.19.0/docs/resources/generic_endpoint vault_generic_endpoint}.

func NewGenericEndpoint

func NewGenericEndpoint(scope constructs.Construct, id *string, config *GenericEndpointConfig) GenericEndpoint

Create a new {@link https://registry.terraform.io/providers/hashicorp/vault/3.19.0/docs/resources/generic_endpoint vault_generic_endpoint} Resource.

type GenericEndpointConfig

type GenericEndpointConfig 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 data to write.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/3.19.0/docs/resources/generic_endpoint#data_json GenericEndpoint#data_json}
	DataJson *string `field:"required" json:"dataJson" yaml:"dataJson"`
	// Full path where to the endpoint that will be written.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/3.19.0/docs/resources/generic_endpoint#path GenericEndpoint#path}
	Path *string `field:"required" json:"path" yaml:"path"`
	// Don't attempt to delete the path from Vault if true.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/3.19.0/docs/resources/generic_endpoint#disable_delete GenericEndpoint#disable_delete}
	DisableDelete interface{} `field:"optional" json:"disableDelete" yaml:"disableDelete"`
	// Don't attempt to read the path from Vault if true; drift won't be detected.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/3.19.0/docs/resources/generic_endpoint#disable_read GenericEndpoint#disable_read}
	DisableRead interface{} `field:"optional" json:"disableRead" yaml:"disableRead"`
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/3.19.0/docs/resources/generic_endpoint#id GenericEndpoint#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"`
	// When reading, disregard fields not present in data_json.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/3.19.0/docs/resources/generic_endpoint#ignore_absent_fields GenericEndpoint#ignore_absent_fields}
	IgnoreAbsentFields interface{} `field:"optional" json:"ignoreAbsentFields" yaml:"ignoreAbsentFields"`
	// Target namespace. (requires Enterprise).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/3.19.0/docs/resources/generic_endpoint#namespace GenericEndpoint#namespace}
	Namespace *string `field:"optional" json:"namespace" yaml:"namespace"`
	// Top-level fields returned by write to persist in state.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/3.19.0/docs/resources/generic_endpoint#write_fields GenericEndpoint#write_fields}
	WriteFields *[]*string `field:"optional" json:"writeFields" yaml:"writeFields"`
}