type CloseRequest struct {// Private is provider-defined ephemeral resource private state data// which was previously provided by the latest Open or Renew operation.//// Use the GetKey method to read data.Private *privatestate.ProviderData}

type CloseResponse struct {// Diagnostics report errors or warnings related to closing the// resource. An empty slice indicates a successful operation with no// warnings or errors generated.Diagnosticsdiag.Diagnostics}

type ConfigValidator interface {// Description describes the validation in plain text formatting.//// This information may be automatically added to ephemeral resource plain text// descriptions by external tooling.Description(context.Context)string// MarkdownDescription describes the validation in Markdown formatting.//// This information may be automatically added to ephemeral resource Markdown// descriptions by external tooling.MarkdownDescription(context.Context)string// ValidateEphemeralResource performs the validation.//// This method name is separate from ConfigValidators in resource and other packages in// order to allow generic validators.ValidateEphemeralResource(context.Context,ValidateConfigRequest, *ValidateConfigResponse)}

type ConfigureRequest struct {// ProviderData is the data set in the// [provider.ConfigureResponse.EphemeralResourceData] field. This data is// provider-specifc and therefore can contain any necessary remote system// clients, custom provider data, or anything else pertinent to the// functionality of the EphemeralResource.//// This data is only set after the ConfigureProvider RPC has been called// by Terraform.ProviderDataany}

type ConfigureResponse struct {// Diagnostics report errors or warnings related to configuring of the// EphemeralResource. An empty slice indicates a successful operation with no// warnings or errors generated.Diagnosticsdiag.Diagnostics}

type Deferred struct {// Reason is the reason for deferring the change.ReasonDeferredReason}

type DeferredReasonint32

func (DeferredReason)String¶

func (dDeferredReason) String()string

type EphemeralResource interface {// Metadata should return the full name of the ephemeral resource, such as// examplecloud_thing.Metadata(context.Context,MetadataRequest, *MetadataResponse)// Schema should return the schema for this ephemeral resource.Schema(context.Context,SchemaRequest, *SchemaResponse)// Open is called when the provider must generate a new ephemeral resource. Config values// should be read from the OpenRequest and new response values set on the OpenResponse.Open(context.Context,OpenRequest, *OpenResponse)}

type EphemeralResourceWithClose interface {EphemeralResource// Close is called when the provider can clean up the ephemeral resource.// Config values may be read from the CloseRequest.Close(context.Context,CloseRequest, *CloseResponse)}

type EphemeralResourceWithConfigValidators interface {EphemeralResource// ConfigValidators returns a list of functions which will all be performed during validation.ConfigValidators(context.Context) []ConfigValidator}

type EphemeralResourceWithConfigure interface {EphemeralResource// Configure enables provider-level data or clients to be set in the// provider-defined EphemeralResource type.Configure(context.Context,ConfigureRequest, *ConfigureResponse)}

type EphemeralResourceWithRenew interface {EphemeralResource// Renew is called when the provider must renew the ephemeral resource based on// the provided RenewAt time. This RenewAt response field can be set in the OpenResponse and RenewResponse.//// Renew cannot return new result data for the ephemeral resource instance, so this logic is only appropriate// for remote objects like HashiCorp Vault leases, which can be renewed without changing their data.Renew(context.Context,RenewRequest, *RenewResponse)}

type EphemeralResourceWithValidateConfig interface {EphemeralResource// ValidateConfig performs the validation.ValidateConfig(context.Context,ValidateConfigRequest, *ValidateConfigResponse)}

type MetadataRequest struct {// ProviderTypeName is the string returned from// [provider.MetadataResponse.TypeName], if the Provider type implements// the Metadata method. This string should prefix the EphemeralResource type name// with an underscore in the response.ProviderTypeNamestring}

type MetadataResponse struct {// TypeName should be the full ephemeral resource type, including the provider// type prefix and an underscore. For example, examplecloud_thing.TypeNamestring}

type OpenClientCapabilities struct {// DeferralAllowed indicates whether the Terraform client initiating// the request allows a deferral response.//// NOTE: This functionality is related to deferred action support, which is currently experimental and is subject// to change or break without warning. It is not protected by version compatibility guarantees.DeferralAllowedbool}

type OpenRequest struct {// Config is the configuration the user supplied for the ephemeral// resource.Configtfsdk.Config// ClientCapabilities defines optionally supported protocol features for the// OpenEphemeralResource RPC, such as forward-compatible Terraform behavior changes.ClientCapabilitiesOpenClientCapabilities}

type OpenResponse struct {// Result is the object representing the values of the ephemeral// resource following the Open operation. This field is pre-populated// from OpenRequest.Config and should be set during the resource's Open// operation.Resulttfsdk.EphemeralResultData// Private is the private state ephemeral resource data following the// Open operation. This field is not pre-populated as there is no// pre-existing private state data during the ephemeral resource's// Open operation.//// This private data will be passed to any Renew or Close operations.Private *privatestate.ProviderData// RenewAt is an optional date/time field that indicates to Terraform// when this ephemeral resource must be renewed at. Terraform will call// the (EphemeralResource).Renew method when the current date/time is on// or after RenewAt during a Terraform operation.//// It is recommended to add extra time (usually no more than a few minutes)// before an ephemeral resource expires to account for latency.RenewAttime.Time// Diagnostics report errors or warnings related to opening the ephemeral// resource. An empty slice indicates a successful operation with no// warnings or errors generated.Diagnosticsdiag.Diagnostics// Deferred indicates that Terraform should defer opening this// ephemeral resource until a followup apply operation.//// This field can only be set if// `(ephemeral.OpenRequest).ClientCapabilities.DeferralAllowed` is true.//// NOTE: This functionality is related to deferred action support, which is currently experimental and is subject// to change or break without warning. It is not protected by version compatibility guarantees.Deferred *Deferred}

type RenewRequest struct {// Private is provider-defined ephemeral resource private state data// which was previously provided by the latest Open or Renew operation.// Any existing data is copied to RenewResponse.Private to prevent// accidental private state data loss.//// Use the GetKey method to read data. Use the SetKey method on// RenewResponse.Private to update or remove a value.Private *privatestate.ProviderData}

type RenewResponse struct {// RenewAt is an optional date/time field that indicates to Terraform// when this ephemeral resource must be renewed at. Terraform will call// the (EphemeralResource).Renew method when the current date/time is on// or after RenewAt during a Terraform operation.//// It is recommended to add extra time (usually no more than a few minutes)// before an ephemeral resource expires to account for latency.RenewAttime.Time// Private is the private state ephemeral resource data following the// Renew operation. This field is pre-populated from RenewRequest.Private// and can be modified during the ephemeral resource's Renew operation.//// This private data will be passed to any Renew or Close operations.Private *privatestate.ProviderData// Diagnostics report errors or warnings related to renewing the ephemeral// resource. An empty slice indicates a successful operation with no// warnings or errors generated.Diagnosticsdiag.Diagnostics}

type SchemaRequest struct{}

type SchemaResponse struct {// Schema is the schema of the ephemeral resource.Schemaschema.Schema// Diagnostics report errors or warnings related to retrieving the ephemeral// resource schema. An empty slice indicates success, with no warnings// or errors generated.Diagnosticsdiag.Diagnostics}

type ValidateConfigRequest struct {// Config is the configuration the user supplied for the ephemeral resource.//// This configuration may contain unknown values if a user uses// interpolation or other functionality that would prevent Terraform// from knowing the value at request time.Configtfsdk.Config}

type ValidateConfigResponse struct {// Diagnostics report errors or warnings related to validating the ephemeral resource// configuration. An empty slice indicates success, with no warnings or// errors generated.Diagnosticsdiag.Diagnostics}