Skip to content

Latest commit

 

History

History
1085 lines (681 loc) · 45.6 KB

dataVaultTransformDecode.go.md

File metadata and controls

1085 lines (681 loc) · 45.6 KB
Raw

dataVaultTransformDecode Submodule

Constructs

DataVaultTransformDecode

Represents a {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/transform_decode vault_transform_decode}.

Initializers 

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

datavaulttransformdecode.NewDataVaultTransformDecode(scope Construct, id *string, config DataVaultTransformDecodeConfig) DataVaultTransformDecode
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 DataVaultTransformDecodeConfig 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 Adds this resource to the terraform JSON output.
ToMetadata No description.
ToTerraform Adds this resource to the terraform JSON output.
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.
InterpolationForAttribute No description.
ResetBatchInput No description.
ResetBatchResults No description.
ResetDecodedValue No description.
ResetId No description.
ResetNamespace No description.
ResetTransformation No description.
ResetTweak No description.
ResetValue 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{}

Adds this resource to the terraform JSON output.

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

Adds this resource to the terraform JSON output.

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
InterpolationForAttribute 
func InterpolationForAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string
ResetBatchInput 
func ResetBatchInput()
ResetBatchResults 
func ResetBatchResults()
ResetDecodedValue 
func ResetDecodedValue()
ResetId 
func ResetId()
ResetNamespace 
func ResetNamespace()
ResetTransformation 
func ResetTransformation()
ResetTweak 
func ResetTweak()
ResetValue 
func ResetValue()

Static Functions

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

datavaulttransformdecode.DataVaultTransformDecode_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/datavaulttransformdecode"

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

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

datavaulttransformdecode.DataVaultTransformDecode_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

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

importFromIdRequired
  • Type: *string

The id of the existing DataVaultTransformDecode that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/transform_decode#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 DataVaultTransformDecode 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.
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.
BatchInputInput interface{} No description.
BatchResultsInput interface{} No description.
DecodedValueInput *string No description.
IdInput *string No description.
NamespaceInput *string No description.
PathInput *string No description.
RoleNameInput *string No description.
TransformationInput *string No description.
TweakInput *string No description.
ValueInput *string No description.
BatchInput interface{} No description.
BatchResults interface{} No description.
DecodedValue *string No description.
Id *string No description.
Namespace *string No description.
Path *string No description.
RoleName *string No description.
Transformation *string No description.
Tweak *string No description.
Value *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
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
BatchInputInputOptional 
func BatchInputInput() interface{}
  • Type: interface{}
BatchResultsInputOptional 
func BatchResultsInput() interface{}
  • Type: interface{}
DecodedValueInputOptional 
func DecodedValueInput() *string
  • Type: *string
IdInputOptional 
func IdInput() *string
  • Type: *string
NamespaceInputOptional 
func NamespaceInput() *string
  • Type: *string
PathInputOptional 
func PathInput() *string
  • Type: *string
RoleNameInputOptional 
func RoleNameInput() *string
  • Type: *string
TransformationInputOptional 
func TransformationInput() *string
  • Type: *string
TweakInputOptional 
func TweakInput() *string
  • Type: *string
ValueInputOptional 
func ValueInput() *string
  • Type: *string
BatchInputRequired 
func BatchInput() interface{}
  • Type: interface{}
BatchResultsRequired 
func BatchResults() interface{}
  • Type: interface{}
DecodedValueRequired 
func DecodedValue() *string
  • Type: *string
IdRequired 
func Id() *string
  • Type: *string
NamespaceRequired 
func Namespace() *string
  • Type: *string
PathRequired 
func Path() *string
  • Type: *string
RoleNameRequired 
func RoleName() *string
  • Type: *string
TransformationRequired 
func Transformation() *string
  • Type: *string
TweakRequired 
func Tweak() *string
  • Type: *string
ValueRequired 
func Value() *string
  • Type: *string

Constants

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

Structs

DataVaultTransformDecodeConfig

Initializer 

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

&datavaulttransformdecode.DataVaultTransformDecodeConfig {
	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{},
	Path: *string,
	RoleName: *string,
	BatchInput: interface{},
	BatchResults: interface{},
	DecodedValue: *string,
	Id: *string,
	Namespace: *string,
	Transformation: *string,
	Tweak: *string,
	Value: *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.
Path *string Path to backend from which to retrieve data.
RoleName *string The name of the role.
BatchInput interface{} Specifies a list of items to be decoded in a single batch.
BatchResults interface{} The result of decoding batch_input.
DecodedValue *string The result of decoding a value.
Id *string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/transform_decode#id DataVaultTransformDecode#id}.
Namespace *string Target namespace. (requires Enterprise).
Transformation *string The transformation to perform.
Tweak *string The tweak value to use. Only applicable for FPE transformations.
Value *string The value in which to decode.
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{}
PathRequired 
Path *string
  • Type: *string

Path to backend from which to retrieve data.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/transform_decode#path DataVaultTransformDecode#path}

RoleNameRequired 
RoleName *string
  • Type: *string

The name of the role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/transform_decode#role_name DataVaultTransformDecode#role_name}

BatchInputOptional 
BatchInput interface{}
  • Type: interface{}

Specifies a list of items to be decoded in a single batch.

If this parameter is set, the top-level parameters 'value', 'transformation' and 'tweak' will be ignored. Each batch item within the list can specify these parameters instead.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/transform_decode#batch_input DataVaultTransformDecode#batch_input}

BatchResultsOptional 
BatchResults interface{}
  • Type: interface{}

The result of decoding batch_input.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/transform_decode#batch_results DataVaultTransformDecode#batch_results}

DecodedValueOptional 
DecodedValue *string
  • Type: *string

The result of decoding a value.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/transform_decode#decoded_value DataVaultTransformDecode#decoded_value}

IdOptional 
Id *string
  • Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/transform_decode#id DataVaultTransformDecode#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/data-sources/transform_decode#namespace DataVaultTransformDecode#namespace}

TransformationOptional 
Transformation *string
  • Type: *string

The transformation to perform.

If no value is provided and the role contains a single transformation, this value will be inferred from the role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/transform_decode#transformation DataVaultTransformDecode#transformation}

TweakOptional 
Tweak *string
  • Type: *string

The tweak value to use. Only applicable for FPE transformations.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/transform_decode#tweak DataVaultTransformDecode#tweak}

ValueOptional 
Value *string
  • Type: *string

The value in which to decode.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/transform_decode#value DataVaultTransformDecode#value}