`dataTfeWorkspace` Submodule

Constructs

DataTfeWorkspace

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

Initializers

from cdktf_cdktf_provider_tfe import data_tfe_workspace

dataTfeWorkspace.DataTfeWorkspace(
  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,
  tag_names: 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/workspace#name DataTfeWorkspace#name}.
`id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/data-sources/workspace#id DataTfeWorkspace#id}.
`organization`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/data-sources/workspace#organization DataTfeWorkspace#organization}.
`tag_names`	`typing.List[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/data-sources/workspace#tag_names DataTfeWorkspace#tag_names}.

`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/workspace#name DataTfeWorkspace#name}.

`id`^Optional

Type: str

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

`tag_names`^Optional

Type: typing.List[str]

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

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_tag_names`	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_tag_names`

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

`is_construct`

from cdktf_cdktf_provider_tfe import data_tfe_workspace

dataTfeWorkspace.DataTfeWorkspace.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_workspace

dataTfeWorkspace.DataTfeWorkspace.is_terraform_element(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`is_terraform_data_source`

from cdktf_cdktf_provider_tfe import data_tfe_workspace

dataTfeWorkspace.DataTfeWorkspace.is_terraform_data_source(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`generate_config_for_import`

from cdktf_cdktf_provider_tfe import data_tfe_workspace

dataTfeWorkspace.DataTfeWorkspace.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

`import_from_id`^Required

Type: str

The id of the existing DataTfeWorkspace that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/data-sources/workspace#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 DataTfeWorkspace 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.
`actions`	`cdktf.BooleanMap`	No description.
`allow_destroy_plan`	`cdktf.IResolvable`	No description.
`apply_duration_average`	`typing.Union[int, float]`	No description.
`assessments_enabled`	`cdktf.IResolvable`	No description.
`auto_apply`	`cdktf.IResolvable`	No description.
`auto_apply_run_trigger`	`cdktf.IResolvable`	No description.
`auto_destroy_activity_duration`	`str`	No description.
`auto_destroy_at`	`str`	No description.
`created_at`	`str`	No description.
`description`	`str`	No description.
`effective_tags`	`cdktf.StringMap`	No description.
`environment`	`str`	No description.
`execution_mode`	`str`	No description.
`file_triggers_enabled`	`cdktf.IResolvable`	No description.
`global_remote_state`	`cdktf.IResolvable`	No description.
`html_url`	`str`	No description.
`hyok_enabled`	`cdktf.IResolvable`	No description.
`inherits_project_auto_destroy`	`cdktf.IResolvable`	No description.
`locked`	`cdktf.IResolvable`	No description.
`operations`	`cdktf.IResolvable`	No description.
`permissions`	`cdktf.BooleanMap`	No description.
`plan_duration_average`	`typing.Union[int, float]`	No description.
`policy_check_failures`	`typing.Union[int, float]`	No description.
`project_id`	`str`	No description.
`queue_all_runs`	`cdktf.IResolvable`	No description.
`remote_state_consumer_ids`	`typing.List[str]`	No description.
`resource_count`	`typing.Union[int, float]`	No description.
`run_failures`	`typing.Union[int, float]`	No description.
`runs_count`	`typing.Union[int, float]`	No description.
`setting_overwrites`	`cdktf.BooleanMap`	No description.
`source`	`str`	No description.
`source_name`	`str`	No description.
`source_url`	`str`	No description.
`speculative_enabled`	`cdktf.IResolvable`	No description.
`ssh_key_id`	`str`	No description.
`structured_run_output_enabled`	`cdktf.IResolvable`	No description.
`terraform_version`	`str`	No description.
`trigger_patterns`	`typing.List[str]`	No description.
`trigger_prefixes`	`typing.List[str]`	No description.
`updated_at`	`str`	No description.
`vcs_repo`	`DataTfeWorkspaceVcsRepoList`	No description.
`working_directory`	`str`	No description.
`id_input`	`str`	No description.
`name_input`	`str`	No description.
`organization_input`	`str`	No description.
`tag_names_input`	`typing.List[str]`	No description.
`id`	`str`	No description.
`name`	`str`	No description.
`organization`	`str`	No description.
`tag_names`	`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

`actions`^Required

actions: BooleanMap

Type: cdktf.BooleanMap

`allow_destroy_plan`^Required

allow_destroy_plan: IResolvable

Type: cdktf.IResolvable

`apply_duration_average`^Required

apply_duration_average: typing.Union[int, float]

Type: typing.Union[int, float]

`assessments_enabled`^Required

assessments_enabled: IResolvable

Type: cdktf.IResolvable

`auto_apply`^Required

auto_apply: IResolvable

Type: cdktf.IResolvable

`auto_apply_run_trigger`^Required

auto_apply_run_trigger: IResolvable

Type: cdktf.IResolvable

`auto_destroy_activity_duration`^Required

auto_destroy_activity_duration: str

Type: str

`auto_destroy_at`^Required

auto_destroy_at: str

Type: str

`created_at`^Required

created_at: str

Type: str

`description`^Required

description: str

Type: str

`effective_tags`^Required

effective_tags: StringMap

Type: cdktf.StringMap

`environment`^Required

environment: str

Type: str

`execution_mode`^Required

execution_mode: str

Type: str

`file_triggers_enabled`^Required

file_triggers_enabled: IResolvable

Type: cdktf.IResolvable

`global_remote_state`^Required

global_remote_state: IResolvable

Type: cdktf.IResolvable

`html_url`^Required

html_url: str

Type: str

`hyok_enabled`^Required

hyok_enabled: IResolvable

Type: cdktf.IResolvable

`inherits_project_auto_destroy`^Required

inherits_project_auto_destroy: IResolvable

Type: cdktf.IResolvable

`locked`^Required

locked: IResolvable

Type: cdktf.IResolvable

`operations`^Required

operations: IResolvable

Type: cdktf.IResolvable

`permissions`^Required

permissions: BooleanMap

Type: cdktf.BooleanMap

`plan_duration_average`^Required

plan_duration_average: typing.Union[int, float]

Type: typing.Union[int, float]

`policy_check_failures`^Required

policy_check_failures: typing.Union[int, float]

Type: typing.Union[int, float]

`project_id`^Required

project_id: str

Type: str

`queue_all_runs`^Required

queue_all_runs: IResolvable

Type: cdktf.IResolvable

`remote_state_consumer_ids`^Required

remote_state_consumer_ids: typing.List[str]

Type: typing.List[str]

`resource_count`^Required

resource_count: typing.Union[int, float]

Type: typing.Union[int, float]

`run_failures`^Required

run_failures: typing.Union[int, float]

Type: typing.Union[int, float]

`runs_count`^Required

runs_count: typing.Union[int, float]

Type: typing.Union[int, float]

`setting_overwrites`^Required

setting_overwrites: BooleanMap

Type: cdktf.BooleanMap

`source`^Required

source: str

Type: str

`source_name`^Required

source_name: str

Type: str

`source_url`^Required

source_url: str

Type: str

`speculative_enabled`^Required

speculative_enabled: IResolvable

Type: cdktf.IResolvable

`ssh_key_id`^Required

ssh_key_id: str

Type: str

`structured_run_output_enabled`^Required

structured_run_output_enabled: IResolvable

Type: cdktf.IResolvable

`terraform_version`^Required

terraform_version: str

Type: str

`trigger_patterns`^Required

trigger_patterns: typing.List[str]

Type: typing.List[str]

`trigger_prefixes`^Required

trigger_prefixes: typing.List[str]

Type: typing.List[str]

`updated_at`^Required

updated_at: str

Type: str

`vcs_repo`^Required

vcs_repo: DataTfeWorkspaceVcsRepoList

Type: DataTfeWorkspaceVcsRepoList

`working_directory`^Required

working_directory: str

Type: str

`id_input`^Optional

id_input: str

Type: str

`name_input`^Optional

name_input: str

Type: str

`organization_input`^Optional

organization_input: str

Type: str

`tag_names_input`^Optional

tag_names_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

`tag_names`^Required

tag_names: typing.List[str]

Type: typing.List[str]

Constants

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

`tfResourceType`^Required

tfResourceType: str

Type: str

Structs

DataTfeWorkspaceConfig

Initializer

from cdktf_cdktf_provider_tfe import data_tfe_workspace

dataTfeWorkspace.DataTfeWorkspaceConfig(
  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,
  tag_names: 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/workspace#name DataTfeWorkspace#name}.
`id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/data-sources/workspace#id DataTfeWorkspace#id}.
`organization`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/data-sources/workspace#organization DataTfeWorkspace#organization}.
`tag_names`	`typing.List[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/data-sources/workspace#tag_names DataTfeWorkspace#tag_names}.

`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/workspace#name DataTfeWorkspace#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/workspace#id DataTfeWorkspace#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/workspace#organization DataTfeWorkspace#organization}.

`tag_names`^Optional

tag_names: 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/workspace#tag_names DataTfeWorkspace#tag_names}.

DataTfeWorkspaceVcsRepo

Initializer

from cdktf_cdktf_provider_tfe import data_tfe_workspace

dataTfeWorkspace.DataTfeWorkspaceVcsRepo()

Classes

DataTfeWorkspaceVcsRepoList

Initializers

from cdktf_cdktf_provider_tfe import data_tfe_workspace

dataTfeWorkspace.DataTfeWorkspaceVcsRepoList(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  wraps_set: bool
)

Name	Type	Description
`terraform_resource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraform_attribute`	`str`	The attribute on the parent resource this class is referencing.
`wraps_set`	`bool`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`terraform_resource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraform_attribute`^Required

Type: str

The attribute on the parent resource this class is referencing.

`wraps_set`^Required

Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name	Description
`all_with_map_key`	Creating an iterator for this complex list.
`compute_fqn`	No description.
`resolve`	Produce the Token's value at resolution time.
`to_string`	Return a string representation of this resolvable object.
`get`	No description.

`all_with_map_key`

def all_with_map_key(
  map_key_attribute_name: str
) -> DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

`map_key_attribute_name`^Required

Type: str

`compute_fqn`

def compute_fqn() -> str

`resolve`

def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`to_string`

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

`get`

def get(
  index: typing.Union[int, float]
) -> DataTfeWorkspaceVcsRepoOutputReference

`index`^Required

Type: typing.Union[int, float]

the index of the item to return.

Properties

Name	Type	Description
`creation_stack`	`typing.List[str]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`str`	No description.

`creation_stack`^Required

creation_stack: typing.List[str]

Type: typing.List[str]

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.

`fqn`^Required

fqn: str

Type: str

DataTfeWorkspaceVcsRepoOutputReference

Initializers

from cdktf_cdktf_provider_tfe import data_tfe_workspace

dataTfeWorkspace.DataTfeWorkspaceVcsRepoOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  complex_object_index: typing.Union[int, float],
  complex_object_is_from_set: bool
)

Name	Type	Description
`terraform_resource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraform_attribute`	`str`	The attribute on the parent resource this class is referencing.
`complex_object_index`	`typing.Union[int, float]`	the index of this item in the list.
`complex_object_is_from_set`	`bool`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`terraform_resource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraform_attribute`^Required

Type: str

The attribute on the parent resource this class is referencing.

`complex_object_index`^Required

Type: typing.Union[int, float]

the index of this item in the list.

`complex_object_is_from_set`^Required

Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name	Description
`compute_fqn`	No description.
`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.
`resolve`	Produce the Token's value at resolution time.
`to_string`	Return a string representation of this resolvable object.

`compute_fqn`

def compute_fqn() -> str

`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(
  property: str
) -> IResolvable

`property`^Required

Type: str

`resolve`

def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`to_string`

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name	Type	Description
`creation_stack`	`typing.List[str]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`str`	No description.
`branch`	`str`	No description.
`github_app_installation_id`	`str`	No description.
`identifier`	`str`	No description.
`ingress_submodules`	`cdktf.IResolvable`	No description.
`oauth_token_id`	`str`	No description.
`tags_regex`	`str`	No description.
`internal_value`	`DataTfeWorkspaceVcsRepo`	No description.

`creation_stack`^Required

creation_stack: typing.List[str]

Type: typing.List[str]

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.

`fqn`^Required

fqn: str

Type: str

`branch`^Required

branch: str

Type: str

`github_app_installation_id`^Required

github_app_installation_id: str

Type: str

`identifier`^Required

identifier: str

Type: str

`ingress_submodules`^Required

ingress_submodules: IResolvable

Type: cdktf.IResolvable

`oauth_token_id`^Required

oauth_token_id: str

Type: str

`tags_regex`^Required

tags_regex: str

Type: str

`internal_value`^Optional

internal_value: DataTfeWorkspaceVcsRepo

Type: DataTfeWorkspaceVcsRepo

Uh oh!

FilesExpand file tree

dataTfeWorkspace.python.md

Latest commit

History

dataTfeWorkspace.python.md

File metadata and controls

dataTfeWorkspace Submodule

Constructs