Skip to content

Latest commit

 

History

History
1445 lines (912 loc) · 53.1 KB

grant.csharp.md

File metadata and controls

1445 lines (912 loc) · 53.1 KB

grant Submodule

Constructs

Grant

Represents a {@link https://registry.terraform.io/providers/databricks/databricks/1.58.0/docs/resources/grant databricks_grant}.

Initializers

using HashiCorp.Cdktf.Providers.Databricks;

new Grant(Construct Scope, string Id, GrantConfig Config);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config GrantConfig 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".
ResetCatalog No description.
ResetExternalLocation No description.
ResetForeignConnection No description.
ResetFunction No description.
ResetId No description.
ResetMetastore No description.
ResetModel No description.
ResetPipeline No description.
ResetRecipient No description.
ResetSchema No description.
ResetShare No description.
ResetStorageCredential No description.
ResetTable No description.
ResetVolume 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.

AddMoveTarget
private void AddMoveTarget(string MoveTarget)

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

HasResourceMove
private object HasResourceMove()
ImportFrom
private void ImportFrom(string Id, TerraformProvider Provider = null)
IdRequired
  • Type: string

ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider

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

MoveFromId
private void MoveFromId(string Id)

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
private void MoveTo(string MoveTarget, object Index = null)

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

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


MoveToId
private void MoveToId(string Id)

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


ResetCatalog
private void ResetCatalog()
ResetExternalLocation
private void ResetExternalLocation()
ResetForeignConnection
private void ResetForeignConnection()
ResetFunction
private void ResetFunction()
ResetId
private void ResetId()
ResetMetastore
private void ResetMetastore()
ResetModel
private void ResetModel()
ResetPipeline
private void ResetPipeline()
ResetRecipient
private void ResetRecipient()
ResetSchema
private void ResetSchema()
ResetShare
private void ResetShare()
ResetStorageCredential
private void ResetStorageCredential()
ResetTable
private void ResetTable()
ResetVolume
private void ResetVolume()

Static Functions

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

IsConstruct
using HashiCorp.Cdktf.Providers.Databricks;

Grant.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;

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

IsTerraformResource
using HashiCorp.Cdktf.Providers.Databricks;

Grant.IsTerraformResource(object X);
XRequired
  • Type: object

GenerateConfigForImport
using HashiCorp.Cdktf.Providers.Databricks;

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

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


ImportFromIdRequired
  • Type: string

The id of the existing Grant that should be imported.

Refer to the {@link https://registry.terraform.io/providers/databricks/databricks/1.58.0/docs/resources/grant#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 Grant 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.
Connection object 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.
Provisioners object[] No description.
CatalogInput string No description.
ExternalLocationInput string No description.
ForeignConnectionInput string No description.
FunctionInput string No description.
IdInput string No description.
MetastoreInput string No description.
ModelInput string No description.
PipelineInput string No description.
PrincipalInput string No description.
PrivilegesInput string[] No description.
RecipientInput string No description.
SchemaInput string No description.
ShareInput string No description.
StorageCredentialInput string No description.
TableInput string No description.
VolumeInput string No description.
Catalog string No description.
ExternalLocation string No description.
ForeignConnection string No description.
Function string No description.
Id string No description.
Metastore string No description.
Model string No description.
Pipeline string No description.
Principal string No description.
Privileges string[] No description.
Recipient string No description.
Schema string No description.
Share string No description.
StorageCredential string No description.
Table string No description.
Volume 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

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

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

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

CatalogInputOptional
public string CatalogInput { get; }
  • Type: string

ExternalLocationInputOptional
public string ExternalLocationInput { get; }
  • Type: string

ForeignConnectionInputOptional
public string ForeignConnectionInput { get; }
  • Type: string

FunctionInputOptional
public string FunctionInput { get; }
  • Type: string

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

MetastoreInputOptional
public string MetastoreInput { get; }
  • Type: string

ModelInputOptional
public string ModelInput { get; }
  • Type: string

PipelineInputOptional
public string PipelineInput { get; }
  • Type: string

PrincipalInputOptional
public string PrincipalInput { get; }
  • Type: string

PrivilegesInputOptional
public string[] PrivilegesInput { get; }
  • Type: string[]

RecipientInputOptional
public string RecipientInput { get; }
  • Type: string

SchemaInputOptional
public string SchemaInput { get; }
  • Type: string

ShareInputOptional
public string ShareInput { get; }
  • Type: string

StorageCredentialInputOptional
public string StorageCredentialInput { get; }
  • Type: string

TableInputOptional
public string TableInput { get; }
  • Type: string

VolumeInputOptional
public string VolumeInput { get; }
  • Type: string

CatalogRequired
public string Catalog { get; }
  • Type: string

ExternalLocationRequired
public string ExternalLocation { get; }
  • Type: string

ForeignConnectionRequired
public string ForeignConnection { get; }
  • Type: string

FunctionRequired
public string Function { get; }
  • Type: string

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

MetastoreRequired
public string Metastore { get; }
  • Type: string

ModelRequired
public string Model { get; }
  • Type: string

PipelineRequired
public string Pipeline { get; }
  • Type: string

PrincipalRequired
public string Principal { get; }
  • Type: string

PrivilegesRequired
public string[] Privileges { get; }
  • Type: string[]

RecipientRequired
public string Recipient { get; }
  • Type: string

SchemaRequired
public string Schema { get; }
  • Type: string

ShareRequired
public string Share { get; }
  • Type: string

StorageCredentialRequired
public string StorageCredential { get; }
  • Type: string

TableRequired
public string Table { get; }
  • Type: string

VolumeRequired
public string Volume { get; }
  • Type: string

Constants

Name Type Description
TfResourceType string No description.

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

Structs

GrantConfig

Initializer

using HashiCorp.Cdktf.Providers.Databricks;

new GrantConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string Principal,
    string[] Privileges,
    string Catalog = null,
    string ExternalLocation = null,
    string ForeignConnection = null,
    string Function = null,
    string Id = null,
    string Metastore = null,
    string Model = null,
    string Pipeline = null,
    string Recipient = null,
    string Schema = null,
    string Share = null,
    string StorageCredential = null,
    string Table = null,
    string Volume = 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.
Principal string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.58.0/docs/resources/grant#principal Grant#principal}.
Privileges string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.58.0/docs/resources/grant#privileges Grant#privileges}.
Catalog string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.58.0/docs/resources/grant#catalog Grant#catalog}.
ExternalLocation string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.58.0/docs/resources/grant#external_location Grant#external_location}.
ForeignConnection string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.58.0/docs/resources/grant#foreign_connection Grant#foreign_connection}.
Function string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.58.0/docs/resources/grant#function Grant#function}.
Id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.58.0/docs/resources/grant#id Grant#id}.
Metastore string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.58.0/docs/resources/grant#metastore Grant#metastore}.
Model string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.58.0/docs/resources/grant#model Grant#model}.
Pipeline string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.58.0/docs/resources/grant#pipeline Grant#pipeline}.
Recipient string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.58.0/docs/resources/grant#recipient Grant#recipient}.
Schema string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.58.0/docs/resources/grant#schema Grant#schema}.
Share string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.58.0/docs/resources/grant#share Grant#share}.
StorageCredential string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.58.0/docs/resources/grant#storage_credential Grant#storage_credential}.
Table string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.58.0/docs/resources/grant#table Grant#table}.
Volume string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.58.0/docs/resources/grant#volume Grant#volume}.

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

PrincipalRequired
public string Principal { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.58.0/docs/resources/grant#principal Grant#principal}.


PrivilegesRequired
public string[] Privileges { get; set; }
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.58.0/docs/resources/grant#privileges Grant#privileges}.


CatalogOptional
public string Catalog { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.58.0/docs/resources/grant#catalog Grant#catalog}.


ExternalLocationOptional
public string ExternalLocation { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.58.0/docs/resources/grant#external_location Grant#external_location}.


ForeignConnectionOptional
public string ForeignConnection { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.58.0/docs/resources/grant#foreign_connection Grant#foreign_connection}.


FunctionOptional
public string Function { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.58.0/docs/resources/grant#function Grant#function}.


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

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


MetastoreOptional
public string Metastore { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.58.0/docs/resources/grant#metastore Grant#metastore}.


ModelOptional
public string Model { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.58.0/docs/resources/grant#model Grant#model}.


PipelineOptional
public string Pipeline { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.58.0/docs/resources/grant#pipeline Grant#pipeline}.


RecipientOptional
public string Recipient { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.58.0/docs/resources/grant#recipient Grant#recipient}.


SchemaOptional
public string Schema { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.58.0/docs/resources/grant#schema Grant#schema}.


ShareOptional
public string Share { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.58.0/docs/resources/grant#share Grant#share}.


StorageCredentialOptional
public string StorageCredential { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.58.0/docs/resources/grant#storage_credential Grant#storage_credential}.


TableOptional
public string Table { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.58.0/docs/resources/grant#table Grant#table}.


VolumeOptional
public string Volume { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.58.0/docs/resources/grant#volume Grant#volume}.