Documentation
¶
Index ¶
- func NetworkArea_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, ...) cdktf.ImportableResource
- func NetworkArea_IsConstruct(x interface{}) *bool
- func NetworkArea_IsTerraformElement(x interface{}) *bool
- func NetworkArea_IsTerraformResource(x interface{}) *bool
- func NetworkArea_TfResourceType() *string
- func NewNetworkAreaNetworkRangesList_Override(n NetworkAreaNetworkRangesList, terraformResource cdktf.IInterpolatingParent, ...)
- func NewNetworkAreaNetworkRangesOutputReference_Override(n NetworkAreaNetworkRangesOutputReference, ...)
- func NewNetworkArea_Override(n NetworkArea, scope constructs.Construct, id *string, ...)
- type NetworkArea
- type NetworkAreaConfig
- type NetworkAreaNetworkRanges
- type NetworkAreaNetworkRangesList
- type NetworkAreaNetworkRangesOutputReference
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NetworkArea_GenerateConfigForImport ¶
func NetworkArea_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource
Generates CDKTF code for importing a NetworkArea resource upon running "cdktf plan <stack-name>".
func NetworkArea_IsConstruct ¶
func NetworkArea_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 NetworkArea_IsTerraformElement ¶
func NetworkArea_IsTerraformElement(x interface{}) *bool
Experimental.
func NetworkArea_IsTerraformResource ¶
func NetworkArea_IsTerraformResource(x interface{}) *bool
Experimental.
func NetworkArea_TfResourceType ¶
func NetworkArea_TfResourceType() *string
func NewNetworkAreaNetworkRangesList_Override ¶
func NewNetworkAreaNetworkRangesList_Override(n NetworkAreaNetworkRangesList, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, wrapsSet *bool)
func NewNetworkAreaNetworkRangesOutputReference_Override ¶
func NewNetworkAreaNetworkRangesOutputReference_Override(n NetworkAreaNetworkRangesOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, complexObjectIndex *float64, complexObjectIsFromSet *bool)
func NewNetworkArea_Override ¶
func NewNetworkArea_Override(n NetworkArea, scope constructs.Construct, id *string, config *NetworkAreaConfig)
Create a new {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.50.0/docs/resources/network_area stackit_network_area} Resource.
Types ¶
type NetworkArea ¶
type NetworkArea interface {
cdktf.TerraformResource
// Experimental.
CdktfStack() cdktf.TerraformStack
// Experimental.
Connection() interface{}
// Experimental.
SetConnection(val interface{})
// Experimental.
ConstructNodeMetadata() *map[string]interface{}
// Experimental.
Count() interface{}
// Experimental.
SetCount(val interface{})
DefaultNameservers() *[]*string
SetDefaultNameservers(val *[]*string)
DefaultNameserversInput() *[]*string
DefaultPrefixLength() *float64
SetDefaultPrefixLength(val *float64)
DefaultPrefixLengthInput() *float64
// Experimental.
DependsOn() *[]*string
// Experimental.
SetDependsOn(val *[]*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)
MaxPrefixLength() *float64
SetMaxPrefixLength(val *float64)
MaxPrefixLengthInput() *float64
MinPrefixLength() *float64
SetMinPrefixLength(val *float64)
MinPrefixLengthInput() *float64
Name() *string
SetName(val *string)
NameInput() *string
NetworkAreaId() *string
NetworkRanges() NetworkAreaNetworkRangesList
NetworkRangesInput() interface{}
// The tree node.
Node() constructs.Node
OrganizationId() *string
SetOrganizationId(val *string)
OrganizationIdInput() *string
ProjectCount() *float64
// Experimental.
Provider() cdktf.TerraformProvider
// Experimental.
SetProvider(val cdktf.TerraformProvider)
// Experimental.
Provisioners() *[]interface{}
// Experimental.
SetProvisioners(val *[]interface{})
// Experimental.
RawOverrides() interface{}
// Experimental.
TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
// Experimental.
TerraformMetaArguments() *map[string]interface{}
// Experimental.
TerraformResourceType() *string
TransferNetwork() *string
SetTransferNetwork(val *string)
TransferNetworkInput() *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)
PutNetworkRanges(value interface{})
ResetDefaultNameservers()
ResetDefaultPrefixLength()
ResetLabels()
ResetMaxPrefixLength()
ResetMinPrefixLength()
// Resets a previously passed logical Id to use the auto-generated logical id again.
// Experimental.
ResetOverrideLogicalId()
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.50.0/docs/resources/network_area stackit_network_area}.
func NewNetworkArea ¶
func NewNetworkArea(scope constructs.Construct, id *string, config *NetworkAreaConfig) NetworkArea
Create a new {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.50.0/docs/resources/network_area stackit_network_area} Resource.
type NetworkAreaConfig ¶
type NetworkAreaConfig 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 network area.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.50.0/docs/resources/network_area#name NetworkArea#name}
Name *string `field:"required" json:"name" yaml:"name"`
// List of Network ranges.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.50.0/docs/resources/network_area#network_ranges NetworkArea#network_ranges}
NetworkRanges interface{} `field:"required" json:"networkRanges" yaml:"networkRanges"`
// STACKIT organization ID to which the network area is associated.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.50.0/docs/resources/network_area#organization_id NetworkArea#organization_id}
OrganizationId *string `field:"required" json:"organizationId" yaml:"organizationId"`
// Classless Inter-Domain Routing (CIDR).
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.50.0/docs/resources/network_area#transfer_network NetworkArea#transfer_network}
TransferNetwork *string `field:"required" json:"transferNetwork" yaml:"transferNetwork"`
// List of DNS Servers/Nameservers.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.50.0/docs/resources/network_area#default_nameservers NetworkArea#default_nameservers}
DefaultNameservers *[]*string `field:"optional" json:"defaultNameservers" yaml:"defaultNameservers"`
// The default prefix length for networks in the network area.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.50.0/docs/resources/network_area#default_prefix_length NetworkArea#default_prefix_length}
DefaultPrefixLength *float64 `field:"optional" json:"defaultPrefixLength" yaml:"defaultPrefixLength"`
// 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.50.0/docs/resources/network_area#labels NetworkArea#labels}
Labels *map[string]*string `field:"optional" json:"labels" yaml:"labels"`
// The maximal prefix length for networks in the network area.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.50.0/docs/resources/network_area#max_prefix_length NetworkArea#max_prefix_length}
MaxPrefixLength *float64 `field:"optional" json:"maxPrefixLength" yaml:"maxPrefixLength"`
// The minimal prefix length for networks in the network area.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.50.0/docs/resources/network_area#min_prefix_length NetworkArea#min_prefix_length}
MinPrefixLength *float64 `field:"optional" json:"minPrefixLength" yaml:"minPrefixLength"`
}
type NetworkAreaNetworkRanges ¶
type NetworkAreaNetworkRanges struct {
// Classless Inter-Domain Routing (CIDR).
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.50.0/docs/resources/network_area#prefix NetworkArea#prefix}
Prefix *string `field:"required" json:"prefix" yaml:"prefix"`
}
type NetworkAreaNetworkRangesList ¶
type NetworkAreaNetworkRangesList 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) NetworkAreaNetworkRangesOutputReference
// 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 NewNetworkAreaNetworkRangesList ¶
func NewNetworkAreaNetworkRangesList(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, wrapsSet *bool) NetworkAreaNetworkRangesList
type NetworkAreaNetworkRangesOutputReference ¶
type NetworkAreaNetworkRangesOutputReference 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
InternalValue() interface{}
SetInternalValue(val interface{})
NetworkRangeId() *string
Prefix() *string
SetPrefix(val *string)
PrefixInput() *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
// 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 NewNetworkAreaNetworkRangesOutputReference ¶
func NewNetworkAreaNetworkRangesOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, complexObjectIndex *float64, complexObjectIsFromSet *bool) NetworkAreaNetworkRangesOutputReference