config

type ConfigurationFile struct {
	// Tfmigrate is a top-level block.
	// It must contain only one block, and multiple blocks are not allowed.
	Tfmigrate TfmigrateBlock `hcl:"tfmigrate,block"`
}

type HistoryBlock struct {
	// Storage is a block for migration history data store.
	Storage StorageBlock `hcl:"storage,block"`
}

type MigrationBlock struct {
	// Type is a type for migration.
	// Valid values are `state` and `multi_state`.
	Type string `hcl:"type,label"`
	// Name is an arbitrary name for migration.
	Name string `hcl:"name,label"`
	// Remain is a body of migration block.
	// We first decode only a block header and then decode schema depending on
	// its type label.
	Remain hcl.Body `hcl:",remain"`
}

type MigrationFile struct {
	// Migration is a migration block.
	// It must contain only one block, and multiple blocks are not allowed,
	// because it's hard to re-run the file if partially failed.
	Migration MigrationBlock `hcl:"migration,block"`
}

type StorageBlock struct {
	// Type is a type for storage.
	// Valid values are as follows:
	// - mock
	// - local
	// - s3
	Type string `hcl:"type,label"`
	// Remain is a body of storage block.
	// We first decode only a block header and then decode schema depending on
	// its type label.
	Remain hcl.Body `hcl:",remain"`
}

type TfmigrateBlock struct {
	// MigrationDir is a path to directory where migration files are stored.
	// Default to `.` (current directory).
	MigrationDir string `hcl:"migration_dir,optional"`
	// IsBackendTerraformCloud is a boolean indicating whether a backend is
	// stored remotely in Terraform Cloud. Defaults to false.
	IsBackendTerraformCloud bool `hcl:"is_backend_terraform_cloud,optional"`
	// History is a block for migration history management.
	History *HistoryBlock `hcl:"history,block"`
}

type TfmigrateConfig struct {
	// MigrationDir is a path to directory where migration files are stored.
	// Default to `.` (current directory).
	MigrationDir string
	// IsBackendTerraformCloud is a boolean representing whether the remote
	// backend is TerraformCloud. Defaults to a value of false.
	IsBackendTerraformCloud bool
	// History is a config for migration history management.
	History *history.Config
}