Skip to content

Latest commit

 

History

History
2323 lines (1482 loc) · 97.6 KB

team.python.md

File metadata and controls

2323 lines (1482 loc) · 97.6 KB

team Submodule

Constructs

Team

Represents a {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team tfe_team}.

Initializers

from cdktf_cdktf_provider_tfe import team

team.Team(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  name: str,
  allow_member_token_management: typing.Union[bool, IResolvable] = None,
  id: str = None,
  organization: str = None,
  organization_access: TeamOrganizationAccess = None,
  sso_team_id: str = None,
  visibility: str = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
name str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#name Team#name}.
allow_member_token_management typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#allow_member_token_management Team#allow_member_token_management}.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#id Team#id}.
organization str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#organization Team#organization}.
organization_access TeamOrganizationAccess organization_access block.
sso_team_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#sso_team_id Team#sso_team_id}.
visibility str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#visibility Team#visibility}.

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope


connectionOptional
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

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

depends_onOptional
  • Type: typing.List[cdktf.ITerraformDependable]

for_eachOptional
  • Type: cdktf.ITerraformIterator

lifecycleOptional
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
  • Type: cdktf.TerraformProvider

provisionersOptional
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

nameRequired
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#name Team#name}.


allow_member_token_managementOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#allow_member_token_management Team#allow_member_token_management}.


idOptional
  • Type: str

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


organizationOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#organization Team#organization}.


organization_accessOptional

organization_access block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#organization_access Team#organization_access}


sso_team_idOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#sso_team_id Team#sso_team_id}.


visibilityOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#visibility Team#visibility}.


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_organization_access No description.
reset_allow_member_token_management No description.
reset_id No description.
reset_organization No description.
reset_organization_access No description.
reset_sso_team_id No description.
reset_visibility No description.

to_string
def to_string() -> str

Returns a string representation of this construct.

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

valueRequired
  • Type: typing.Any

override_logical_id
def override_logical_id(
  new_logical_id: str
) -> None

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

new_logical_idRequired
  • Type: str

The new logical ID to use for this stack element.


reset_override_logical_id
def reset_override_logical_id() -> None

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

to_hcl_terraform
def to_hcl_terraform() -> typing.Any
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_targetRequired
  • 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_attributeRequired
  • Type: str

get_boolean_attribute
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str

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

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

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

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

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

get_string_attribute
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str

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

has_resource_move
def has_resource_move() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]
import_from
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str

providerOptional
  • Type: cdktf.TerraformProvider

interpolation_for_attribute
def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • 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.

idRequired
  • Type: str

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


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

Moves this resource to the target resource given by moveTarget.

move_targetRequired
  • Type: str

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


indexOptional
  • Type: typing.Union[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".

idRequired
  • Type: str

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


put_organization_access
def put_organization_access(
  access_secret_teams: typing.Union[bool, IResolvable] = None,
  manage_agent_pools: typing.Union[bool, IResolvable] = None,
  manage_membership: typing.Union[bool, IResolvable] = None,
  manage_modules: typing.Union[bool, IResolvable] = None,
  manage_organization_access: typing.Union[bool, IResolvable] = None,
  manage_policies: typing.Union[bool, IResolvable] = None,
  manage_policy_overrides: typing.Union[bool, IResolvable] = None,
  manage_projects: typing.Union[bool, IResolvable] = None,
  manage_providers: typing.Union[bool, IResolvable] = None,
  manage_run_tasks: typing.Union[bool, IResolvable] = None,
  manage_teams: typing.Union[bool, IResolvable] = None,
  manage_vcs_settings: typing.Union[bool, IResolvable] = None,
  manage_workspaces: typing.Union[bool, IResolvable] = None,
  read_projects: typing.Union[bool, IResolvable] = None,
  read_workspaces: typing.Union[bool, IResolvable] = None
) -> None
access_secret_teamsOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#access_secret_teams Team#access_secret_teams}.


manage_agent_poolsOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#manage_agent_pools Team#manage_agent_pools}.


manage_membershipOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#manage_membership Team#manage_membership}.


manage_modulesOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#manage_modules Team#manage_modules}.


manage_organization_accessOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#manage_organization_access Team#manage_organization_access}.


manage_policiesOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#manage_policies Team#manage_policies}.


manage_policy_overridesOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#manage_policy_overrides Team#manage_policy_overrides}.


manage_projectsOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#manage_projects Team#manage_projects}.


manage_providersOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#manage_providers Team#manage_providers}.


manage_run_tasksOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#manage_run_tasks Team#manage_run_tasks}.


manage_teamsOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#manage_teams Team#manage_teams}.


manage_vcs_settingsOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#manage_vcs_settings Team#manage_vcs_settings}.


manage_workspacesOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#manage_workspaces Team#manage_workspaces}.


read_projectsOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#read_projects Team#read_projects}.


read_workspacesOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#read_workspaces Team#read_workspaces}.


reset_allow_member_token_management
def reset_allow_member_token_management() -> None
reset_id
def reset_id() -> None
reset_organization
def reset_organization() -> None
reset_organization_access
def reset_organization_access() -> None
reset_sso_team_id
def reset_sso_team_id() -> None
reset_visibility
def reset_visibility() -> 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 Team resource upon running "cdktf plan ".

is_construct
from cdktf_cdktf_provider_tfe import team

team.Team.is_construct(
  x: typing.Any
)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: typing.Any

Any object.


is_terraform_element
from cdktf_cdktf_provider_tfe import team

team.Team.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any

is_terraform_resource
from cdktf_cdktf_provider_tfe import team

team.Team.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any

generate_config_for_import
from cdktf_cdktf_provider_tfe import team

team.Team.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


import_to_idRequired
  • Type: str

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


import_from_idRequired
  • Type: str

The id of the existing Team that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#import import section} in the documentation of this resource for the id to use


providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the Team 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 typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[str] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
organization_access TeamOrganizationAccessOutputReference No description.
allow_member_token_management_input typing.Union[bool, cdktf.IResolvable] No description.
id_input str No description.
name_input str No description.
organization_access_input TeamOrganizationAccess No description.
organization_input str No description.
sso_team_id_input str No description.
visibility_input str No description.
allow_member_token_management typing.Union[bool, cdktf.IResolvable] No description.
id str No description.
name str No description.
organization str No description.
sso_team_id str No description.
visibility str No description.

nodeRequired
node: Node
  • Type: constructs.Node

The tree node.


cdktf_stackRequired
cdktf_stack: TerraformStack
  • Type: cdktf.TerraformStack

fqnRequired
fqn: str
  • Type: str

friendly_unique_idRequired
friendly_unique_id: str
  • Type: str

terraform_meta_argumentsRequired
terraform_meta_arguments: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]

terraform_resource_typeRequired
terraform_resource_type: str
  • Type: str

terraform_generator_metadataOptional
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktf.TerraformProviderGeneratorMetadata

connectionOptional
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

countOptional
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

depends_onOptional
depends_on: typing.List[str]
  • Type: typing.List[str]

for_eachOptional
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator

lifecycleOptional
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
provider: TerraformProvider
  • Type: cdktf.TerraformProvider

provisionersOptional
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

organization_accessRequired
organization_access: TeamOrganizationAccessOutputReference

allow_member_token_management_inputOptional
allow_member_token_management_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

id_inputOptional
id_input: str
  • Type: str

name_inputOptional
name_input: str
  • Type: str

organization_access_inputOptional
organization_access_input: TeamOrganizationAccess

organization_inputOptional
organization_input: str
  • Type: str

sso_team_id_inputOptional
sso_team_id_input: str
  • Type: str

visibility_inputOptional
visibility_input: str
  • Type: str

allow_member_token_managementRequired
allow_member_token_management: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

idRequired
id: str
  • Type: str

nameRequired
name: str
  • Type: str

organizationRequired
organization: str
  • Type: str

sso_team_idRequired
sso_team_id: str
  • Type: str

visibilityRequired
visibility: str
  • Type: str

Constants

Name Type Description
tfResourceType str No description.

tfResourceTypeRequired
tfResourceType: str
  • Type: str

Structs

TeamConfig

Initializer

from cdktf_cdktf_provider_tfe import team

team.TeamConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  name: str,
  allow_member_token_management: typing.Union[bool, IResolvable] = None,
  id: str = None,
  organization: str = None,
  organization_access: TeamOrganizationAccess = None,
  sso_team_id: str = None,
  visibility: str = None
)

Properties

Name Type Description
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
name str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#name Team#name}.
allow_member_token_management typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#allow_member_token_management Team#allow_member_token_management}.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#id Team#id}.
organization str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#organization Team#organization}.
organization_access TeamOrganizationAccess organization_access block.
sso_team_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#sso_team_id Team#sso_team_id}.
visibility str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#visibility Team#visibility}.

connectionOptional
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

countOptional
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

depends_onOptional
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktf.ITerraformDependable]

for_eachOptional
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator

lifecycleOptional
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
provider: TerraformProvider
  • Type: cdktf.TerraformProvider

provisionersOptional
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

nameRequired
name: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#name Team#name}.


allow_member_token_managementOptional
allow_member_token_management: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#allow_member_token_management Team#allow_member_token_management}.


idOptional
id: str
  • Type: str

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


organizationOptional
organization: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#organization Team#organization}.


organization_accessOptional
organization_access: TeamOrganizationAccess

organization_access block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#organization_access Team#organization_access}


sso_team_idOptional
sso_team_id: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#sso_team_id Team#sso_team_id}.


visibilityOptional
visibility: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#visibility Team#visibility}.


TeamOrganizationAccess

Initializer

from cdktf_cdktf_provider_tfe import team

team.TeamOrganizationAccess(
  access_secret_teams: typing.Union[bool, IResolvable] = None,
  manage_agent_pools: typing.Union[bool, IResolvable] = None,
  manage_membership: typing.Union[bool, IResolvable] = None,
  manage_modules: typing.Union[bool, IResolvable] = None,
  manage_organization_access: typing.Union[bool, IResolvable] = None,
  manage_policies: typing.Union[bool, IResolvable] = None,
  manage_policy_overrides: typing.Union[bool, IResolvable] = None,
  manage_projects: typing.Union[bool, IResolvable] = None,
  manage_providers: typing.Union[bool, IResolvable] = None,
  manage_run_tasks: typing.Union[bool, IResolvable] = None,
  manage_teams: typing.Union[bool, IResolvable] = None,
  manage_vcs_settings: typing.Union[bool, IResolvable] = None,
  manage_workspaces: typing.Union[bool, IResolvable] = None,
  read_projects: typing.Union[bool, IResolvable] = None,
  read_workspaces: typing.Union[bool, IResolvable] = None
)

Properties

Name Type Description
access_secret_teams typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#access_secret_teams Team#access_secret_teams}.
manage_agent_pools typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#manage_agent_pools Team#manage_agent_pools}.
manage_membership typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#manage_membership Team#manage_membership}.
manage_modules typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#manage_modules Team#manage_modules}.
manage_organization_access typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#manage_organization_access Team#manage_organization_access}.
manage_policies typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#manage_policies Team#manage_policies}.
manage_policy_overrides typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#manage_policy_overrides Team#manage_policy_overrides}.
manage_projects typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#manage_projects Team#manage_projects}.
manage_providers typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#manage_providers Team#manage_providers}.
manage_run_tasks typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#manage_run_tasks Team#manage_run_tasks}.
manage_teams typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#manage_teams Team#manage_teams}.
manage_vcs_settings typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#manage_vcs_settings Team#manage_vcs_settings}.
manage_workspaces typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#manage_workspaces Team#manage_workspaces}.
read_projects typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#read_projects Team#read_projects}.
read_workspaces typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#read_workspaces Team#read_workspaces}.

access_secret_teamsOptional
access_secret_teams: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#access_secret_teams Team#access_secret_teams}.


manage_agent_poolsOptional
manage_agent_pools: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#manage_agent_pools Team#manage_agent_pools}.


manage_membershipOptional
manage_membership: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#manage_membership Team#manage_membership}.


manage_modulesOptional
manage_modules: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#manage_modules Team#manage_modules}.


manage_organization_accessOptional
manage_organization_access: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#manage_organization_access Team#manage_organization_access}.


manage_policiesOptional
manage_policies: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#manage_policies Team#manage_policies}.


manage_policy_overridesOptional
manage_policy_overrides: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#manage_policy_overrides Team#manage_policy_overrides}.


manage_projectsOptional
manage_projects: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#manage_projects Team#manage_projects}.


manage_providersOptional
manage_providers: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#manage_providers Team#manage_providers}.


manage_run_tasksOptional
manage_run_tasks: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#manage_run_tasks Team#manage_run_tasks}.


manage_teamsOptional
manage_teams: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#manage_teams Team#manage_teams}.


manage_vcs_settingsOptional
manage_vcs_settings: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#manage_vcs_settings Team#manage_vcs_settings}.


manage_workspacesOptional
manage_workspaces: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#manage_workspaces Team#manage_workspaces}.


read_projectsOptional
read_projects: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#read_projects Team#read_projects}.


read_workspacesOptional
read_workspaces: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team#read_workspaces Team#read_workspaces}.


Classes

TeamOrganizationAccessOutputReference

Initializers

from cdktf_cdktf_provider_tfe import team

team.TeamOrganizationAccessOutputReference(
  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_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraform_attributeRequired
  • 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_access_secret_teams No description.
reset_manage_agent_pools No description.
reset_manage_membership No description.
reset_manage_modules No description.
reset_manage_organization_access No description.
reset_manage_policies No description.
reset_manage_policy_overrides No description.
reset_manage_projects No description.
reset_manage_providers No description.
reset_manage_run_tasks No description.
reset_manage_teams No description.
reset_manage_vcs_settings No description.
reset_manage_workspaces No description.
reset_read_projects No description.
reset_read_workspaces 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_attributeRequired
  • Type: str

get_boolean_attribute
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str

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

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

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

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

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

get_string_attribute
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str

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

interpolation_for_attribute
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str

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

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

to_string
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_access_secret_teams
def reset_access_secret_teams() -> None
reset_manage_agent_pools
def reset_manage_agent_pools() -> None
reset_manage_membership
def reset_manage_membership() -> None
reset_manage_modules
def reset_manage_modules() -> None
reset_manage_organization_access
def reset_manage_organization_access() -> None
reset_manage_policies
def reset_manage_policies() -> None
reset_manage_policy_overrides
def reset_manage_policy_overrides() -> None
reset_manage_projects
def reset_manage_projects() -> None
reset_manage_providers
def reset_manage_providers() -> None
reset_manage_run_tasks
def reset_manage_run_tasks() -> None
reset_manage_teams
def reset_manage_teams() -> None
reset_manage_vcs_settings
def reset_manage_vcs_settings() -> None
reset_manage_workspaces
def reset_manage_workspaces() -> None
reset_read_projects
def reset_read_projects() -> None
reset_read_workspaces
def reset_read_workspaces() -> 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.
access_secret_teams_input typing.Union[bool, cdktf.IResolvable] No description.
manage_agent_pools_input typing.Union[bool, cdktf.IResolvable] No description.
manage_membership_input typing.Union[bool, cdktf.IResolvable] No description.
manage_modules_input typing.Union[bool, cdktf.IResolvable] No description.
manage_organization_access_input typing.Union[bool, cdktf.IResolvable] No description.
manage_policies_input typing.Union[bool, cdktf.IResolvable] No description.
manage_policy_overrides_input typing.Union[bool, cdktf.IResolvable] No description.
manage_projects_input typing.Union[bool, cdktf.IResolvable] No description.
manage_providers_input typing.Union[bool, cdktf.IResolvable] No description.
manage_run_tasks_input typing.Union[bool, cdktf.IResolvable] No description.
manage_teams_input typing.Union[bool, cdktf.IResolvable] No description.
manage_vcs_settings_input typing.Union[bool, cdktf.IResolvable] No description.
manage_workspaces_input typing.Union[bool, cdktf.IResolvable] No description.
read_projects_input typing.Union[bool, cdktf.IResolvable] No description.
read_workspaces_input typing.Union[bool, cdktf.IResolvable] No description.
access_secret_teams typing.Union[bool, cdktf.IResolvable] No description.
manage_agent_pools typing.Union[bool, cdktf.IResolvable] No description.
manage_membership typing.Union[bool, cdktf.IResolvable] No description.
manage_modules typing.Union[bool, cdktf.IResolvable] No description.
manage_organization_access typing.Union[bool, cdktf.IResolvable] No description.
manage_policies typing.Union[bool, cdktf.IResolvable] No description.
manage_policy_overrides typing.Union[bool, cdktf.IResolvable] No description.
manage_projects typing.Union[bool, cdktf.IResolvable] No description.
manage_providers typing.Union[bool, cdktf.IResolvable] No description.
manage_run_tasks typing.Union[bool, cdktf.IResolvable] No description.
manage_teams typing.Union[bool, cdktf.IResolvable] No description.
manage_vcs_settings typing.Union[bool, cdktf.IResolvable] No description.
manage_workspaces typing.Union[bool, cdktf.IResolvable] No description.
read_projects typing.Union[bool, cdktf.IResolvable] No description.
read_workspaces typing.Union[bool, cdktf.IResolvable] No description.
internal_value TeamOrganizationAccess No description.

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


fqnRequired
fqn: str
  • Type: str

access_secret_teams_inputOptional
access_secret_teams_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

manage_agent_pools_inputOptional
manage_agent_pools_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

manage_membership_inputOptional
manage_membership_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

manage_modules_inputOptional
manage_modules_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

manage_organization_access_inputOptional
manage_organization_access_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

manage_policies_inputOptional
manage_policies_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

manage_policy_overrides_inputOptional
manage_policy_overrides_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

manage_projects_inputOptional
manage_projects_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

manage_providers_inputOptional
manage_providers_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

manage_run_tasks_inputOptional
manage_run_tasks_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

manage_teams_inputOptional
manage_teams_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

manage_vcs_settings_inputOptional
manage_vcs_settings_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

manage_workspaces_inputOptional
manage_workspaces_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

read_projects_inputOptional
read_projects_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

read_workspaces_inputOptional
read_workspaces_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

access_secret_teamsRequired
access_secret_teams: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

manage_agent_poolsRequired
manage_agent_pools: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

manage_membershipRequired
manage_membership: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

manage_modulesRequired
manage_modules: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

manage_organization_accessRequired
manage_organization_access: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

manage_policiesRequired
manage_policies: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

manage_policy_overridesRequired
manage_policy_overrides: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

manage_projectsRequired
manage_projects: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

manage_providersRequired
manage_providers: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

manage_run_tasksRequired
manage_run_tasks: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

manage_teamsRequired
manage_teams: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

manage_vcs_settingsRequired
manage_vcs_settings: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

manage_workspacesRequired
manage_workspaces: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

read_projectsRequired
read_projects: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

read_workspacesRequired
read_workspaces: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

internal_valueOptional
internal_value: TeamOrganizationAccess