storageIntegration.typescript.md

storageIntegration Submodule

Constructs

StorageIntegration

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

Initializers

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

new storageIntegration.StorageIntegration(scope: Construct, id: string, config: StorageIntegrationConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	StorageIntegrationConfig	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: StorageIntegrationConfig

---

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".
resetAzureTenantId	No description.
resetComment	No description.
resetEnabled	No description.
resetId	No description.
resetStorageAwsObjectAcl	No description.
resetStorageAwsRoleArn	No description.
resetStorageBlockedLocations	No description.
resetType	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".

---

resetAzureTenantId

public resetAzureTenantId(): void

resetComment

public resetComment(): void

resetEnabled

public resetEnabled(): void

resetId

public resetId(): void

resetStorageAwsObjectAcl

public resetStorageAwsObjectAcl(): void

resetStorageAwsRoleArn

public resetStorageAwsRoleArn(): void

resetStorageBlockedLocations

public resetStorageBlockedLocations(): void

resetType

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

---

isConstruct

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

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

storageIntegration.StorageIntegration.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

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

storageIntegration.StorageIntegration.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

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

storageIntegration.StorageIntegration.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

---

importFromId^Required

• Type: string

The id of the existing StorageIntegration that should be imported.

Refer to the {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/storage_integration#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 StorageIntegration 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.
azureConsentUrl	string	No description.
azureMultiTenantAppName	string	No description.
createdOn	string	No description.
fullyQualifiedName	string	No description.
storageAwsExternalId	string	No description.
storageAwsIamUserArn	string	No description.
storageGcpServiceAccount	string	No description.
azureTenantIdInput	string	No description.
commentInput	string	No description.
enabledInput	boolean | cdktf.IResolvable	No description.
idInput	string	No description.
nameInput	string	No description.
storageAllowedLocationsInput	string[]	No description.
storageAwsObjectAclInput	string	No description.
storageAwsRoleArnInput	string	No description.
storageBlockedLocationsInput	string[]	No description.
storageProviderInput	string	No description.
typeInput	string	No description.
azureTenantId	string	No description.
comment	string	No description.
enabled	boolean | cdktf.IResolvable	No description.
id	string	No description.
name	string	No description.
storageAllowedLocations	string[]	No description.
storageAwsObjectAcl	string	No description.
storageAwsRoleArn	string	No description.
storageBlockedLocations	string[]	No description.
storageProvider	string	No description.
type	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[]

---

azureConsentUrl^Required

public readonly azureConsentUrl: string;

• Type: string

---

azureMultiTenantAppName^Required

public readonly azureMultiTenantAppName: string;

• Type: string

---

createdOn^Required

public readonly createdOn: string;

• Type: string

---

fullyQualifiedName^Required

public readonly fullyQualifiedName: string;

• Type: string

---

storageAwsExternalId^Required

public readonly storageAwsExternalId: string;

• Type: string

---

storageAwsIamUserArn^Required

public readonly storageAwsIamUserArn: string;

• Type: string

---

storageGcpServiceAccount^Required

public readonly storageGcpServiceAccount: string;

• Type: string

---

azureTenantIdInput^Optional

public readonly azureTenantIdInput: string;

• Type: string

---

commentInput^Optional

public readonly commentInput: string;

• Type: string

---

enabledInput^Optional

public readonly enabledInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

nameInput^Optional

public readonly nameInput: string;

• Type: string

---

storageAllowedLocationsInput^Optional

public readonly storageAllowedLocationsInput: string[];

• Type: string[]

---

storageAwsObjectAclInput^Optional

public readonly storageAwsObjectAclInput: string;

• Type: string

---

storageAwsRoleArnInput^Optional

public readonly storageAwsRoleArnInput: string;

• Type: string

---

storageBlockedLocationsInput^Optional

public readonly storageBlockedLocationsInput: string[];

• Type: string[]

---

storageProviderInput^Optional

public readonly storageProviderInput: string;

• Type: string

---

typeInput^Optional

public readonly typeInput: string;

• Type: string

---

azureTenantId^Required

public readonly azureTenantId: string;

• Type: string

---

comment^Required

public readonly comment: string;

• Type: string

---

enabled^Required

public readonly enabled: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

id^Required

public readonly id: string;

• Type: string

---

name^Required

public readonly name: string;

• Type: string

---

storageAllowedLocations^Required

public readonly storageAllowedLocations: string[];

• Type: string[]

---

storageAwsObjectAcl^Required

public readonly storageAwsObjectAcl: string;

• Type: string

---

storageAwsRoleArn^Required

public readonly storageAwsRoleArn: string;

• Type: string

---

storageBlockedLocations^Required

public readonly storageBlockedLocations: string[];

• Type: string[]

---

storageProvider^Required

public readonly storageProvider: string;

• Type: string

---

type^Required

public readonly type: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

StorageIntegrationConfig

Initializer

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

const storageIntegrationConfig: storageIntegration.StorageIntegrationConfig = { ... }

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.
name	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/storage_integration#name StorageIntegration#name}.
storageAllowedLocations	string[]	Explicitly limits external stages that use the integration to reference one or more storage locations.
storageProvider	string	Specifies the storage provider for the integration. Valid options are: S3 | S3GOV | S3CHINA | GCS | AZURE.
azureTenantId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/storage_integration#azure_tenant_id StorageIntegration#azure_tenant_id}.
comment	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/storage_integration#comment StorageIntegration#comment}.
enabled	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/storage_integration#enabled StorageIntegration#enabled}.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/storage_integration#id StorageIntegration#id}.
storageAwsObjectAcl	string	"bucket-owner-full-control" Enables support for AWS access control lists (ACLs) to grant the bucket owner full control.
storageAwsRoleArn	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/storage_integration#storage_aws_role_arn StorageIntegration#storage_aws_role_arn}.
storageBlockedLocations	string[]	Explicitly prohibits external stages that use the integration from referencing one or more storage locations.
type	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/storage_integration#type StorageIntegration#type}.

---

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

---

name^Required

public readonly name: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/storage_integration#name StorageIntegration#name}.

---

storageAllowedLocations^Required

public readonly storageAllowedLocations: string[];

• Type: string[]

Explicitly limits external stages that use the integration to reference one or more storage locations.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/storage_integration#storage_allowed_locations StorageIntegration#storage_allowed_locations}

---

storageProvider^Required

public readonly storageProvider: string;

• Type: string

Specifies the storage provider for the integration. Valid options are: S3 | S3GOV | S3CHINA | GCS | AZURE.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/storage_integration#storage_provider StorageIntegration#storage_provider}

---

azureTenantId^Optional

public readonly azureTenantId: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/storage_integration#azure_tenant_id StorageIntegration#azure_tenant_id}.

---

comment^Optional

public readonly comment: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/storage_integration#comment StorageIntegration#comment}.

---

enabled^Optional

public readonly enabled: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/storage_integration#enabled StorageIntegration#enabled}.

---

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/storage_integration#id StorageIntegration#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.

---

storageAwsObjectAcl^Optional

public readonly storageAwsObjectAcl: string;

• Type: string

"bucket-owner-full-control" Enables support for AWS access control lists (ACLs) to grant the bucket owner full control.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/storage_integration#storage_aws_object_acl StorageIntegration#storage_aws_object_acl}

---

storageAwsRoleArn^Optional

public readonly storageAwsRoleArn: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/storage_integration#storage_aws_role_arn StorageIntegration#storage_aws_role_arn}.

---

storageBlockedLocations^Optional

public readonly storageBlockedLocations: string[];

• Type: string[]

Explicitly prohibits external stages that use the integration from referencing one or more storage locations.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/storage_integration#storage_blocked_locations StorageIntegration#storage_blocked_locations}

---

type^Optional

public readonly type: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/storage_integration#type StorageIntegration#type}.

---