Skip to content

Files

Latest commit

6164312 · Dec 19, 2024

History

History
733 lines (456 loc) · 31.8 KB
·

dataDatabricksCatalogs.go.md

File metadata and controls

733 lines (456 loc) · 31.8 KB
·

dataDatabricksCatalogs Submodule

Constructs

DataDatabricksCatalogs

Represents a {@link https://registry.terraform.io/providers/databricks/databricks/1.62.0/docs/data-sources/catalogs databricks_catalogs}.

Initializers

import "github.com/cdktf/cdktf-provider-databricks-go/databricks/v13/datadatabrickscatalogs"

datadatabrickscatalogs.NewDataDatabricksCatalogs(scope Construct, id *string, config DataDatabricksCatalogsConfig) DataDatabricksCatalogs
Name Type Description
scope github.com/aws/constructs-go/constructs/v10.Construct The scope in which to define this construct.
id *string The scoped construct ID.
config DataDatabricksCatalogsConfig No description.

scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.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.
ResetId No description.
ResetIds No description.

ToString
func ToString() *string

Returns a string representation of this construct.

AddOverride
func AddOverride(path *string, value interface{})
pathRequired
  • Type: *string

valueRequired
  • Type: interface{}

OverrideLogicalId
func OverrideLogicalId(newLogicalId *string)

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

newLogicalIdRequired
  • Type: *string

The new logical ID to use for this stack element.


ResetOverrideLogicalId
func ResetOverrideLogicalId()

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

ToHclTerraform
func ToHclTerraform() interface{}

Adds this resource to the terraform JSON output.

ToMetadata
func ToMetadata() interface{}
ToTerraform
func ToTerraform() interface{}

Adds this resource to the terraform JSON output.

GetAnyMapAttribute
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
terraformAttributeRequired
  • Type: *string

GetBooleanAttribute
func GetBooleanAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string

GetBooleanMapAttribute
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
terraformAttributeRequired
  • Type: *string

GetListAttribute
func GetListAttribute(terraformAttribute *string) *[]*string
terraformAttributeRequired
  • Type: *string

GetNumberAttribute
func GetNumberAttribute(terraformAttribute *string) *f64
terraformAttributeRequired
  • Type: *string

GetNumberListAttribute
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
terraformAttributeRequired
  • Type: *string

GetNumberMapAttribute
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
terraformAttributeRequired
  • Type: *string

GetStringAttribute
func GetStringAttribute(terraformAttribute *string) *string
terraformAttributeRequired
  • Type: *string

GetStringMapAttribute
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
terraformAttributeRequired
  • Type: *string

InterpolationForAttribute
func InterpolationForAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string

ResetId
func ResetId()
ResetIds
func ResetIds()

Static Functions

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

IsConstruct
import "github.com/cdktf/cdktf-provider-databricks-go/databricks/v13/datadatabrickscatalogs"

datadatabrickscatalogs.DataDatabricksCatalogs_IsConstruct(x interface{}) *bool

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: interface{}

Any object.


IsTerraformElement
import "github.com/cdktf/cdktf-provider-databricks-go/databricks/v13/datadatabrickscatalogs"

datadatabrickscatalogs.DataDatabricksCatalogs_IsTerraformElement(x interface{}) *bool
xRequired
  • Type: interface{}

IsTerraformDataSource
import "github.com/cdktf/cdktf-provider-databricks-go/databricks/v13/datadatabrickscatalogs"

datadatabrickscatalogs.DataDatabricksCatalogs_IsTerraformDataSource(x interface{}) *bool
xRequired
  • Type: interface{}

GenerateConfigForImport
import "github.com/cdktf/cdktf-provider-databricks-go/databricks/v13/datadatabrickscatalogs"

datadatabrickscatalogs.DataDatabricksCatalogs_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

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

scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.


importToIdRequired
  • Type: *string

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


importFromIdRequired
  • Type: *string

The id of the existing DataDatabricksCatalogs that should be imported.

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


providerOptional
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

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


Properties

Name Type Description
Node github.com/aws/constructs-go/constructs/v10.Node The tree node.
CdktfStack github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack No description.
Fqn *string No description.
FriendlyUniqueId *string No description.
TerraformMetaArguments *map[string]interface{} No description.
TerraformResourceType *string No description.
TerraformGeneratorMetadata github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata No description.
Count interface{} No description.
DependsOn *[]*string No description.
ForEach github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator No description.
Lifecycle github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle No description.
Provider github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider No description.
IdInput *string No description.
IdsInput *[]*string No description.
Id *string No description.
Ids *[]*string No description.

NodeRequired
func Node() Node
  • Type: github.com/aws/constructs-go/constructs/v10.Node

The tree node.


CdktfStackRequired
func CdktfStack() TerraformStack
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack

FqnRequired
func Fqn() *string
  • Type: *string

FriendlyUniqueIdRequired
func FriendlyUniqueId() *string
  • Type: *string

TerraformMetaArgumentsRequired
func TerraformMetaArguments() *map[string]interface{}
  • Type: *map[string]interface{}

TerraformResourceTypeRequired
func TerraformResourceType() *string
  • Type: *string

TerraformGeneratorMetadataOptional
func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata

CountOptional
func Count() interface{}
  • Type: interface{}

DependsOnOptional
func DependsOn() *[]*string
  • Type: *[]*string

ForEachOptional
func ForEach() ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator

LifecycleOptional
func Lifecycle() TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle

ProviderOptional
func Provider() TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

IdInputOptional
func IdInput() *string
  • Type: *string

IdsInputOptional
func IdsInput() *[]*string
  • Type: *[]*string

IdRequired
func Id() *string
  • Type: *string

IdsRequired
func Ids() *[]*string
  • Type: *[]*string

Constants

Name Type Description
TfResourceType *string No description.

TfResourceTypeRequired
func TfResourceType() *string
  • Type: *string

Structs

DataDatabricksCatalogsConfig

Initializer

import "github.com/cdktf/cdktf-provider-databricks-go/databricks/v13/datadatabrickscatalogs"

&datadatabrickscatalogs.DataDatabricksCatalogsConfig {
	Connection: interface{},
	Count: interface{},
	DependsOn: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable,
	ForEach: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator,
	Lifecycle: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle,
	Provider: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider,
	Provisioners: *[]interface{},
	Id: *string,
	Ids: *[]*string,
}

Properties

Name Type Description
Connection interface{} No description.
Count interface{} No description.
DependsOn *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable No description.
ForEach github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator No description.
Lifecycle github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle No description.
Provider github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider No description.
Provisioners *[]interface{} No description.
Id *string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.62.0/docs/data-sources/catalogs#id DataDatabricksCatalogs#id}.
Ids *[]*string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.62.0/docs/data-sources/catalogs#ids DataDatabricksCatalogs#ids}.

ConnectionOptional
Connection interface{}
  • Type: interface{}

CountOptional
Count interface{}
  • Type: interface{}

DependsOnOptional
DependsOn *[]ITerraformDependable
  • Type: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable

ForEachOptional
ForEach ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator

LifecycleOptional
Lifecycle TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle

ProviderOptional
Provider TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

ProvisionersOptional
Provisioners *[]interface{}
  • Type: *[]interface{}

IdOptional
Id *string
  • Type: *string

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


IdsOptional
Ids *[]*string
  • Type: *[]*string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.62.0/docs/data-sources/catalogs#ids DataDatabricksCatalogs#ids}.