builtin/provider/terraform: Add field descriptions
This commit is contained in:
parent
61c4e49b11
commit
bc87be384b
|
@ -18,24 +18,42 @@ func dataSourceRemoteStateGetSchema() providers.Schema {
|
||||||
Block: &configschema.Block{
|
Block: &configschema.Block{
|
||||||
Attributes: map[string]*configschema.Attribute{
|
Attributes: map[string]*configschema.Attribute{
|
||||||
"backend": {
|
"backend": {
|
||||||
Type: cty.String,
|
Type: cty.String,
|
||||||
Required: true,
|
Description: "The remote backend to use, e.g. `remote` or `http`.",
|
||||||
|
DescriptionKind: configschema.StringMarkdown,
|
||||||
|
Required: true,
|
||||||
},
|
},
|
||||||
"config": {
|
"config": {
|
||||||
Type: cty.DynamicPseudoType,
|
Type: cty.DynamicPseudoType,
|
||||||
Optional: true,
|
Description: "The configuration of the remote backend. " +
|
||||||
|
"Although this is optional, most backends require " +
|
||||||
|
"some configuration.\n\n" +
|
||||||
|
"The object can use any arguments that would be valid " +
|
||||||
|
"in the equivalent `terraform { backend \"<TYPE>\" { ... } }` " +
|
||||||
|
"block.",
|
||||||
|
DescriptionKind: configschema.StringMarkdown,
|
||||||
|
Optional: true,
|
||||||
},
|
},
|
||||||
"defaults": {
|
"defaults": {
|
||||||
Type: cty.DynamicPseudoType,
|
Type: cty.DynamicPseudoType,
|
||||||
Optional: true,
|
Description: "Default values for outputs, in case " +
|
||||||
|
"the state file is empty or lacks a required output.",
|
||||||
|
DescriptionKind: configschema.StringMarkdown,
|
||||||
|
Optional: true,
|
||||||
},
|
},
|
||||||
"outputs": {
|
"outputs": {
|
||||||
Type: cty.DynamicPseudoType,
|
Type: cty.DynamicPseudoType,
|
||||||
Computed: true,
|
Description: "An object containing every root-level " +
|
||||||
|
"output in the remote state.",
|
||||||
|
DescriptionKind: configschema.StringMarkdown,
|
||||||
|
Computed: true,
|
||||||
},
|
},
|
||||||
"workspace": {
|
"workspace": {
|
||||||
Type: cty.String,
|
Type: cty.String,
|
||||||
Optional: true,
|
Description: "The Terraform workspace to use, if " +
|
||||||
|
"the backend supports workspaces.",
|
||||||
|
DescriptionKind: configschema.StringMarkdown,
|
||||||
|
Optional: true,
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
|
Loading…
Reference in New Issue