package tfplugin5

Get desktop application:
View/edit binary Protocol Buffers messages

////// Information about what a provider supports/expects

• rpc GetMetadata (GetMetadata.Request, GetMetadata.Response)

  tfplugin5.proto:319

  GetMetadata 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 GetSchema RPC as a fallback.

  message GetMetadata.Request

  tfplugin5.proto:366

  (message has no fields)

  message GetMetadata.Response

  tfplugin5.proto:369

  • optional ServerCapabilities server_capabilities = 1

  • repeated Diagnostic diagnostics = 2

  • repeated DataSourceMetadata data_sources = 3

  • repeated ResourceMetadata resources = 4

  • repeated FunctionMetadata functions = 5

    functions returns metadata for any functions.

  • repeated EphemeralResourceMetadata ephemeral_resources = 6

• rpc GetSchema (GetProviderSchema.Request, GetProviderSchema.Response)

  tfplugin5.proto:323

  GetSchema returns schema information for the provider, data resources, and managed resources.

  message GetProviderSchema.Request

  tfplugin5.proto:399

  (message has no fields)

  message GetProviderSchema.Response

  tfplugin5.proto:401

  • optional Schema provider = 1

  • map<string, Schema> resource_schemas = 2

  • map<string, Schema> data_source_schemas = 3

  • repeated Diagnostic diagnostics = 4

  • optional Schema provider_meta = 5

  • optional ServerCapabilities server_capabilities = 6

  • map<string, Function> functions = 7

    functions is a mapping of function names to definitions.

  • map<string, Schema> ephemeral_resource_schemas = 8

• rpc GetResourceIdentitySchemas (GetResourceIdentitySchemas.Request, GetResourceIdentitySchemas.Response)

  tfplugin5.proto:326

  GetResourceIdentitySchemas returns the identity schemas for all managed resources.

  message GetResourceIdentitySchemas.Request

  tfplugin5.proto:794

  (message has no fields)

  message GetResourceIdentitySchemas.Response

  tfplugin5.proto:796

  • map<string, ResourceIdentitySchema> identity_schemas = 1

    identity_schemas is a mapping of resource type names to their identity schemas.

  • repeated Diagnostic diagnostics = 2

    diagnostics is the collection of warning and error diagnostics for this request.

• rpc PrepareProviderConfig (PrepareProviderConfig.Request, PrepareProviderConfig.Response)

  tfplugin5.proto:327

  message PrepareProviderConfig.Request

  tfplugin5.proto:416

  • optional DynamicValue config = 1

  message PrepareProviderConfig.Response

  tfplugin5.proto:419

  • optional DynamicValue prepared_config = 1

  • repeated Diagnostic diagnostics = 2

• rpc ValidateResourceTypeConfig (ValidateResourceTypeConfig.Request, ValidateResourceTypeConfig.Response)

  tfplugin5.proto:328

  message ValidateResourceTypeConfig.Request

  tfplugin5.proto:462

  • string type_name = 1

  • optional DynamicValue config = 2

  • optional ClientCapabilities client_capabilities = 3

  message ValidateResourceTypeConfig.Response

  tfplugin5.proto:467

  • repeated Diagnostic diagnostics = 1

• rpc ValidateDataSourceConfig (ValidateDataSourceConfig.Request, ValidateDataSourceConfig.Response)

  tfplugin5.proto:329

  message ValidateDataSourceConfig.Request

  tfplugin5.proto:473

  • string type_name = 1

  • optional DynamicValue config = 2

  message ValidateDataSourceConfig.Response

  tfplugin5.proto:477

  • repeated Diagnostic diagnostics = 1

• rpc UpgradeResourceState (UpgradeResourceState.Request, UpgradeResourceState.Response)

  tfplugin5.proto:330

  message UpgradeResourceState.Request

  tfplugin5.proto:435

  Request 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 RawState 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 UpgradeResourceState.Response

  tfplugin5.proto:448

  • optional DynamicValue 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 Diagnostic 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.

• rpc UpgradeResourceIdentity (UpgradeResourceIdentity.Request, UpgradeResourceIdentity.Response)

  tfplugin5.proto:333

  UpgradeResourceIdentityData should return the upgraded resource identity data for a managed resource type.

  message UpgradeResourceIdentity.Request

  tfplugin5.proto:806

  • string 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 RawState 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 UpgradeResourceIdentity.Response

  tfplugin5.proto:819

  • optional ResourceIdentityData upgraded_identity = 1

    upgraded_identity returns the upgraded resource identity data

  • repeated Diagnostic diagnostics = 2

    diagnostics is the collection of warning and error diagnostics for this request

• rpc Configure (Configure.Request, Configure.Response)

  tfplugin5.proto:336

  ////// One-time initialization, called before other functions below

  message Configure.Request

  tfplugin5.proto:483

  • string terraform_version = 1

  • optional DynamicValue config = 2

  • optional ClientCapabilities client_capabilities = 3

  message Configure.Response

  tfplugin5.proto:488

  • repeated Diagnostic diagnostics = 1

• rpc ReadResource (ReadResource.Request, ReadResource.Response)

  tfplugin5.proto:339

  ////// Managed Resource Lifecycle

  message ReadResource.Request

  tfplugin5.proto:502

  Request 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 DynamicValue current_state = 2

  • bytes private = 3

  • optional DynamicValue provider_meta = 4

  • optional ClientCapabilities client_capabilities = 5

  • optional ResourceIdentityData current_identity = 6

  message ReadResource.Response

  tfplugin5.proto:510

  • optional DynamicValue new_state = 1

  • repeated Diagnostic diagnostics = 2

  • bytes private = 3

  • optional Deferred deferred = 4

    deferred is set if the provider is deferring the change. If set the caller needs to handle the deferral.

  • optional ResourceIdentityData new_identity = 5

• rpc PlanResourceChange (PlanResourceChange.Request, PlanResourceChange.Response)

  tfplugin5.proto:340

  message PlanResourceChange.Request

  tfplugin5.proto:522

  • string type_name = 1

  • optional DynamicValue prior_state = 2

  • optional DynamicValue proposed_new_state = 3

  • optional DynamicValue config = 4

  • bytes prior_private = 5

  • optional DynamicValue provider_meta = 6

  • optional ClientCapabilities client_capabilities = 7

  • optional ResourceIdentityData prior_identity = 8

  message PlanResourceChange.Response

  tfplugin5.proto:533

  • optional DynamicValue planned_state = 1

  • repeated AttributePath requires_replace = 2

  • bytes planned_private = 3

  • repeated Diagnostic 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 deferred = 6

    deferred is set if the provider is deferring the change. If set the caller needs to handle the deferral.

  • optional ResourceIdentityData planned_identity = 7

• rpc ApplyResourceChange (ApplyResourceChange.Request, ApplyResourceChange.Response)

  tfplugin5.proto:341

  message ApplyResourceChange.Request

  tfplugin5.proto:560

  • string type_name = 1

  • optional DynamicValue prior_state = 2

  • optional DynamicValue planned_state = 3

  • optional DynamicValue config = 4

  • bytes planned_private = 5

  • optional DynamicValue provider_meta = 6

  • optional ResourceIdentityData planned_identity = 7

  message ApplyResourceChange.Response

  tfplugin5.proto:569

  • optional DynamicValue new_state = 1

  • bytes private = 2

  • repeated Diagnostic 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 ResourceIdentityData new_identity = 5

• rpc ImportResourceState (ImportResourceState.Request, ImportResourceState.Response)

  tfplugin5.proto:342

  message ImportResourceState.Request

  tfplugin5.proto:591

  • string type_name = 1

  • string id = 2

  • optional ClientCapabilities client_capabilities = 3

  • optional ResourceIdentityData identity = 4

  message ImportResourceState.Response

  tfplugin5.proto:605

  • repeated ImportedResource imported_resources = 1

  • repeated Diagnostic diagnostics = 2

  • optional Deferred deferred = 3

    deferred is set if the provider is deferring the change. If set the caller needs to handle the deferral.

• rpc MoveResourceState (MoveResourceState.Request, MoveResourceState.Response)

  tfplugin5.proto:343

  message MoveResourceState.Request

  tfplugin5.proto:615

  • string 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 RawState 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 RawState 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 MoveResourceState.Response

  tfplugin5.proto:647

  • optional DynamicValue target_state = 1

    The state of the resource after it has been moved.

  • repeated Diagnostic 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 ResourceIdentityData target_identity = 4

• rpc ReadDataSource (ReadDataSource.Request, ReadDataSource.Response)

  tfplugin5.proto:344

  message ReadDataSource.Request

  tfplugin5.proto:662

  • string type_name = 1

  • optional DynamicValue config = 2

  • optional DynamicValue provider_meta = 3

  • optional ClientCapabilities client_capabilities = 4

  message ReadDataSource.Response

  tfplugin5.proto:668

  • optional DynamicValue state = 1

  • repeated Diagnostic diagnostics = 2

  • optional Deferred deferred = 3

    deferred is set if the provider is deferring the change. If set the caller needs to handle the deferral.

• rpc ValidateEphemeralResourceConfig (ValidateEphemeralResourceConfig.Request, ValidateEphemeralResourceConfig.Response)

  tfplugin5.proto:347

  ////// Ephemeral Resource Lifecycle

  message ValidateEphemeralResourceConfig.Request

  tfplugin5.proto:744

  • string type_name = 1

  • optional DynamicValue config = 2

  message ValidateEphemeralResourceConfig.Response

  tfplugin5.proto:748

  • repeated Diagnostic diagnostics = 1

• rpc OpenEphemeralResource (OpenEphemeralResource.Request, OpenEphemeralResource.Response)

  tfplugin5.proto:348

  message OpenEphemeralResource.Request

  tfplugin5.proto:754

  • string type_name = 1

  • optional DynamicValue config = 2

  • optional ClientCapabilities client_capabilities = 3

  message OpenEphemeralResource.Response

  tfplugin5.proto:759

  • repeated Diagnostic diagnostics = 1

  • optional google.protobuf.Timestamp renew_at = 2

  • optional DynamicValue result = 3

  • optional bytes private = 4

  • optional Deferred deferred = 5

    deferred is set if the provider is deferring the change. If set the caller needs to handle the deferral.

• rpc RenewEphemeralResource (RenewEphemeralResource.Request, RenewEphemeralResource.Response)

  tfplugin5.proto:349

  message RenewEphemeralResource.Request

  tfplugin5.proto:771

  • string type_name = 1

  • optional bytes private = 2

  message RenewEphemeralResource.Response

  tfplugin5.proto:775

  • repeated Diagnostic diagnostics = 1

  • optional google.protobuf.Timestamp renew_at = 2

  • optional bytes private = 3

• rpc CloseEphemeralResource (CloseEphemeralResource.Request, CloseEphemeralResource.Response)

  tfplugin5.proto:350

  message CloseEphemeralResource.Request

  tfplugin5.proto:783

  • string type_name = 1

  • optional bytes private = 2

  message CloseEphemeralResource.Response

  tfplugin5.proto:787

  • repeated Diagnostic diagnostics = 1

• rpc GetFunctions (GetFunctions.Request, GetFunctions.Response)

  tfplugin5.proto:355

  GetFunctions returns the definitions of all functions.

  message GetFunctions.Request

  tfplugin5.proto:714

  (message has no fields)

  message GetFunctions.Response

  tfplugin5.proto:716

  • map<string, Function> functions = 1

    functions is a mapping of function names to definitions.

  • repeated Diagnostic diagnostics = 2

    diagnostics is any warnings or errors.

• rpc CallFunction (CallFunction.Request, CallFunction.Response)

  tfplugin5.proto:359

  CallFunction runs the provider-defined function logic and returns the result with any diagnostics.

  message CallFunction.Request

  tfplugin5.proto:726

  • string name = 1

    name is the name of the function being called.

  • repeated DynamicValue arguments = 2

    arguments is the data of each function argument value.

  message CallFunction.Response

  tfplugin5.proto:734

  • optional DynamicValue result = 1

    result is result value after running the function logic.

  • optional FunctionError error = 2

    error is any error from the function logic.

• rpc Stop (Stop.Request, Stop.Response)

  tfplugin5.proto:362

  ////// Graceful Shutdown

• rpc GetSchema (GetProvisionerSchema.Request, GetProvisionerSchema.Response)

  tfplugin5.proto:678

  message GetProvisionerSchema.Request

  tfplugin5.proto:685

  (message has no fields)

  message GetProvisionerSchema.Response

  tfplugin5.proto:687

  • optional Schema provisioner = 1

  • repeated Diagnostic diagnostics = 2

• rpc ValidateProvisionerConfig (ValidateProvisionerConfig.Request, ValidateProvisionerConfig.Response)

  tfplugin5.proto:679

  message ValidateProvisionerConfig.Request

  tfplugin5.proto:694

  • optional DynamicValue config = 1

  message ValidateProvisionerConfig.Response

  tfplugin5.proto:697

  • repeated Diagnostic diagnostics = 1

• rpc ProvisionResource (ProvisionResource.Request, stream ProvisionResource.Response)

  tfplugin5.proto:680

  message ProvisionResource.Request

  tfplugin5.proto:703

  • optional DynamicValue config = 1

  • optional DynamicValue connection = 2

  message ProvisionResource.Response

  tfplugin5.proto:707

  • string output = 1

  • repeated Diagnostic diagnostics = 2

• rpc Stop (Stop.Request, Stop.Response)

  tfplugin5.proto:681

(message has no fields)

Used in: Diagnostic, PlanResourceChange.Response

• repeated AttributePath.Step steps = 1

Used in: AttributePath

• 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 has no fields)

ClientCapabilities 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: Configure.Request, ImportResourceState.Request, OpenEphemeralResource.Request, PlanResourceChange.Request, ReadDataSource.Request, ReadResource.Request, ValidateResourceTypeConfig.Request

• 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 has no fields)

(message has no fields)

Deferred is a message that indicates that change is deferred for a reason.

Used in: ImportResourceState.Response, OpenEphemeralResource.Response, PlanResourceChange.Response, ReadDataSource.Response, ReadResource.Response

• Deferred.Reason reason = 1

  reason is the reason for deferring the change.

Reason is the reason for deferring the change.

Used in: Deferred

• 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.

Used in: ApplyResourceChange.Response, CloseEphemeralResource.Response, Configure.Response, GetFunctions.Response, GetMetadata.Response, GetProviderSchema.Response, GetProvisionerSchema.Response, GetResourceIdentitySchemas.Response, ImportResourceState.Response, MoveResourceState.Response, OpenEphemeralResource.Response, PlanResourceChange.Response, PrepareProviderConfig.Response, ProvisionResource.Response, ReadDataSource.Response, ReadResource.Response, RenewEphemeralResource.Response, UpgradeResourceIdentity.Response, UpgradeResourceState.Response, ValidateDataSourceConfig.Response, ValidateEphemeralResourceConfig.Response, ValidateProvisionerConfig.Response, ValidateResourceTypeConfig.Response

• Diagnostic.Severity severity = 1

• string summary = 2

• string detail = 3

• optional AttributePath attribute = 4

Used in: Diagnostic

• INVALID = 0

• ERROR = 1

• WARNING = 2

DynamicValue is an opaque encoding of terraform data, with the field name indicating the encoding scheme used.

Used in: ApplyResourceChange.Request, ApplyResourceChange.Response, CallFunction.Request, CallFunction.Response, Configure.Request, ImportResourceState.ImportedResource, MoveResourceState.Response, OpenEphemeralResource.Request, OpenEphemeralResource.Response, PlanResourceChange.Request, PlanResourceChange.Response, PrepareProviderConfig.Request, PrepareProviderConfig.Response, ProvisionResource.Request, ReadDataSource.Request, ReadDataSource.Response, ReadResource.Request, ReadResource.Response, ResourceIdentityData, UpgradeResourceState.Response, ValidateDataSourceConfig.Request, ValidateEphemeralResourceConfig.Request, ValidateProvisionerConfig.Request, ValidateResourceTypeConfig.Request

• bytes msgpack = 1

• bytes json = 2

Used in: GetFunctions.Response, GetProviderSchema.Response

• repeated Function.Parameter parameters = 1

  parameters is the ordered list of positional function parameters.

• optional Function.Parameter 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 Function.Return 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.

Used in: Function

• 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.

Used in: Function

• bytes type = 1

  type is the type constraint for the function result.

Used in: CallFunction.Response

• string text = 1

• optional int64 function_argument = 2

  The optional function_argument records the index position of the argument which caused the error.

(message has no fields)

(message has no fields)

Used in: Response

• string type_name = 1

Used in: Response

• string type_name = 1

Used in: Response

• string name = 1

  name is the function name.

Used in: Response

• string type_name = 1

(message has no fields)

(message has no fields)

Returns resource identity schemas for all resources

(message has no fields)

(message has no fields)

Used in: Response

• string type_name = 1

• optional DynamicValue state = 2

• bytes private = 3

• optional ResourceIdentityData identity = 4

(message has no fields)

(message has no fields)

(message has no fields)

(message has no fields)

(message has no fields)

RawState 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: MoveResourceState.Request, UpgradeResourceIdentity.Request, UpgradeResourceState.Request

• bytes json = 1

• map<string, string> flatmap = 2

(message has no fields)

(message has no fields)

(message has no fields)

ResourceIdentityData is a separate message for better extensibility

Used in: ApplyResourceChange.Request, ApplyResourceChange.Response, ImportResourceState.ImportedResource, ImportResourceState.Request, MoveResourceState.Response, PlanResourceChange.Request, PlanResourceChange.Response, ReadResource.Request, ReadResource.Response, UpgradeResourceIdentity.Response

• optional DynamicValue 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.

ResourceIdentitySchema 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: GetResourceIdentitySchemas.Response

• 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 ResourceIdentitySchema.IdentityAttribute 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.

IdentityAttribute represents one value of data within resource identity. These are always used in resource identity comparisons.

Used in: ResourceIdentitySchema

• 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

Schema is the configuration schema for a Resource, Provider, or Provisioner.

Used in: GetProviderSchema.Response, GetProvisionerSchema.Response

• 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 Schema.Block block = 2

  Block is the top level configuration block for this schema.

Used in: Block

• string name = 1

• bytes type = 2

• 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 = 10

  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.

Used in: Schema, NestedBlock

• int64 version = 1

• repeated Attribute attributes = 2

• repeated NestedBlock block_types = 3

• string description = 4

• StringKind description_kind = 5

• bool deprecated = 6

Used in: Block

• string type_name = 1

• optional Block block = 2

• NestedBlock.NestingMode nesting = 3

• int64 min_items = 4

• int64 max_items = 5

Used in: NestedBlock

• INVALID = 0

• SINGLE = 1

• LIST = 2

• SET = 3

• MAP = 4

• GROUP = 5

ServerCapabilities 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: GetMetadata.Response, GetProviderSchema.Response

• 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 has no fields)

Used as request type in: Provider.Stop, Provisioner.Stop

(message has no fields)

Used as response type in: Provider.Stop, Provisioner.Stop

• string Error = 1

Used in: Function, Function.Parameter, Schema.Attribute, Schema.Block

• PLAIN = 0

• MARKDOWN = 1

(message has no fields)

(message has no fields)

(message has no fields)

(message has no fields)

(message has no fields)

(message has no fields)