package tfplugin6
Get desktop application:
View/edit binary Protocol Buffers messages
service Provider
tfplugin6.proto:335////// Information about what a provider supports/expects
message
tfplugin6.proto:606string type_name = 1
optional prior_state = 2
optional planned_state = 3
optional config = 4
bytes planned_private = 5
optional provider_meta = 6
optional planned_identity = 7
message
tfplugin6.proto:615optional new_state = 1
bytes private = 2
repeated diagnostics = 3
bool legacy_type_system = 4
This may be set only by the helper/schema "SDK" in the main Terraform repository, to request that Terraform Core >=0.12 permit additional inconsistencies that can result from the legacy SDK type system and its imprecise mapping to the >=0.12 type system. The change in behavior implied by this flag makes sense only for the specific details of the legacy SDK type system, and are not a general mechanism to avoid proper type handling in providers. ==== DO NOT USE THIS ==== ==== THIS MUST BE LEFT UNSET IN ALL OTHER SDKS ==== ==== DO NOT USE THIS ====
optional new_identity = 5
rpc CallFunction (, )
tfplugin6.proto:387CallFunction runs the provider-defined function logic and returns the result with any diagnostics.
message
tfplugin6.proto:736string name = 1
name is the name of the function being called.
repeated arguments = 2
arguments is the data of each function argument value.
message
tfplugin6.proto:744optional result = 1
result is result value after running the function logic.
optional error = 2
error is any error from the function logic.
message
tfplugin6.proto:793string type_name = 1
optional bytes private = 2
message
tfplugin6.proto:797repeated diagnostics = 1
rpc ConfigureProvider (, )
tfplugin6.proto:360////// One-time initialization, called before other functions below
message
tfplugin6.proto:529string terraform_version = 1
optional config = 2
optional client_capabilities = 3
message
tfplugin6.proto:534repeated diagnostics = 1
rpc GetFunctions (, )
tfplugin6.proto:383GetFunctions returns the definitions of all functions.
message
tfplugin6.proto:724(message has no fields)
message
tfplugin6.proto:726map<string, > functions = 1
functions is a mapping of function names to definitions.
repeated diagnostics = 2
diagnostics is any warnings or errors.
rpc GetMetadata (, )
tfplugin6.proto:343GetMetadata returns upfront information about server capabilities and supported resource types without requiring the server to instantiate all schema information, which may be memory intensive. This RPC is optional, where clients may receive an unimplemented RPC error. Clients should ignore the error and call the GetProviderSchema RPC as a fallback.
message
tfplugin6.proto:399(message has no fields)
message
tfplugin6.proto:402optional server_capabilities = 1
repeated diagnostics = 2
repeated data_sources = 3
repeated resources = 4
repeated functions = 5
functions returns metadata for any functions.
repeated ephemeral_resources = 6
repeated list_resources = 7
repeated actions = 9
rpc GetProviderSchema (, )
tfplugin6.proto:347GetSchema returns schema information for the provider, data resources, and managed resources.
message
tfplugin6.proto:443(message has no fields)
message
tfplugin6.proto:445optional provider = 1
map<string, > resource_schemas = 2
map<string, > data_source_schemas = 3
repeated diagnostics = 4
optional provider_meta = 5
optional server_capabilities = 6
map<string, > functions = 7
functions is a mapping of function names to definitions.
map<string, > ephemeral_resource_schemas = 8
map<string, > list_resource_schemas = 9
map<string, > action_schemas = 11
GetResourceIdentitySchemas returns the identity schemas for all managed resources.
message
tfplugin6.proto:804(message has no fields)
message
tfplugin6.proto:806map<string, > identity_schemas = 1
identity_schemas is a mapping of resource type names to their identity schemas.
repeated diagnostics = 2
diagnostics is the collection of warning and error diagnostics for this request.
message
tfplugin6.proto:637string type_name = 1
string id = 2
optional client_capabilities = 3
optional identity = 4
message
tfplugin6.proto:651repeated imported_resources = 1
repeated diagnostics = 2
optional deferred = 3
deferred is set if the provider is deferring the change. If set the caller needs to handle the deferral.
rpc InvokeAction (, stream )
tfplugin6.proto:392message
tfplugin6.proto:907string action_type = 1
optional config = 2
optional client_capabilities = 3
message
tfplugin6.proto:913oneof type
progress = 1
completed = 2
rpc ListResource (, stream )
tfplugin6.proto:377///// List
message
tfplugin6.proto:839string type_name = 1
type_name is the list resource type name.
optional config = 2
configuration is the list ConfigSchema-based configuration data.
bool include_resource_object = 3
when include_resource_object is set to true, the provider should include the full resource object for each result
int64 limit = 4
The maximum number of results that Terraform is expecting. The stream will stop, once this limit is reached.
message
tfplugin6.proto:855optional identity = 1
identity is the resource identity data of the resource instance.
string display_name = 2
display_name can be displayed in a UI to make it easier for humans to identify a resource
optional resource_object = 3
optional resource object which can be useful when combining list blocks in configuration
repeated diagnostic = 4
A warning or error diagnostics for this event
rpc MoveResourceState (, )
tfplugin6.proto:367message
tfplugin6.proto:661string source_provider_address = 1
The address of the provider the resource is being moved from.
string source_type_name = 2
The resource type that the resource is being moved from.
int64 source_schema_version = 3
The schema version of the resource type that the resource is being moved from.
optional source_state = 4
The raw state of the resource being moved. Only the json field is populated, as there should be no legacy providers using the flatmap format that support newly introduced RPCs.
string target_type_name = 5
The resource type that the resource is being moved to.
bytes source_private = 6
The private state of the resource being moved.
optional source_identity = 7
The raw identity of the resource being moved. Only the json field is populated, as there should be no legacy providers using the flatmap format that support newly introduced RPCs.
int64 source_identity_schema_version = 8
The identity schema version of the resource type that the resource is being moved from.
message
tfplugin6.proto:693optional target_state = 1
The state of the resource after it has been moved.
repeated diagnostics = 2
Any diagnostics that occurred during the move.
bytes target_private = 3
The private state of the resource after it has been moved.
optional target_identity = 4
message
tfplugin6.proto:764string type_name = 1
optional config = 2
optional client_capabilities = 3
message
tfplugin6.proto:769repeated diagnostics = 1
optional renew_at = 2
optional result = 3
optional bytes private = 4
optional deferred = 5
deferred is set if the provider is deferring the change. If set the caller needs to handle the deferral.
rpc PlanAction (, )
tfplugin6.proto:391message
tfplugin6.proto:893string action_type = 1
optional config = 2
optional client_capabilities = 3
message
tfplugin6.proto:898repeated diagnostics = 1
optional deferred = 2
metadata
message
tfplugin6.proto:568string type_name = 1
optional prior_state = 2
optional proposed_new_state = 3
optional config = 4
bytes prior_private = 5
optional provider_meta = 6
optional client_capabilities = 7
optional prior_identity = 8
message
tfplugin6.proto:579optional planned_state = 1
repeated requires_replace = 2
bytes planned_private = 3
repeated diagnostics = 4
bool legacy_type_system = 5
This may be set only by the helper/schema "SDK" in the main Terraform repository, to request that Terraform Core >=0.12 permit additional inconsistencies that can result from the legacy SDK type system and its imprecise mapping to the >=0.12 type system. The change in behavior implied by this flag makes sense only for the specific details of the legacy SDK type system, and are not a general mechanism to avoid proper type handling in providers. ==== DO NOT USE THIS ==== ==== THIS MUST BE LEFT UNSET IN ALL OTHER SDKS ==== ==== DO NOT USE THIS ====
optional deferred = 6
deferred is set if the provider is deferring the change. If set the caller needs to handle the deferral.
optional planned_identity = 7
rpc ReadDataSource (, )
tfplugin6.proto:368message
tfplugin6.proto:708string type_name = 1
optional config = 2
optional provider_meta = 3
optional client_capabilities = 4
message
tfplugin6.proto:714optional state = 1
repeated diagnostics = 2
optional deferred = 3
deferred is set if the provider is deferring the change. If set the caller needs to handle the deferral.
rpc ReadResource (, )
tfplugin6.proto:363////// Managed Resource Lifecycle
message
tfplugin6.proto:548Request is the message that is sent to the provider during the ReadResource RPC. This message intentionally does not include configuration data as any configuration-based or configuration-conditional changes should occur during the PlanResourceChange RPC. Additionally, the configuration is not guaranteed to be wholly known nor match the given prior state, which could lead to unexpected provider behaviors for practitioners.
string type_name = 1
optional current_state = 2
bytes private = 3
optional provider_meta = 4
optional client_capabilities = 5
optional current_identity = 6
message
tfplugin6.proto:556optional new_state = 1
repeated diagnostics = 2
bytes private = 3
optional deferred = 4
deferred is set if the provider is deferring the change. If set the caller needs to handle the deferral.
optional new_identity = 5
message
tfplugin6.proto:781string type_name = 1
optional bytes private = 2
message
tfplugin6.proto:785repeated diagnostics = 1
optional renew_at = 2
optional bytes private = 3
rpc StopProvider (, )
tfplugin6.proto:395////// Graceful Shutdown
message
tfplugin6.proto:71(message has no fields)
message
tfplugin6.proto:73string Error = 1
UpgradeResourceIdentityData should return the upgraded resource identity data for a managed resource type.
message
tfplugin6.proto:816string type_name = 1
type_name is the managed resource type name
int64 version = 2
version is the version of the resource identity data to upgrade
optional raw_identity = 3
raw_identity is the raw identity as stored for the resource. Core does not have access to the identity schema of prior_version, so it's the provider's responsibility to interpret this value using the appropriate older schema. The raw_identity will be json encoded.
message
tfplugin6.proto:829optional upgraded_identity = 1
upgraded_identity returns the upgraded resource identity data
repeated diagnostics = 2
diagnostics is the collection of warning and error diagnostics for this request
message
tfplugin6.proto:481Request is the message that is sent to the provider during the UpgradeResourceState RPC. This message intentionally does not include configuration data as any configuration-based or configuration-conditional changes should occur during the PlanResourceChange RPC. Additionally, the configuration is not guaranteed to exist (in the case of resource destruction), be wholly known, nor match the given prior state, which could lead to unexpected provider behaviors for practitioners.
string type_name = 1
int64 version = 2
version is the schema_version number recorded in the state file
optional raw_state = 3
raw_state is the raw states as stored for the resource. Core does not have access to the schema of prior_version, so it's the provider's responsibility to interpret this value using the appropriate older schema. The raw_state will be the json encoded state, or a legacy flat-mapped format.
message
tfplugin6.proto:494optional upgraded_state = 1
new_state is a msgpack-encoded data structure that, when interpreted with the _current_ schema for this resource type, is functionally equivalent to that which was given in prior_state_raw.
repeated diagnostics = 2
diagnostics describes any errors encountered during migration that could not be safely resolved, and warnings about any possibly-risky assumptions made in the upgrade process.
////// Actions Lifecycle
message
tfplugin6.proto:883string action_type = 1
optional config = 2
message
tfplugin6.proto:887repeated diagnostics = 1
message
tfplugin6.proto:519string type_name = 1
optional config = 2
message
tfplugin6.proto:523repeated diagnostics = 1
////// Ephemeral Resource Lifecycle
message
tfplugin6.proto:754string type_name = 1
optional config = 2
message
tfplugin6.proto:758repeated diagnostics = 1
message
tfplugin6.proto:871string type_name = 1
optional config = 2
optional include_resource_object = 3
optional limit = 4
message
tfplugin6.proto:877repeated diagnostics = 1
message
tfplugin6.proto:463optional config = 1
message
tfplugin6.proto:466repeated diagnostics = 2
message
tfplugin6.proto:508string type_name = 1
optional config = 2
optional client_capabilities = 3
message
tfplugin6.proto:513repeated diagnostics = 1
message
tfplugin6.proto:279Used in:
optional schema = 1
of the action itself
message
tfplugin6.proto:605(message has no fields)
message
tfplugin6.proto:55Used in: ,
repeated steps = 1
message
tfplugin6.proto:56Used in:
oneof selector
string attribute_name = 1
Set "attribute_name" to represent looking up an attribute in the current object value.
string element_key_string = 2
Set "element_key_*" to represent looking up an element in an indexable collection type.
int64 element_key_int = 3
message
tfplugin6.proto:735(message has no fields)
message
tfplugin6.proto:307ClientCapabilities allows Terraform to publish information regarding supported protocol features. This is used to indicate availability of certain forward-compatible changes which may be optional in a major protocol version, but cannot be tested for directly.
Used in: , , , , , , , ,
bool deferral_allowed = 1
The deferral_allowed capability signals that the client is able to handle deferred responses from the provider.
bool write_only_attributes_allowed = 2
The write_only_attributes_allowed capability signals that the client is able to handle write_only attributes for managed resources.
message
tfplugin6.proto:792(message has no fields)
message
tfplugin6.proto:528(message has no fields)
message
tfplugin6.proto:317Deferred is a message that indicates that change is deferred for a reason.
Used in: , , , , ,
Deferred.Reason reason = 1
reason is the reason for deferring the change.
Reason is the reason for deferring the change.
Used in:
UNKNOWN = 0
UNKNOWN is the default value, and should not be used.
RESOURCE_CONFIG_UNKNOWN = 1
RESOURCE_CONFIG_UNKNOWN is used when the config is partially unknown and the real values need to be known before the change can be planned.
PROVIDER_CONFIG_UNKNOWN = 2
PROVIDER_CONFIG_UNKNOWN is used when parts of the provider configuration are unknown, e.g. the provider configuration is only known after the apply is done.
ABSENT_PREREQ = 3
ABSENT_PREREQ is used when a hard dependency has not been satisfied.
message
tfplugin6.proto:36Used in: , , , , , , , , , , , , , , , , , , , , , , , ,
Diagnostic.Severity severity = 1
string summary = 2
string detail = 3
optional attribute = 4
Used in:
INVALID = 0
ERROR = 1
WARNING = 2
message
tfplugin6.proto:31DynamicValue is an opaque encoding of terraform data, with the field name indicating the encoding scheme used.
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , ,
bytes msgpack = 1
bytes json = 2
message
tfplugin6.proto:223Used in: ,
repeated parameters = 1
parameters is the ordered list of positional function parameters.
optional variadic_parameter = 2
variadic_parameter is an optional final parameter which accepts zero or more argument values, in which Terraform will send an ordered list of the parameter type.
optional return = 3
return is the function result.
string summary = 4
summary is the human-readable shortened documentation for the function.
string description = 5
description is human-readable documentation for the function.
StringKind description_kind = 6
description_kind is the formatting of the description.
string deprecation_message = 7
deprecation_message is human-readable documentation if the function is deprecated.
message
tfplugin6.proto:248Used in:
string name = 1
name is the human-readable display name for the parameter.
bytes type = 2
type is the type constraint for the parameter.
bool allow_null_value = 3
allow_null_value when enabled denotes that a null argument value can be passed to the provider. When disabled, Terraform returns an error if the argument value is null.
bool allow_unknown_values = 4
allow_unknown_values when enabled denotes that only wholly known argument values will be passed to the provider. When disabled, Terraform skips the function call entirely and assumes an unknown value result from the function.
string description = 5
description is human-readable documentation for the parameter.
StringKind description_kind = 6
description_kind is the formatting of the description.
message
tfplugin6.proto:273Used in:
bytes type = 1
type is the type constraint for the function result.
message
tfplugin6.proto:48Used in:
string text = 1
optional int64 function_argument = 2
The optional function_argument records the index position of the argument which caused the error.
message
tfplugin6.proto:723(message has no fields)
message
tfplugin6.proto:398(message has no fields)
message
tfplugin6.proto:437Used in:
string type_name = 1
message
tfplugin6.proto:421Used in:
string type_name = 1
message
tfplugin6.proto:429Used in:
string type_name = 1
message
tfplugin6.proto:416Used in:
string name = 1
name is the function name.
message
tfplugin6.proto:433Used in:
string type_name = 1
message
tfplugin6.proto:425Used in:
string type_name = 1
message
tfplugin6.proto:442(message has no fields)
message
tfplugin6.proto:803Returns resource identity schemas for all resources
(message has no fields)
message
tfplugin6.proto:636(message has no fields)
message
tfplugin6.proto:644Used in:
string type_name = 1
optional state = 2
bytes private = 3
optional identity = 4
message
tfplugin6.proto:906(message has no fields)
message
tfplugin6.proto:918Used in:
repeated diagnostics = 1
message
tfplugin6.proto:914Used in:
string message = 1
message to be printed in the console / HCPT
message
tfplugin6.proto:838(message has no fields)
message
tfplugin6.proto:660(message has no fields)
message
tfplugin6.proto:763(message has no fields)
message
tfplugin6.proto:892(message has no fields)
message
tfplugin6.proto:567(message has no fields)
message
tfplugin6.proto:81RawState holds the stored state for a resource to be upgraded by the provider. It can be in one of two formats, the current json encoded format in bytes, or the legacy flatmap format as a map of strings.
Used in: , ,
bytes json = 1
map<string, string> flatmap = 2
message
tfplugin6.proto:707(message has no fields)
message
tfplugin6.proto:539(message has no fields)
message
tfplugin6.proto:780(message has no fields)
message
tfplugin6.proto:213ResourceIdentityData is a separate message for better extensibility
Used in: , , , , , , , , , ,
optional identity_data = 1
identity_data is the resource identity data for the given definition. It should be decoded using the identity schema. This data is considered permanent for the identity version and suitable for longer-term storage.
message
tfplugin6.proto:168ResourceIdentitySchema represents the structure and types of data used to identify a managed resource type. Effectively, resource identity is a versioned object that can be used to compare resources, whether already managed and/or being discovered.
Used in:
int64 version = 1
version is the identity version and separate from the Schema version. Any time the structure or format of identity_attributes changes, this version should be incremented. Versioning implicitly starts at 0 and by convention should be incremented by 1 each change. When comparing identity_attributes data, differing versions should always be treated as inequal.
repeated identity_attributes = 2
identity_attributes are the individual value definitions which define identity data for a managed resource type. This information is used to decode DynamicValue of identity data. These attributes are intended for permanent identity data and must be wholly representative of all data necessary to compare two managed resource instances with no other data. This generally should include account, endpoint, location, and automatically generated identifiers. For some resources, this may include configuration-based data, such as a required name which must be unique.
message
tfplugin6.proto:171IdentityAttribute represents one value of data within resource identity. These are always used in resource identity comparisons.
Used in:
string name = 1
name is the identity attribute name
bytes type = 2
type is the identity attribute type
bool required_for_import = 3
required_for_import when enabled signifies that this attribute must be defined for ImportResourceState to complete successfully
bool optional_for_import = 4
optional_for_import when enabled signifies that this attribute is not required for ImportResourceState, because it can be supplied by the provider. It is still possible to supply this attribute during import.
string description = 5
description is a human-readable description of the attribute in Markdown
message
tfplugin6.proto:92Schema is the configuration schema for a Resource or Provider.
Used in: ,
int64 version = 1
The version of the schema. Schemas are versioned, so that providers can upgrade a saved resource state when the schema is changed.
optional block = 2
Block is the top level configuration block for this schema.
message
tfplugin6.proto:102Used in: ,
string name = 1
bytes type = 2
optional nested_type = 10
string description = 3
bool required = 4
bool optional = 5
bool computed = 6
bool sensitive = 7
StringKind description_kind = 8
bool deprecated = 9
bool write_only = 11
write_only indicates that the attribute value will be provided via configuration and must be omitted from state. write_only must be combined with optional or required, and is only valid for managed resource schemas.
message
tfplugin6.proto:93Used in: ,
int64 version = 1
repeated attributes = 2
repeated block_types = 3
string description = 4
StringKind description_kind = 5
bool deprecated = 6
message
tfplugin6.proto:120Used in:
string type_name = 1
optional block = 2
NestedBlock.NestingMode nesting = 3
int64 min_items = 4
int64 max_items = 5
Used in:
INVALID = 0
SINGLE = 1
LIST = 2
SET = 3
MAP = 4
GROUP = 5
message
tfplugin6.proto:137Used in:
repeated attributes = 1
Object.NestingMode nesting = 3
int64 min_items = 4
MinItems and MaxItems were never used in the protocol, and have no effect on validation.
int64 max_items = 5
Used in:
INVALID = 0
SINGLE = 1
LIST = 2
SET = 3
MAP = 4
message
tfplugin6.proto:287ServerCapabilities allows providers to communicate extra information regarding supported protocol features. This is used to indicate availability of certain forward-compatible changes which may be optional in a major protocol version, but cannot be tested for directly.
Used in: ,
bool plan_destroy = 1
The plan_destroy capability signals that a provider expects a call to PlanResourceChange when a resource is going to be destroyed.
bool get_provider_schema_optional = 2
The get_provider_schema_optional capability indicates that this provider does not require calling GetProviderSchema to operate normally, and the caller can used a cached copy of the provider's schema.
bool move_resource_state = 3
The move_resource_state capability signals that a provider supports the MoveResourceState RPC.
message
tfplugin6.proto:70(message has no fields)
Used in: , , ,
PLAIN = 0
MARKDOWN = 1
message
tfplugin6.proto:815(message has no fields)
message
tfplugin6.proto:471(message has no fields)
message
tfplugin6.proto:882(message has no fields)
message
tfplugin6.proto:518(message has no fields)
message
tfplugin6.proto:753(message has no fields)
message
tfplugin6.proto:870(message has no fields)
message
tfplugin6.proto:462(message has no fields)
message
tfplugin6.proto:507(message has no fields)