generic

Documentation

Index

• Constants
• func DataSourceNotFoundDiag(err error) diag.Diagnostic
• func DesiredStateErrorDiag(source string, err error) diag.Diagnostic
• func GetCloudControlResourceDescriptionsValue(id string, descriptions []cctypes.ResourceDescription) tftypes.Value
• func Multiset() planmodifier.List
• func NewPluralDataSource(_ context.Context, optFns ...DataSourceOptionsFunc) (datasource.DataSource, error)
• func NewResource(_ context.Context, optFns ...ResourceOptionsFunc) (resource.Resource, error)
• func NewSingularDataSource(_ context.Context, optFns ...DataSourceOptionsFunc) (datasource.DataSource, error)
• func ResourceAttributeNotSetInImportStateDiag(err error) diag.Diagnostic
• func ResourceIdentifierNotFoundDiag(err error) diag.Diagnostic
• func ResourceIdentifierNotSetDiag(err error) diag.Diagnostic
• func ResourceNotFoundAfterWriteDiag(err error) diag.Diagnostic
• func ResourceNotFoundWarningDiag(err error) diag.Diagnostic
• func ServiceOperationEmptyResultDiag(service string, operation string) diag.Diagnostic
• func ServiceOperationErrorDiag(service string, operation string, err error) diag.Diagnostic
• func ServiceOperationWaiterErrorDiag(service string, operation string, err error) diag.Diagnostic
• func SetUnknownValuesFromResourceModel(ctx context.Context, state *tfsdk.State, unknowns []*tftypes.AttributePath, ...) error
• func UnknownValuePaths(_ context.Context, val tftypes.Value) ([]*tftypes.AttributePath, error)
• type DataSourceOptions
  • func (opts DataSourceOptions) WithAttributeNameMap(v map[string]string) DataSourceOptions
  • func (opts DataSourceOptions) WithCloudFormationTypeName(v string) DataSourceOptions
  • func (opts DataSourceOptions) WithTerraformSchema(v schema.Schema) DataSourceOptions
  • func (opts DataSourceOptions) WithTerraformTypeName(v string) DataSourceOptions
• type DataSourceOptionsFunc
• type ResourceOptions
  • func (opts ResourceOptions) IsImmutableType(v bool) ResourceOptions
  • func (opts ResourceOptions) WithAttributeNameMap(v map[string]string) ResourceOptions
  • func (opts ResourceOptions) WithCloudFormationTypeName(v string) ResourceOptions
  • func (opts ResourceOptions) WithConfigValidators(vs ...resource.ConfigValidator) ResourceOptions
  • func (opts ResourceOptions) WithCreateTimeoutInMinutes(v int) ResourceOptions
  • func (opts ResourceOptions) WithDeleteTimeoutInMinutes(v int) ResourceOptions
  • func (opts ResourceOptions) WithTerraformSchema(v schema.Schema) ResourceOptions
  • func (opts ResourceOptions) WithTerraformTypeName(v string) ResourceOptions
  • func (opts ResourceOptions) WithUpdateTimeoutInMinutes(v int) ResourceOptions
  • func (opts ResourceOptions) WithWriteOnlyPropertyPaths(v []string) ResourceOptions
• type ResourceOptionsFunc

Constants

const (
	LoggingKeyCFNType = "cfn_type"
)

Functions

func DataSourceNotFoundDiag

func DataSourceNotFoundDiag(err error) diag.Diagnostic

func DesiredStateErrorDiag

func DesiredStateErrorDiag(source string, err error) diag.Diagnostic

func GetCloudControlResourceDescriptionsValue

func GetCloudControlResourceDescriptionsValue(id string, descriptions []cctypes.ResourceDescription) tftypes.Value

GetCloudControlResourceDescriptionsValue returns the Terraform Value for the specified Cloud Control API ResourceDescriptions.

func Multiset

func Multiset() planmodifier.List

A multiset is an array allowing non-unique items with insertion order not significant. Multisets do not correspond directly with either Terraform Lists (insertion order is significant) or Sets (unique items). Multiset Attributes are declared as Lists with a plan modifier that suppresses semantically insignificant differences.

func NewPluralDataSource

func NewPluralDataSource(_ context.Context, optFns ...DataSourceOptionsFunc) (datasource.DataSource, error)

NewPluralDataSource returns a new plural DataSource from the specified variadic list of functional options. It's public as it's called from generated code.

func NewResource

func NewResource(_ context.Context, optFns ...ResourceOptionsFunc) (resource.Resource, error)

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

func NewSingularDataSource

func NewSingularDataSource(_ context.Context, optFns ...DataSourceOptionsFunc) (datasource.DataSource, error)

NewSingularDataSource returns a new singular DataSource from the specified variadic list of functional options. It's public as it's called from generated code.

func ResourceAttributeNotSetInImportStateDiag

func ResourceAttributeNotSetInImportStateDiag(err error) diag.Diagnostic

func ResourceIdentifierNotFoundDiag

func ResourceIdentifierNotFoundDiag(err error) diag.Diagnostic

func ResourceIdentifierNotSetDiag

func ResourceIdentifierNotSetDiag(err error) diag.Diagnostic

func ResourceNotFoundAfterWriteDiag

func ResourceNotFoundAfterWriteDiag(err error) diag.Diagnostic

func ResourceNotFoundWarningDiag

func ResourceNotFoundWarningDiag(err error) diag.Diagnostic

func ServiceOperationEmptyResultDiag

func ServiceOperationEmptyResultDiag(service string, operation string) diag.Diagnostic

func ServiceOperationErrorDiag

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

func ServiceOperationWaiterErrorDiag

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

func SetUnknownValuesFromResourceModel

func SetUnknownValuesFromResourceModel(ctx context.Context, state *tfsdk.State, unknowns []*tftypes.AttributePath, resourceModel string, cfToTfNameMap map[string]string) error

SetUnknownValuesFromResourceModel fills any unknown State values from a Cloud Control ResourceModel (string). The unknown value paths are obtained from the State via a previous call to UnknownValuePaths. Functionality is split between these 2 functions, rather than calling UnknownValuePaths from within this function, so as to avoid unnecessary Cloud Control API calls to obtain the current ResourceModel.

func UnknownValuePaths

func UnknownValuePaths(_ context.Context, val tftypes.Value) ([]*tftypes.AttributePath, error)

UnknownValuePaths returns all the paths to all the unknown values in the specified Terraform Value.

Types

type DataSourceOptions

type DataSourceOptions []DataSourceOptionsFunc

func (DataSourceOptions) WithAttributeNameMap

func (opts DataSourceOptions) WithAttributeNameMap(v map[string]string) DataSourceOptions

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 (DataSourceOptions) WithCloudFormationTypeName

func (opts DataSourceOptions) WithCloudFormationTypeName(v string) DataSourceOptions

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 (DataSourceOptions) WithTerraformSchema

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

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 (DataSourceOptions) WithTerraformTypeName

func (opts DataSourceOptions) WithTerraformTypeName(v string) DataSourceOptions

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.

type DataSourceOptionsFunc

type DataSourceOptionsFunc func(*genericDataSource) error

DataSourceOptionsFunc is a type alias for a data source type functional option.

type ResourceOptions

type ResourceOptions []ResourceOptionsFunc

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

func (ResourceOptions) IsImmutableType

func (opts ResourceOptions) IsImmutableType(v bool) ResourceOptions

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 (ResourceOptions) WithAttributeNameMap

func (opts ResourceOptions) WithAttributeNameMap(v map[string]string) ResourceOptions

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 (ResourceOptions) WithCloudFormationTypeName

func (opts ResourceOptions) WithCloudFormationTypeName(v string) ResourceOptions

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 (ResourceOptions) WithConfigValidators

func (opts ResourceOptions) WithConfigValidators(vs ...resource.ConfigValidator) ResourceOptions

WithConfigValidators is a helper function to construct functional options that set a resource type's config validators, 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 (ResourceOptions) WithCreateTimeoutInMinutes

func (opts ResourceOptions) WithCreateTimeoutInMinutes(v int) ResourceOptions

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 (ResourceOptions) WithDeleteTimeoutInMinutes

func (opts ResourceOptions) WithDeleteTimeoutInMinutes(v int) ResourceOptions

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 (ResourceOptions) WithTerraformSchema

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

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 (ResourceOptions) WithTerraformTypeName

func (opts ResourceOptions) WithTerraformTypeName(v string) ResourceOptions

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 (ResourceOptions) WithUpdateTimeoutInMinutes

func (opts ResourceOptions) WithUpdateTimeoutInMinutes(v int) ResourceOptions

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 (ResourceOptions) WithWriteOnlyPropertyPaths

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

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 ResourceOptionsFunc

type ResourceOptionsFunc func(*genericResource) error

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