config

• BackendType
• CiConfig
• DependencyRef
• HookConfig
• HookOnError
• LifecycleEvent
• LocalBackend
• ModuleConstraint
• ProviderConstraint
• S3Backend
• TagsInject
• TfDoConfig
• init_cmd
• show_cmd

Symbol Details

class: BackendType

• source

  Since: 0.6.0

class BackendType(StrEnum):
    ...

Changes

Version	Change
0.6.0	Made public

class: HookConfig

• source

  Since: 0.6.0

class HookConfig(BaseModel):
    name: str
    cmd: str | None = None
    py_locate: str | None = None
    lifecycle_events: list[LifecycleEvent]
    timeout_seconds: int = 30
    priority: int = 5000
    on_error: HookOnError | None = None

Field	Type	Default	Since
name	str	-	0.6.0
cmd	str | None	None	0.6.0
py_locate	str | None	None	0.6.0
lifecycle_events	list[LifecycleEvent]	-	0.6.0
timeout_seconds	int	30	0.6.0
priority	int	5000	0.6.0
on_error	HookOnError | None	None	0.6.0

Changes

Version	Change
0.6.0	Made public

class: HookOnError

• source

  Since: 0.6.0

class HookOnError(StrEnum):
    ...

Changes

Version	Change
0.6.0	Made public

class: LifecycleEvent

• source

  Since: 0.6.0

class LifecycleEvent(StrEnum):
    ...

Changes

Version	Change
0.6.0	Made public

class: LocalBackend

• source

  Since: 0.6.0

class LocalBackend(BaseModel):
    type: Literal[local] = <BackendType.LOCAL: 'local'>
    path: str

Field	Type	Default	Since
type	Literal[local]	<BackendType.LOCAL: 'local'>	0.6.0
path	str	-	0.6.0

Changes

Version	Change
0.6.0	Made public

class: TagsInject

• source

  Since: 0.6.0

class TagsInject(StrEnum):
    ...

Changes

Version	Change
0.6.0	Made public

cli_command: show_cmd

• source

  Since: 0.6.0

def show_cmd() -> None:
    ...

Print resolved tfdo.yaml config layers and merged result for current work directory.

Changes

Version	Change
0.6.0	Made public

cli_command: init_cmd

• source

  Since: 0.6.0

def init_cmd(*, dry_run: bool = False) -> None:
    ...

Detect run directories and generate a starter tfdo.yaml.

CLI Options:

Flag	Type	Default	Description
--dry-run	bool	False	Preview detected directories without writing tfdo.yaml

Changes

Version	Change
0.6.0	Made public

class: CiConfig

• source

  Since: 0.7.0

class CiConfig(BaseModel):
    oidc: bool = False
    repo_org: str | None = None
    repo_name: str | None = None
    oidc_roles: dict[str, str] = ...
    tfdo_install: str = 'git+https://github.com/EspenAlbert/tfdo.git@main'

Field	Type	Default	Since
oidc	bool	False	0.7.0
repo_org	str | None	None	0.7.0
repo_name	str | None	None	0.7.0
oidc_roles	dict[str, str]	...	0.7.0
tfdo_install	str	'git+https://github.com/EspenAlbert/tfdo.git@main'	0.7.0

Changes

Version	Change
0.7.0	Made public

class: ModuleConstraint

• source

  Since: 0.7.0

class ModuleConstraint(BaseModel):
    source: str
    constraint: str | None = None

Field	Type	Default	Since
source	str	-	0.7.0
constraint	str | None	None	0.7.0

Changes

Version	Change
0.7.0	Made public

class: ProviderConstraint

• source

  Since: 0.7.0

class ProviderConstraint(BaseModel):
    name: str
    source: str | None = None
    constraint: str | None = None

Field	Type	Default	Since
name	str	-	0.7.0
source	str | None	None	0.7.0
constraint	str | None	None	0.7.0

Changes

Version	Change
0.7.0	Made public