`vappEntity` Submodule

Constructs

VappEntity

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

Initializers

using HashiCorp.Cdktf.Providers.Vsphere;

new VappEntity(Construct Scope, string Id, VappEntityConfig Config);

Name	Type	Description
`Scope`	`Constructs.Construct`	The scope in which to define this construct.
`Id`	`string`	The scoped construct ID.
`Config`	`VappEntityConfig`	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: VappEntityConfig

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".
`ResetCustomAttributes`	No description.
`ResetId`	No description.
`ResetStartAction`	No description.
`ResetStartDelay`	No description.
`ResetStartOrder`	No description.
`ResetStopAction`	No description.
`ResetStopDelay`	No description.
`ResetTags`	No description.
`ResetWaitForGuest`	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".

`ResetCustomAttributes`

private void ResetCustomAttributes()

`ResetId`

private void ResetId()

`ResetStartAction`

private void ResetStartAction()

`ResetStartDelay`

private void ResetStartDelay()

`ResetStartOrder`

private void ResetStartOrder()

`ResetStopAction`

private void ResetStopAction()

`ResetStopDelay`

private void ResetStopDelay()

`ResetTags`

private void ResetTags()

`ResetWaitForGuest`

private void ResetWaitForGuest()

Static Functions

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

`IsConstruct`

using HashiCorp.Cdktf.Providers.Vsphere;

VappEntity.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;

VappEntity.IsTerraformElement(object X);

`X`^Required

Type: object

`IsTerraformResource`

using HashiCorp.Cdktf.Providers.Vsphere;

VappEntity.IsTerraformResource(object X);

`X`^Required

Type: object

`GenerateConfigForImport`

using HashiCorp.Cdktf.Providers.Vsphere;

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

Generates CDKTF code for importing a VappEntity 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 VappEntity to import.

`ImportFromId`^Required

Type: string

The id of the existing VappEntity that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.11.0/docs/resources/vapp_entity#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 VappEntity 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.
`ContainerIdInput`	`string`	No description.
`CustomAttributesInput`	`System.Collections.Generic.IDictionary<string, string>`	No description.
`IdInput`	`string`	No description.
`StartActionInput`	`string`	No description.
`StartDelayInput`	`double`	No description.
`StartOrderInput`	`double`	No description.
`StopActionInput`	`string`	No description.
`StopDelayInput`	`double`	No description.
`TagsInput`	`string[]`	No description.
`TargetIdInput`	`string`	No description.
`WaitForGuestInput`	`object`	No description.
`ContainerId`	`string`	No description.
`CustomAttributes`	`System.Collections.Generic.IDictionary<string, string>`	No description.
`Id`	`string`	No description.
`StartAction`	`string`	No description.
`StartDelay`	`double`	No description.
`StartOrder`	`double`	No description.
`StopAction`	`string`	No description.
`StopDelay`	`double`	No description.
`Tags`	`string[]`	No description.
`TargetId`	`string`	No description.
`WaitForGuest`	`object`	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[]

`ContainerIdInput`^Optional

public string ContainerIdInput { get; }

Type: string

`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

`StartActionInput`^Optional

public string StartActionInput { get; }

Type: string

`StartDelayInput`^Optional

public double StartDelayInput { get; }

Type: double

`StartOrderInput`^Optional

public double StartOrderInput { get; }

Type: double

`StopActionInput`^Optional

public string StopActionInput { get; }

Type: string

`StopDelayInput`^Optional

public double StopDelayInput { get; }

Type: double

`TagsInput`^Optional

public string[] TagsInput { get; }

Type: string[]

`TargetIdInput`^Optional

public string TargetIdInput { get; }

Type: string

`WaitForGuestInput`^Optional

public object WaitForGuestInput { get; }

Type: object

`ContainerId`^Required

public string ContainerId { get; }

Type: string

`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

`StartAction`^Required

public string StartAction { get; }

Type: string

`StartDelay`^Required

public double StartDelay { get; }

Type: double

`StartOrder`^Required

public double StartOrder { get; }

Type: double

`StopAction`^Required

public string StopAction { get; }

Type: string

`StopDelay`^Required

public double StopDelay { get; }

Type: double

`Tags`^Required

public string[] Tags { get; }

Type: string[]

`TargetId`^Required

public string TargetId { get; }

Type: string

`WaitForGuest`^Required

public object WaitForGuest { get; }

Type: object

Constants

Name	Type	Description
`TfResourceType`	`string`	No description.

`TfResourceType`^Required

public string TfResourceType { get; }

Type: string

Structs

VappEntityConfig

Initializer

using HashiCorp.Cdktf.Providers.Vsphere;

new VappEntityConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string ContainerId,
    string TargetId,
    System.Collections.Generic.IDictionary<string, string> CustomAttributes = null,
    string Id = null,
    string StartAction = null,
    double StartDelay = null,
    double StartOrder = null,
    string StopAction = null,
    double StopDelay = null,
    string[] Tags = null,
    object WaitForGuest = 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.
`ContainerId`	`string`	Managed object ID of the vApp container the entity is a member of.
`TargetId`	`string`	Managed object ID of the entity to power on or power off.
`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_entity#id VappEntity#id}.
`StartAction`	`string`	How to start the entity.
`StartDelay`	`double`	Delay in seconds before continuing with the next entity in the order of entities to be started.
`StartOrder`	`double`	Order to start and stop target in vApp.
`StopAction`	`string`	Defines the stop action for the entity.
`StopDelay`	`double`	Delay in seconds before continuing with the next entity in the order of entities to be stopped.
`Tags`	`string[]`	A list of tag IDs to apply to this object.
`WaitForGuest`	`object`	Determines if the VM should be marked as being started when VMware Tools are ready instead of waiting for start_delay.

`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[]

`ContainerId`^Required

public string ContainerId { get; set; }

Type: string

Managed object ID of the vApp container the entity is a member of.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.11.0/docs/resources/vapp_entity#container_id VappEntity#container_id}

`TargetId`^Required

public string TargetId { get; set; }

Type: string

Managed object ID of the entity to power on or power off.

This can be a virtual machine or a vApp.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.11.0/docs/resources/vapp_entity#target_id VappEntity#target_id}

`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_entity#custom_attributes VappEntity#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_entity#id VappEntity#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.

`StartAction`^Optional

public string StartAction { get; set; }

Type: string

How to start the entity.

Valid settings are none or powerOn. If set to none, then the entity does not participate in auto-start.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.11.0/docs/resources/vapp_entity#start_action VappEntity#start_action}

`StartDelay`^Optional

public double StartDelay { get; set; }

Type: double

Delay in seconds before continuing with the next entity in the order of entities to be started.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.11.0/docs/resources/vapp_entity#start_delay VappEntity#start_delay}

`StartOrder`^Optional

public double StartOrder { get; set; }

Type: double

Order to start and stop target in vApp.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.11.0/docs/resources/vapp_entity#start_order VappEntity#start_order}

`StopAction`^Optional

public string StopAction { get; set; }

Type: string

Defines the stop action for the entity.

Can be set to none, powerOff, guestShutdown, or suspend. If set to none, then the entity does not participate in auto-stop.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.11.0/docs/resources/vapp_entity#stop_action VappEntity#stop_action}

`StopDelay`^Optional

public double StopDelay { get; set; }

Type: double

Delay in seconds before continuing with the next entity in the order of entities to be stopped.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.11.0/docs/resources/vapp_entity#stop_delay VappEntity#stop_delay}

`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_entity#tags VappEntity#tags}

`WaitForGuest`^Optional

public object WaitForGuest { get; set; }

Type: object

Determines if the VM should be marked as being started when VMware Tools are ready instead of waiting for start_delay.

This property has no effect for vApps.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.11.0/docs/resources/vapp_entity#wait_for_guest VappEntity#wait_for_guest}

Files

vappEntity.csharp.md

Latest commit

History

vappEntity.csharp.md

File metadata and controls

vappEntity Submodule

Constructs

VappEntity

Initializers

ScopeRequired

IdRequired

ConfigRequired

Methods

ToString

AddOverride

PathRequired

ValueRequired

OverrideLogicalId

NewLogicalIdRequired

ResetOverrideLogicalId

ToHclTerraform

ToMetadata

ToTerraform

AddMoveTarget

MoveTargetRequired

GetAnyMapAttribute

TerraformAttributeRequired

GetBooleanAttribute

TerraformAttributeRequired

GetBooleanMapAttribute

TerraformAttributeRequired

GetListAttribute

TerraformAttributeRequired

GetNumberAttribute

TerraformAttributeRequired

GetNumberListAttribute

TerraformAttributeRequired

GetNumberMapAttribute

TerraformAttributeRequired

GetStringAttribute

TerraformAttributeRequired

GetStringMapAttribute

TerraformAttributeRequired

HasResourceMove

ImportFrom

IdRequired

ProviderOptional

InterpolationForAttribute

TerraformAttributeRequired

MoveFromId

IdRequired

MoveTo

MoveTargetRequired

IndexOptional

MoveToId

IdRequired

ResetCustomAttributes

ResetId

ResetStartAction

ResetStartDelay

ResetStartOrder

ResetStopAction

ResetStopDelay

ResetTags

ResetWaitForGuest

Static Functions

IsConstruct

XRequired

IsTerraformElement

XRequired

IsTerraformResource

XRequired

GenerateConfigForImport

ScopeRequired

ImportToIdRequired

ImportFromIdRequired

ProviderOptional

Properties

NodeRequired

`vappEntity` Submodule

`Scope`^Required

`Id`^Required

`Config`^Required

`ToString`

`AddOverride`

`Path`^Required

`Value`^Required

`OverrideLogicalId`

`NewLogicalId`^Required

`ResetOverrideLogicalId`

`ToHclTerraform`

`ToMetadata`

`ToTerraform`

`AddMoveTarget`

`MoveTarget`^Required

`GetAnyMapAttribute`

`TerraformAttribute`^Required

`GetBooleanAttribute`

`TerraformAttribute`^Required

`GetBooleanMapAttribute`

`TerraformAttribute`^Required

`GetListAttribute`

`TerraformAttribute`^Required

`GetNumberAttribute`

`TerraformAttribute`^Required

`GetNumberListAttribute`

`TerraformAttribute`^Required

`GetNumberMapAttribute`

`TerraformAttribute`^Required

`GetStringAttribute`

`TerraformAttribute`^Required

`GetStringMapAttribute`

`TerraformAttribute`^Required

`HasResourceMove`

`ImportFrom`

`Id`^Required

`Provider`^Optional

`InterpolationForAttribute`

`TerraformAttribute`^Required

`MoveFromId`

`Id`^Required

`MoveTo`

`MoveTarget`^Required

`Index`^Optional

`MoveToId`

`Id`^Required

`ResetCustomAttributes`

`ResetId`

`ResetStartAction`

`ResetStartDelay`

`ResetStartOrder`

`ResetStopAction`

`ResetStopDelay`

`ResetTags`

`ResetWaitForGuest`

`IsConstruct`

`X`^Required

`IsTerraformElement`

`X`^Required

`IsTerraformResource`

`X`^Required

`GenerateConfigForImport`

`Scope`^Required

`ImportToId`^Required

`ImportFromId`^Required

`Provider`^Optional

`Node`^Required

`CdktfStack`^Required

`Fqn`^Required

`FriendlyUniqueId`^Required

`TerraformMetaArguments`^Required

`TerraformResourceType`^Required

`TerraformGeneratorMetadata`^Optional

`Connection`^Optional

`Count`^Optional

`DependsOn`^Optional

`ForEach`^Optional

`Lifecycle`^Optional

`Provider`^Optional