Documentation
¶
Index ¶
- func CopyValueAtPath(ctx context.Context, dst, src *tfsdk.State, path *tftypes.AttributePath) error
- func DesiredStateErrorDiag(source string, err error) *tfprotov6.Diagnostic
- 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 Unknowns(ctx context.Context, val tftypes.Value, tfToCfNameMap map[string]string) (unknowns, error)
- type ResourceTypeOptions
- func (opts ResourceTypeOptions) IsImmutableType(v bool) ResourceTypeOptions
- func (opts ResourceTypeOptions) WithAttributeNameMap(v map[string]string) 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) WithRequiredAttributesValidators(v ...validate.RequiredAttributesFunc) ResourceTypeOptions
- func (opts ResourceTypeOptions) WithSyntheticIDAttribute(v bool) ResourceTypeOptions
- func (opts ResourceTypeOptions) WithTerraformSchema(v tfsdk.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 WithAttributeNameMap(v map[string]string) ResourceTypeOptionsFunc
- func WithCloudFormationTypeName(v string) ResourceTypeOptionsFunc
- func WithCreateTimeoutInMinutes(v int) ResourceTypeOptionsFunc
- func WithDeleteTimeoutInMinutes(v int) ResourceTypeOptionsFunc
- func WithRequiredAttributesValidators(fs ...validate.RequiredAttributesFunc) ResourceTypeOptionsFunc
- func WithSyntheticIDAttribute(v bool) ResourceTypeOptionsFunc
- func WithTerraformSchema(v tfsdk.Schema) ResourceTypeOptionsFunc
- func WithTerraformTypeName(v string) ResourceTypeOptionsFunc
- func WithUpdateTimeoutInMinutes(v int) ResourceTypeOptionsFunc
- func WithWriteOnlyPropertyPaths(v []string) ResourceTypeOptionsFunc
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CopyValueAtPath ¶
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 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
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) WithAttributeNameMap ¶ added in v0.0.5
func (opts ResourceTypeOptions) WithAttributeNameMap(v map[string]string) ResourceTypeOptions
WithAttributeNameMap is a helper function to construct functional options that set a resource type's attribute name map, 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) WithRequiredAttributesValidators ¶ added in v0.0.5
func (opts ResourceTypeOptions) WithRequiredAttributesValidators(v ...validate.RequiredAttributesFunc) ResourceTypeOptions
WithRequiredAttributesValidator is a helper function to construct functional options that set a resource type's required attribyte validator, 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) WithSyntheticIDAttribute ¶ added in v0.0.5
func (opts ResourceTypeOptions) WithSyntheticIDAttribute(v bool) ResourceTypeOptions
WithSyntheticIDAttribute is a helper function to construct functional options that set a resource type's synthetic ID attribute 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) WithTerraformSchema ¶
func (opts ResourceTypeOptions) WithTerraformSchema(v tfsdk.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 WithAttributeNameMap ¶ added in v0.0.5
func WithAttributeNameMap(v map[string]string) ResourceTypeOptionsFunc
WithAttributeNameMap is a helper function to construct functional options that set a resource type's attribute name maps. If multiple WithAttributeNameMap 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 WithRequiredAttributesValidators ¶ added in v0.0.5
func WithRequiredAttributesValidators(fs ...validate.RequiredAttributesFunc) ResourceTypeOptionsFunc
WithRequiredAttributesValidators is a helper function to construct functional options that set a resource type's required attributes validators. If multiple WithDeleteTimeoutInMinutes calls are made, the last call overrides the previous calls' values.
func WithSyntheticIDAttribute ¶ added in v0.0.5
func WithSyntheticIDAttribute(v bool) ResourceTypeOptionsFunc
WithSyntheticIDAttribute is a helper function to construct functional options that set a resource type's synthetic ID attribute flag. If multiple WithSyntheticIDAttribute calls are made, the last call overrides the previous calls' values.
func WithTerraformSchema ¶
func WithTerraformSchema(v tfsdk.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.
Source Files