Documentation ¶
Index ¶
- Constants
- func CopyValueAtPath(ctx context.Context, dst, src *tfsdk.State, path *tftypes.AttributePath) error
- func DataSourceNotFoundDiag(err error) diag.Diagnostic
- func DefaultValue(val attr.Value) tfsdk.AttributePlanModifier
- func DesiredStateErrorDiag(source string, err error) diag.Diagnostic
- func GetCloudControlResourceDescriptionsValue(id string, descriptions []cctypes.ResourceDescription) tftypes.Value
- func Multiset() tfsdk.AttributePlanModifier
- func NewPluralDataSourceType(_ context.Context, optFns ...DataSourceTypeOptionsFunc) (tfsdk.DataSourceType, error)
- func NewResourceType(_ context.Context, optFns ...ResourceTypeOptionsFunc) (tfsdk.ResourceType, error)
- func NewSingularDataSourceType(_ context.Context, optFns ...DataSourceTypeOptionsFunc) (tfsdk.DataSourceType, 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(ctx context.Context, val tftypes.Value) ([]*tftypes.AttributePath, error)
- type DataSourceTypeOptions
- func (opts DataSourceTypeOptions) WithAttributeNameMap(v map[string]string) DataSourceTypeOptions
- func (opts DataSourceTypeOptions) WithCloudFormationTypeName(v string) DataSourceTypeOptions
- func (opts DataSourceTypeOptions) WithTerraformSchema(v tfsdk.Schema) DataSourceTypeOptions
- func (opts DataSourceTypeOptions) WithTerraformTypeName(v string) DataSourceTypeOptions
- type DataSourceTypeOptionsFunc
- 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
Constants ¶
const (
LoggingKeyCFNType = "cfn_type"
)
Variables ¶
This section is empty.
Functions ¶
func CopyValueAtPath ¶
CopyValueAtPath copies the value at a specified path from source State to destination State.
func DataSourceNotFoundDiag ¶ added in v0.0.7
func DataSourceNotFoundDiag(err error) diag.Diagnostic
func DefaultValue ¶ added in v0.0.9
func DefaultValue(val attr.Value) tfsdk.AttributePlanModifier
DefaultValue return an AttributePlanModifier that sets the specified value if the planned value is Null and the current value is the default.
func DesiredStateErrorDiag ¶
func DesiredStateErrorDiag(source string, err error) diag.Diagnostic
func GetCloudControlResourceDescriptionsValue ¶ added in v0.0.10
func GetCloudControlResourceDescriptionsValue(id string, descriptions []cctypes.ResourceDescription) tftypes.Value
GetCloudControlResourceDescriptionsValue returns the Terraform Value for the specified Cloud Control API ResourceDescriptions.
func Multiset ¶ added in v0.0.9
func Multiset() tfsdk.AttributePlanModifier
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 NewPluralDataSourceType ¶ added in v0.0.6
func NewPluralDataSourceType(_ context.Context, optFns ...DataSourceTypeOptionsFunc) (tfsdk.DataSourceType, error)
NewPluralDataSourceType returns a new pluralDataSourceType from the specified variadic list of functional options. It's public as it's called from generated code.
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 NewSingularDataSourceType ¶ added in v0.0.7
func NewSingularDataSourceType(_ context.Context, optFns ...DataSourceTypeOptionsFunc) (tfsdk.DataSourceType, error)
NewSingularDataSourceType returns a new singularDataSourceType from the specified variadic list of functional options. It's public as it's called from generated code.
func ResourceAttributeNotSetInImportStateDiag ¶ added in v0.0.11
func ResourceAttributeNotSetInImportStateDiag(err error) diag.Diagnostic
func ResourceIdentifierNotFoundDiag ¶
func ResourceIdentifierNotFoundDiag(err error) diag.Diagnostic
func ResourceIdentifierNotSetDiag ¶
func ResourceIdentifierNotSetDiag(err error) diag.Diagnostic
func ResourceNotFoundAfterWriteDiag ¶ added in v0.0.14
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 ¶ added in v0.10.0
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 ¶ added in v0.10.0
UnknownValuePaths returns all the paths to all the unknown values in the specified Terraform Value.
Types ¶
type DataSourceTypeOptions ¶ added in v0.0.6
type DataSourceTypeOptions []DataSourceTypeOptionsFunc
func (DataSourceTypeOptions) WithAttributeNameMap ¶ added in v0.0.7
func (opts DataSourceTypeOptions) WithAttributeNameMap(v map[string]string) DataSourceTypeOptions
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 (DataSourceTypeOptions) WithCloudFormationTypeName ¶ added in v0.0.7
func (opts DataSourceTypeOptions) WithCloudFormationTypeName(v string) DataSourceTypeOptions
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 (DataSourceTypeOptions) WithTerraformSchema ¶ added in v0.0.7
func (opts DataSourceTypeOptions) WithTerraformSchema(v tfsdk.Schema) DataSourceTypeOptions
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 (DataSourceTypeOptions) WithTerraformTypeName ¶ added in v0.0.7
func (opts DataSourceTypeOptions) WithTerraformTypeName(v string) DataSourceTypeOptions
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 DataSourceTypeOptionsFunc ¶ added in v0.0.6
type DataSourceTypeOptionsFunc func(*dataSourceType) error
DataSourceTypeOptionsFunc is a type alias for a data source type functional option.
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.