vappContainer.csharp.md

vappContainer Submodule

Constructs

VappContainer

Represents a {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.11.0/docs/resources/vapp_container vsphere_vapp_container}.

Initializers

using HashiCorp.Cdktf.Providers.Vsphere;

new VappContainer(Construct Scope, string Id, VappContainerConfig Config);

Name	Type	Description
Scope	Constructs.Construct	The scope in which to define this construct.
Id	string	The scoped construct ID.
Config	VappContainerConfig	No description.

---

Scope^Required

• Type: Constructs.Construct

The scope in which to define this construct.

---

Id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

Config^Required

• Type: VappContainerConfig

---

Methods

Name	Description
ToString	Returns a string representation of this construct.
AddOverride	No description.
OverrideLogicalId	Overrides the auto-generated logical ID with a specific ID.
ResetOverrideLogicalId	Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform	No description.
ToMetadata	No description.
ToTerraform	Adds this resource to the terraform JSON output.
AddMoveTarget	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
GetAnyMapAttribute	No description.
GetBooleanAttribute	No description.
GetBooleanMapAttribute	No description.
GetListAttribute	No description.
GetNumberAttribute	No description.
GetNumberListAttribute	No description.
GetNumberMapAttribute	No description.
GetStringAttribute	No description.
GetStringMapAttribute	No description.
HasResourceMove	No description.
ImportFrom	No description.
InterpolationForAttribute	No description.
MoveFromId	Move the resource corresponding to "id" to this resource.
MoveTo	Moves this resource to the target resource given by moveTarget.
MoveToId	Moves this resource to the resource corresponding to "id".
ResetCpuExpandable	No description.
ResetCpuLimit	No description.
ResetCpuReservation	No description.
ResetCpuShareLevel	No description.
ResetCpuShares	No description.
ResetCustomAttributes	No description.
ResetId	No description.
ResetMemoryExpandable	No description.
ResetMemoryLimit	No description.
ResetMemoryReservation	No description.
ResetMemoryShareLevel	No description.
ResetMemoryShares	No description.
ResetParentFolderId	No description.
ResetTags	No description.

---

ToString

private string ToString()

Returns a string representation of this construct.

AddOverride

private void AddOverride(string Path, object Value)

Path^Required

• Type: string

---

Value^Required

• Type: object

---

OverrideLogicalId

private void OverrideLogicalId(string NewLogicalId)

Overrides the auto-generated logical ID with a specific ID.

NewLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

ResetOverrideLogicalId

private void ResetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

ToHclTerraform

private object ToHclTerraform()

ToMetadata

private object ToMetadata()

ToTerraform

private object ToTerraform()

Adds this resource to the terraform JSON output.

AddMoveTarget

private void AddMoveTarget(string MoveTarget)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

MoveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

GetAnyMapAttribute

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanAttribute

private IResolvable GetBooleanAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanMapAttribute

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetListAttribute

private string[] GetListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberAttribute

private double GetNumberAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberListAttribute

private double[] GetNumberListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberMapAttribute

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringAttribute

private string GetStringAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringMapAttribute

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

HasResourceMove

private object HasResourceMove()

ImportFrom

private void ImportFrom(string Id, TerraformProvider Provider = null)

Id^Required

• Type: string

---

Provider^Optional

• Type: HashiCorp.Cdktf.TerraformProvider

---

InterpolationForAttribute

private IResolvable InterpolationForAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

MoveFromId

private void MoveFromId(string Id)

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.

Id^Required

• Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

---

MoveTo

private void MoveTo(string MoveTarget, object Index = null)

Moves this resource to the target resource given by moveTarget.

MoveTarget^Required

• Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

---

Index^Optional

• Type: object

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

---

MoveToId

private void MoveToId(string Id)

Moves this resource to the resource corresponding to "id".

Id^Required

• Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

---

ResetCpuExpandable

private void ResetCpuExpandable()

ResetCpuLimit

private void ResetCpuLimit()

ResetCpuReservation

private void ResetCpuReservation()

ResetCpuShareLevel

private void ResetCpuShareLevel()

ResetCpuShares

private void ResetCpuShares()

ResetCustomAttributes

private void ResetCustomAttributes()

ResetId

private void ResetId()

ResetMemoryExpandable

private void ResetMemoryExpandable()

ResetMemoryLimit

private void ResetMemoryLimit()

ResetMemoryReservation

private void ResetMemoryReservation()

ResetMemoryShareLevel

private void ResetMemoryShareLevel()

ResetMemoryShares

private void ResetMemoryShares()

ResetParentFolderId

private void ResetParentFolderId()

ResetTags

private void ResetTags()

Static Functions

Name	Description
IsConstruct	Checks if x is a construct.
IsTerraformElement	No description.
IsTerraformResource	No description.
GenerateConfigForImport	Generates CDKTF code for importing a VappContainer resource upon running "cdktf plan ".

---

IsConstruct

using HashiCorp.Cdktf.Providers.Vsphere;

VappContainer.IsConstruct(object X);

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.

X^Required

• Type: object

Any object.

---

IsTerraformElement

using HashiCorp.Cdktf.Providers.Vsphere;

VappContainer.IsTerraformElement(object X);

X^Required

• Type: object

---

IsTerraformResource

using HashiCorp.Cdktf.Providers.Vsphere;

VappContainer.IsTerraformResource(object X);

X^Required

• Type: object

---

GenerateConfigForImport

using HashiCorp.Cdktf.Providers.Vsphere;

VappContainer.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

Generates CDKTF code for importing a VappContainer resource upon running "cdktf plan ".

Scope^Required

• Type: Constructs.Construct

The scope in which to define this construct.

---

ImportToId^Required

• Type: string

The construct id used in the generated config for the VappContainer to import.

---

ImportFromId^Required

• Type: string

The id of the existing VappContainer that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.11.0/docs/resources/vapp_container#import import section} in the documentation of this resource for the id to use

---

Provider^Optional

• Type: HashiCorp.Cdktf.TerraformProvider

? Optional instance of the provider where the VappContainer to import is found.

---

Properties

Name	Type	Description
Node	Constructs.Node	The tree node.
CdktfStack	HashiCorp.Cdktf.TerraformStack	No description.
Fqn	string	No description.
FriendlyUniqueId	string	No description.
TerraformMetaArguments	System.Collections.Generic.IDictionary<string, object>	No description.
TerraformResourceType	string	No description.
TerraformGeneratorMetadata	HashiCorp.Cdktf.TerraformProviderGeneratorMetadata	No description.
Connection	object	No description.
Count	object	No description.
DependsOn	string[]	No description.
ForEach	HashiCorp.Cdktf.ITerraformIterator	No description.
Lifecycle	HashiCorp.Cdktf.TerraformResourceLifecycle	No description.
Provider	HashiCorp.Cdktf.TerraformProvider	No description.
Provisioners	object[]	No description.
CpuExpandableInput	object	No description.
CpuLimitInput	double	No description.
CpuReservationInput	double	No description.
CpuShareLevelInput	string	No description.
CpuSharesInput	double	No description.
CustomAttributesInput	System.Collections.Generic.IDictionary<string, string>	No description.
IdInput	string	No description.
MemoryExpandableInput	object	No description.
MemoryLimitInput	double	No description.
MemoryReservationInput	double	No description.
MemoryShareLevelInput	string	No description.
MemorySharesInput	double	No description.
NameInput	string	No description.
ParentFolderIdInput	string	No description.
ParentResourcePoolIdInput	string	No description.
TagsInput	string[]	No description.
CpuExpandable	object	No description.
CpuLimit	double	No description.
CpuReservation	double	No description.
CpuShareLevel	string	No description.
CpuShares	double	No description.
CustomAttributes	System.Collections.Generic.IDictionary<string, string>	No description.
Id	string	No description.
MemoryExpandable	object	No description.
MemoryLimit	double	No description.
MemoryReservation	double	No description.
MemoryShareLevel	string	No description.
MemoryShares	double	No description.
Name	string	No description.
ParentFolderId	string	No description.
ParentResourcePoolId	string	No description.
Tags	string[]	No description.

---

Node^Required

public Node Node { get; }

• Type: Constructs.Node

The tree node.

---

CdktfStack^Required

public TerraformStack CdktfStack { get; }

• Type: HashiCorp.Cdktf.TerraformStack

---

Fqn^Required

public string Fqn { get; }

• Type: string

---

FriendlyUniqueId^Required

public string FriendlyUniqueId { get; }

• Type: string

---

TerraformMetaArguments^Required

public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }

• Type: System.Collections.Generic.IDictionary<string, object>

---

TerraformResourceType^Required

public string TerraformResourceType { get; }

• Type: string

---

TerraformGeneratorMetadata^Optional

public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }

• Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

---

Connection^Optional

public object Connection { get; }

• Type: object

---

Count^Optional

public object Count { get; }

• Type: object

---

DependsOn^Optional

public string[] DependsOn { get; }

• Type: string[]

---

ForEach^Optional

public ITerraformIterator ForEach { get; }

• Type: HashiCorp.Cdktf.ITerraformIterator

---

Lifecycle^Optional

public TerraformResourceLifecycle Lifecycle { get; }

• Type: HashiCorp.Cdktf.TerraformResourceLifecycle

---

Provider^Optional

public TerraformProvider Provider { get; }

• Type: HashiCorp.Cdktf.TerraformProvider

---

Provisioners^Optional

public object[] Provisioners { get; }

• Type: object[]

---

CpuExpandableInput^Optional

public object CpuExpandableInput { get; }

• Type: object

---

CpuLimitInput^Optional

public double CpuLimitInput { get; }

• Type: double

---

CpuReservationInput^Optional

public double CpuReservationInput { get; }

• Type: double

---

CpuShareLevelInput^Optional

public string CpuShareLevelInput { get; }

• Type: string

---

CpuSharesInput^Optional

public double CpuSharesInput { get; }

• Type: double

---

CustomAttributesInput^Optional

public System.Collections.Generic.IDictionary<string, string> CustomAttributesInput { get; }

• Type: System.Collections.Generic.IDictionary<string, string>

---

IdInput^Optional

public string IdInput { get; }

• Type: string

---

MemoryExpandableInput^Optional

public object MemoryExpandableInput { get; }

• Type: object

---

MemoryLimitInput^Optional

public double MemoryLimitInput { get; }

• Type: double

---

MemoryReservationInput^Optional

public double MemoryReservationInput { get; }

• Type: double

---

MemoryShareLevelInput^Optional

public string MemoryShareLevelInput { get; }

• Type: string

---

MemorySharesInput^Optional

public double MemorySharesInput { get; }

• Type: double

---

NameInput^Optional

public string NameInput { get; }

• Type: string

---

ParentFolderIdInput^Optional

public string ParentFolderIdInput { get; }

• Type: string

---

ParentResourcePoolIdInput^Optional

public string ParentResourcePoolIdInput { get; }

• Type: string

---

TagsInput^Optional

public string[] TagsInput { get; }

• Type: string[]

---

CpuExpandable^Required

public object CpuExpandable { get; }

• Type: object

---

CpuLimit^Required

public double CpuLimit { get; }

• Type: double

---

CpuReservation^Required

public double CpuReservation { get; }

• Type: double

---

CpuShareLevel^Required

public string CpuShareLevel { get; }

• Type: string

---

CpuShares^Required

public double CpuShares { get; }

• Type: double

---

CustomAttributes^Required

public System.Collections.Generic.IDictionary<string, string> CustomAttributes { get; }

• Type: System.Collections.Generic.IDictionary<string, string>

---

Id^Required

public string Id { get; }

• Type: string

---

MemoryExpandable^Required

public object MemoryExpandable { get; }

• Type: object

---

MemoryLimit^Required

public double MemoryLimit { get; }

• Type: double

---

MemoryReservation^Required

public double MemoryReservation { get; }

• Type: double

---

MemoryShareLevel^Required

public string MemoryShareLevel { get; }

• Type: string

---

MemoryShares^Required

public double MemoryShares { get; }

• Type: double

---

Name^Required

public string Name { get; }

• Type: string

---

ParentFolderId^Required

public string ParentFolderId { get; }

• Type: string

---

ParentResourcePoolId^Required

public string ParentResourcePoolId { get; }

• Type: string

---

Tags^Required

public string[] Tags { get; }

• Type: string[]

---

Constants

Name	Type	Description
TfResourceType	string	No description.

---

TfResourceType^Required

public string TfResourceType { get; }

• Type: string

---

Structs

VappContainerConfig

Initializer

using HashiCorp.Cdktf.Providers.Vsphere;

new VappContainerConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string Name,
    string ParentResourcePoolId,
    object CpuExpandable = null,
    double CpuLimit = null,
    double CpuReservation = null,
    string CpuShareLevel = null,
    double CpuShares = null,
    System.Collections.Generic.IDictionary<string, string> CustomAttributes = null,
    string Id = null,
    object MemoryExpandable = null,
    double MemoryLimit = null,
    double MemoryReservation = null,
    string MemoryShareLevel = null,
    double MemoryShares = null,
    string ParentFolderId = null,
    string[] Tags = null
};

Properties

Name	Type	Description
Connection	object	No description.
Count	object	No description.
DependsOn	HashiCorp.Cdktf.ITerraformDependable[]	No description.
ForEach	HashiCorp.Cdktf.ITerraformIterator	No description.
Lifecycle	HashiCorp.Cdktf.TerraformResourceLifecycle	No description.
Provider	HashiCorp.Cdktf.TerraformProvider	No description.
Provisioners	object[]	No description.
Name	string	The name of the vApp container.
ParentResourcePoolId	string	The managed object ID of the parent resource pool or the compute resource the vApp container is in.
CpuExpandable	object	Determines if the reservation on a vApp container can grow beyond the specified value, if the parent resource pool has unreserved resources.
CpuLimit	double	The utilization of a vApp container will not exceed this limit, even if there are available resources.
CpuReservation	double	Amount of CPU (MHz) that is guaranteed available to the vApp container.
CpuShareLevel	string	The allocation level.
CpuShares	double	The number of shares allocated.
CustomAttributes	System.Collections.Generic.IDictionary<string, string>	A list of custom attributes to set on this resource.
Id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.11.0/docs/resources/vapp_container#id VappContainer#id}.
MemoryExpandable	object	Determines if the reservation on a vApp container can grow beyond the specified value, if the parent resource pool has unreserved resources.
MemoryLimit	double	The utilization of a vApp container will not exceed this limit, even if there are available resources.
MemoryReservation	double	Amount of memory (MB) that is guaranteed available to the vApp container.
MemoryShareLevel	string	The allocation level.
MemoryShares	double	The number of shares allocated.
ParentFolderId	string	The ID of the parent VM folder.
Tags	string[]	A list of tag IDs to apply to this object.

---

Connection^Optional

public object Connection { get; set; }

• Type: object

---

Count^Optional

public object Count { get; set; }

• Type: object

---

DependsOn^Optional

public ITerraformDependable[] DependsOn { get; set; }

• Type: HashiCorp.Cdktf.ITerraformDependable[]

---

ForEach^Optional

public ITerraformIterator ForEach { get; set; }

• Type: HashiCorp.Cdktf.ITerraformIterator

---

Lifecycle^Optional

public TerraformResourceLifecycle Lifecycle { get; set; }

• Type: HashiCorp.Cdktf.TerraformResourceLifecycle

---

Provider^Optional

public TerraformProvider Provider { get; set; }

• Type: HashiCorp.Cdktf.TerraformProvider

---

Provisioners^Optional

public object[] Provisioners { get; set; }

• Type: object[]

---

Name^Required

public string Name { get; set; }

• Type: string

The name of the vApp container.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.11.0/docs/resources/vapp_container#name VappContainer#name}

---

ParentResourcePoolId^Required

public string ParentResourcePoolId { get; set; }

• Type: string

The managed object ID of the parent resource pool or the compute resource the vApp container is in.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.11.0/docs/resources/vapp_container#parent_resource_pool_id VappContainer#parent_resource_pool_id}

---

CpuExpandable^Optional

public object CpuExpandable { get; set; }

• Type: object

Determines if the reservation on a vApp container can grow beyond the specified value, if the parent resource pool has unreserved resources.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.11.0/docs/resources/vapp_container#cpu_expandable VappContainer#cpu_expandable}

---

CpuLimit^Optional

public double CpuLimit { get; set; }

• Type: double

The utilization of a vApp container will not exceed this limit, even if there are available resources.

Set to -1 for unlimited.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.11.0/docs/resources/vapp_container#cpu_limit VappContainer#cpu_limit}

---

CpuReservation^Optional

public double CpuReservation { get; set; }

• Type: double

Amount of CPU (MHz) that is guaranteed available to the vApp container.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.11.0/docs/resources/vapp_container#cpu_reservation VappContainer#cpu_reservation}

---

CpuShareLevel^Optional

public string CpuShareLevel { get; set; }

• Type: string

The allocation level.

The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. Can be one of low, normal, high, or custom.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.11.0/docs/resources/vapp_container#cpu_share_level VappContainer#cpu_share_level}

---

CpuShares^Optional

public double CpuShares { get; set; }

• Type: double

The number of shares allocated.

Used to determine resource allocation in case of resource contention. If this is set, cpu_share_level must be custom.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.11.0/docs/resources/vapp_container#cpu_shares VappContainer#cpu_shares}

---

CustomAttributes^Optional

public System.Collections.Generic.IDictionary<string, string> CustomAttributes { get; set; }

• Type: System.Collections.Generic.IDictionary<string, string>

A list of custom attributes to set on this resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.11.0/docs/resources/vapp_container#custom_attributes VappContainer#custom_attributes}

---

Id^Optional

public string Id { get; set; }

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.11.0/docs/resources/vapp_container#id VappContainer#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.

---

MemoryExpandable^Optional

public object MemoryExpandable { get; set; }

• Type: object

Determines if the reservation on a vApp container can grow beyond the specified value, if the parent resource pool has unreserved resources.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.11.0/docs/resources/vapp_container#memory_expandable VappContainer#memory_expandable}

---

MemoryLimit^Optional

public double MemoryLimit { get; set; }

• Type: double

The utilization of a vApp container will not exceed this limit, even if there are available resources.

Set to -1 for unlimited.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.11.0/docs/resources/vapp_container#memory_limit VappContainer#memory_limit}

---

MemoryReservation^Optional

public double MemoryReservation { get; set; }

• Type: double

Amount of memory (MB) that is guaranteed available to the vApp container.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.11.0/docs/resources/vapp_container#memory_reservation VappContainer#memory_reservation}

---

MemoryShareLevel^Optional

public string MemoryShareLevel { get; set; }

• Type: string

The allocation level.

The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. Can be one of low, normal, high, or custom.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.11.0/docs/resources/vapp_container#memory_share_level VappContainer#memory_share_level}

---

MemoryShares^Optional

public double MemoryShares { get; set; }

• Type: double

The number of shares allocated.

Used to determine resource allocation in case of resource contention. If this is set, memory_share_level must be custom.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.11.0/docs/resources/vapp_container#memory_shares VappContainer#memory_shares}

---

ParentFolderId^Optional

public string ParentFolderId { get; set; }

• Type: string

The ID of the parent VM folder.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.11.0/docs/resources/vapp_container#parent_folder_id VappContainer#parent_folder_id}

---

Tags^Optional

public string[] Tags { get; set; }

• Type: string[]

A list of tag IDs to apply to this object.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.11.0/docs/resources/vapp_container#tags VappContainer#tags}

---