generic

Documentation

Index

• func CopyValueAtPath(ctx context.Context, dst, src *tfsdk.State, path *tftypes.AttributePath) error
• func DesiredStateErrorDiag(source string, err error) *tfprotov6.Diagnostic
• func GetCloudFormationDesiredState(ctx context.Context, val tftypes.Value) (string, error)
• func GetCloudFormationDesiredStateRaw(_ context.Context, val tftypes.Value) (map[string]interface{}, error)
• func GetCloudFormationResourceModelRawValue(ctx context.Context, schema *schema.Schema, ...) (tftypes.Value, error)
• func GetCloudFormationResourceModelValue(ctx context.Context, schema *schema.Schema, resourceModel string) (tftypes.Value, error)
• func NewResourceType(_ context.Context, optFns ...ResourceTypeOptionsFunc) (tfsdk.ResourceType, error)
• func ResourceIdentifierNotFoundDiag(err error) *tfprotov6.Diagnostic
• func ResourceIdentifierNotSetDiag(err error) *tfprotov6.Diagnostic
• func ResourceNotFoundAfterCreationDiag(err error) *tfprotov6.Diagnostic
• func ResourceNotFoundWarningDiag(err error) *tfprotov6.Diagnostic
• func ServiceOperationEmptyResultDiag(service string, operation string) *tfprotov6.Diagnostic
• func ServiceOperationErrorDiag(service string, operation string, err error) *tfprotov6.Diagnostic
• func ServiceOperationWaiterErrorDiag(service string, operation string, err error) *tfprotov6.Diagnostic
• func SetUnknownValuesFromCloudFormationResourceModel(ctx context.Context, state *tfsdk.State, resourceModel string) error
• func SetUnknownValuesFromCloudFormationResourceModelRaw(ctx context.Context, state *tfsdk.State, resourceModel map[string]interface{}) error
• type ResourceTypeOptions
  • func (opts ResourceTypeOptions) IsImmutableType(v bool) ResourceTypeOptions
  • func (opts ResourceTypeOptions) WithCloudFormationTypeName(v string) ResourceTypeOptions
  • func (opts ResourceTypeOptions) WithCreateTimeoutInMinutes(v int) ResourceTypeOptions
  • func (opts ResourceTypeOptions) WithDeleteTimeoutInMinutes(v int) ResourceTypeOptions
  • func (opts ResourceTypeOptions) WithTerraformSchema(v schema.Schema) ResourceTypeOptions
  • func (opts ResourceTypeOptions) WithTerraformTypeName(v string) ResourceTypeOptions
  • func (opts ResourceTypeOptions) WithUpdateTimeoutInMinutes(v int) ResourceTypeOptions
  • func (opts ResourceTypeOptions) WithWriteOnlyPropertyPaths(v []string) ResourceTypeOptions
• type ResourceTypeOptionsFunc
  • func IsImmutableType(v bool) ResourceTypeOptionsFunc
  • func WithCloudFormationTypeName(v string) ResourceTypeOptionsFunc
  • func WithCreateTimeoutInMinutes(v int) ResourceTypeOptionsFunc
  • func WithDeleteTimeoutInMinutes(v int) ResourceTypeOptionsFunc
  • func WithTerraformSchema(v schema.Schema) ResourceTypeOptionsFunc
  • func WithTerraformTypeName(v string) ResourceTypeOptionsFunc
  • func WithUpdateTimeoutInMinutes(v int) ResourceTypeOptionsFunc
  • func WithWriteOnlyPropertyPaths(v []string) ResourceTypeOptionsFunc
• type UnknownValuePath
  • func GetUnknownValuePaths(_ context.Context, val tftypes.Value) ([]UnknownValuePath, error)

Functions

func CopyValueAtPath

func CopyValueAtPath(ctx context.Context, dst, src *tfsdk.State, path *tftypes.AttributePath) error

CopyValueAtPath copies the value at a specified path from source State to destination State.

func DesiredStateErrorDiag

func DesiredStateErrorDiag(source string, err error) *tfprotov6.Diagnostic

func GetCloudFormationDesiredState

func GetCloudFormationDesiredState(ctx context.Context, val tftypes.Value) (string, error)

GetCloudFormationDesiredState returns the string representing CloudFormation DesiredState from a Terraform Value.

func GetCloudFormationDesiredStateRaw

func GetCloudFormationDesiredStateRaw(_ context.Context, val tftypes.Value) (map[string]interface{}, error)

GetCloudFormationDesiredStateRaw returns the raw map[string]interface{} representing CloudFormation DesiredState from a Terraform Plan.

func GetCloudFormationResourceModelRawValue

func GetCloudFormationResourceModelRawValue(ctx context.Context, schema *schema.Schema, resourceModel map[string]interface{}) (tftypes.Value, error)

GetCloudFormationResourceModelRawValue returns the Terraform Value for the specified CloudFormation ResourceModel (raw map[string]interface{}).

func GetCloudFormationResourceModelValue

func GetCloudFormationResourceModelValue(ctx context.Context, schema *schema.Schema, resourceModel string) (tftypes.Value, error)

GetCloudFormationResourceModelValue returns the Terraform Value for the specified CloudFormation ResourceModel (string).

func NewResourceType

func NewResourceType(_ context.Context, optFns ...ResourceTypeOptionsFunc) (tfsdk.ResourceType, error)

NewResourceType returns a new ResourceType from the specified varidaic list of functional options. It's public as it's called from generated code.

func ResourceIdentifierNotFoundDiag

func ResourceIdentifierNotFoundDiag(err error) *tfprotov6.Diagnostic

func ResourceIdentifierNotSetDiag

func ResourceIdentifierNotSetDiag(err error) *tfprotov6.Diagnostic

func ResourceNotFoundAfterCreationDiag

func ResourceNotFoundAfterCreationDiag(err error) *tfprotov6.Diagnostic

func ResourceNotFoundWarningDiag

func ResourceNotFoundWarningDiag(err error) *tfprotov6.Diagnostic

func ServiceOperationEmptyResultDiag

func ServiceOperationEmptyResultDiag(service string, operation string) *tfprotov6.Diagnostic

func ServiceOperationErrorDiag

func ServiceOperationErrorDiag(service string, operation string, err error) *tfprotov6.Diagnostic

func ServiceOperationWaiterErrorDiag

func ServiceOperationWaiterErrorDiag(service string, operation string, err error) *tfprotov6.Diagnostic

func SetUnknownValuesFromCloudFormationResourceModel

func SetUnknownValuesFromCloudFormationResourceModel(ctx context.Context, state *tfsdk.State, resourceModel string) error

SetUnknownValuesFromCloudFormationResourceModel fills any unknown State values from a CloudFormation ResourceModel (string).

func SetUnknownValuesFromCloudFormationResourceModelRaw

func SetUnknownValuesFromCloudFormationResourceModelRaw(ctx context.Context, state *tfsdk.State, resourceModel map[string]interface{}) error

SetUnknownValuesFromCloudFormationResourceModelRaw fills any unknown State values from a CloudFormation ResourceModel (raw map[string]interface{}).

Types

type ResourceTypeOptions

type ResourceTypeOptions []ResourceTypeOptionsFunc

ResourceTypeOptions is a type alias for a slice of resource type functional options.

func (ResourceTypeOptions) IsImmutableType

func (opts ResourceTypeOptions) IsImmutableType(v bool) ResourceTypeOptions

IsImmutableType is a helper function to construct functional options that set a resource type's Terraform immutability flag, append that function to the current slice of functional options and return the new slice of options. It is intended to be chained with other similar helper functions in a builder pattern.

func (ResourceTypeOptions) WithCloudFormationTypeName

func (opts ResourceTypeOptions) WithCloudFormationTypeName(v string) ResourceTypeOptions

WithCloudFormationTypeName is a helper function to construct functional options that set a resource type's CloudFormation type name, append that function to the current slice of functional options and return the new slice of options. It is intended to be chained with other similar helper functions in a builder pattern.

func (ResourceTypeOptions) WithCreateTimeoutInMinutes

func (opts ResourceTypeOptions) WithCreateTimeoutInMinutes(v int) ResourceTypeOptions

WithCreateTimeoutInMinutes is a helper function to construct functional options that set a resource type's create timeout, append that function to the current slice of functional options and return the new slice of options. It is intended to be chained with other similar helper functions in a builder pattern.

func (ResourceTypeOptions) WithDeleteTimeoutInMinutes

func (opts ResourceTypeOptions) WithDeleteTimeoutInMinutes(v int) ResourceTypeOptions

WithDeleteTimeoutInMinutes is a helper function to construct functional options that set a resource type's delete timeout, append that function to the current slice of functional options and return the new slice of options. It is intended to be chained with other similar helper functions in a builder pattern.

func (ResourceTypeOptions) WithTerraformSchema

func (opts ResourceTypeOptions) WithTerraformSchema(v schema.Schema) ResourceTypeOptions

WithTerraformSchema is a helper function to construct functional options that set a resource type's Terraform schema, append that function to the current slice of functional options and return the new slice of options. It is intended to be chained with other similar helper functions in a builder pattern.

func (ResourceTypeOptions) WithTerraformTypeName

func (opts ResourceTypeOptions) WithTerraformTypeName(v string) ResourceTypeOptions

WithTerraformTypeName is a helper function to construct functional options that set a resource type's Terraform type name, append that function to the current slice of functional options and return the new slice of options. It is intended to be chained with other similar helper functions in a builder pattern.

func (ResourceTypeOptions) WithUpdateTimeoutInMinutes

func (opts ResourceTypeOptions) WithUpdateTimeoutInMinutes(v int) ResourceTypeOptions

WithUpdateTimeoutInMinutes is a helper function to construct functional options that set a resource type's update timeout, append that function to the current slice of functional options and return the new slice of options. It is intended to be chained with other similar helper functions in a builder pattern.

func (ResourceTypeOptions) WithWriteOnlyPropertyPaths

func (opts ResourceTypeOptions) WithWriteOnlyPropertyPaths(v []string) ResourceTypeOptions

WithWriteOnlyPropertyPaths is a helper function to construct functional options that set a resource type's write-only property paths, append that function to the current slice of functional options and return the new slice of options. It is intended to be chained with other similar helper functions in a builder pattern.

type ResourceTypeOptionsFunc

type ResourceTypeOptionsFunc func(*resourceType) error

ResourceTypeOptionsFunc is a type alias for a resource type functional option.

func IsImmutableType

func IsImmutableType(v bool) ResourceTypeOptionsFunc

IsImmutableType is a helper function to construct functional options that set a resource type's immutability flag. If multiple IsImmutableType calls are made, the last call overrides the previous calls' values.

func WithCloudFormationTypeName

func WithCloudFormationTypeName(v string) ResourceTypeOptionsFunc

WithCloudFormationTypeName is a helper function to construct functional options that set a resource type's CloudFormation type name. If multiple WithCloudFormationTypeName calls are made, the last call overrides the previous calls' values.

func WithCreateTimeoutInMinutes

func WithCreateTimeoutInMinutes(v int) ResourceTypeOptionsFunc

WithCreateTimeoutInMinutes is a helper function to construct functional options that set a resource type's create timeout (in minutes). If multiple WithCreateTimeoutInMinutes calls are made, the last call overrides the previous calls' values.

func WithDeleteTimeoutInMinutes

func WithDeleteTimeoutInMinutes(v int) ResourceTypeOptionsFunc

WithDeleteTimeoutInMinutes is a helper function to construct functional options that set a resource type's delete timeout (in minutes). If multiple WithDeleteTimeoutInMinutes calls are made, the last call overrides the previous calls' values.

func WithTerraformSchema

func WithTerraformSchema(v schema.Schema) ResourceTypeOptionsFunc

WithTerraformSchema is a helper function to construct functional options that set a resource type's Terraform schema. If multiple WithTerraformSchema calls are made, the last call overrides the previous calls' values.

func WithTerraformTypeName

func WithTerraformTypeName(v string) ResourceTypeOptionsFunc

WithTerraformTypeName is a helper function to construct functional options that set a resource type's Terraform type name. If multiple WithTerraformTypeName calls are made, the last call overrides the previous calls' values.

func WithUpdateTimeoutInMinutes

func WithUpdateTimeoutInMinutes(v int) ResourceTypeOptionsFunc

WithUpdateTimeoutInMinutes is a helper function to construct functional options that set a resource type's update timeout (in minutes). If multiple WithUpdateTimeoutInMinutes calls are made, the last call overrides the previous calls' values.

func WithWriteOnlyPropertyPaths

func WithWriteOnlyPropertyPaths(v []string) ResourceTypeOptionsFunc

WithWriteOnlyPropertyPaths is a helper function to construct functional options that set a resource type's write-only property paths (JSON Pointer). If multiple WithWriteOnlyPropertyPaths calls are made, the last call overrides the previous calls' values.

type UnknownValuePath

type UnknownValuePath struct {
	InTerraformState              *tftypes.AttributePath
	InCloudFormationResourceModel *tftypes.AttributePath
}

UnknownValuePath represents the path to an unknown (!val.IsKnown()) value. It holds paths in both the Terraform State and CloudFormation ResourceModel (raw map[string]interface{}).

func GetUnknownValuePaths

func GetUnknownValuePaths(_ context.Context, val tftypes.Value) ([]UnknownValuePath, error)

GetUnknownValuePaths returns all the UnknownValuePaths for the specified value.