Skip to content

Latest commit

 

History

History
1239 lines (767 loc) · 50.4 KB

streamGrant.typescript.md

File metadata and controls

1239 lines (767 loc) · 50.4 KB
Raw

streamGrant Submodule

Constructs

StreamGrant

Represents a {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/stream_grant snowflake_stream_grant}.

Initializers 

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

new streamGrant.StreamGrant(scope: Construct, id: string, config: StreamGrantConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config StreamGrantConfig 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".
resetEnableMultipleGrants No description.
resetId No description.
resetOnAll No description.
resetOnFuture No description.
resetPrivilege No description.
resetRevertOwnershipToRoleName No description.
resetSchemaName No description.
resetStreamName No description.
resetWithGrantOption 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".

resetEnableMultipleGrants 
public resetEnableMultipleGrants(): void
resetId 
public resetId(): void
resetOnAll 
public resetOnAll(): void
resetOnFuture 
public resetOnFuture(): void
resetPrivilege 
public resetPrivilege(): void
resetRevertOwnershipToRoleName 
public resetRevertOwnershipToRoleName(): void
resetSchemaName 
public resetSchemaName(): void
resetStreamName 
public resetStreamName(): void
resetWithGrantOption 
public resetWithGrantOption(): 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 StreamGrant resource upon running "cdktf plan ".
isConstruct 
import { streamGrant } from '@cdktf/provider-snowflake'

streamGrant.StreamGrant.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 { streamGrant } from '@cdktf/provider-snowflake'

streamGrant.StreamGrant.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { streamGrant } from '@cdktf/provider-snowflake'

streamGrant.StreamGrant.isTerraformResource(x: any)
xRequired
  • Type: any
generateConfigForImport 
import { streamGrant } from '@cdktf/provider-snowflake'

streamGrant.StreamGrant.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

importFromIdRequired
  • Type: string

The id of the existing StreamGrant that should be imported.

Refer to the {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/stream_grant#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 StreamGrant 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.
databaseNameInput string No description.
enableMultipleGrantsInput boolean | cdktf.IResolvable No description.
idInput string No description.
onAllInput boolean | cdktf.IResolvable No description.
onFutureInput boolean | cdktf.IResolvable No description.
privilegeInput string No description.
revertOwnershipToRoleNameInput string No description.
rolesInput string[] No description.
schemaNameInput string No description.
streamNameInput string No description.
withGrantOptionInput boolean | cdktf.IResolvable No description.
databaseName string No description.
enableMultipleGrants boolean | cdktf.IResolvable No description.
id string No description.
onAll boolean | cdktf.IResolvable No description.
onFuture boolean | cdktf.IResolvable No description.
privilege string No description.
revertOwnershipToRoleName string No description.
roles string[] No description.
schemaName string No description.
streamName string No description.
withGrantOption boolean | cdktf.IResolvable 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[]
databaseNameInputOptional 
public readonly databaseNameInput: string;
  • Type: string
enableMultipleGrantsInputOptional 
public readonly enableMultipleGrantsInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
idInputOptional 
public readonly idInput: string;
  • Type: string
onAllInputOptional 
public readonly onAllInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
onFutureInputOptional 
public readonly onFutureInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
privilegeInputOptional 
public readonly privilegeInput: string;
  • Type: string
revertOwnershipToRoleNameInputOptional 
public readonly revertOwnershipToRoleNameInput: string;
  • Type: string
rolesInputOptional 
public readonly rolesInput: string[];
  • Type: string[]
schemaNameInputOptional 
public readonly schemaNameInput: string;
  • Type: string
streamNameInputOptional 
public readonly streamNameInput: string;
  • Type: string
withGrantOptionInputOptional 
public readonly withGrantOptionInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
databaseNameRequired 
public readonly databaseName: string;
  • Type: string
enableMultipleGrantsRequired 
public readonly enableMultipleGrants: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
idRequired 
public readonly id: string;
  • Type: string
onAllRequired 
public readonly onAll: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
onFutureRequired 
public readonly onFuture: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
privilegeRequired 
public readonly privilege: string;
  • Type: string
revertOwnershipToRoleNameRequired 
public readonly revertOwnershipToRoleName: string;
  • Type: string
rolesRequired 
public readonly roles: string[];
  • Type: string[]
schemaNameRequired 
public readonly schemaName: string;
  • Type: string
streamNameRequired 
public readonly streamName: string;
  • Type: string
withGrantOptionRequired 
public readonly withGrantOption: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Constants

Name Type Description
tfResourceType string No description.
tfResourceTypeRequired 
public readonly tfResourceType: string;
  • Type: string

Structs

StreamGrantConfig

Initializer 

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

const streamGrantConfig: streamGrant.StreamGrantConfig = { ... }

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.
databaseName string The name of the database containing the current or future streams on which to grant privileges.
roles string[] Grants privilege to these roles.
enableMultipleGrants boolean | cdktf.IResolvable When this is set to true, multiple grants of the same type can be created.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/stream_grant#id StreamGrant#id}.
onAll boolean | cdktf.IResolvable When this is set to true and a schema_name is provided, apply this grant on all streams in the given schema.
onFuture boolean | cdktf.IResolvable When this is set to true and a schema_name is provided, apply this grant on all future streams in the given schema.
privilege string The privilege to grant on the current or future stream. To grant all privileges, use the value ALL PRIVILEGES.
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 streams on which to grant privileges.
streamName string The name of the stream on which to grant privileges immediately (only valid if on_future is false).
withGrantOption boolean | cdktf.IResolvable When this is set to true, allows the recipient role to grant the privileges to other roles.
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[]
databaseNameRequired 
public readonly databaseName: string;
  • Type: string

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/stream_grant#database_name StreamGrant#database_name}

rolesRequired 
public readonly roles: string[];
  • Type: string[]

Grants privilege to these roles.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/stream_grant#roles StreamGrant#roles}

enableMultipleGrantsOptional 
public readonly enableMultipleGrants: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

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.90.0/docs/resources/stream_grant#enable_multiple_grants StreamGrant#enable_multiple_grants}

idOptional 
public readonly id: string;
  • Type: string

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

onAllOptional 
public readonly onAll: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

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

When this is true and no schema_name is provided apply this grant on all streams in the given database. The stream_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.90.0/docs/resources/stream_grant#on_all StreamGrant#on_all}

onFutureOptional 
public readonly onFuture: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

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

When this is true and no schema_name is provided apply this grant on all future streams in the given database. The stream_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.90.0/docs/resources/stream_grant#on_future StreamGrant#on_future}

privilegeOptional 
public readonly privilege: string;
  • Type: string

The privilege to grant on the current or future stream. To grant all privileges, use the value ALL PRIVILEGES.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/stream_grant#privilege StreamGrant#privilege}

revertOwnershipToRoleNameOptional 
public readonly revertOwnershipToRoleName: string;
  • 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.90.0/docs/resources/stream_grant#revert_ownership_to_role_name StreamGrant#revert_ownership_to_role_name}

schemaNameOptional 
public readonly schemaName: string;
  • Type: string

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/stream_grant#schema_name StreamGrant#schema_name}

streamNameOptional 
public readonly streamName: string;
  • Type: string

The name of the stream 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.90.0/docs/resources/stream_grant#stream_name StreamGrant#stream_name}

withGrantOptionOptional 
public readonly withGrantOption: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

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.90.0/docs/resources/stream_grant#with_grant_option StreamGrant#with_grant_option}