modifiers

package
v0.9.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 5, 2022 License: MIT Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BoolDefaultModifier

type BoolDefaultModifier struct {
	Default bool
}

BoolDefaultModifier is a plan modifier that sets a default value for a types.BoolType attribute when it is not configured. The attribute must be marked as Optional and Computed. When setting the state during the resource Create, Read, or Update methods, this default value must also be included or the Terraform CLI will generate an error.

func NewBoolDefaultModifier

func NewBoolDefaultModifier(defaultValue bool) BoolDefaultModifier

func (BoolDefaultModifier) Description

func (m BoolDefaultModifier) Description(_ context.Context) string

Description returns a plain text description of the validator's behavior, suitable for a practitioner to understand its impact.

func (BoolDefaultModifier) MarkdownDescription

func (m BoolDefaultModifier) MarkdownDescription(_ context.Context) string

MarkdownDescription returns a markdown formatted description of the validator's behavior, suitable for a practitioner to understand its impact.

func (BoolDefaultModifier) Modify

Modify runs the logic of the plan modifier. Access to the configuration, plan, and state is available in `req`, while `resp` contains fields for updating the planned value, triggering resource replacement, and returning diagnostics.

type Int64DefaultModifier

type Int64DefaultModifier struct {
	Default int64
}

Int64DefaultModifier is a plan modifier that sets a default value for a types.Int64Type attribute when it is not configured. The attribute must be marked as Optional and Computed. When setting the state during the resource Create, Read, or Update methods, this default value must also be included or the Terraform CLI will generate an error.

func NewInt64DefaultModifier

func NewInt64DefaultModifier(defaultValue int64) Int64DefaultModifier

func (Int64DefaultModifier) Description

func (m Int64DefaultModifier) Description(_ context.Context) string

Description returns a plain text description of the validator's behavior, suitable for a practitioner to understand its impact.

func (Int64DefaultModifier) MarkdownDescription

func (m Int64DefaultModifier) MarkdownDescription(_ context.Context) string

MarkdownDescription returns a markdown formatted description of the validator's behavior, suitable for a practitioner to understand its impact.

func (Int64DefaultModifier) Modify

Modify runs the logic of the plan modifier. Access to the configuration, plan, and state is available in `req`, while `resp` contains fields for updating the planned value, triggering resource replacement, and returning diagnostics.

type StringDefaultModifier

type StringDefaultModifier struct {
	Default string
}

StringDefaultModifier is a plan modifier that sets a default value for a types.StringType attribute when it is not configured. The attribute must be marked as Optional and Computed. When setting the state during the resource Create, Read, or Update methods, this default value must also be included or the Terraform CLI will generate an error.

func NewStringDefaultModifier

func NewStringDefaultModifier(defaultValue string) StringDefaultModifier

func (StringDefaultModifier) Description

func (m StringDefaultModifier) Description(_ context.Context) string

Description returns a plain text description of the validator's behavior, suitable for a practitioner to understand its impact.

func (StringDefaultModifier) MarkdownDescription

func (m StringDefaultModifier) MarkdownDescription(_ context.Context) string

MarkdownDescription returns a markdown formatted description of the validator's behavior, suitable for a practitioner to understand its impact.

func (StringDefaultModifier) Modify

Modify runs the logic of the plan modifier. Access to the configuration, plan, and state is available in `req`, while `resp` contains fields for updating the planned value, triggering resource replacement, and returning diagnostics.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL