framework

Documentation

Index

• func GetDataSourceMeta(req datasource.ConfigureRequest, resp *datasource.ConfigureResponse) *config.Config
• func GetResourceMeta(req resource.ConfigureRequest, resp *resource.ConfigureResponse) *config.Config
• func IDAttribute(description string) schema.StringAttribute
• func IDAttributeDefaultDescription() schema.StringAttribute
• type BaseDataSource
  • func NewBaseDataSource(cfg BaseDataSourceConfig) BaseDataSource
  • func (r *BaseDataSource) Configure(ctx context.Context, req datasource.ConfigureRequest, ...)
  • func (r *BaseDataSource) Metadata(ctx context.Context, req datasource.MetadataRequest, ...)
  • func (r *BaseDataSource) Schema(ctx context.Context, req datasource.SchemaRequest, ...)
• type BaseDataSourceConfig
• type BaseResource
  • func NewBaseResource(cfg BaseResourceConfig) BaseResource
  • func (r *BaseResource) Configure(ctx context.Context, req resource.ConfigureRequest, ...)
  • func (r *BaseResource) ImportState(ctx context.Context, req resource.ImportStateRequest, ...)
  • func (r *BaseResource) Metadata(ctx context.Context, req resource.MetadataRequest, ...)
  • func (r *BaseResource) Schema(ctx context.Context, req resource.SchemaRequest, resp *resource.SchemaResponse)
• type BaseResourceConfig
• 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 GetDataSourceMeta

func GetDataSourceMeta(
	req datasource.ConfigureRequest,
	resp *datasource.ConfigureResponse,
) *config.Config

func GetResourceMeta

func GetResourceMeta(
	req resource.ConfigureRequest,
	resp *resource.ConfigureResponse,
) *config.Config

func IDAttribute

func IDAttribute(description string) schema.StringAttribute

func IDAttributeDefaultDescription

func IDAttributeDefaultDescription() schema.StringAttribute

Types

type BaseDataSource

type BaseDataSource struct {
	Config BaseDataSourceConfig
	Meta   *config.Config
}

BaseDataSource contains various re-usable fields and methods intended for use in data source implementations by composition.

func NewBaseDataSource

func NewBaseDataSource(cfg BaseDataSourceConfig) BaseDataSource

NewBaseDataSource returns a new instance of the BaseDataSource struct for cleaner initialization.

func (*BaseDataSource) Configure

func (r *BaseDataSource) Configure(
	ctx context.Context,
	req datasource.ConfigureRequest,
	resp *datasource.ConfigureResponse,
)

func (*BaseDataSource) Metadata

func (r *BaseDataSource) Metadata(
	ctx context.Context,
	req datasource.MetadataRequest,
	resp *datasource.MetadataResponse,
)

func (*BaseDataSource) Schema

func (r *BaseDataSource) Schema(
	ctx context.Context,
	req datasource.SchemaRequest,
	resp *datasource.SchemaResponse,
)

type BaseDataSourceConfig

type BaseDataSourceConfig struct {
	Name string

	// Optional
	Schema *schema.Schema
}

BaseDataSourceConfig contains all configurable base resource fields.

type BaseResource

type BaseResource struct {
	Config BaseResourceConfig
	Meta   *config.Config
}

BaseResource contains various re-usable fields and methods intended for use in resource implementations by composition.

func NewBaseResource

func NewBaseResource(cfg BaseResourceConfig) BaseResource

NewBaseResource returns a new instance of the BaseResource struct for cleaner initialization.

func (*BaseResource) Configure

func (r *BaseResource) Configure(
	ctx context.Context,
	req resource.ConfigureRequest,
	resp *resource.ConfigureResponse,
)

func (*BaseResource) ImportState

func (r *BaseResource) ImportState(
	ctx context.Context,
	req resource.ImportStateRequest,
	resp *resource.ImportStateResponse,
)

ImportState should be overridden for resources with complex read logic (e.g. parent ID).

func (*BaseResource) Metadata

func (r *BaseResource) Metadata(
	ctx context.Context,
	req resource.MetadataRequest,
	resp *resource.MetadataResponse,
)

func (*BaseResource) Schema

func (r *BaseResource) Schema(
	ctx context.Context,
	req resource.SchemaRequest,
	resp *resource.SchemaResponse,
)

type BaseResourceConfig

type BaseResourceConfig struct {
	Name   string
	IDAttr string

	// Optional
	Schema *schema.Schema
}

BaseResourceConfig contains all configurable base resource fields.

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.