genvid.toolbox.TerraformProvider

警告

これは API のベータ版で、今後のリリースで変更される可能性があります。

class genvid.toolbox.TerraformProvider(name: str, alias: typing.Union[str, NoneType] = None, version: typing.Union[str, NoneType] = None, **arguments)

ベースクラス: object

Terraform のプロバイダ設定を表すクラス。

この class の主な目的は、プロバイダの基本的な検証を行い、 JSON との間で簡単に変換できるようにすることです。

この class では、構築上の明らかなエラーを処理します。ただし、使用上のエラーの多くは Terraform が処理を行います。例えば、特定の引数が特定のプロバイダに対して有効かどうかはわかりません。しかし、』version』 は正規の引数として渡せないことがわかっています…

パラメータ:
  • name – プロバイダの名前、すべてのプロバイダに必要です。
  • alias – 同じ名前のプロバイダを区別するためのエイリアス。
  • version – 希望するバージョンの文字列の制約。このパラメータは非推奨であり、今後のバージョンでは削除される予定です。
  • arguments – プロバイダに渡す任意の数の引数。
UNKNOWN_KEYS_ERROR = 'Unknown keys in data definition: {}'
into_generic(*args, pretty=False) → typing.Mapping
戻り値:TerraformProvider の一般的な表現です。
static from_generic(data: typing.Mapping) → genvid.toolbox.terraform_provider.TerraformProvider

一般的な表現から TerraformProvider を構築します。例えば、ある種のマッピング (dict など)。

バックエンドが認識できるフォーマットの JSON にシリアライズするために、一般的な表現を選択しました。

パラメータ:data – プロバイダの表現を尊重するすべてのマッピング。
戻り値:表現が有効である場合の Terraform プロバイダ。
static into_generic_list(providers: typing.Iterable[ForwardRef('TerraformProvider')]) → typing.Sequence[typing.Mapping]

反復子を一般的な表現のシーケンスに変換します。

パラメータ:providers – プロバイダの反復。
戻り値:結果として得られるマッピングのシーケンス。
static from_generic_list(providers: typing.Iterable[typing.Mapping]) → typing.Sequence[ForwardRef('TerraformProvider')]

プロバイダを表すマッピングの反復可能なプロバイダのシーケンスを返します。

パラメータ:providers – マッピングの反復。
戻り値:結果として得られるプロバイダのシーケンス。
class terraformProvider.TerraformProvider

genvid.toolbox.TerraformProvider の実装