Documentation
¶
Index ¶
- func NewVolumeSourceOutputReference_Override(v VolumeSourceOutputReference, terraformResource cdktf.IInterpolatingParent, ...)
- func NewVolume_Override(v Volume, scope constructs.Construct, id *string, config *VolumeConfig)
- func Volume_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, ...) cdktf.ImportableResource
- func Volume_IsConstruct(x interface{}) *bool
- func Volume_IsTerraformElement(x interface{}) *bool
- func Volume_IsTerraformResource(x interface{}) *bool
- func Volume_TfResourceType() *string
- type Volume
- type VolumeConfig
- type VolumeSource
- type VolumeSourceOutputReference
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewVolumeSourceOutputReference_Override ¶
func NewVolumeSourceOutputReference_Override(v VolumeSourceOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string)
func NewVolume_Override ¶
func NewVolume_Override(v Volume, scope constructs.Construct, id *string, config *VolumeConfig)
Create a new {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.33.0/docs/resources/volume stackit_volume} Resource.
func Volume_GenerateConfigForImport ¶
func Volume_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource
Generates CDKTF code for importing a Volume resource upon running "cdktf plan <stack-name>".
func Volume_IsConstruct ¶
func Volume_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 Volume_IsTerraformResource ¶
func Volume_IsTerraformResource(x interface{}) *bool
Experimental.
func Volume_TfResourceType ¶
func Volume_TfResourceType() *string
Types ¶
type Volume ¶
type Volume interface {
cdktf.TerraformResource
AvailabilityZone() *string
SetAvailabilityZone(val *string)
AvailabilityZoneInput() *string
// Experimental.
CdktfStack() cdktf.TerraformStack
// Experimental.
Connection() interface{}
// Experimental.
SetConnection(val interface{})
// Experimental.
ConstructNodeMetadata() *map[string]interface{}
// Experimental.
Count() interface{}
// Experimental.
SetCount(val interface{})
// Experimental.
DependsOn() *[]*string
// Experimental.
SetDependsOn(val *[]*string)
Description() *string
SetDescription(val *string)
DescriptionInput() *string
// Experimental.
ForEach() cdktf.ITerraformIterator
// Experimental.
SetForEach(val cdktf.ITerraformIterator)
// Experimental.
Fqn() *string
// Experimental.
FriendlyUniqueId() *string
Id() *string
Labels() *map[string]*string
SetLabels(val *map[string]*string)
LabelsInput() *map[string]*string
// Experimental.
Lifecycle() *cdktf.TerraformResourceLifecycle
// Experimental.
SetLifecycle(val *cdktf.TerraformResourceLifecycle)
Name() *string
SetName(val *string)
NameInput() *string
// The tree node.
Node() constructs.Node
PerformanceClass() *string
SetPerformanceClass(val *string)
PerformanceClassInput() *string
ProjectId() *string
SetProjectId(val *string)
ProjectIdInput() *string
// Experimental.
Provider() cdktf.TerraformProvider
// Experimental.
SetProvider(val cdktf.TerraformProvider)
// Experimental.
Provisioners() *[]interface{}
// Experimental.
SetProvisioners(val *[]interface{})
// Experimental.
RawOverrides() interface{}
ServerId() *string
SetServerId(val *string)
ServerIdInput() *string
Size() *float64
SetSize(val *float64)
SizeInput() *float64
Source() VolumeSourceOutputReference
SourceInput() interface{}
// Experimental.
TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
// Experimental.
TerraformMetaArguments() *map[string]interface{}
// Experimental.
TerraformResourceType() *string
VolumeId() *string
// Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
// Experimental.
AddMoveTarget(moveTarget *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.
HasResourceMove() interface{}
// Experimental.
ImportFrom(id *string, provider cdktf.TerraformProvider)
// Experimental.
InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
// Move the resource corresponding to "id" to this resource.
//
// Note that the resource being moved from must be marked as moved using it's instance function.
// Experimental.
MoveFromId(id *string)
// Moves this resource to the target resource given by moveTarget.
// Experimental.
MoveTo(moveTarget *string, index interface{})
// Moves this resource to the resource corresponding to "id".
// Experimental.
MoveToId(id *string)
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
PutSource(value *VolumeSource)
ResetDescription()
ResetLabels()
ResetName()
// Resets a previously passed logical Id to use the auto-generated logical id again.
// Experimental.
ResetOverrideLogicalId()
ResetPerformanceClass()
ResetServerId()
ResetSize()
ResetSource()
SynthesizeAttributes() *map[string]interface{}
SynthesizeHclAttributes() *map[string]interface{}
// 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/stackitcloud/stackit/0.33.0/docs/resources/volume stackit_volume}.
func NewVolume ¶
func NewVolume(scope constructs.Construct, id *string, config *VolumeConfig) Volume
Create a new {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.33.0/docs/resources/volume stackit_volume} Resource.
type VolumeConfig ¶
type VolumeConfig 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 availability zone of the volume.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.33.0/docs/resources/volume#availability_zone Volume#availability_zone}
AvailabilityZone *string `field:"required" json:"availabilityZone" yaml:"availabilityZone"`
// STACKIT project ID to which the volume is associated.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.33.0/docs/resources/volume#project_id Volume#project_id}
ProjectId *string `field:"required" json:"projectId" yaml:"projectId"`
// The description of the volume.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.33.0/docs/resources/volume#description Volume#description}
Description *string `field:"optional" json:"description" yaml:"description"`
// Labels are key-value string pairs which can be attached to a resource container.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.33.0/docs/resources/volume#labels Volume#labels}
Labels *map[string]*string `field:"optional" json:"labels" yaml:"labels"`
// The name of the volume.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.33.0/docs/resources/volume#name Volume#name}
Name *string `field:"optional" json:"name" yaml:"name"`
// The performance class of the volume.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.33.0/docs/resources/volume#performance_class Volume#performance_class}
PerformanceClass *string `field:"optional" json:"performanceClass" yaml:"performanceClass"`
// The server ID of the server to which the volume is attached to.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.33.0/docs/resources/volume#server_id Volume#server_id}
ServerId *string `field:"optional" json:"serverId" yaml:"serverId"`
// The size of the volume in GB.
//
// It can only be updated to a larger value than the current size. Either `size` or `source` must be provided
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.33.0/docs/resources/volume#size Volume#size}
Size *float64 `field:"optional" json:"size" yaml:"size"`
// The source of the volume.
//
// It can be either a volume, an image, a snapshot or a backup. Either `size` or `source` must be provided
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.33.0/docs/resources/volume#source Volume#source}
Source *VolumeSource `field:"optional" json:"source" yaml:"source"`
}
type VolumeSource ¶
type VolumeSource struct {
// The ID of the source, e.g. image ID.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.33.0/docs/resources/volume#id Volume#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:"required" json:"id" yaml:"id"`
// The type of the source. Supported values are: `volume`, `image`, `snapshot`, `backup`.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.33.0/docs/resources/volume#type Volume#type}
Type *string `field:"required" json:"type" yaml:"type"`
}
type VolumeSourceOutputReference ¶
type VolumeSourceOutputReference 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
// Experimental.
Fqn() *string
Id() *string
SetId(val *string)
IdInput() *string
InternalValue() interface{}
SetInternalValue(val interface{})
// Experimental.
TerraformAttribute() *string
// Experimental.
SetTerraformAttribute(val *string)
// Experimental.
TerraformResource() cdktf.IInterpolatingParent
// Experimental.
SetTerraformResource(val cdktf.IInterpolatingParent)
Type() *string
SetType(val *string)
TypeInput() *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
// 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 NewVolumeSourceOutputReference ¶
func NewVolumeSourceOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string) VolumeSourceOutputReference