Skip to content

Latest commit

 

History

History
991 lines (624 loc) · 46 KB

dataDatabricksClusterPolicy.csharp.md

File metadata and controls

991 lines (624 loc) · 46 KB

dataDatabricksClusterPolicy Submodule

Constructs

DataDatabricksClusterPolicy

Represents a {@link https://registry.terraform.io/providers/databricks/databricks/1.52.0/docs/data-sources/cluster_policy databricks_cluster_policy}.

Initializers

using HashiCorp.Cdktf.Providers.Databricks;

new DataDatabricksClusterPolicy(Construct Scope, string Id, DataDatabricksClusterPolicyConfig Config = null);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config DataDatabricksClusterPolicyConfig 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


ConfigOptional

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 Adds this resource to the terraform JSON output.
ToMetadata No description.
ToTerraform Adds this resource to the terraform JSON output.
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.
InterpolationForAttribute No description.
ResetDefinition No description.
ResetDescription No description.
ResetId No description.
ResetIsDefault No description.
ResetMaxClustersPerUser No description.
ResetName No description.
ResetPolicyFamilyDefinitionOverrides No description.
ResetPolicyFamilyId 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()

Adds this resource to the terraform JSON output.

ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()

Adds this resource to the terraform JSON output.

GetAnyMapAttribute
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanAttribute
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanMapAttribute
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetListAttribute
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberAttribute
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberListAttribute
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberMapAttribute
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringAttribute
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringMapAttribute
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

InterpolationForAttribute
private IResolvable InterpolationForAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

ResetDefinition
private void ResetDefinition()
ResetDescription
private void ResetDescription()
ResetId
private void ResetId()
ResetIsDefault
private void ResetIsDefault()
ResetMaxClustersPerUser
private void ResetMaxClustersPerUser()
ResetName
private void ResetName()
ResetPolicyFamilyDefinitionOverrides
private void ResetPolicyFamilyDefinitionOverrides()
ResetPolicyFamilyId
private void ResetPolicyFamilyId()

Static Functions

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

IsConstruct
using HashiCorp.Cdktf.Providers.Databricks;

DataDatabricksClusterPolicy.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.Databricks;

DataDatabricksClusterPolicy.IsTerraformElement(object X);
XRequired
  • Type: object

IsTerraformDataSource
using HashiCorp.Cdktf.Providers.Databricks;

DataDatabricksClusterPolicy.IsTerraformDataSource(object X);
XRequired
  • Type: object

GenerateConfigForImport
using HashiCorp.Cdktf.Providers.Databricks;

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

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


ImportFromIdRequired
  • Type: string

The id of the existing DataDatabricksClusterPolicy that should be imported.

Refer to the {@link https://registry.terraform.io/providers/databricks/databricks/1.52.0/docs/data-sources/cluster_policy#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 DataDatabricksClusterPolicy 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.
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.
DefinitionInput string No description.
DescriptionInput string No description.
IdInput string No description.
IsDefaultInput object No description.
MaxClustersPerUserInput double No description.
NameInput string No description.
PolicyFamilyDefinitionOverridesInput string No description.
PolicyFamilyIdInput string No description.
Definition string No description.
Description string No description.
Id string No description.
IsDefault object No description.
MaxClustersPerUser double No description.
Name string No description.
PolicyFamilyDefinitionOverrides string No description.
PolicyFamilyId 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

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

TerraformResourceTypeRequired
public string TerraformResourceType { get; }
  • Type: string

TerraformGeneratorMetadataOptional
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
  • Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

CountOptional
public object Count { get; }
  • Type: object

DependsOnOptional
public string[] DependsOn { get; }
  • Type: string[]

ForEachOptional
public ITerraformIterator ForEach { get; }
  • Type: HashiCorp.Cdktf.ITerraformIterator

LifecycleOptional
public TerraformResourceLifecycle Lifecycle { get; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle

ProviderOptional
public TerraformProvider Provider { get; }
  • Type: HashiCorp.Cdktf.TerraformProvider

DefinitionInputOptional
public string DefinitionInput { get; }
  • Type: string

DescriptionInputOptional
public string DescriptionInput { get; }
  • Type: string

IdInputOptional
public string IdInput { get; }
  • Type: string

IsDefaultInputOptional
public object IsDefaultInput { get; }
  • Type: object

MaxClustersPerUserInputOptional
public double MaxClustersPerUserInput { get; }
  • Type: double

NameInputOptional
public string NameInput { get; }
  • Type: string

PolicyFamilyDefinitionOverridesInputOptional
public string PolicyFamilyDefinitionOverridesInput { get; }
  • Type: string

PolicyFamilyIdInputOptional
public string PolicyFamilyIdInput { get; }
  • Type: string

DefinitionRequired
public string Definition { get; }
  • Type: string

DescriptionRequired
public string Description { get; }
  • Type: string

IdRequired
public string Id { get; }
  • Type: string

IsDefaultRequired
public object IsDefault { get; }
  • Type: object

MaxClustersPerUserRequired
public double MaxClustersPerUser { get; }
  • Type: double

NameRequired
public string Name { get; }
  • Type: string

PolicyFamilyDefinitionOverridesRequired
public string PolicyFamilyDefinitionOverrides { get; }
  • Type: string

PolicyFamilyIdRequired
public string PolicyFamilyId { get; }
  • Type: string

Constants

Name Type Description
TfResourceType string No description.

TfResourceTypeRequired
public string TfResourceType { get; }
  • Type: string

Structs

DataDatabricksClusterPolicyConfig

Initializer

using HashiCorp.Cdktf.Providers.Databricks;

new DataDatabricksClusterPolicyConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string Definition = null,
    string Description = null,
    string Id = null,
    object IsDefault = null,
    double MaxClustersPerUser = null,
    string Name = null,
    string PolicyFamilyDefinitionOverrides = null,
    string PolicyFamilyId = 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.
Definition string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.52.0/docs/data-sources/cluster_policy#definition DataDatabricksClusterPolicy#definition}.
Description string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.52.0/docs/data-sources/cluster_policy#description DataDatabricksClusterPolicy#description}.
Id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.52.0/docs/data-sources/cluster_policy#id DataDatabricksClusterPolicy#id}.
IsDefault object Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.52.0/docs/data-sources/cluster_policy#is_default DataDatabricksClusterPolicy#is_default}.
MaxClustersPerUser double Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.52.0/docs/data-sources/cluster_policy#max_clusters_per_user DataDatabricksClusterPolicy#max_clusters_per_user}.
Name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.52.0/docs/data-sources/cluster_policy#name DataDatabricksClusterPolicy#name}.
PolicyFamilyDefinitionOverrides string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.52.0/docs/data-sources/cluster_policy#policy_family_definition_overrides DataDatabricksClusterPolicy#policy_family_definition_overrides}.
PolicyFamilyId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.52.0/docs/data-sources/cluster_policy#policy_family_id DataDatabricksClusterPolicy#policy_family_id}.

ConnectionOptional
public object Connection { get; set; }
  • Type: object

CountOptional
public object Count { get; set; }
  • Type: object

DependsOnOptional
public ITerraformDependable[] DependsOn { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformDependable[]

ForEachOptional
public ITerraformIterator ForEach { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformIterator

LifecycleOptional
public TerraformResourceLifecycle Lifecycle { get; set; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle

ProviderOptional
public TerraformProvider Provider { get; set; }
  • Type: HashiCorp.Cdktf.TerraformProvider

ProvisionersOptional
public object[] Provisioners { get; set; }
  • Type: object[]

DefinitionOptional
public string Definition { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.52.0/docs/data-sources/cluster_policy#definition DataDatabricksClusterPolicy#definition}.


DescriptionOptional
public string Description { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.52.0/docs/data-sources/cluster_policy#description DataDatabricksClusterPolicy#description}.


IdOptional
public string Id { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.52.0/docs/data-sources/cluster_policy#id DataDatabricksClusterPolicy#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.


IsDefaultOptional
public object IsDefault { get; set; }
  • Type: object

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.52.0/docs/data-sources/cluster_policy#is_default DataDatabricksClusterPolicy#is_default}.


MaxClustersPerUserOptional
public double MaxClustersPerUser { get; set; }
  • Type: double

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.52.0/docs/data-sources/cluster_policy#max_clusters_per_user DataDatabricksClusterPolicy#max_clusters_per_user}.


NameOptional
public string Name { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.52.0/docs/data-sources/cluster_policy#name DataDatabricksClusterPolicy#name}.


PolicyFamilyDefinitionOverridesOptional
public string PolicyFamilyDefinitionOverrides { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.52.0/docs/data-sources/cluster_policy#policy_family_definition_overrides DataDatabricksClusterPolicy#policy_family_definition_overrides}.


PolicyFamilyIdOptional
public string PolicyFamilyId { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.52.0/docs/data-sources/cluster_policy#policy_family_id DataDatabricksClusterPolicy#policy_family_id}.