Skip to content

Latest commit

 

History

History
1977 lines (1224 loc) · 92.4 KB

externalLocation.typescript.md

File metadata and controls

1977 lines (1224 loc) · 92.4 KB

externalLocation Submodule

Constructs

ExternalLocation

Represents a {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/external_location databricks_external_location}.

Initializers

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

new externalLocation.ExternalLocation(scope: Construct, id: string, config: ExternalLocationConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config ExternalLocationConfig 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.
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".
putEncryptionDetails No description.
resetAccessPoint No description.
resetComment No description.
resetEncryptionDetails No description.
resetForceDestroy No description.
resetForceUpdate No description.
resetId No description.
resetMetastoreId No description.
resetOwner No description.
resetReadOnly No description.
resetSkipValidation 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
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget
public addMoveTarget(moveTarget: string): void

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

moveTargetRequired
  • Type: string

The string move target that will correspond to this resource.


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

hasResourceMove
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string

providerOptional
  • Type: cdktf.TerraformProvider

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

moveFromId
public moveFromId(id: string): void

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.

idRequired
  • Type: string

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


moveTo
public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: string

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


indexOptional
  • Type: string | number

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


moveToId
public moveToId(id: string): void

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

idRequired
  • Type: string

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


putEncryptionDetails
public putEncryptionDetails(value: ExternalLocationEncryptionDetails): void
valueRequired

resetAccessPoint
public resetAccessPoint(): void
resetComment
public resetComment(): void
resetEncryptionDetails
public resetEncryptionDetails(): void
resetForceDestroy
public resetForceDestroy(): void
resetForceUpdate
public resetForceUpdate(): void
resetId
public resetId(): void
resetMetastoreId
public resetMetastoreId(): void
resetOwner
public resetOwner(): void
resetReadOnly
public resetReadOnly(): void
resetSkipValidation
public resetSkipValidation(): void

Static Functions

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

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

externalLocation.ExternalLocation.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 { externalLocation } from '@cdktf/provider-databricks'

externalLocation.ExternalLocation.isTerraformElement(x: any)
xRequired
  • Type: any

isTerraformResource
import { externalLocation } from '@cdktf/provider-databricks'

externalLocation.ExternalLocation.isTerraformResource(x: any)
xRequired
  • Type: any

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

externalLocation.ExternalLocation.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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


importFromIdRequired
  • Type: string

The id of the existing ExternalLocation that should be imported.

Refer to the {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/external_location#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 ExternalLocation 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.
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection 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.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
encryptionDetails ExternalLocationEncryptionDetailsOutputReference No description.
accessPointInput string No description.
commentInput string No description.
credentialNameInput string No description.
encryptionDetailsInput ExternalLocationEncryptionDetails No description.
forceDestroyInput boolean | cdktf.IResolvable No description.
forceUpdateInput boolean | cdktf.IResolvable No description.
idInput string No description.
metastoreIdInput string No description.
nameInput string No description.
ownerInput string No description.
readOnlyInput boolean | cdktf.IResolvable No description.
skipValidationInput boolean | cdktf.IResolvable No description.
urlInput string No description.
accessPoint string No description.
comment string No description.
credentialName string No description.
forceDestroy boolean | cdktf.IResolvable No description.
forceUpdate boolean | cdktf.IResolvable No description.
id string No description.
metastoreId string No description.
name string No description.
owner string No description.
readOnly boolean | cdktf.IResolvable No description.
skipValidation boolean | cdktf.IResolvable No description.
url 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

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

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

encryptionDetailsRequired
public readonly encryptionDetails: ExternalLocationEncryptionDetailsOutputReference;

accessPointInputOptional
public readonly accessPointInput: string;
  • Type: string

commentInputOptional
public readonly commentInput: string;
  • Type: string

credentialNameInputOptional
public readonly credentialNameInput: string;
  • Type: string

encryptionDetailsInputOptional
public readonly encryptionDetailsInput: ExternalLocationEncryptionDetails;

forceDestroyInputOptional
public readonly forceDestroyInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

forceUpdateInputOptional
public readonly forceUpdateInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

idInputOptional
public readonly idInput: string;
  • Type: string

metastoreIdInputOptional
public readonly metastoreIdInput: string;
  • Type: string

nameInputOptional
public readonly nameInput: string;
  • Type: string

ownerInputOptional
public readonly ownerInput: string;
  • Type: string

readOnlyInputOptional
public readonly readOnlyInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

skipValidationInputOptional
public readonly skipValidationInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

urlInputOptional
public readonly urlInput: string;
  • Type: string

accessPointRequired
public readonly accessPoint: string;
  • Type: string

commentRequired
public readonly comment: string;
  • Type: string

credentialNameRequired
public readonly credentialName: string;
  • Type: string

forceDestroyRequired
public readonly forceDestroy: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

forceUpdateRequired
public readonly forceUpdate: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

idRequired
public readonly id: string;
  • Type: string

metastoreIdRequired
public readonly metastoreId: string;
  • Type: string

nameRequired
public readonly name: string;
  • Type: string

ownerRequired
public readonly owner: string;
  • Type: string

readOnlyRequired
public readonly readOnly: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

skipValidationRequired
public readonly skipValidation: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

urlRequired
public readonly url: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

ExternalLocationConfig

Initializer

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

const externalLocationConfig: externalLocation.ExternalLocationConfig = { ... }

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.
credentialName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/external_location#credential_name ExternalLocation#credential_name}.
name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/external_location#name ExternalLocation#name}.
url string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/external_location#url ExternalLocation#url}.
accessPoint string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/external_location#access_point ExternalLocation#access_point}.
comment string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/external_location#comment ExternalLocation#comment}.
encryptionDetails ExternalLocationEncryptionDetails encryption_details block.
forceDestroy boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/external_location#force_destroy ExternalLocation#force_destroy}.
forceUpdate boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/external_location#force_update ExternalLocation#force_update}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/external_location#id ExternalLocation#id}.
metastoreId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/external_location#metastore_id ExternalLocation#metastore_id}.
owner string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/external_location#owner ExternalLocation#owner}.
readOnly boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/external_location#read_only ExternalLocation#read_only}.
skipValidation boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/external_location#skip_validation ExternalLocation#skip_validation}.

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

credentialNameRequired
public readonly credentialName: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/external_location#credential_name ExternalLocation#credential_name}.


nameRequired
public readonly name: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/external_location#name ExternalLocation#name}.


urlRequired
public readonly url: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/external_location#url ExternalLocation#url}.


accessPointOptional
public readonly accessPoint: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/external_location#access_point ExternalLocation#access_point}.


commentOptional
public readonly comment: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/external_location#comment ExternalLocation#comment}.


encryptionDetailsOptional
public readonly encryptionDetails: ExternalLocationEncryptionDetails;

encryption_details block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/external_location#encryption_details ExternalLocation#encryption_details}


forceDestroyOptional
public readonly forceDestroy: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/external_location#force_destroy ExternalLocation#force_destroy}.


forceUpdateOptional
public readonly forceUpdate: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/external_location#force_update ExternalLocation#force_update}.


idOptional
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/external_location#id ExternalLocation#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.


metastoreIdOptional
public readonly metastoreId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/external_location#metastore_id ExternalLocation#metastore_id}.


ownerOptional
public readonly owner: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/external_location#owner ExternalLocation#owner}.


readOnlyOptional
public readonly readOnly: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/external_location#read_only ExternalLocation#read_only}.


skipValidationOptional
public readonly skipValidation: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/external_location#skip_validation ExternalLocation#skip_validation}.


ExternalLocationEncryptionDetails

Initializer

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

const externalLocationEncryptionDetails: externalLocation.ExternalLocationEncryptionDetails = { ... }

Properties

Name Type Description
sseEncryptionDetails ExternalLocationEncryptionDetailsSseEncryptionDetails sse_encryption_details block.

sseEncryptionDetailsOptional
public readonly sseEncryptionDetails: ExternalLocationEncryptionDetailsSseEncryptionDetails;

sse_encryption_details block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/external_location#sse_encryption_details ExternalLocation#sse_encryption_details}


ExternalLocationEncryptionDetailsSseEncryptionDetails

Initializer

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

const externalLocationEncryptionDetailsSseEncryptionDetails: externalLocation.ExternalLocationEncryptionDetailsSseEncryptionDetails = { ... }

Properties

Name Type Description
algorithm string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/external_location#algorithm ExternalLocation#algorithm}.
awsKmsKeyArn string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/external_location#aws_kms_key_arn ExternalLocation#aws_kms_key_arn}.

algorithmOptional
public readonly algorithm: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/external_location#algorithm ExternalLocation#algorithm}.


awsKmsKeyArnOptional
public readonly awsKmsKeyArn: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/external_location#aws_kms_key_arn ExternalLocation#aws_kms_key_arn}.


Classes

ExternalLocationEncryptionDetailsOutputReference

Initializers

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

new externalLocation.ExternalLocationEncryptionDetailsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


Methods

Name Description
computeFqn No description.
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.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
putSseEncryptionDetails No description.
resetSseEncryptionDetails No description.

computeFqn
public computeFqn(): string
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(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

putSseEncryptionDetails
public putSseEncryptionDetails(value: ExternalLocationEncryptionDetailsSseEncryptionDetails): void
valueRequired

resetSseEncryptionDetails
public resetSseEncryptionDetails(): void

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
sseEncryptionDetails ExternalLocationEncryptionDetailsSseEncryptionDetailsOutputReference No description.
sseEncryptionDetailsInput ExternalLocationEncryptionDetailsSseEncryptionDetails No description.
internalValue ExternalLocationEncryptionDetails No description.

creationStackRequired
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


fqnRequired
public readonly fqn: string;
  • Type: string

sseEncryptionDetailsRequired
public readonly sseEncryptionDetails: ExternalLocationEncryptionDetailsSseEncryptionDetailsOutputReference;

sseEncryptionDetailsInputOptional
public readonly sseEncryptionDetailsInput: ExternalLocationEncryptionDetailsSseEncryptionDetails;

internalValueOptional
public readonly internalValue: ExternalLocationEncryptionDetails;

ExternalLocationEncryptionDetailsSseEncryptionDetailsOutputReference

Initializers

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

new externalLocation.ExternalLocationEncryptionDetailsSseEncryptionDetailsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


Methods

Name Description
computeFqn No description.
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.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetAlgorithm No description.
resetAwsKmsKeyArn No description.

computeFqn
public computeFqn(): string
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(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetAlgorithm
public resetAlgorithm(): void
resetAwsKmsKeyArn
public resetAwsKmsKeyArn(): void

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
algorithmInput string No description.
awsKmsKeyArnInput string No description.
algorithm string No description.
awsKmsKeyArn string No description.
internalValue ExternalLocationEncryptionDetailsSseEncryptionDetails No description.

creationStackRequired
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


fqnRequired
public readonly fqn: string;
  • Type: string

algorithmInputOptional
public readonly algorithmInput: string;
  • Type: string

awsKmsKeyArnInputOptional
public readonly awsKmsKeyArnInput: string;
  • Type: string

algorithmRequired
public readonly algorithm: string;
  • Type: string

awsKmsKeyArnRequired
public readonly awsKmsKeyArn: string;
  • Type: string

internalValueOptional
public readonly internalValue: ExternalLocationEncryptionDetailsSseEncryptionDetails;