Skip to content

Latest commit

 

History

History
1298 lines (824 loc) · 57.1 KB

dataVaultTransformDecode.python.md

File metadata and controls

1298 lines (824 loc) · 57.1 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 

from cdktf_cdktf_provider_vault import data_vault_transform_decode

dataVaultTransformDecode.DataVaultTransformDecode(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  path: str,
  role_name: str,
  batch_input: typing.Union[IResolvable, typing.List[typing.Mapping[str]]] = None,
  batch_results: typing.Union[IResolvable, typing.List[typing.Mapping[str]]] = None,
  decoded_value: str = None,
  id: str = None,
  namespace: str = None,
  transformation: str = None,
  tweak: str = None,
  value: str = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
path str Path to backend from which to retrieve data.
role_name str The name of the role.
batch_input typing.Union[cdktf.IResolvable, typing.List[typing.Mapping[str]]] Specifies a list of items to be decoded in a single batch.
batch_results typing.Union[cdktf.IResolvable, typing.List[typing.Mapping[str]]] The result of decoding batch_input.
decoded_value str The result of decoding a value.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/transform_decode#id DataVaultTransformDecode#id}.
namespace str Target namespace. (requires Enterprise).
transformation str The transformation to perform.
tweak str The tweak value to use. Only applicable for FPE transformations.
value str The value in which to decode.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional
  • Type: cdktf.ITerraformIterator
lifecycleOptional
  • Type: cdktf.TerraformResourceLifecycle
providerOptional
  • Type: cdktf.TerraformProvider
provisionersOptional
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
pathRequired
  • Type: str

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}

role_nameRequired
  • Type: str

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}

batch_inputOptional
  • Type: typing.Union[cdktf.IResolvable, typing.List[typing.Mapping[str]]]

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}

batch_resultsOptional
  • Type: typing.Union[cdktf.IResolvable, typing.List[typing.Mapping[str]]]

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}

decoded_valueOptional
  • Type: str

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
  • Type: str

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
  • Type: str

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
  • Type: str

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
  • Type: str

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
  • Type: str

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}

Methods

Name Description
to_string Returns a string representation of this construct.
add_override No description.
override_logical_id Overrides the auto-generated logical ID with a specific ID.
reset_override_logical_id Resets a previously passed logical Id to use the auto-generated logical id again.
to_hcl_terraform Adds this resource to the terraform JSON output.
to_metadata No description.
to_terraform Adds this resource to the terraform JSON output.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
reset_batch_input No description.
reset_batch_results No description.
reset_decoded_value No description.
reset_id No description.
reset_namespace No description.
reset_transformation No description.
reset_tweak No description.
reset_value No description.
to_string 
def to_string() -> str

Returns a string representation of this construct.

add_override 
def add_override(
  path: str,
  value: typing.Any
) -> None
pathRequired
  • Type: str
valueRequired
  • Type: typing.Any
override_logical_id 
def override_logical_id(
  new_logical_id: str
) -> None

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

new_logical_idRequired
  • Type: str

The new logical ID to use for this stack element.

reset_override_logical_id 
def reset_override_logical_id() -> None

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

to_hcl_terraform 
def to_hcl_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

to_metadata 
def to_metadata() -> typing.Any
to_terraform 
def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
reset_batch_input 
def reset_batch_input() -> None
reset_batch_results 
def reset_batch_results() -> None
reset_decoded_value 
def reset_decoded_value() -> None
reset_id 
def reset_id() -> None
reset_namespace 
def reset_namespace() -> None
reset_transformation 
def reset_transformation() -> None
reset_tweak 
def reset_tweak() -> None
reset_value 
def reset_value() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_data_source No description.
generate_config_for_import Generates CDKTF code for importing a DataVaultTransformDecode resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_vault import data_vault_transform_decode

dataVaultTransformDecode.DataVaultTransformDecode.is_construct(
  x: typing.Any
)

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: typing.Any

Any object.

is_terraform_element 
from cdktf_cdktf_provider_vault import data_vault_transform_decode

dataVaultTransformDecode.DataVaultTransformDecode.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_data_source 
from cdktf_cdktf_provider_vault import data_vault_transform_decode

dataVaultTransformDecode.DataVaultTransformDecode.is_terraform_data_source(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_vault import data_vault_transform_decode

dataVaultTransformDecode.DataVaultTransformDecode.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

import_to_idRequired
  • Type: str

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

import_from_idRequired
  • Type: str

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: cdktf.TerraformProvider

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

Properties

Name Type Description
node constructs.Node The tree node.
cdktf_stack cdktf.TerraformStack No description.
fqn str No description.
friendly_unique_id str No description.
terraform_meta_arguments typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktf.TerraformProviderGeneratorMetadata No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[str] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
batch_input_input typing.Union[cdktf.IResolvable, typing.List[typing.Mapping[str]]] No description.
batch_results_input typing.Union[cdktf.IResolvable, typing.List[typing.Mapping[str]]] No description.
decoded_value_input str No description.
id_input str No description.
namespace_input str No description.
path_input str No description.
role_name_input str No description.
transformation_input str No description.
tweak_input str No description.
value_input str No description.
batch_input typing.Union[cdktf.IResolvable, typing.List[typing.Mapping[str]]] No description.
batch_results typing.Union[cdktf.IResolvable, typing.List[typing.Mapping[str]]] No description.
decoded_value str No description.
id str No description.
namespace str No description.
path str No description.
role_name str No description.
transformation str No description.
tweak str No description.
value str No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

cdktf_stackRequired 
cdktf_stack: TerraformStack
  • Type: cdktf.TerraformStack
fqnRequired 
fqn: str
  • Type: str
friendly_unique_idRequired 
friendly_unique_id: str
  • Type: str
terraform_meta_argumentsRequired 
terraform_meta_arguments: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
terraform_resource_typeRequired 
terraform_resource_type: str
  • Type: str
terraform_generator_metadataOptional 
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktf.TerraformProviderGeneratorMetadata
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[str]
  • Type: typing.List[str]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
batch_input_inputOptional 
batch_input_input: typing.Union[IResolvable, typing.List[typing.Mapping[str]]]
  • Type: typing.Union[cdktf.IResolvable, typing.List[typing.Mapping[str]]]
batch_results_inputOptional 
batch_results_input: typing.Union[IResolvable, typing.List[typing.Mapping[str]]]
  • Type: typing.Union[cdktf.IResolvable, typing.List[typing.Mapping[str]]]
decoded_value_inputOptional 
decoded_value_input: str
  • Type: str
id_inputOptional 
id_input: str
  • Type: str
namespace_inputOptional 
namespace_input: str
  • Type: str
path_inputOptional 
path_input: str
  • Type: str
role_name_inputOptional 
role_name_input: str
  • Type: str
transformation_inputOptional 
transformation_input: str
  • Type: str
tweak_inputOptional 
tweak_input: str
  • Type: str
value_inputOptional 
value_input: str
  • Type: str
batch_inputRequired 
batch_input: typing.Union[IResolvable, typing.List[typing.Mapping[str]]]
  • Type: typing.Union[cdktf.IResolvable, typing.List[typing.Mapping[str]]]
batch_resultsRequired 
batch_results: typing.Union[IResolvable, typing.List[typing.Mapping[str]]]
  • Type: typing.Union[cdktf.IResolvable, typing.List[typing.Mapping[str]]]
decoded_valueRequired 
decoded_value: str
  • Type: str
idRequired 
id: str
  • Type: str
namespaceRequired 
namespace: str
  • Type: str
pathRequired 
path: str
  • Type: str
role_nameRequired 
role_name: str
  • Type: str
transformationRequired 
transformation: str
  • Type: str
tweakRequired 
tweak: str
  • Type: str
valueRequired 
value: str
  • Type: str

Constants

Name Type Description
tfResourceType str No description.
tfResourceTypeRequired 
tfResourceType: str
  • Type: str

Structs

DataVaultTransformDecodeConfig

Initializer 

from cdktf_cdktf_provider_vault import data_vault_transform_decode

dataVaultTransformDecode.DataVaultTransformDecodeConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  path: str,
  role_name: str,
  batch_input: typing.Union[IResolvable, typing.List[typing.Mapping[str]]] = None,
  batch_results: typing.Union[IResolvable, typing.List[typing.Mapping[str]]] = None,
  decoded_value: str = None,
  id: str = None,
  namespace: str = None,
  transformation: str = None,
  tweak: str = None,
  value: str = None
)

Properties

Name Type Description
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
path str Path to backend from which to retrieve data.
role_name str The name of the role.
batch_input typing.Union[cdktf.IResolvable, typing.List[typing.Mapping[str]]] Specifies a list of items to be decoded in a single batch.
batch_results typing.Union[cdktf.IResolvable, typing.List[typing.Mapping[str]]] The result of decoding batch_input.
decoded_value str The result of decoding a value.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/transform_decode#id DataVaultTransformDecode#id}.
namespace str Target namespace. (requires Enterprise).
transformation str The transformation to perform.
tweak str The tweak value to use. Only applicable for FPE transformations.
value str The value in which to decode.
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
pathRequired 
path: str
  • Type: str

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}

role_nameRequired 
role_name: str
  • Type: str

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}

batch_inputOptional 
batch_input: typing.Union[IResolvable, typing.List[typing.Mapping[str]]]
  • Type: typing.Union[cdktf.IResolvable, typing.List[typing.Mapping[str]]]

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}

batch_resultsOptional 
batch_results: typing.Union[IResolvable, typing.List[typing.Mapping[str]]]
  • Type: typing.Union[cdktf.IResolvable, typing.List[typing.Mapping[str]]]

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}

decoded_valueOptional 
decoded_value: str
  • Type: str

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: str
  • Type: str

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: str
  • Type: str

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: str
  • Type: str

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: str
  • Type: str

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: str
  • Type: str

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}