grantPrivilegesToShare.typescript.md

grantPrivilegesToShare Submodule

Constructs

GrantPrivilegesToShare

Represents a {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/grant_privileges_to_share snowflake_grant_privileges_to_share}.

Initializers

import { grantPrivilegesToShare } from '@cdktf/provider-snowflake'

new grantPrivilegesToShare.GrantPrivilegesToShare(scope: Construct, id: string, config: GrantPrivilegesToShareConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	GrantPrivilegesToShareConfig	No description.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Required

• Type: GrantPrivilegesToShareConfig

---

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".
resetId	No description.
resetOnAllTablesInSchema	No description.
resetOnDatabase	No description.
resetOnFunction	No description.
resetOnSchema	No description.
resetOnTable	No description.
resetOnTag	No description.
resetOnView	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

addOverride

public addOverride(path: string, value: any): void

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

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

newLogicalId^Required

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

moveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

getAnyMapAttribute

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

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

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

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

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

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

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

terraformAttribute^Required

• Type: string

---

hasResourceMove

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

importFrom

public importFrom(id: string, provider?: TerraformProvider): void

id^Required

• Type: string

---

provider^Optional

• Type: cdktf.TerraformProvider

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

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

id^Required

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

moveTarget^Required

• Type: string

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

---

index^Optional

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

id^Required

• Type: string

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

---

resetId

public resetId(): void

resetOnAllTablesInSchema

public resetOnAllTablesInSchema(): void

resetOnDatabase

public resetOnDatabase(): void

resetOnFunction

public resetOnFunction(): void

resetOnSchema

public resetOnSchema(): void

resetOnTable

public resetOnTable(): void

resetOnTag

public resetOnTag(): void

resetOnView

public resetOnView(): 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 GrantPrivilegesToShare resource upon running "cdktf plan ".

---

isConstruct

import { grantPrivilegesToShare } from '@cdktf/provider-snowflake'

grantPrivilegesToShare.GrantPrivilegesToShare.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.

x^Required

• Type: any

Any object.

---

isTerraformElement

import { grantPrivilegesToShare } from '@cdktf/provider-snowflake'

grantPrivilegesToShare.GrantPrivilegesToShare.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

import { grantPrivilegesToShare } from '@cdktf/provider-snowflake'

grantPrivilegesToShare.GrantPrivilegesToShare.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { grantPrivilegesToShare } from '@cdktf/provider-snowflake'

grantPrivilegesToShare.GrantPrivilegesToShare.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

importToId^Required

• Type: string

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

---

importFromId^Required

• Type: string

The id of the existing GrantPrivilegesToShare that should be imported.

Refer to the {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/grant_privileges_to_share#import import section} in the documentation of this resource for the id to use

---

provider^Optional

• Type: cdktf.TerraformProvider

? Optional instance of the provider where the GrantPrivilegesToShare 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.
idInput	string	No description.
onAllTablesInSchemaInput	string	No description.
onDatabaseInput	string	No description.
onFunctionInput	string	No description.
onSchemaInput	string	No description.
onTableInput	string	No description.
onTagInput	string	No description.
onViewInput	string	No description.
privilegesInput	string[]	No description.
toShareInput	string	No description.
id	string	No description.
onAllTablesInSchema	string	No description.
onDatabase	string	No description.
onFunction	string	No description.
onSchema	string	No description.
onTable	string	No description.
onTag	string	No description.
onView	string	No description.
privileges	string[]	No description.
toShare	string	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

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

• Type: {[ key: string ]: any}

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

onAllTablesInSchemaInput^Optional

public readonly onAllTablesInSchemaInput: string;

• Type: string

---

onDatabaseInput^Optional

public readonly onDatabaseInput: string;

• Type: string

---

onFunctionInput^Optional

public readonly onFunctionInput: string;

• Type: string

---

onSchemaInput^Optional

public readonly onSchemaInput: string;

• Type: string

---

onTableInput^Optional

public readonly onTableInput: string;

• Type: string

---

onTagInput^Optional

public readonly onTagInput: string;

• Type: string

---

onViewInput^Optional

public readonly onViewInput: string;

• Type: string

---

privilegesInput^Optional

public readonly privilegesInput: string[];

• Type: string[]

---

toShareInput^Optional

public readonly toShareInput: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

onAllTablesInSchema^Required

public readonly onAllTablesInSchema: string;

• Type: string

---

onDatabase^Required

public readonly onDatabase: string;

• Type: string

---

onFunction^Required

public readonly onFunction: string;

• Type: string

---

onSchema^Required

public readonly onSchema: string;

• Type: string

---

onTable^Required

public readonly onTable: string;

• Type: string

---

onTag^Required

public readonly onTag: string;

• Type: string

---

onView^Required

public readonly onView: string;

• Type: string

---

privileges^Required

public readonly privileges: string[];

• Type: string[]

---

toShare^Required

public readonly toShare: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

GrantPrivilegesToShareConfig

Initializer

import { grantPrivilegesToShare } from '@cdktf/provider-snowflake'

const grantPrivilegesToShareConfig: grantPrivilegesToShare.GrantPrivilegesToShareConfig = { ... }

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.
privileges	string[]	The privileges to grant on the share. See available list of privileges: https://docs.snowflake.com/en/sql-reference/sql/grant-privilege-share#syntax.
toShare	string	The fully qualified name of the share on which privileges will be granted.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/grant_privileges_to_share#id GrantPrivilegesToShare#id}.
onAllTablesInSchema	string	The fully qualified identifier for the schema for which the specified privilege will be granted for all tables.
onDatabase	string	The fully qualified name of the database on which privileges will be granted.
onFunction	string	The fully qualified name of the function on which privileges will be granted.
onSchema	string	The fully qualified name of the schema on which privileges will be granted.
onTable	string	The fully qualified name of the table on which privileges will be granted.
onTag	string	The fully qualified name of the tag on which privileges will be granted.
onView	string	The fully qualified name of the view on which privileges will be granted.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

privileges^Required

public readonly privileges: string[];

• Type: string[]

The privileges to grant on the share. See available list of privileges: https://docs.snowflake.com/en/sql-reference/sql/grant-privilege-share#syntax.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/grant_privileges_to_share#privileges GrantPrivilegesToShare#privileges}

---

toShare^Required

public readonly toShare: string;

• Type: string

The fully qualified name of the share on which privileges will be granted.

For more information about this resource, see docs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/grant_privileges_to_share#to_share GrantPrivilegesToShare#to_share}

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/grant_privileges_to_share#id GrantPrivilegesToShare#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.

---

onAllTablesInSchema^Optional

public readonly onAllTablesInSchema: string;

• Type: string

The fully qualified identifier for the schema for which the specified privilege will be granted for all tables.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/grant_privileges_to_share#on_all_tables_in_schema GrantPrivilegesToShare#on_all_tables_in_schema}

---

onDatabase^Optional

public readonly onDatabase: string;

• Type: string

The fully qualified name of the database on which privileges will be granted.

For more information about this resource, see docs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/grant_privileges_to_share#on_database GrantPrivilegesToShare#on_database}

---

onFunction^Optional

public readonly onFunction: string;

• Type: string

The fully qualified name of the function on which privileges will be granted.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/grant_privileges_to_share#on_function GrantPrivilegesToShare#on_function}

---

onSchema^Optional

public readonly onSchema: string;

• Type: string

The fully qualified name of the schema on which privileges will be granted.

For more information about this resource, see docs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/grant_privileges_to_share#on_schema GrantPrivilegesToShare#on_schema}

---

onTable^Optional

public readonly onTable: string;

• Type: string

The fully qualified name of the table on which privileges will be granted.

For more information about this resource, see docs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/grant_privileges_to_share#on_table GrantPrivilegesToShare#on_table}

---

onTag^Optional

public readonly onTag: string;

• Type: string

The fully qualified name of the tag on which privileges will be granted.

For more information about this resource, see docs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/grant_privileges_to_share#on_tag GrantPrivilegesToShare#on_tag}

---

onView^Optional

public readonly onView: string;

• Type: string

The fully qualified name of the view on which privileges will be granted.

For more information about this resource, see docs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/grant_privileges_to_share#on_view GrantPrivilegesToShare#on_view}

---