dataupcloudstorage

README

data_upcloud_storage

Refer to the Terraform Registry for docs: data_upcloud_storage.

Documentation

Index

• func DataUpcloudStorage_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, ...) cdktf.ImportableResource
• func DataUpcloudStorage_IsConstruct(x interface{}) *bool
• func DataUpcloudStorage_IsTerraformDataSource(x interface{}) *bool
• func DataUpcloudStorage_IsTerraformElement(x interface{}) *bool
• func DataUpcloudStorage_TfResourceType() *string
• func NewDataUpcloudStorage_Override(d DataUpcloudStorage, scope constructs.Construct, id *string, ...)
• type DataUpcloudStorage
  • func NewDataUpcloudStorage(scope constructs.Construct, id *string, config *DataUpcloudStorageConfig) DataUpcloudStorage
• type DataUpcloudStorageConfig

Functions

func DataUpcloudStorage_GenerateConfigForImport

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

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

func DataUpcloudStorage_IsConstruct

func DataUpcloudStorage_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 DataUpcloudStorage_IsTerraformDataSource

func DataUpcloudStorage_IsTerraformDataSource(x interface{}) *bool

Experimental.

func DataUpcloudStorage_IsTerraformElement

func DataUpcloudStorage_IsTerraformElement(x interface{}) *bool

Experimental.

func DataUpcloudStorage_TfResourceType

func DataUpcloudStorage_TfResourceType() *string

func NewDataUpcloudStorage_Override

func NewDataUpcloudStorage_Override(d DataUpcloudStorage, scope constructs.Construct, id *string, config *DataUpcloudStorageConfig)

Create a new {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.16.0/docs/data-sources/storage upcloud_storage} Data Source.

Types

type DataUpcloudStorage

type DataUpcloudStorage interface {
	cdktf.TerraformDataSource
	AccessType() *string
	SetAccessType(val *string)
	AccessTypeInput() *string
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Count() interface{}
	// Experimental.
	SetCount(val interface{})
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(val *[]*string)
	Encrypt() cdktf.IResolvable
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	Id() *string
	SetId(val *string)
	IdInput() *string
	Labels() cdktf.StringMap
	// Experimental.
	Lifecycle() *cdktf.TerraformResourceLifecycle
	// Experimental.
	SetLifecycle(val *cdktf.TerraformResourceLifecycle)
	MostRecent() interface{}
	SetMostRecent(val interface{})
	MostRecentInput() interface{}
	Name() *string
	SetName(val *string)
	NameInput() *string
	NameRegex() *string
	SetNameRegex(val *string)
	NameRegexInput() *string
	// The tree node.
	Node() constructs.Node
	// Experimental.
	Provider() cdktf.TerraformProvider
	// Experimental.
	SetProvider(val cdktf.TerraformProvider)
	// Experimental.
	RawOverrides() interface{}
	Size() *float64
	State() *string
	SystemLabels() cdktf.StringMap
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformMetaArguments() *map[string]interface{}
	// Experimental.
	TerraformResourceType() *string
	Tier() *string
	Title() *string
	SetTitle(val *string)
	TitleInput() *string
	Type() *string
	SetType(val *string)
	TypeInput() *string
	Zone() *string
	SetZone(val *string)
	ZoneInput() *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)
	ResetAccessType()
	ResetId()
	ResetMostRecent()
	ResetName()
	ResetNameRegex()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetTitle()
	ResetType()
	ResetZone()
	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/upcloudltd/upcloud/5.16.0/docs/data-sources/storage upcloud_storage}.

func NewDataUpcloudStorage

func NewDataUpcloudStorage(scope constructs.Construct, id *string, config *DataUpcloudStorageConfig) DataUpcloudStorage

Create a new {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.16.0/docs/data-sources/storage upcloud_storage} Data Source.

type DataUpcloudStorageConfig

type DataUpcloudStorageConfig 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 access type of the storage, `public` or `private`.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.16.0/docs/data-sources/storage#access_type DataUpcloudStorage#access_type}
	AccessType *string `field:"optional" json:"accessType" yaml:"accessType"`
	// UUID of the storage.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.16.0/docs/data-sources/storage#id DataUpcloudStorage#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"`
	// If more than one result is returned, use the most recent storage.
	//
	// This is only useful with private storages. Public storages might give unpredictable results.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.16.0/docs/data-sources/storage#most_recent DataUpcloudStorage#most_recent}
	MostRecent interface{} `field:"optional" json:"mostRecent" yaml:"mostRecent"`
	// Exact name of the storage (same as title). Deprecated, use `title` instead.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.16.0/docs/data-sources/storage#name DataUpcloudStorage#name}
	Name *string `field:"optional" json:"name" yaml:"name"`
	// Use regular expression to match storage name. Deprecated, use exact title or UUID instead.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.16.0/docs/data-sources/storage#name_regex DataUpcloudStorage#name_regex}
	NameRegex *string `field:"optional" json:"nameRegex" yaml:"nameRegex"`
	// The title of the storage.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.16.0/docs/data-sources/storage#title DataUpcloudStorage#title}
	Title *string `field:"optional" json:"title" yaml:"title"`
	// The type of the storage.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.16.0/docs/data-sources/storage#type DataUpcloudStorage#type}
	Type *string `field:"optional" json:"type" yaml:"type"`
	// The zone the storage is in, e.g. `de-fra1`.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.16.0/docs/data-sources/storage#zone DataUpcloudStorage#zone}
	Zone *string `field:"optional" json:"zone" yaml:"zone"`
}