Skip to content
This repository was archived by the owner on Dec 10, 2025. It is now read-only.

provider.python.md

Latest commit

 

History

History
687 lines (432 loc) · 23.6 KB

provider.python.md

File metadata and controls

687 lines (432 loc) · 23.6 KB
Raw

provider Submodule

Constructs

TfeProvider

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

Initializers 

from cdktf_cdktf_provider_tfe import provider

provider.TfeProvider(
  scope: Construct,
  id: str,
  alias: str = None,
  hostname: str = None,
  organization: str = None,
  ssl_skip_verify: bool | IResolvable = None,
  token: str = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
alias str Alias name.
hostname str The Terraform Enterprise hostname to connect to. Defaults to app.terraform.io.
organization str The organization to apply to a resource if one is not defined on the resource itself.
ssl_skip_verify bool | cdktf.IResolvable Whether or not to skip certificate verifications.
token str The token used to authenticate with Terraform Enterprise.
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

aliasOptional
  • Type: str

Alias name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs#alias TfeProvider#alias}

hostnameOptional
  • Type: str

The Terraform Enterprise hostname to connect to. Defaults to app.terraform.io.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs#hostname TfeProvider#hostname}

organizationOptional
  • Type: str

The organization to apply to a resource if one is not defined on the resource itself.

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

ssl_skip_verifyOptional
  • Type: bool | cdktf.IResolvable

Whether or not to skip certificate verifications.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs#ssl_skip_verify TfeProvider#ssl_skip_verify}

tokenOptional
  • Type: str

The token used to authenticate with Terraform Enterprise.

We recommend omitting the token which can be set as credentials in the CLI config file.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs#token TfeProvider#token}

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.
reset_alias No description.
reset_hostname No description.
reset_organization No description.
reset_ssl_skip_verify No description.
reset_token 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.

reset_alias 
def reset_alias() -> None
reset_hostname 
def reset_hostname() -> None
reset_organization 
def reset_organization() -> None
reset_ssl_skip_verify 
def reset_ssl_skip_verify() -> None
reset_token 
def reset_token() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_provider No description.
generate_config_for_import Generates CDKTF code for importing a TfeProvider resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_tfe import provider

provider.TfeProvider.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 provider

provider.TfeProvider.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_provider 
from cdktf_cdktf_provider_tfe import provider

provider.TfeProvider.is_terraform_provider(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_tfe import provider

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

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

import_from_idRequired
  • Type: str

The id of the existing TfeProvider that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs#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 TfeProvider 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.
meta_attributes typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktf.TerraformProviderGeneratorMetadata No description.
terraform_provider_source str No description.
alias str No description.
alias_input str No description.
hostname_input str No description.
organization_input str No description.
ssl_skip_verify_input bool | cdktf.IResolvable No description.
token_input str No description.
hostname str No description.
organization str No description.
ssl_skip_verify bool | cdktf.IResolvable No description.
token 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
meta_attributesRequired 
meta_attributes: 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
terraform_provider_sourceOptional 
terraform_provider_source: str
  • Type: str
aliasOptional 
alias: str
  • Type: str
alias_inputOptional 
alias_input: str
  • Type: str
hostname_inputOptional 
hostname_input: str
  • Type: str
organization_inputOptional 
organization_input: str
  • Type: str
ssl_skip_verify_inputOptional 
ssl_skip_verify_input: bool | IResolvable
  • Type: bool | cdktf.IResolvable
token_inputOptional 
token_input: str
  • Type: str
hostnameOptional 
hostname: str
  • Type: str
organizationOptional 
organization: str
  • Type: str
ssl_skip_verifyOptional 
ssl_skip_verify: bool | IResolvable
  • Type: bool | cdktf.IResolvable
tokenOptional 
token: str
  • Type: str

Constants

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

Structs

TfeProviderConfig

Initializer 

from cdktf_cdktf_provider_tfe import provider

provider.TfeProviderConfig(
  alias: str = None,
  hostname: str = None,
  organization: str = None,
  ssl_skip_verify: bool | IResolvable = None,
  token: str = None
)

Properties

Name Type Description
alias str Alias name.
hostname str The Terraform Enterprise hostname to connect to. Defaults to app.terraform.io.
organization str The organization to apply to a resource if one is not defined on the resource itself.
ssl_skip_verify bool | cdktf.IResolvable Whether or not to skip certificate verifications.
token str The token used to authenticate with Terraform Enterprise.
aliasOptional 
alias: str
  • Type: str

Alias name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs#alias TfeProvider#alias}

hostnameOptional 
hostname: str
  • Type: str

The Terraform Enterprise hostname to connect to. Defaults to app.terraform.io.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs#hostname TfeProvider#hostname}

organizationOptional 
organization: str
  • Type: str

The organization to apply to a resource if one is not defined on the resource itself.

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

ssl_skip_verifyOptional 
ssl_skip_verify: bool | IResolvable
  • Type: bool | cdktf.IResolvable

Whether or not to skip certificate verifications.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs#ssl_skip_verify TfeProvider#ssl_skip_verify}

tokenOptional 
token: str
  • Type: str

The token used to authenticate with Terraform Enterprise.

We recommend omitting the token which can be set as credentials in the CLI config file.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs#token TfeProvider#token}