Skip to content

Latest commit

 

History

History
998 lines (628 loc) · 37.3 KB

provider.csharp.md

File metadata and controls

998 lines (628 loc) · 37.3 KB
Raw

provider Submodule

Constructs

VsphereProvider

Represents a {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.10.0/docs vsphere}.

Initializers 

using HashiCorp.Cdktf.Providers.Vsphere;

new VsphereProvider(Construct Scope, string Id, VsphereProviderConfig Config);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config VsphereProviderConfig No description.
ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.

IdRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

ConfigRequired

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.
ResetAlias No description.
ResetAllowUnverifiedSsl No description.
ResetApiTimeout No description.
ResetClientDebug No description.
ResetClientDebugPath No description.
ResetClientDebugPathRun No description.
ResetPersistSession No description.
ResetRestSessionPath No description.
ResetVcenterServer No description.
ResetVimKeepAlive No description.
ResetVimSessionPath No description.
ResetVsphereServer No description.
ToString 
private string ToString()

Returns a string representation of this construct.

AddOverride 
private void AddOverride(string Path, object Value)
PathRequired
  • Type: string
ValueRequired
  • Type: object
OverrideLogicalId 
private void OverrideLogicalId(string NewLogicalId)

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

NewLogicalIdRequired
  • 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.

ResetAlias 
private void ResetAlias()
ResetAllowUnverifiedSsl 
private void ResetAllowUnverifiedSsl()
ResetApiTimeout 
private void ResetApiTimeout()
ResetClientDebug 
private void ResetClientDebug()
ResetClientDebugPath 
private void ResetClientDebugPath()
ResetClientDebugPathRun 
private void ResetClientDebugPathRun()
ResetPersistSession 
private void ResetPersistSession()
ResetRestSessionPath 
private void ResetRestSessionPath()
ResetVcenterServer 
private void ResetVcenterServer()
ResetVimKeepAlive 
private void ResetVimKeepAlive()
ResetVimSessionPath 
private void ResetVimSessionPath()
ResetVsphereServer 
private void ResetVsphereServer()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformProvider No description.
GenerateConfigForImport Generates CDKTF code for importing a VsphereProvider resource upon running "cdktf plan ".
IsConstruct 
using HashiCorp.Cdktf.Providers.Vsphere;

VsphereProvider.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.

XRequired
  • Type: object

Any object.

IsTerraformElement 
using HashiCorp.Cdktf.Providers.Vsphere;

VsphereProvider.IsTerraformElement(object X);
XRequired
  • Type: object
IsTerraformProvider 
using HashiCorp.Cdktf.Providers.Vsphere;

VsphereProvider.IsTerraformProvider(object X);
XRequired
  • Type: object
GenerateConfigForImport 
using HashiCorp.Cdktf.Providers.Vsphere;

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

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

ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.

ImportToIdRequired
  • Type: string

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

ImportFromIdRequired
  • Type: string

The id of the existing VsphereProvider that should be imported.

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

ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider

? Optional instance of the provider where the VsphereProvider 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.
MetaAttributes System.Collections.Generic.IDictionary<string, object> No description.
TerraformResourceType string No description.
TerraformGeneratorMetadata HashiCorp.Cdktf.TerraformProviderGeneratorMetadata No description.
TerraformProviderSource string No description.
Alias string No description.
AliasInput string No description.
AllowUnverifiedSslInput object No description.
ApiTimeoutInput double No description.
ClientDebugInput object No description.
ClientDebugPathInput string No description.
ClientDebugPathRunInput string No description.
PasswordInput string No description.
PersistSessionInput object No description.
RestSessionPathInput string No description.
UserInput string No description.
VcenterServerInput string No description.
VimKeepAliveInput double No description.
VimSessionPathInput string No description.
VsphereServerInput string No description.
AllowUnverifiedSsl object No description.
ApiTimeout double No description.
ClientDebug object No description.
ClientDebugPath string No description.
ClientDebugPathRun string No description.
Password string No description.
PersistSession object No description.
RestSessionPath string No description.
User string No description.
VcenterServer string No description.
VimKeepAlive double No description.
VimSessionPath string No description.
VsphereServer string No description.
NodeRequired 
public Node Node { get; }
  • Type: Constructs.Node

The tree node.

CdktfStackRequired 
public TerraformStack CdktfStack { get; }
  • Type: HashiCorp.Cdktf.TerraformStack
FqnRequired 
public string Fqn { get; }
  • Type: string
FriendlyUniqueIdRequired 
public string FriendlyUniqueId { get; }
  • Type: string
MetaAttributesRequired 
public System.Collections.Generic.IDictionary<string, object> MetaAttributes { get; }
  • Type: System.Collections.Generic.IDictionary<string, object>
TerraformResourceTypeRequired 
public string TerraformResourceType { get; }
  • Type: string
TerraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
  • Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata
TerraformProviderSourceOptional 
public string TerraformProviderSource { get; }
  • Type: string
AliasOptional 
public string Alias { get; }
  • Type: string
AliasInputOptional 
public string AliasInput { get; }
  • Type: string
AllowUnverifiedSslInputOptional 
public object AllowUnverifiedSslInput { get; }
  • Type: object
ApiTimeoutInputOptional 
public double ApiTimeoutInput { get; }
  • Type: double
ClientDebugInputOptional 
public object ClientDebugInput { get; }
  • Type: object
ClientDebugPathInputOptional 
public string ClientDebugPathInput { get; }
  • Type: string
ClientDebugPathRunInputOptional 
public string ClientDebugPathRunInput { get; }
  • Type: string
PasswordInputOptional 
public string PasswordInput { get; }
  • Type: string
PersistSessionInputOptional 
public object PersistSessionInput { get; }
  • Type: object
RestSessionPathInputOptional 
public string RestSessionPathInput { get; }
  • Type: string
UserInputOptional 
public string UserInput { get; }
  • Type: string
VcenterServerInputOptional 
public string VcenterServerInput { get; }
  • Type: string
VimKeepAliveInputOptional 
public double VimKeepAliveInput { get; }
  • Type: double
VimSessionPathInputOptional 
public string VimSessionPathInput { get; }
  • Type: string
VsphereServerInputOptional 
public string VsphereServerInput { get; }
  • Type: string
AllowUnverifiedSslOptional 
public object AllowUnverifiedSsl { get; }
  • Type: object
ApiTimeoutOptional 
public double ApiTimeout { get; }
  • Type: double
ClientDebugOptional 
public object ClientDebug { get; }
  • Type: object
ClientDebugPathOptional 
public string ClientDebugPath { get; }
  • Type: string
ClientDebugPathRunOptional 
public string ClientDebugPathRun { get; }
  • Type: string
PasswordOptional 
public string Password { get; }
  • Type: string
PersistSessionOptional 
public object PersistSession { get; }
  • Type: object
RestSessionPathOptional 
public string RestSessionPath { get; }
  • Type: string
UserOptional 
public string User { get; }
  • Type: string
VcenterServerOptional 
public string VcenterServer { get; }
  • Type: string
VimKeepAliveOptional 
public double VimKeepAlive { get; }
  • Type: double
VimSessionPathOptional 
public string VimSessionPath { get; }
  • Type: string
VsphereServerOptional 
public string VsphereServer { get; }
  • Type: string

Constants

Name Type Description
TfResourceType string No description.
TfResourceTypeRequired 
public string TfResourceType { get; }
  • Type: string

Structs

VsphereProviderConfig

Initializer 

using HashiCorp.Cdktf.Providers.Vsphere;

new VsphereProviderConfig {
    string Password,
    string User,
    string Alias = null,
    object AllowUnverifiedSsl = null,
    double ApiTimeout = null,
    object ClientDebug = null,
    string ClientDebugPath = null,
    string ClientDebugPathRun = null,
    object PersistSession = null,
    string RestSessionPath = null,
    string VcenterServer = null,
    double VimKeepAlive = null,
    string VimSessionPath = null,
    string VsphereServer = null
};

Properties

Name Type Description
Password string The user password for vSphere API operations.
User string The user name for vSphere API operations.
Alias string Alias name.
AllowUnverifiedSsl object If set, VMware vSphere client will permit unverifiable SSL certificates.
ApiTimeout double API timeout in minutes (Default: 5).
ClientDebug object govmomi debug.
ClientDebugPath string govmomi debug path for debug.
ClientDebugPathRun string govmomi debug path for a single run.
PersistSession object Persist vSphere client sessions to disk.
RestSessionPath string The directory to save vSphere REST API sessions to.
VcenterServer string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.10.0/docs#vcenter_server VsphereProvider#vcenter_server}.
VimKeepAlive double Keep alive interval for the VIM session in minutes.
VimSessionPath string The directory to save vSphere SOAP API sessions to.
VsphereServer string The vSphere Server name for vSphere API operations.
PasswordRequired 
public string Password { get; set; }
  • Type: string

The user password for vSphere API operations.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.10.0/docs#password VsphereProvider#password}

UserRequired 
public string User { get; set; }
  • Type: string

The user name for vSphere API operations.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.10.0/docs#user VsphereProvider#user}

AliasOptional 
public string Alias { get; set; }
  • Type: string

Alias name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.10.0/docs#alias VsphereProvider#alias}

AllowUnverifiedSslOptional 
public object AllowUnverifiedSsl { get; set; }
  • Type: object

If set, VMware vSphere client will permit unverifiable SSL certificates.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.10.0/docs#allow_unverified_ssl VsphereProvider#allow_unverified_ssl}

ApiTimeoutOptional 
public double ApiTimeout { get; set; }
  • Type: double

API timeout in minutes (Default: 5).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.10.0/docs#api_timeout VsphereProvider#api_timeout}

ClientDebugOptional 
public object ClientDebug { get; set; }
  • Type: object

govmomi debug.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.10.0/docs#client_debug VsphereProvider#client_debug}

ClientDebugPathOptional 
public string ClientDebugPath { get; set; }
  • Type: string

govmomi debug path for debug.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.10.0/docs#client_debug_path VsphereProvider#client_debug_path}

ClientDebugPathRunOptional 
public string ClientDebugPathRun { get; set; }
  • Type: string

govmomi debug path for a single run.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.10.0/docs#client_debug_path_run VsphereProvider#client_debug_path_run}

PersistSessionOptional 
public object PersistSession { get; set; }
  • Type: object

Persist vSphere client sessions to disk.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.10.0/docs#persist_session VsphereProvider#persist_session}

RestSessionPathOptional 
public string RestSessionPath { get; set; }
  • Type: string

The directory to save vSphere REST API sessions to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.10.0/docs#rest_session_path VsphereProvider#rest_session_path}

VcenterServerOptional 
public string VcenterServer { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.10.0/docs#vcenter_server VsphereProvider#vcenter_server}.

VimKeepAliveOptional 
public double VimKeepAlive { get; set; }
  • Type: double

Keep alive interval for the VIM session in minutes.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.10.0/docs#vim_keep_alive VsphereProvider#vim_keep_alive}

VimSessionPathOptional 
public string VimSessionPath { get; set; }
  • Type: string

The directory to save vSphere SOAP API sessions to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.10.0/docs#vim_session_path VsphereProvider#vim_session_path}

VsphereServerOptional 
public string VsphereServer { get; set; }
  • Type: string

The vSphere Server name for vSphere API operations.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vsphere/2.10.0/docs#vsphere_server VsphereProvider#vsphere_server}