datacoderparameter

package
v0.0.275 Latest Latest
Warning

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

 Go to latest Published: Mar 11, 2024 License: AGPL-3.0 Imports: 7 Imported by: 0

README

data_coder_parameter

Refer to the Terraform Registry for docs: data_coder_parameter.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DataCoderParameter_GenerateConfigForImport 

func DataCoderParameter_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource

Generates CDKTF code for importing a DataCoderParameter resource upon running "cdktf plan <stack-name>".

func DataCoderParameter_IsConstruct 

func DataCoderParameter_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

Returns: true if `x` is an object created from a class which extends `Construct`.

func DataCoderParameter_IsTerraformDataSource 

func DataCoderParameter_IsTerraformDataSource(x interface{}) *bool

Experimental.

func DataCoderParameter_IsTerraformElement 

func DataCoderParameter_IsTerraformElement(x interface{}) *bool

Experimental.

func DataCoderParameter_TfResourceType 

func DataCoderParameter_TfResourceType() *string

func NewDataCoderParameterOptionList_Override 

func NewDataCoderParameterOptionList_Override(d DataCoderParameterOptionList, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, wrapsSet *bool)

func NewDataCoderParameterOptionOutputReference_Override 

func NewDataCoderParameterOptionOutputReference_Override(d DataCoderParameterOptionOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, complexObjectIndex *float64, complexObjectIsFromSet *bool)

func NewDataCoderParameterValidationOutputReference_Override 

func NewDataCoderParameterValidationOutputReference_Override(d DataCoderParameterValidationOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string)

func NewDataCoderParameter_Override 

func NewDataCoderParameter_Override(d DataCoderParameter, scope constructs.Construct, id *string, config *DataCoderParameterConfig)

Create a new {@link https://registry.terraform.io/providers/coder/coder/0.13.0/docs/data-sources/parameter coder_parameter} Data Source.

Types

type DataCoderParameter 

type DataCoderParameter interface {
	cdktf.TerraformDataSource
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Count() interface{}
	// Experimental.
	SetCount(val interface{})
	Default() *string
	SetDefault(val *string)
	DefaultInput() *string
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(val *[]*string)
	Description() *string
	SetDescription(val *string)
	DescriptionInput() *string
	DisplayName() *string
	SetDisplayName(val *string)
	DisplayNameInput() *string
	Ephemeral() interface{}
	SetEphemeral(val interface{})
	EphemeralInput() interface{}
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	Icon() *string
	SetIcon(val *string)
	IconInput() *string
	Id() *string
	SetId(val *string)
	IdInput() *string
	// Experimental.
	Lifecycle() *cdktf.TerraformResourceLifecycle
	// Experimental.
	SetLifecycle(val *cdktf.TerraformResourceLifecycle)
	Mutable() interface{}
	SetMutable(val interface{})
	MutableInput() interface{}
	Name() *string
	SetName(val *string)
	NameInput() *string
	// The tree node.
	Node() constructs.Node
	Option() DataCoderParameterOptionList
	Optional() cdktf.IResolvable
	OptionInput() interface{}
	Order() *float64
	SetOrder(val *float64)
	OrderInput() *float64
	// Experimental.
	Provider() cdktf.TerraformProvider
	// Experimental.
	SetProvider(val cdktf.TerraformProvider)
	// Experimental.
	RawOverrides() interface{}
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformMetaArguments() *map[string]interface{}
	// Experimental.
	TerraformResourceType() *string
	Type() *string
	SetType(val *string)
	TypeInput() *string
	Validation() DataCoderParameterValidationOutputReference
	ValidationInput() *DataCoderParameterValidation
	Value() *string
	// Experimental.
	AddOverride(path *string, value interface{})
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	PutOption(value interface{})
	PutValidation(value *DataCoderParameterValidation)
	ResetDefault()
	ResetDescription()
	ResetDisplayName()
	ResetEphemeral()
	ResetIcon()
	ResetId()
	ResetMutable()
	ResetOption()
	ResetOrder()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetType()
	ResetValidation()
	SynthesizeAttributes() *map[string]interface{}
	SynthesizeHclAttributes() *map[string]interface{}
	// Adds this resource to the terraform JSON output.
	// Experimental.
	ToHclTerraform() interface{}
	// Experimental.
	ToMetadata() interface{}
	// Returns a string representation of this construct.
	ToString() *string
	// Adds this resource to the terraform JSON output.
	// Experimental.
	ToTerraform() interface{}
}

Represents a {@link https://registry.terraform.io/providers/coder/coder/0.13.0/docs/data-sources/parameter coder_parameter}.

func NewDataCoderParameter 

func NewDataCoderParameter(scope constructs.Construct, id *string, config *DataCoderParameterConfig) DataCoderParameter

Create a new {@link https://registry.terraform.io/providers/coder/coder/0.13.0/docs/data-sources/parameter coder_parameter} Data Source.

type DataCoderParameterConfig 

type DataCoderParameterConfig struct {
	// Experimental.
	Connection interface{} `field:"optional" json:"connection" yaml:"connection"`
	// Experimental.
	Count interface{} `field:"optional" json:"count" yaml:"count"`
	// Experimental.
	DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"`
	// Experimental.
	ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"`
	// Experimental.
	Lifecycle *cdktf.TerraformResourceLifecycle `field:"optional" json:"lifecycle" yaml:"lifecycle"`
	// Experimental.
	Provider cdktf.TerraformProvider `field:"optional" json:"provider" yaml:"provider"`
	// Experimental.
	Provisioners *[]interface{} `field:"optional" json:"provisioners" yaml:"provisioners"`
	// The name of the parameter. If this is changed, developers will be re-prompted for a new value.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/coder/coder/0.13.0/docs/data-sources/parameter#name DataCoderParameter#name}
	Name *string `field:"required" json:"name" yaml:"name"`
	// A default value for the parameter.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/coder/coder/0.13.0/docs/data-sources/parameter#default DataCoderParameter#default}
	Default *string `field:"optional" json:"default" yaml:"default"`
	// Describe what this parameter does.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/coder/coder/0.13.0/docs/data-sources/parameter#description DataCoderParameter#description}
	Description *string `field:"optional" json:"description" yaml:"description"`
	// The displayed name of the parameter as it will appear in the interface.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/coder/coder/0.13.0/docs/data-sources/parameter#display_name DataCoderParameter#display_name}
	DisplayName *string `field:"optional" json:"displayName" yaml:"displayName"`
	// The value of an ephemeral parameter will not be preserved between consecutive workspace builds.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/coder/coder/0.13.0/docs/data-sources/parameter#ephemeral DataCoderParameter#ephemeral}
	Ephemeral interface{} `field:"optional" json:"ephemeral" yaml:"ephemeral"`
	// A URL to an icon that will display in the dashboard.
	//
	// View built-in icons here: https://github.com/coder/coder/tree/main/site/static/icon. Use a built-in icon with `data.coder_workspace.me.access_url + "/icon/<path>"`.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/coder/coder/0.13.0/docs/data-sources/parameter#icon DataCoderParameter#icon}
	Icon *string `field:"optional" json:"icon" yaml:"icon"`
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/coder/coder/0.13.0/docs/data-sources/parameter#id DataCoderParameter#id}.
	//
	// Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2.
	// If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.
	Id *string `field:"optional" json:"id" yaml:"id"`
	// Whether this value can be changed after workspace creation.
	//
	// This can be destructive for values like region, so use with caution!
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/coder/coder/0.13.0/docs/data-sources/parameter#mutable DataCoderParameter#mutable}
	Mutable interface{} `field:"optional" json:"mutable" yaml:"mutable"`
	// option block.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/coder/coder/0.13.0/docs/data-sources/parameter#option DataCoderParameter#option}
	Option interface{} `field:"optional" json:"option" yaml:"option"`
	// The order determines the position of a template parameter in the UI/CLI presentation.
	//
	// The lowest order is shown first and parameters with equal order are sorted by name (ascending order).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/coder/coder/0.13.0/docs/data-sources/parameter#order DataCoderParameter#order}
	Order *float64 `field:"optional" json:"order" yaml:"order"`
	// The type of this parameter. Must be one of: "number", "string", "bool", or "list(string)".
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/coder/coder/0.13.0/docs/data-sources/parameter#type DataCoderParameter#type}
	Type *string `field:"optional" json:"type" yaml:"type"`
	// validation block.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/coder/coder/0.13.0/docs/data-sources/parameter#validation DataCoderParameter#validation}
	Validation *DataCoderParameterValidation `field:"optional" json:"validation" yaml:"validation"`
}

type DataCoderParameterOption 

type DataCoderParameterOption struct {
	// The display name of this value in the UI.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/coder/coder/0.13.0/docs/data-sources/parameter#name DataCoderParameter#name}
	Name *string `field:"required" json:"name" yaml:"name"`
	// The value of this option set on the parameter if selected.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/coder/coder/0.13.0/docs/data-sources/parameter#value DataCoderParameter#value}
	Value *string `field:"required" json:"value" yaml:"value"`
	// Describe what selecting this value does.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/coder/coder/0.13.0/docs/data-sources/parameter#description DataCoderParameter#description}
	Description *string `field:"optional" json:"description" yaml:"description"`
	// A URL to an icon that will display in the dashboard.
	//
	// View built-in icons here: https://github.com/coder/coder/tree/main/site/static/icon. Use a built-in icon with `data.coder_workspace.me.access_url + "/icon/<path>"`.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/coder/coder/0.13.0/docs/data-sources/parameter#icon DataCoderParameter#icon}
	Icon *string `field:"optional" json:"icon" yaml:"icon"`
}

type DataCoderParameterOptionList 

type DataCoderParameterOptionList interface {
	cdktf.ComplexList
	// The creation stack of this resolvable which will be appended to errors thrown during resolution.
	//
	// If this returns an empty array the stack will not be attached.
	// Experimental.
	CreationStack() *[]*string
	// Experimental.
	Fqn() *string
	InternalValue() interface{}
	SetInternalValue(val interface{})
	// The attribute on the parent resource this class is referencing.
	TerraformAttribute() *string
	SetTerraformAttribute(val *string)
	// The parent resource.
	TerraformResource() cdktf.IInterpolatingParent
	SetTerraformResource(val cdktf.IInterpolatingParent)
	// whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
	WrapsSet() *bool
	SetWrapsSet(val *bool)
	// Creating an iterator for this complex list.
	//
	// The list will be converted into a map with the mapKeyAttributeName as the key.
	// Experimental.
	AllWithMapKey(mapKeyAttributeName *string) cdktf.DynamicListTerraformIterator
	// Experimental.
	ComputeFqn() *string
	Get(index *float64) DataCoderParameterOptionOutputReference
	// Produce the Token's value at resolution time.
	// Experimental.
	Resolve(_context cdktf.IResolveContext) interface{}
	// Return a string representation of this resolvable object.
	//
	// Returns a reversible string representation.
	// Experimental.
	ToString() *string
}

func NewDataCoderParameterOptionList 

func NewDataCoderParameterOptionList(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, wrapsSet *bool) DataCoderParameterOptionList

type DataCoderParameterOptionOutputReference 

type DataCoderParameterOptionOutputReference interface {
	cdktf.ComplexObject
	// the index of the complex object in a list.
	// Experimental.
	ComplexObjectIndex() interface{}
	// Experimental.
	SetComplexObjectIndex(val interface{})
	// set to true if this item is from inside a set and needs tolist() for accessing it set to "0" for single list items.
	// Experimental.
	ComplexObjectIsFromSet() *bool
	// Experimental.
	SetComplexObjectIsFromSet(val *bool)
	// The creation stack of this resolvable which will be appended to errors thrown during resolution.
	//
	// If this returns an empty array the stack will not be attached.
	// Experimental.
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	DescriptionInput() *string
	// Experimental.
	Fqn() *string
	Icon() *string
	SetIcon(val *string)
	IconInput() *string
	InternalValue() interface{}
	SetInternalValue(val interface{})
	Name() *string
	SetName(val *string)
	NameInput() *string
	// Experimental.
	TerraformAttribute() *string
	// Experimental.
	SetTerraformAttribute(val *string)
	// Experimental.
	TerraformResource() cdktf.IInterpolatingParent
	// Experimental.
	SetTerraformResource(val cdktf.IInterpolatingParent)
	Value() *string
	SetValue(val *string)
	ValueInput() *string
	// Experimental.
	ComputeFqn() *string
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	InterpolationAsList() cdktf.IResolvable
	// Experimental.
	InterpolationForAttribute(property *string) cdktf.IResolvable
	ResetDescription()
	ResetIcon()
	// Produce the Token's value at resolution time.
	// Experimental.
	Resolve(_context cdktf.IResolveContext) interface{}
	// Return a string representation of this resolvable object.
	//
	// Returns a reversible string representation.
	// Experimental.
	ToString() *string
}

func NewDataCoderParameterOptionOutputReference 

func NewDataCoderParameterOptionOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, complexObjectIndex *float64, complexObjectIsFromSet *bool) DataCoderParameterOptionOutputReference

type DataCoderParameterValidation 

type DataCoderParameterValidation struct {
	// An error message to display if the value doesn't match the provided regex.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/coder/coder/0.13.0/docs/data-sources/parameter#error DataCoderParameter#error}
	Error *string `field:"optional" json:"error" yaml:"error"`
	// The maximum of a number parameter.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/coder/coder/0.13.0/docs/data-sources/parameter#max DataCoderParameter#max}
	Max *float64 `field:"optional" json:"max" yaml:"max"`
	// The minimum of a number parameter.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/coder/coder/0.13.0/docs/data-sources/parameter#min DataCoderParameter#min}
	Min *float64 `field:"optional" json:"min" yaml:"min"`
	// Number monotonicity, either increasing or decreasing.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/coder/coder/0.13.0/docs/data-sources/parameter#monotonic DataCoderParameter#monotonic}
	Monotonic *string `field:"optional" json:"monotonic" yaml:"monotonic"`
	// A regex for the input parameter to match against.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/coder/coder/0.13.0/docs/data-sources/parameter#regex DataCoderParameter#regex}
	Regex *string `field:"optional" json:"regex" yaml:"regex"`
}

type DataCoderParameterValidationOutputReference 

type DataCoderParameterValidationOutputReference interface {
	cdktf.ComplexObject
	// the index of the complex object in a list.
	// Experimental.
	ComplexObjectIndex() interface{}
	// Experimental.
	SetComplexObjectIndex(val interface{})
	// set to true if this item is from inside a set and needs tolist() for accessing it set to "0" for single list items.
	// Experimental.
	ComplexObjectIsFromSet() *bool
	// Experimental.
	SetComplexObjectIsFromSet(val *bool)
	// The creation stack of this resolvable which will be appended to errors thrown during resolution.
	//
	// If this returns an empty array the stack will not be attached.
	// Experimental.
	CreationStack() *[]*string
	Error() *string
	SetError(val *string)
	ErrorInput() *string
	// Experimental.
	Fqn() *string
	InternalValue() *DataCoderParameterValidation
	SetInternalValue(val *DataCoderParameterValidation)
	Max() *float64
	SetMax(val *float64)
	MaxDisabled() cdktf.IResolvable
	MaxInput() *float64
	Min() *float64
	SetMin(val *float64)
	MinDisabled() cdktf.IResolvable
	MinInput() *float64
	Monotonic() *string
	SetMonotonic(val *string)
	MonotonicInput() *string
	Regex() *string
	SetRegex(val *string)
	RegexInput() *string
	// Experimental.
	TerraformAttribute() *string
	// Experimental.
	SetTerraformAttribute(val *string)
	// Experimental.
	TerraformResource() cdktf.IInterpolatingParent
	// Experimental.
	SetTerraformResource(val cdktf.IInterpolatingParent)
	// Experimental.
	ComputeFqn() *string
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	InterpolationAsList() cdktf.IResolvable
	// Experimental.
	InterpolationForAttribute(property *string) cdktf.IResolvable
	ResetError()
	ResetMax()
	ResetMin()
	ResetMonotonic()
	ResetRegex()
	// Produce the Token's value at resolution time.
	// Experimental.
	Resolve(_context cdktf.IResolveContext) interface{}
	// Return a string representation of this resolvable object.
	//
	// Returns a reversible string representation.
	// Experimental.
	ToString() *string
}

func NewDataCoderParameterValidationOutputReference 

func NewDataCoderParameterValidationOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string) DataCoderParameterValidationOutputReference

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.