`dataTfeVariableSet` Submodule

Constructs

DataTfeVariableSet

Represents a {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/data-sources/variable_set tfe_variable_set}.

Initializers

from cdktf_cdktf_provider_tfe import data_tfe_variable_set

dataTfeVariableSet.DataTfeVariableSet(
  scope: Construct,
  id: str,
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: 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[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  name: str,
  id: str = None,
  organization: str = None,
  parent_project_id: str = None,
  project_ids: typing.List[str] = None,
  variable_ids: typing.List[str] = None,
  workspace_ids: typing.List[str] = None
)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`str`	The scoped construct ID.
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`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[cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner]`	No description.
`name`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/data-sources/variable_set#name DataTfeVariableSet#name}.
`id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/data-sources/variable_set#id DataTfeVariableSet#id}.
`organization`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/data-sources/variable_set#organization DataTfeVariableSet#organization}.
`parent_project_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/data-sources/variable_set#parent_project_id DataTfeVariableSet#parent_project_id}.
`project_ids`	`typing.List[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/data-sources/variable_set#project_ids DataTfeVariableSet#project_ids}.
`variable_ids`	`typing.List[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/data-sources/variable_set#variable_ids DataTfeVariableSet#variable_ids}.
`workspace_ids`	`typing.List[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/data-sources/variable_set#workspace_ids DataTfeVariableSet#workspace_ids}.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

`connection`^Optional

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

Type: typing.Union[int, float] | cdktf.TerraformCount

`depends_on`^Optional

Type: typing.List[cdktf.ITerraformDependable]

`for_each`^Optional

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

Type: cdktf.TerraformProvider

`provisioners`^Optional

Type: typing.List[cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner]

`name`^Required

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/data-sources/variable_set#name DataTfeVariableSet#name}.

`id`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/data-sources/variable_set#id DataTfeVariableSet#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.

`organization`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/data-sources/variable_set#organization DataTfeVariableSet#organization}.

`parent_project_id`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/data-sources/variable_set#parent_project_id DataTfeVariableSet#parent_project_id}.

`project_ids`^Optional

Type: typing.List[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/data-sources/variable_set#project_ids DataTfeVariableSet#project_ids}.

`variable_ids`^Optional

Type: typing.List[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/data-sources/variable_set#variable_ids DataTfeVariableSet#variable_ids}.

`workspace_ids`^Optional

Type: typing.List[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/data-sources/variable_set#workspace_ids DataTfeVariableSet#workspace_ids}.

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_id`	No description.
`reset_organization`	No description.
`reset_parent_project_id`	No description.
`reset_project_ids`	No description.
`reset_variable_ids`	No description.
`reset_workspace_ids`	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

`path`^Required

Type: str

`value`^Required

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_id`^Required

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_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

`terraform_attribute`^Required

Type: str

`get_list_attribute`

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

`terraform_attribute`^Required

Type: str

`get_number_attribute`

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

`terraform_attribute`^Required

Type: str

`interpolation_for_attribute`

def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`reset_id`

def reset_id() -> None

`reset_organization`

def reset_organization() -> None

`reset_parent_project_id`

def reset_parent_project_id() -> None

`reset_project_ids`

def reset_project_ids() -> None

`reset_variable_ids`

def reset_variable_ids() -> None

`reset_workspace_ids`

def reset_workspace_ids() -> 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 DataTfeVariableSet resource upon running "cdktf plan ".

`is_construct`

from cdktf_cdktf_provider_tfe import data_tfe_variable_set

dataTfeVariableSet.DataTfeVariableSet.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.

`x`^Required

Type: typing.Any

Any object.

`is_terraform_element`

from cdktf_cdktf_provider_tfe import data_tfe_variable_set

dataTfeVariableSet.DataTfeVariableSet.is_terraform_element(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`is_terraform_data_source`

from cdktf_cdktf_provider_tfe import data_tfe_variable_set

dataTfeVariableSet.DataTfeVariableSet.is_terraform_data_source(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`generate_config_for_import`

from cdktf_cdktf_provider_tfe import data_tfe_variable_set

dataTfeVariableSet.DataTfeVariableSet.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`import_to_id`^Required

Type: str

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

`import_from_id`^Required

Type: str

The id of the existing DataTfeVariableSet that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/data-sources/variable_set#import import section} in the documentation of this resource for the id to use

`provider`^Optional

Type: cdktf.TerraformProvider

? Optional instance of the provider where the DataTfeVariableSet 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[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.
`description`	`str`	No description.
`global`	`cdktf.IResolvable`	No description.
`priority`	`cdktf.IResolvable`	No description.
`id_input`	`str`	No description.
`name_input`	`str`	No description.
`organization_input`	`str`	No description.
`parent_project_id_input`	`str`	No description.
`project_ids_input`	`typing.List[str]`	No description.
`variable_ids_input`	`typing.List[str]`	No description.
`workspace_ids_input`	`typing.List[str]`	No description.
`id`	`str`	No description.
`name`	`str`	No description.
`organization`	`str`	No description.
`parent_project_id`	`str`	No description.
`project_ids`	`typing.List[str]`	No description.
`variable_ids`	`typing.List[str]`	No description.
`workspace_ids`	`typing.List[str]`	No description.

`node`^Required

node: Node

Type: constructs.Node

The tree node.

`cdktf_stack`^Required

cdktf_stack: TerraformStack

Type: cdktf.TerraformStack

`fqn`^Required

fqn: str

Type: str

`friendly_unique_id`^Required

friendly_unique_id: str

Type: str

`terraform_meta_arguments`^Required

terraform_meta_arguments: typing.Mapping[typing.Any]

Type: typing.Mapping[typing.Any]

`terraform_resource_type`^Required

terraform_resource_type: str

Type: str

`terraform_generator_metadata`^Optional

terraform_generator_metadata: TerraformProviderGeneratorMetadata

Type: cdktf.TerraformProviderGeneratorMetadata

`count`^Optional

count: typing.Union[int, float] | TerraformCount

Type: typing.Union[int, float] | cdktf.TerraformCount

`depends_on`^Optional

depends_on: typing.List[str]

Type: typing.List[str]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktf.TerraformProvider

`description`^Required

description: str

Type: str

`global`^Required

global: IResolvable

Type: cdktf.IResolvable

`priority`^Required

priority: IResolvable

Type: cdktf.IResolvable

`id_input`^Optional

id_input: str

Type: str

`name_input`^Optional

name_input: str

Type: str

`organization_input`^Optional

organization_input: str

Type: str

`parent_project_id_input`^Optional

parent_project_id_input: str

Type: str

`project_ids_input`^Optional

project_ids_input: typing.List[str]

Type: typing.List[str]

`variable_ids_input`^Optional

variable_ids_input: typing.List[str]

Type: typing.List[str]

`workspace_ids_input`^Optional

workspace_ids_input: typing.List[str]

Type: typing.List[str]

`id`^Required

id: str

Type: str

`name`^Required

name: str

Type: str

`organization`^Required

organization: str

Type: str

`parent_project_id`^Required

parent_project_id: str

Type: str

`project_ids`^Required

project_ids: typing.List[str]

Type: typing.List[str]

`variable_ids`^Required

variable_ids: typing.List[str]

Type: typing.List[str]

`workspace_ids`^Required

workspace_ids: typing.List[str]

Type: typing.List[str]

Constants

Name	Type	Description
`tfResourceType`	`str`	No description.

`tfResourceType`^Required

tfResourceType: str

Type: str

Structs

DataTfeVariableSetConfig

Initializer

from cdktf_cdktf_provider_tfe import data_tfe_variable_set

dataTfeVariableSet.DataTfeVariableSetConfig(
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: 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[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  name: str,
  id: str = None,
  organization: str = None,
  parent_project_id: str = None,
  project_ids: typing.List[str] = None,
  variable_ids: typing.List[str] = None,
  workspace_ids: typing.List[str] = None
)

Properties

Name	Type	Description
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`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[cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner]`	No description.
`name`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/data-sources/variable_set#name DataTfeVariableSet#name}.
`id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/data-sources/variable_set#id DataTfeVariableSet#id}.
`organization`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/data-sources/variable_set#organization DataTfeVariableSet#organization}.
`parent_project_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/data-sources/variable_set#parent_project_id DataTfeVariableSet#parent_project_id}.
`project_ids`	`typing.List[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/data-sources/variable_set#project_ids DataTfeVariableSet#project_ids}.
`variable_ids`	`typing.List[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/data-sources/variable_set#variable_ids DataTfeVariableSet#variable_ids}.
`workspace_ids`	`typing.List[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/data-sources/variable_set#workspace_ids DataTfeVariableSet#workspace_ids}.

`connection`^Optional

connection: SSHProvisionerConnection | WinrmProvisionerConnection

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

count: typing.Union[int, float] | TerraformCount

Type: typing.Union[int, float] | cdktf.TerraformCount

`depends_on`^Optional

depends_on: typing.List[ITerraformDependable]

Type: typing.List[cdktf.ITerraformDependable]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktf.TerraformProvider

`provisioners`^Optional

provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]

Type: typing.List[cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner]

`name`^Required

name: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/data-sources/variable_set#name DataTfeVariableSet#name}.

`id`^Optional

id: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/data-sources/variable_set#id DataTfeVariableSet#id}.

`organization`^Optional

organization: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/data-sources/variable_set#organization DataTfeVariableSet#organization}.

`parent_project_id`^Optional

parent_project_id: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/data-sources/variable_set#parent_project_id DataTfeVariableSet#parent_project_id}.

`project_ids`^Optional

project_ids: typing.List[str]

Type: typing.List[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/data-sources/variable_set#project_ids DataTfeVariableSet#project_ids}.

`variable_ids`^Optional

variable_ids: typing.List[str]

Type: typing.List[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/data-sources/variable_set#variable_ids DataTfeVariableSet#variable_ids}.

`workspace_ids`^Optional

workspace_ids: typing.List[str]

Type: typing.List[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/data-sources/variable_set#workspace_ids DataTfeVariableSet#workspace_ids}.

Uh oh!

FilesExpand file tree

dataTfeVariableSet.python.md

Latest commit

History

dataTfeVariableSet.python.md

File metadata and controls

dataTfeVariableSet Submodule

Constructs