Skip to content

Latest commit

 

History

History
1101 lines (689 loc) · 51.6 KB

dataDatabricksSparkVersion.typescript.md

File metadata and controls

1101 lines (689 loc) · 51.6 KB

dataDatabricksSparkVersion Submodule

Constructs

DataDatabricksSparkVersion

Represents a {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/data-sources/spark_version databricks_spark_version}.

Initializers

import { dataDatabricksSparkVersion } from '@cdktf/provider-databricks'

new dataDatabricksSparkVersion.DataDatabricksSparkVersion(scope: Construct, id: string, config?: DataDatabricksSparkVersionConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config DataDatabricksSparkVersionConfig 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.
resetBeta No description.
resetGenomics No description.
resetGpu No description.
resetGraviton No description.
resetId No description.
resetLatest No description.
resetLongTermSupport No description.
resetMl No description.
resetPhoton No description.
resetScala No description.
resetSparkVersion No description.

toString
public toString(): string

Returns a string representation of this construct.

addOverride
public addOverride(path: string, value: any): void
pathRequired
  • Type: string

valueRequired
  • Type: any

overrideLogicalId
public overrideLogicalId(newLogicalId: string): void

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

newLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.


resetOverrideLogicalId
public resetOverrideLogicalId(): void

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

toHclTerraform
public toHclTerraform(): any

Adds this resource to the terraform JSON output.

toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any

Adds this resource to the terraform JSON output.

getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string

interpolationForAttribute
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

resetBeta
public resetBeta(): void
resetGenomics
public resetGenomics(): void
resetGpu
public resetGpu(): void
resetGraviton
public resetGraviton(): void
resetId
public resetId(): void
resetLatest
public resetLatest(): void
resetLongTermSupport
public resetLongTermSupport(): void
resetMl
public resetMl(): void
resetPhoton
public resetPhoton(): void
resetScala
public resetScala(): void
resetSparkVersion
public resetSparkVersion(): void

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformDataSource No description.
generateConfigForImport Generates CDKTF code for importing a DataDatabricksSparkVersion resource upon running "cdktf plan ".

isConstruct
import { dataDatabricksSparkVersion } from '@cdktf/provider-databricks'

dataDatabricksSparkVersion.DataDatabricksSparkVersion.isConstruct(x: any)

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: any

Any object.


isTerraformElement
import { dataDatabricksSparkVersion } from '@cdktf/provider-databricks'

dataDatabricksSparkVersion.DataDatabricksSparkVersion.isTerraformElement(x: any)
xRequired
  • Type: any

isTerraformDataSource
import { dataDatabricksSparkVersion } from '@cdktf/provider-databricks'

dataDatabricksSparkVersion.DataDatabricksSparkVersion.isTerraformDataSource(x: any)
xRequired
  • Type: any

generateConfigForImport
import { dataDatabricksSparkVersion } from '@cdktf/provider-databricks'

dataDatabricksSparkVersion.DataDatabricksSparkVersion.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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


importFromIdRequired
  • Type: string

The id of the existing DataDatabricksSparkVersion that should be imported.

Refer to the {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/data-sources/spark_version#import import section} in the documentation of this resource for the id to use


providerOptional
  • Type: cdktf.TerraformProvider

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


Properties

Name Type Description
node constructs.Node The tree node.
cdktfStack cdktf.TerraformStack No description.
fqn string No description.
friendlyUniqueId string No description.
terraformMetaArguments {[ key: string ]: any} No description.
terraformResourceType string No description.
terraformGeneratorMetadata cdktf.TerraformProviderGeneratorMetadata No description.
count number | cdktf.TerraformCount No description.
dependsOn string[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
betaInput boolean | cdktf.IResolvable No description.
genomicsInput boolean | cdktf.IResolvable No description.
gpuInput boolean | cdktf.IResolvable No description.
gravitonInput boolean | cdktf.IResolvable No description.
idInput string No description.
latestInput boolean | cdktf.IResolvable No description.
longTermSupportInput boolean | cdktf.IResolvable No description.
mlInput boolean | cdktf.IResolvable No description.
photonInput boolean | cdktf.IResolvable No description.
scalaInput string No description.
sparkVersionInput string No description.
beta boolean | cdktf.IResolvable No description.
genomics boolean | cdktf.IResolvable No description.
gpu boolean | cdktf.IResolvable No description.
graviton boolean | cdktf.IResolvable No description.
id string No description.
latest boolean | cdktf.IResolvable No description.
longTermSupport boolean | cdktf.IResolvable No description.
ml boolean | cdktf.IResolvable No description.
photon boolean | cdktf.IResolvable No description.
scala string No description.
sparkVersion string No description.

nodeRequired
public readonly node: Node;
  • Type: constructs.Node

The tree node.


cdktfStackRequired
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack

fqnRequired
public readonly fqn: string;
  • Type: string

friendlyUniqueIdRequired
public readonly friendlyUniqueId: string;
  • Type: string

terraformMetaArgumentsRequired
public readonly terraformMetaArguments: {[ key: string ]: any};
  • Type: {[ key: string ]: any}

terraformResourceTypeRequired
public readonly terraformResourceType: string;
  • Type: string

terraformGeneratorMetadataOptional
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: string[];
  • Type: string[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

betaInputOptional
public readonly betaInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

genomicsInputOptional
public readonly genomicsInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

gpuInputOptional
public readonly gpuInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

gravitonInputOptional
public readonly gravitonInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

idInputOptional
public readonly idInput: string;
  • Type: string

latestInputOptional
public readonly latestInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

longTermSupportInputOptional
public readonly longTermSupportInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

mlInputOptional
public readonly mlInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

photonInputOptional
public readonly photonInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

scalaInputOptional
public readonly scalaInput: string;
  • Type: string

sparkVersionInputOptional
public readonly sparkVersionInput: string;
  • Type: string

betaRequired
public readonly beta: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

genomicsRequired
public readonly genomics: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

gpuRequired
public readonly gpu: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

gravitonRequired
public readonly graviton: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

idRequired
public readonly id: string;
  • Type: string

latestRequired
public readonly latest: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

longTermSupportRequired
public readonly longTermSupport: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

mlRequired
public readonly ml: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

photonRequired
public readonly photon: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

scalaRequired
public readonly scala: string;
  • Type: string

sparkVersionRequired
public readonly sparkVersion: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

DataDatabricksSparkVersionConfig

Initializer

import { dataDatabricksSparkVersion } from '@cdktf/provider-databricks'

const dataDatabricksSparkVersionConfig: dataDatabricksSparkVersion.DataDatabricksSparkVersionConfig = { ... }

Properties

Name Type Description
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn cdktf.ITerraformDependable[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
beta boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/data-sources/spark_version#beta DataDatabricksSparkVersion#beta}.
genomics boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/data-sources/spark_version#genomics DataDatabricksSparkVersion#genomics}.
gpu boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/data-sources/spark_version#gpu DataDatabricksSparkVersion#gpu}.
graviton boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/data-sources/spark_version#graviton DataDatabricksSparkVersion#graviton}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/data-sources/spark_version#id DataDatabricksSparkVersion#id}.
latest boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/data-sources/spark_version#latest DataDatabricksSparkVersion#latest}.
longTermSupport boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/data-sources/spark_version#long_term_support DataDatabricksSparkVersion#long_term_support}.
ml boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/data-sources/spark_version#ml DataDatabricksSparkVersion#ml}.
photon boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/data-sources/spark_version#photon DataDatabricksSparkVersion#photon}.
scala string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/data-sources/spark_version#scala DataDatabricksSparkVersion#scala}.
sparkVersion string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/data-sources/spark_version#spark_version DataDatabricksSparkVersion#spark_version}.

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

betaOptional
public readonly beta: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/data-sources/spark_version#beta DataDatabricksSparkVersion#beta}.


genomicsOptional
public readonly genomics: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/data-sources/spark_version#genomics DataDatabricksSparkVersion#genomics}.


gpuOptional
public readonly gpu: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/data-sources/spark_version#gpu DataDatabricksSparkVersion#gpu}.


gravitonOptional
public readonly graviton: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/data-sources/spark_version#graviton DataDatabricksSparkVersion#graviton}.


idOptional
public readonly id: string;
  • Type: string

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


latestOptional
public readonly latest: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/data-sources/spark_version#latest DataDatabricksSparkVersion#latest}.


longTermSupportOptional
public readonly longTermSupport: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/data-sources/spark_version#long_term_support DataDatabricksSparkVersion#long_term_support}.


mlOptional
public readonly ml: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/data-sources/spark_version#ml DataDatabricksSparkVersion#ml}.


photonOptional
public readonly photon: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/data-sources/spark_version#photon DataDatabricksSparkVersion#photon}.


scalaOptional
public readonly scala: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/data-sources/spark_version#scala DataDatabricksSparkVersion#scala}.


sparkVersionOptional
public readonly sparkVersion: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/data-sources/spark_version#spark_version DataDatabricksSparkVersion#spark_version}.