Skip to content

Latest commit

 

History

History

sdk

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
frameworkhelpers
frameworkhelpers
 
 
README.md
README.md
 
 
ephemeral_resource.go
ephemeral_resource.go
 
 
framework_data_source.go
framework_data_source.go
 
 
framework_migration_experimental.md
framework_migration_experimental.md
 
 
framework_resource.go
framework_resource.go
 
 
framework_service_registration.go
framework_service_registration.go
 
 
logger.go
logger.go
 
 
logger_console.go
logger_console.go
 
 
logger_diagnostics.go
logger_diagnostics.go
 
 
logger_null.go
logger_null.go
 
 
plugin_sdk_test.go
plugin_sdk_test.go
 
 
resource.go
resource.go
 
 
resource_data.go
resource_data.go
 
 
resource_data_pluginsdk.go
resource_data_pluginsdk.go
 
 
resource_decode.go
resource_decode.go
 
 
resource_decode_test.go
resource_decode_test.go
 
 
resource_encode.go
resource_encode.go
 
 
resource_encode_test.go
resource_encode_test.go
 
 
resource_helpers.go
resource_helpers.go
 
 
resource_helpers_test.go
resource_helpers_test.go
 
 
resource_id.go
resource_id.go
 
 
resource_test.go
resource_test.go
 
 
service_registration.go
service_registration.go
 
 
wrapper_data_source.go
wrapper_data_source.go
 
 
wrapper_helpers.go
wrapper_helpers.go
 
 
wrapper_resource.go
wrapper_resource.go
 
 
wrapper_validate.go
wrapper_validate.go
 
 
wrapper_validate_test.go
wrapper_validate_test.go
 
 

README.md

SDK for Strongly-Typed Resources

This package is used for writing strongly-typed Data Sources and Resources.

The benefits of a typed resources over an untyped resource are:

  • The Context object passed into each method always has a deadline/timeout attached to it
  • The Read function is automatically called at the end of a Create and Update function - meaning users don't have to do this
  • Each Resource has to have an ID Formatter and Validation Function
  • The Model Object is validated via unit tests to ensure it contains the relevant struct tags

Ultimately this allows bugs to be caught by the Compiler (for example if a Read function is unimplemented) - or Unit Tests (for example should the tfschema struct tags be missing) - rather than during Provider Initialization, which reduces the feedback loop.

For help on how to add typed resources to the provider, please view the following tutorials in our contributor guidelines: