fileFormatGrant.csharp.md

fileFormatGrant Submodule

Constructs

FileFormatGrant

Represents a {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/file_format_grant snowflake_file_format_grant}.

Initializers

using HashiCorp.Cdktf.Providers.Snowflake;

new FileFormatGrant(Construct Scope, string Id, FileFormatGrantConfig Config);

Name	Type	Description
Scope	Constructs.Construct	The scope in which to define this construct.
Id	string	The scoped construct ID.
Config	FileFormatGrantConfig	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: FileFormatGrantConfig

---

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".
ResetEnableMultipleGrants	No description.
ResetFileFormatName	No description.
ResetId	No description.
ResetOnAll	No description.
ResetOnFuture	No description.
ResetPrivilege	No description.
ResetRevertOwnershipToRoleName	No description.
ResetSchemaName	No description.
ResetWithGrantOption	No description.

---

ToString

private string ToString()

Returns a string representation of this construct.

AddOverride

private void AddOverride(string Path, object Value)

Path^Required

• Type: string

---

Value^Required

• Type: object

---

OverrideLogicalId

private void OverrideLogicalId(string NewLogicalId)

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

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.

MoveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

GetAnyMapAttribute

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanAttribute

private IResolvable GetBooleanAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanMapAttribute

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetListAttribute

private string[] GetListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberAttribute

private double GetNumberAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberListAttribute

private double[] GetNumberListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberMapAttribute

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringAttribute

private string GetStringAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringMapAttribute

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

HasResourceMove

private object HasResourceMove()

ImportFrom

private void ImportFrom(string Id, TerraformProvider Provider = null)

Id^Required

• Type: string

---

Provider^Optional

• Type: HashiCorp.Cdktf.TerraformProvider

---

InterpolationForAttribute

private IResolvable InterpolationForAttribute(string TerraformAttribute)

TerraformAttribute^Required

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

Id^Required

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

MoveTarget^Required

• Type: string

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

---

Index^Optional

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

Id^Required

• Type: string

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

---

ResetEnableMultipleGrants

private void ResetEnableMultipleGrants()

ResetFileFormatName

private void ResetFileFormatName()

ResetId

private void ResetId()

ResetOnAll

private void ResetOnAll()

ResetOnFuture

private void ResetOnFuture()

ResetPrivilege

private void ResetPrivilege()

ResetRevertOwnershipToRoleName

private void ResetRevertOwnershipToRoleName()

ResetSchemaName

private void ResetSchemaName()

ResetWithGrantOption

private void ResetWithGrantOption()

Static Functions

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

---

IsConstruct

using HashiCorp.Cdktf.Providers.Snowflake;

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

X^Required

• Type: object

Any object.

---

IsTerraformElement

using HashiCorp.Cdktf.Providers.Snowflake;

FileFormatGrant.IsTerraformElement(object X);

X^Required

• Type: object

---

IsTerraformResource

using HashiCorp.Cdktf.Providers.Snowflake;

FileFormatGrant.IsTerraformResource(object X);

X^Required

• Type: object

---

GenerateConfigForImport

using HashiCorp.Cdktf.Providers.Snowflake;

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

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

---

ImportFromId^Required

• Type: string

The id of the existing FileFormatGrant that should be imported.

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

---

Provider^Optional

• Type: HashiCorp.Cdktf.TerraformProvider

? Optional instance of the provider where the FileFormatGrant 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.
DatabaseNameInput	string	No description.
EnableMultipleGrantsInput	object	No description.
FileFormatNameInput	string	No description.
IdInput	string	No description.
OnAllInput	object	No description.
OnFutureInput	object	No description.
PrivilegeInput	string	No description.
RevertOwnershipToRoleNameInput	string	No description.
RolesInput	string[]	No description.
SchemaNameInput	string	No description.
WithGrantOptionInput	object	No description.
DatabaseName	string	No description.
EnableMultipleGrants	object	No description.
FileFormatName	string	No description.
Id	string	No description.
OnAll	object	No description.
OnFuture	object	No description.
Privilege	string	No description.
RevertOwnershipToRoleName	string	No description.
Roles	string[]	No description.
SchemaName	string	No description.
WithGrantOption	object	No description.

---

Node^Required

public Node Node { get; }

• Type: Constructs.Node

The tree node.

---

CdktfStack^Required

public TerraformStack CdktfStack { get; }

• Type: HashiCorp.Cdktf.TerraformStack

---

Fqn^Required

public string Fqn { get; }

• Type: string

---

FriendlyUniqueId^Required

public string FriendlyUniqueId { get; }

• Type: string

---

TerraformMetaArguments^Required

public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }

• Type: System.Collections.Generic.IDictionary<string, object>

---

TerraformResourceType^Required

public string TerraformResourceType { get; }

• Type: string

---

TerraformGeneratorMetadata^Optional

public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }

• Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

---

Connection^Optional

public object Connection { get; }

• Type: object

---

Count^Optional

public object Count { get; }

• Type: object

---

DependsOn^Optional

public string[] DependsOn { get; }

• Type: string[]

---

ForEach^Optional

public ITerraformIterator ForEach { get; }

• Type: HashiCorp.Cdktf.ITerraformIterator

---

Lifecycle^Optional

public TerraformResourceLifecycle Lifecycle { get; }

• Type: HashiCorp.Cdktf.TerraformResourceLifecycle

---

Provider^Optional

public TerraformProvider Provider { get; }

• Type: HashiCorp.Cdktf.TerraformProvider

---

Provisioners^Optional

public object[] Provisioners { get; }

• Type: object[]

---

DatabaseNameInput^Optional

public string DatabaseNameInput { get; }

• Type: string

---

EnableMultipleGrantsInput^Optional

public object EnableMultipleGrantsInput { get; }

• Type: object

---

FileFormatNameInput^Optional

public string FileFormatNameInput { get; }

• Type: string

---

IdInput^Optional

public string IdInput { get; }

• Type: string

---

OnAllInput^Optional

public object OnAllInput { get; }

• Type: object

---

OnFutureInput^Optional

public object OnFutureInput { get; }

• Type: object

---

PrivilegeInput^Optional

public string PrivilegeInput { get; }

• Type: string

---

RevertOwnershipToRoleNameInput^Optional

public string RevertOwnershipToRoleNameInput { get; }

• Type: string

---

RolesInput^Optional

public string[] RolesInput { get; }

• Type: string[]

---

SchemaNameInput^Optional

public string SchemaNameInput { get; }

• Type: string

---

WithGrantOptionInput^Optional

public object WithGrantOptionInput { get; }

• Type: object

---

DatabaseName^Required

public string DatabaseName { get; }

• Type: string

---

EnableMultipleGrants^Required

public object EnableMultipleGrants { get; }

• Type: object

---

FileFormatName^Required

public string FileFormatName { get; }

• Type: string

---

Id^Required

public string Id { get; }

• Type: string

---

OnAll^Required

public object OnAll { get; }

• Type: object

---

OnFuture^Required

public object OnFuture { get; }

• Type: object

---

Privilege^Required

public string Privilege { get; }

• Type: string

---

RevertOwnershipToRoleName^Required

public string RevertOwnershipToRoleName { get; }

• Type: string

---

Roles^Required

public string[] Roles { get; }

• Type: string[]

---

SchemaName^Required

public string SchemaName { get; }

• Type: string

---

WithGrantOption^Required

public object WithGrantOption { get; }

• Type: object

---

Constants

Name	Type	Description
TfResourceType	string	No description.

---

TfResourceType^Required

public string TfResourceType { get; }

• Type: string

---

Structs

FileFormatGrantConfig

Initializer

using HashiCorp.Cdktf.Providers.Snowflake;

new FileFormatGrantConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string DatabaseName,
    string[] Roles,
    object EnableMultipleGrants = null,
    string FileFormatName = null,
    string Id = null,
    object OnAll = null,
    object OnFuture = null,
    string Privilege = null,
    string RevertOwnershipToRoleName = null,
    string SchemaName = null,
    object WithGrantOption = 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.
DatabaseName	string	The name of the database containing the current or future file formats on which to grant privileges.
Roles	string[]	Grants privilege to these roles.
EnableMultipleGrants	object	When this is set to true, multiple grants of the same type can be created.
FileFormatName	string	The name of the file format on which to grant privileges immediately (only valid if on_future is false).
Id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/file_format_grant#id FileFormatGrant#id}.
OnAll	object	When this is set to true and a schema_name is provided, apply this grant on all file formats in the given schema.
OnFuture	object	When this is set to true and a schema_name is provided, apply this grant on all future file formats in the given schema.
Privilege	string	The privilege to grant on the current or future file format.
RevertOwnershipToRoleName	string	The name of the role to revert ownership to on destroy.
SchemaName	string	The name of the schema containing the current or future file formats on which to grant privileges.
WithGrantOption	object	When this is set to true, allows the recipient role to grant the privileges to other roles.

---

Connection^Optional

public object Connection { get; set; }

• Type: object

---

Count^Optional

public object Count { get; set; }

• Type: object

---

DependsOn^Optional

public ITerraformDependable[] DependsOn { get; set; }

• Type: HashiCorp.Cdktf.ITerraformDependable[]

---

ForEach^Optional

public ITerraformIterator ForEach { get; set; }

• Type: HashiCorp.Cdktf.ITerraformIterator

---

Lifecycle^Optional

public TerraformResourceLifecycle Lifecycle { get; set; }

• Type: HashiCorp.Cdktf.TerraformResourceLifecycle

---

Provider^Optional

public TerraformProvider Provider { get; set; }

• Type: HashiCorp.Cdktf.TerraformProvider

---

Provisioners^Optional

public object[] Provisioners { get; set; }

• Type: object[]

---

DatabaseName^Required

public string DatabaseName { get; set; }

• Type: string

The name of the database containing the current or future file formats on which to grant privileges.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/file_format_grant#database_name FileFormatGrant#database_name}

---

Roles^Required

public string[] Roles { get; set; }

• Type: string[]

Grants privilege to these roles.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/file_format_grant#roles FileFormatGrant#roles}

---

EnableMultipleGrants^Optional

public object EnableMultipleGrants { get; set; }

• Type: object

When this is set to true, multiple grants of the same type can be created.

This will cause Terraform to not revoke grants applied to roles and objects outside Terraform.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/file_format_grant#enable_multiple_grants FileFormatGrant#enable_multiple_grants}

---

FileFormatName^Optional

public string FileFormatName { get; set; }

• Type: string

The name of the file format on which to grant privileges immediately (only valid if on_future is false).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/file_format_grant#file_format_name FileFormatGrant#file_format_name}

---

Id^Optional

public string Id { get; set; }

• Type: string

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

---

OnAll^Optional

public object OnAll { get; set; }

• Type: object

When this is set to true and a schema_name is provided, apply this grant on all file formats in the given schema.

When this is true and no schema_name is provided apply this grant on all file formats in the given database. The file_format_name field must be unset in order to use on_all. Cannot be used together with on_future.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/file_format_grant#on_all FileFormatGrant#on_all}

---

OnFuture^Optional

public object OnFuture { get; set; }

• Type: object

When this is set to true and a schema_name is provided, apply this grant on all future file formats in the given schema.

When this is true and no schema_name is provided apply this grant on all future file formats in the given database. The file_format_name field must be unset in order to use on_future. Cannot be used together with on_all.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/file_format_grant#on_future FileFormatGrant#on_future}

---

Privilege^Optional

public string Privilege { get; set; }

• Type: string

The privilege to grant on the current or future file format.

To grant all privileges, use the value ALL PRIVILEGES

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/file_format_grant#privilege FileFormatGrant#privilege}

---

RevertOwnershipToRoleName^Optional

public string RevertOwnershipToRoleName { get; set; }

• Type: string

The name of the role to revert ownership to on destroy.

Has no effect unless privilege is set to OWNERSHIP

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/file_format_grant#revert_ownership_to_role_name FileFormatGrant#revert_ownership_to_role_name}

---

SchemaName^Optional

public string SchemaName { get; set; }

• Type: string

The name of the schema containing the current or future file formats on which to grant privileges.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/file_format_grant#schema_name FileFormatGrant#schema_name}

---

WithGrantOption^Optional

public object WithGrantOption { get; set; }

• Type: object

When this is set to true, allows the recipient role to grant the privileges to other roles.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/file_format_grant#with_grant_option FileFormatGrant#with_grant_option}

---