framework

README

Terraform Plugin Framework

This package and its subpackages contain Terraform Plugin Framework functionality.

Documentation

Index

• func ARNAttributeComputedOnly() schema.StringAttribute
• func IDAttribute() schema.StringAttribute
• type DataSourceWithConfigure
  • func (d *DataSourceWithConfigure) Configure(_ context.Context, request datasource.ConfigureRequest, ...)
  • func (w *DataSourceWithConfigure) Meta() *conns.AWSClient
  • func (w *DataSourceWithConfigure) MigratedFromPluginSDK() bool
  • func (w *DataSourceWithConfigure) SetMigratedFromPluginSDK(migrated bool)
• type ResourceWithConfigure
  • func (r *ResourceWithConfigure) Configure(_ context.Context, request resource.ConfigureRequest, ...)
  • func (w *ResourceWithConfigure) Meta() *conns.AWSClient
  • func (w *ResourceWithConfigure) MigratedFromPluginSDK() bool
  • func (w *ResourceWithConfigure) SetMigratedFromPluginSDK(migrated bool)
  • func (r *ResourceWithConfigure) SetTagsAll(ctx context.Context, request resource.ModifyPlanRequest, ...)
• type WithImportByID
  • func (w *WithImportByID) ImportState(ctx context.Context, request resource.ImportStateRequest, ...)
• type WithTimeouts
  • func (w *WithTimeouts) CreateTimeout(ctx context.Context, timeouts timeouts.Value) time.Duration
  • func (w *WithTimeouts) DeleteTimeout(ctx context.Context, timeouts timeouts.Value) time.Duration
  • func (w *WithTimeouts) ReadTimeout(ctx context.Context, timeouts timeouts.Value) time.Duration
  • func (w *WithTimeouts) SetDefaultCreateTimeout(timeout time.Duration)
  • func (w *WithTimeouts) SetDefaultDeleteTimeout(timeout time.Duration)
  • func (w *WithTimeouts) SetDefaultReadTimeout(timeout time.Duration)
  • func (w *WithTimeouts) SetDefaultUpdateTimeout(timeout time.Duration)
  • func (w *WithTimeouts) UpdateTimeout(ctx context.Context, timeouts timeouts.Value) time.Duration

Functions

func ARNAttributeComputedOnly

func ARNAttributeComputedOnly() schema.StringAttribute

func IDAttribute

func IDAttribute() schema.StringAttribute

Types

type DataSourceWithConfigure

type DataSourceWithConfigure struct {
	// contains filtered or unexported fields
}

DataSourceWithConfigure is a structure to be embedded within a DataSource that implements the DataSourceWithConfigure interface.

func (*DataSourceWithConfigure) Configure

func (d *DataSourceWithConfigure) Configure(_ context.Context, request datasource.ConfigureRequest, response *datasource.ConfigureResponse)

Configure enables provider-level data or clients to be set in the provider-defined DataSource type. It is separately executed for each ReadDataSource RPC.

func (*DataSourceWithConfigure) Meta

func (w *DataSourceWithConfigure) Meta() *conns.AWSClient

func (*DataSourceWithConfigure) MigratedFromPluginSDK

func (w *DataSourceWithConfigure) MigratedFromPluginSDK() bool

MigratedFromPluginSDK returns whether or not the resource (or data source) has been migrated from terraform-plugin-sdk.

func (*DataSourceWithConfigure) SetMigratedFromPluginSDK

func (w *DataSourceWithConfigure) SetMigratedFromPluginSDK(migrated bool)

SetMigratedFromPluginSDK sets whether or not the resource (or data source) has been migrated from terraform-plugin-sdk.

type ResourceWithConfigure

type ResourceWithConfigure struct {
	// contains filtered or unexported fields
}

ResourceWithConfigure is a structure to be embedded within a Resource that implements the ResourceWithConfigure interface.

func (*ResourceWithConfigure) Configure

func (r *ResourceWithConfigure) Configure(_ context.Context, request resource.ConfigureRequest, response *resource.ConfigureResponse)

Configure enables provider-level data or clients to be set in the provider-defined Resource type.

func (*ResourceWithConfigure) Meta

func (w *ResourceWithConfigure) Meta() *conns.AWSClient

func (*ResourceWithConfigure) MigratedFromPluginSDK

func (w *ResourceWithConfigure) MigratedFromPluginSDK() bool

MigratedFromPluginSDK returns whether or not the resource (or data source) has been migrated from terraform-plugin-sdk.

func (*ResourceWithConfigure) SetMigratedFromPluginSDK

func (w *ResourceWithConfigure) SetMigratedFromPluginSDK(migrated bool)

SetMigratedFromPluginSDK sets whether or not the resource (or data source) has been migrated from terraform-plugin-sdk.

func (*ResourceWithConfigure) SetTagsAll

func (r *ResourceWithConfigure) SetTagsAll(ctx context.Context, request resource.ModifyPlanRequest, response *resource.ModifyPlanResponse)

SetTagsAll calculates the new value for the `tags_all` attribute.

type WithImportByID

type WithImportByID struct{}

WithImportByID is intended to be embedded in resources which import state via the "id" attribute. See https://developer.hashicorp.com/terraform/plugin/framework/resources/import.

func (*WithImportByID) ImportState

func (w *WithImportByID) ImportState(ctx context.Context, request resource.ImportStateRequest, response *resource.ImportStateResponse)

type WithTimeouts

type WithTimeouts struct {
	// contains filtered or unexported fields
}

WithTimeouts is intended to be embedded in resources which use the special "timeouts" nested block. See https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts.

func (*WithTimeouts) CreateTimeout

func (w *WithTimeouts) CreateTimeout(ctx context.Context, timeouts timeouts.Value) time.Duration

CreateTimeout returns any configured Create timeout value or the default value.

func (*WithTimeouts) DeleteTimeout

func (w *WithTimeouts) DeleteTimeout(ctx context.Context, timeouts timeouts.Value) time.Duration

DeleteTimeout returns any configured Delete timeout value or the default value.

func (*WithTimeouts) ReadTimeout

func (w *WithTimeouts) ReadTimeout(ctx context.Context, timeouts timeouts.Value) time.Duration

ReadTimeout returns any configured Read timeout value or the default value.

func (*WithTimeouts) SetDefaultCreateTimeout

func (w *WithTimeouts) SetDefaultCreateTimeout(timeout time.Duration)

SetDefaultCreateTimeout sets the resource's default Create timeout value.

func (*WithTimeouts) SetDefaultDeleteTimeout

func (w *WithTimeouts) SetDefaultDeleteTimeout(timeout time.Duration)

SetDefaultDeleteTimeout sets the resource's default Delete timeout value.

func (*WithTimeouts) SetDefaultReadTimeout

func (w *WithTimeouts) SetDefaultReadTimeout(timeout time.Duration)

SetDefaultReadTimeout sets the resource's default Read timeout value.

func (*WithTimeouts) SetDefaultUpdateTimeout

func (w *WithTimeouts) SetDefaultUpdateTimeout(timeout time.Duration)

SetDefaultUpdateTimeout sets the resource's default Update timeout value.

func (*WithTimeouts) UpdateTimeout

func (w *WithTimeouts) UpdateTimeout(ctx context.Context, timeouts timeouts.Value) time.Duration

UpdateTimeout returns any configured Update timeout value or the default value.