`policySet` Submodule

Constructs

PolicySet

Represents a {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set tfe_policy_set}.

Initializers

from cdktf_cdktf_provider_tfe import policy_set

policySet.PolicySet(
  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,
  agent_enabled: bool | IResolvable = None,
  description: str = None,
  global: bool | IResolvable = None,
  id: str = None,
  kind: str = None,
  organization: str = None,
  overridable: bool | IResolvable = None,
  policies_path: str = None,
  policy_ids: typing.List[str] = None,
  policy_tool_version: str = None,
  slug: typing.Mapping[str] = None,
  vcs_repo: PolicySetVcsRepo = 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/resources/policy_set#name PolicySet#name}.
`agent_enabled`	`bool \| cdktf.IResolvable`	Whether the policy set is executed in the HCP Terraform agent. True by default for OPA policies.
`description`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#description PolicySet#description}.
`global`	`bool \| cdktf.IResolvable`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#global PolicySet#global}.
`id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#id PolicySet#id}.
`kind`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#kind PolicySet#kind}.
`organization`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#organization PolicySet#organization}.
`overridable`	`bool \| cdktf.IResolvable`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#overridable PolicySet#overridable}.
`policies_path`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#policies_path PolicySet#policies_path}.
`policy_ids`	`typing.List[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#policy_ids PolicySet#policy_ids}.
`policy_tool_version`	`str`	The policy tool version to run the policy evaluation against.
`slug`	`typing.Mapping[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#slug PolicySet#slug}.
`vcs_repo`	`PolicySetVcsRepo`	vcs_repo block.
`workspace_ids`	`typing.List[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#workspace_ids PolicySet#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/resources/policy_set#name PolicySet#name}.

`agent_enabled`^Optional

Type: bool | cdktf.IResolvable

Whether the policy set is executed in the HCP Terraform agent. True by default for OPA policies.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#agent_enabled PolicySet#agent_enabled}

`description`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#description PolicySet#description}.

`global`^Optional

Type: bool | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#global PolicySet#global}.

`id`^Optional

Type: str

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

`kind`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#kind PolicySet#kind}.

`organization`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#organization PolicySet#organization}.

`overridable`^Optional

Type: bool | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#overridable PolicySet#overridable}.

`policies_path`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#policies_path PolicySet#policies_path}.

`policy_ids`^Optional

Type: typing.List[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#policy_ids PolicySet#policy_ids}.

`policy_tool_version`^Optional

Type: str

The policy tool version to run the policy evaluation against.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#policy_tool_version PolicySet#policy_tool_version}

`slug`^Optional

Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#slug PolicySet#slug}.

`vcs_repo`^Optional

Type: PolicySetVcsRepo

vcs_repo block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#vcs_repo PolicySet#vcs_repo}

`workspace_ids`^Optional

Type: typing.List[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#workspace_ids PolicySet#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`	No description.
`to_metadata`	No description.
`to_terraform`	Adds this resource to the terraform JSON output.
`add_move_target`	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
`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.
`has_resource_move`	No description.
`import_from`	No description.
`interpolation_for_attribute`	No description.
`move_from_id`	Move the resource corresponding to "id" to this resource.
`move_to`	Moves this resource to the target resource given by moveTarget.
`move_to_id`	Moves this resource to the resource corresponding to "id".
`put_vcs_repo`	No description.
`reset_agent_enabled`	No description.
`reset_description`	No description.
`reset_global`	No description.
`reset_id`	No description.
`reset_kind`	No description.
`reset_organization`	No description.
`reset_overridable`	No description.
`reset_policies_path`	No description.
`reset_policy_ids`	No description.
`reset_policy_tool_version`	No description.
`reset_slug`	No description.
`reset_vcs_repo`	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

`to_metadata`

def to_metadata() -> typing.Any

`to_terraform`

def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

`add_move_target`

def add_move_target(
  move_target: str
) -> None

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

`move_target`^Required

Type: str

The string move target that will correspond to this resource.

`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

`has_resource_move`

def has_resource_move() -> TerraformResourceMoveByTarget | TerraformResourceMoveById

`import_from`

def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None

`id`^Required

Type: str

`provider`^Optional

Type: cdktf.TerraformProvider

`interpolation_for_attribute`

def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`move_from_id`

def move_from_id(
  id: str
) -> None

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

`id`^Required

Type: str

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

`move_to`

def move_to(
  move_target: str,
  index: str | typing.Union[int, float] = None
) -> None

Moves this resource to the target resource given by moveTarget.

`move_target`^Required

Type: str

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

`index`^Optional

Type: str | typing.Union[int, float]

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

`move_to_id`

def move_to_id(
  id: str
) -> None

Moves this resource to the resource corresponding to "id".

`id`^Required

Type: str

Full id of resource to move to, e.g. "aws_s3_bucket.example".

`put_vcs_repo`

def put_vcs_repo(
  identifier: str,
  branch: str = None,
  github_app_installation_id: str = None,
  ingress_submodules: bool | IResolvable = None,
  oauth_token_id: str = None
) -> None

`identifier`^Required

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#identifier PolicySet#identifier}.

`branch`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#branch PolicySet#branch}.

`github_app_installation_id`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#github_app_installation_id PolicySet#github_app_installation_id}.

`ingress_submodules`^Optional

Type: bool | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#ingress_submodules PolicySet#ingress_submodules}.

`oauth_token_id`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#oauth_token_id PolicySet#oauth_token_id}.

`reset_agent_enabled`

def reset_agent_enabled() -> None

`reset_description`

def reset_description() -> None

`reset_global`

def reset_global() -> None

`reset_id`

def reset_id() -> None

`reset_kind`

def reset_kind() -> None

`reset_organization`

def reset_organization() -> None

`reset_overridable`

def reset_overridable() -> None

`reset_policies_path`

def reset_policies_path() -> None

`reset_policy_ids`

def reset_policy_ids() -> None

`reset_policy_tool_version`

def reset_policy_tool_version() -> None

`reset_slug`

def reset_slug() -> None

`reset_vcs_repo`

def reset_vcs_repo() -> 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_resource`	No description.
`generate_config_for_import`	Generates CDKTF code for importing a PolicySet resource upon running "cdktf plan ".

`is_construct`

from cdktf_cdktf_provider_tfe import policy_set

policySet.PolicySet.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 policy_set

policySet.PolicySet.is_terraform_element(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`is_terraform_resource`

from cdktf_cdktf_provider_tfe import policy_set

policySet.PolicySet.is_terraform_resource(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`generate_config_for_import`

from cdktf_cdktf_provider_tfe import policy_set

policySet.PolicySet.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

`import_from_id`^Required

Type: str

The id of the existing PolicySet that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_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 PolicySet 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.
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	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.
`provisioners`	`typing.List[cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner]`	No description.
`vcs_repo`	`PolicySetVcsRepoOutputReference`	No description.
`agent_enabled_input`	`bool \| cdktf.IResolvable`	No description.
`description_input`	`str`	No description.
`global_input`	`bool \| cdktf.IResolvable`	No description.
`id_input`	`str`	No description.
`kind_input`	`str`	No description.
`name_input`	`str`	No description.
`organization_input`	`str`	No description.
`overridable_input`	`bool \| cdktf.IResolvable`	No description.
`policies_path_input`	`str`	No description.
`policy_ids_input`	`typing.List[str]`	No description.
`policy_tool_version_input`	`str`	No description.
`slug_input`	`typing.Mapping[str]`	No description.
`vcs_repo_input`	`PolicySetVcsRepo`	No description.
`workspace_ids_input`	`typing.List[str]`	No description.
`agent_enabled`	`bool \| cdktf.IResolvable`	No description.
`description`	`str`	No description.
`global`	`bool \| cdktf.IResolvable`	No description.
`id`	`str`	No description.
`kind`	`str`	No description.
`name`	`str`	No description.
`organization`	`str`	No description.
`overridable`	`bool \| cdktf.IResolvable`	No description.
`policies_path`	`str`	No description.
`policy_ids`	`typing.List[str]`	No description.
`policy_tool_version`	`str`	No description.
`slug`	`typing.Mapping[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

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

`provisioners`^Optional

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

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

`vcs_repo`^Required

vcs_repo: PolicySetVcsRepoOutputReference

Type: PolicySetVcsRepoOutputReference

`agent_enabled_input`^Optional

agent_enabled_input: bool | IResolvable

Type: bool | cdktf.IResolvable

`description_input`^Optional

description_input: str

Type: str

`global_input`^Optional

global_input: bool | IResolvable

Type: bool | cdktf.IResolvable

`id_input`^Optional

id_input: str

Type: str

`kind_input`^Optional

kind_input: str

Type: str

`name_input`^Optional

name_input: str

Type: str

`organization_input`^Optional

organization_input: str

Type: str

`overridable_input`^Optional

overridable_input: bool | IResolvable

Type: bool | cdktf.IResolvable

`policies_path_input`^Optional

policies_path_input: str

Type: str

`policy_ids_input`^Optional

policy_ids_input: typing.List[str]

Type: typing.List[str]

`policy_tool_version_input`^Optional

policy_tool_version_input: str

Type: str

`slug_input`^Optional

slug_input: typing.Mapping[str]

Type: typing.Mapping[str]

`vcs_repo_input`^Optional

vcs_repo_input: PolicySetVcsRepo

Type: PolicySetVcsRepo

`workspace_ids_input`^Optional

workspace_ids_input: typing.List[str]

Type: typing.List[str]

`agent_enabled`^Required

agent_enabled: bool | IResolvable

Type: bool | cdktf.IResolvable

`description`^Required

description: str

Type: str

`global`^Required

global: bool | IResolvable

Type: bool | cdktf.IResolvable

`id`^Required

id: str

Type: str

`kind`^Required

kind: str

Type: str

`name`^Required

name: str

Type: str

`organization`^Required

organization: str

Type: str

`overridable`^Required

overridable: bool | IResolvable

Type: bool | cdktf.IResolvable

`policies_path`^Required

policies_path: str

Type: str

`policy_ids`^Required

policy_ids: typing.List[str]

Type: typing.List[str]

`policy_tool_version`^Required

policy_tool_version: str

Type: str

`slug`^Required

slug: typing.Mapping[str]

Type: typing.Mapping[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

PolicySetConfig

Initializer

from cdktf_cdktf_provider_tfe import policy_set

policySet.PolicySetConfig(
  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,
  agent_enabled: bool | IResolvable = None,
  description: str = None,
  global: bool | IResolvable = None,
  id: str = None,
  kind: str = None,
  organization: str = None,
  overridable: bool | IResolvable = None,
  policies_path: str = None,
  policy_ids: typing.List[str] = None,
  policy_tool_version: str = None,
  slug: typing.Mapping[str] = None,
  vcs_repo: PolicySetVcsRepo = 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/resources/policy_set#name PolicySet#name}.
`agent_enabled`	`bool \| cdktf.IResolvable`	Whether the policy set is executed in the HCP Terraform agent. True by default for OPA policies.
`description`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#description PolicySet#description}.
`global`	`bool \| cdktf.IResolvable`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#global PolicySet#global}.
`id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#id PolicySet#id}.
`kind`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#kind PolicySet#kind}.
`organization`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#organization PolicySet#organization}.
`overridable`	`bool \| cdktf.IResolvable`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#overridable PolicySet#overridable}.
`policies_path`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#policies_path PolicySet#policies_path}.
`policy_ids`	`typing.List[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#policy_ids PolicySet#policy_ids}.
`policy_tool_version`	`str`	The policy tool version to run the policy evaluation against.
`slug`	`typing.Mapping[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#slug PolicySet#slug}.
`vcs_repo`	`PolicySetVcsRepo`	vcs_repo block.
`workspace_ids`	`typing.List[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#workspace_ids PolicySet#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/resources/policy_set#name PolicySet#name}.

`agent_enabled`^Optional

agent_enabled: bool | IResolvable

Type: bool | cdktf.IResolvable

Whether the policy set is executed in the HCP Terraform agent. True by default for OPA policies.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#agent_enabled PolicySet#agent_enabled}

`description`^Optional

description: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#description PolicySet#description}.

`global`^Optional

global: bool | IResolvable

Type: bool | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#global PolicySet#global}.

`id`^Optional

id: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#id PolicySet#id}.

`kind`^Optional

kind: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#kind PolicySet#kind}.

`organization`^Optional

organization: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#organization PolicySet#organization}.

`overridable`^Optional

overridable: bool | IResolvable

Type: bool | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#overridable PolicySet#overridable}.

`policies_path`^Optional

policies_path: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#policies_path PolicySet#policies_path}.

`policy_ids`^Optional

policy_ids: typing.List[str]

Type: typing.List[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#policy_ids PolicySet#policy_ids}.

`policy_tool_version`^Optional

policy_tool_version: str

Type: str

The policy tool version to run the policy evaluation against.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#policy_tool_version PolicySet#policy_tool_version}

`slug`^Optional

slug: typing.Mapping[str]

Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#slug PolicySet#slug}.

`vcs_repo`^Optional

vcs_repo: PolicySetVcsRepo

Type: PolicySetVcsRepo

vcs_repo block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#vcs_repo PolicySet#vcs_repo}

`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/resources/policy_set#workspace_ids PolicySet#workspace_ids}.

PolicySetVcsRepo

Initializer

from cdktf_cdktf_provider_tfe import policy_set

policySet.PolicySetVcsRepo(
  identifier: str,
  branch: str = None,
  github_app_installation_id: str = None,
  ingress_submodules: bool | IResolvable = None,
  oauth_token_id: str = None
)

Properties

Name	Type	Description
`identifier`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#identifier PolicySet#identifier}.
`branch`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#branch PolicySet#branch}.
`github_app_installation_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#github_app_installation_id PolicySet#github_app_installation_id}.
`ingress_submodules`	`bool \| cdktf.IResolvable`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#ingress_submodules PolicySet#ingress_submodules}.
`oauth_token_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#oauth_token_id PolicySet#oauth_token_id}.

`identifier`^Required

identifier: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#identifier PolicySet#identifier}.

`branch`^Optional

branch: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#branch PolicySet#branch}.

`github_app_installation_id`^Optional

github_app_installation_id: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#github_app_installation_id PolicySet#github_app_installation_id}.

`ingress_submodules`^Optional

ingress_submodules: bool | IResolvable

Type: bool | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#ingress_submodules PolicySet#ingress_submodules}.

`oauth_token_id`^Optional

oauth_token_id: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/policy_set#oauth_token_id PolicySet#oauth_token_id}.

Classes

PolicySetVcsRepoOutputReference

Initializers

from cdktf_cdktf_provider_tfe import policy_set

policySet.PolicySetVcsRepoOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)

Name	Type	Description
`terraform_resource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraform_attribute`	`str`	The attribute on the parent resource this class is referencing.

`terraform_resource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraform_attribute`^Required

Type: str

The attribute on the parent resource this class is referencing.

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.
`reset_branch`	No description.
`reset_github_app_installation_id`	No description.
`reset_ingress_submodules`	No description.
`reset_oauth_token_id`	No description.

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

`reset_branch`

def reset_branch() -> None

`reset_github_app_installation_id`

def reset_github_app_installation_id() -> None

`reset_ingress_submodules`

def reset_ingress_submodules() -> None

`reset_oauth_token_id`

def reset_oauth_token_id() -> None

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_input`	`str`	No description.
`github_app_installation_id_input`	`str`	No description.
`identifier_input`	`str`	No description.
`ingress_submodules_input`	`bool \| cdktf.IResolvable`	No description.
`oauth_token_id_input`	`str`	No description.
`branch`	`str`	No description.
`github_app_installation_id`	`str`	No description.
`identifier`	`str`	No description.
`ingress_submodules`	`bool \| cdktf.IResolvable`	No description.
`oauth_token_id`	`str`	No description.
`internal_value`	`PolicySetVcsRepo`	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_input`^Optional

branch_input: str

Type: str

`github_app_installation_id_input`^Optional

github_app_installation_id_input: str

Type: str

`identifier_input`^Optional

identifier_input: str

Type: str

`ingress_submodules_input`^Optional

ingress_submodules_input: bool | IResolvable

Type: bool | cdktf.IResolvable

`oauth_token_id_input`^Optional

oauth_token_id_input: 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: bool | IResolvable

Type: bool | cdktf.IResolvable

`oauth_token_id`^Required

oauth_token_id: str

Type: str

`internal_value`^Optional

internal_value: PolicySetVcsRepo

Type: PolicySetVcsRepo

Uh oh!

FilesExpand file tree

policySet.python.md

Latest commit

History

policySet.python.md

File metadata and controls

policySet Submodule

Constructs

PolicySet

Initializers

scopeRequired

idRequired

connectionOptional

countOptional

depends_onOptional

for_eachOptional

lifecycleOptional

providerOptional

provisionersOptional

nameRequired

agent_enabledOptional

descriptionOptional

globalOptional

idOptional

kindOptional

organizationOptional

overridableOptional

policies_pathOptional

policy_idsOptional

policy_tool_versionOptional

slugOptional

vcs_repoOptional

workspace_idsOptional

Methods

to_string

add_override

pathRequired

valueRequired

override_logical_id

new_logical_idRequired

reset_override_logical_id

to_hcl_terraform

to_metadata

to_terraform

add_move_target

move_targetRequired

get_any_map_attribute

terraform_attributeRequired

get_boolean_attribute

terraform_attributeRequired

get_boolean_map_attribute

terraform_attributeRequired

get_list_attribute

terraform_attributeRequired

get_number_attribute

terraform_attributeRequired

get_number_list_attribute

terraform_attributeRequired

get_number_map_attribute

terraform_attributeRequired

get_string_attribute

terraform_attributeRequired

get_string_map_attribute

terraform_attributeRequired

has_resource_move

import_from

idRequired

providerOptional

interpolation_for_attribute

terraform_attributeRequired

move_from_id

idRequired

move_to

move_targetRequired

indexOptional

move_to_id

idRequired

put_vcs_repo

identifierRequired

`policySet` Submodule

`scope`^Required

`id`^Required

`connection`^Optional

`count`^Optional

`depends_on`^Optional

`for_each`^Optional

`lifecycle`^Optional

`provider`^Optional

`provisioners`^Optional

`name`^Required

`agent_enabled`^Optional

`description`^Optional

`global`^Optional

`id`^Optional

`kind`^Optional

`organization`^Optional

`overridable`^Optional

`policies_path`^Optional

`policy_ids`^Optional

`policy_tool_version`^Optional

`slug`^Optional

`vcs_repo`^Optional

`workspace_ids`^Optional

`to_string`

`add_override`

`path`^Required

`value`^Required

`override_logical_id`

`new_logical_id`^Required

`reset_override_logical_id`

`to_hcl_terraform`

`to_metadata`

`to_terraform`

`add_move_target`

`move_target`^Required

`get_any_map_attribute`

`terraform_attribute`^Required

`get_boolean_attribute`

`terraform_attribute`^Required

`get_boolean_map_attribute`

`terraform_attribute`^Required

`get_list_attribute`

`terraform_attribute`^Required

`get_number_attribute`

`terraform_attribute`^Required

`get_number_list_attribute`

`terraform_attribute`^Required

`get_number_map_attribute`

`terraform_attribute`^Required

`get_string_attribute`

`terraform_attribute`^Required

`get_string_map_attribute`

`terraform_attribute`^Required

`has_resource_move`

`import_from`

`id`^Required

`provider`^Optional

`interpolation_for_attribute`

`terraform_attribute`^Required

`move_from_id`

`id`^Required

`move_to`

`move_target`^Required

`index`^Optional

`move_to_id`

`id`^Required

`put_vcs_repo`

`identifier`^Required

`branch`^Optional

`github_app_installation_id`^Optional

`ingress_submodules`^Optional

`oauth_token_id`^Optional

`reset_agent_enabled`

`reset_description`

`reset_global`

`reset_id`

`reset_kind`

`reset_organization`

`reset_overridable`