apiIntegration.typescript.md

apiIntegration Submodule

Constructs

ApiIntegration

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

Initializers

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

new apiIntegration.ApiIntegration(scope: Construct, id: string, config: ApiIntegrationConfig)

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

---

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".
resetApiAwsRoleArn	No description.
resetApiBlockedPrefixes	No description.
resetApiGcpServiceAccount	No description.
resetApiKey	No description.
resetAzureAdApplicationId	No description.
resetAzureTenantId	No description.
resetComment	No description.
resetEnabled	No description.
resetGoogleAudience	No description.
resetId	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".

---

resetApiAwsRoleArn

public resetApiAwsRoleArn(): void

resetApiBlockedPrefixes

public resetApiBlockedPrefixes(): void

resetApiGcpServiceAccount

public resetApiGcpServiceAccount(): void

resetApiKey

public resetApiKey(): void

resetAzureAdApplicationId

public resetAzureAdApplicationId(): void

resetAzureTenantId

public resetAzureTenantId(): void

resetComment

public resetComment(): void

resetEnabled

public resetEnabled(): void

resetGoogleAudience

public resetGoogleAudience(): void

resetId

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

---

isConstruct

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

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

apiIntegration.ApiIntegration.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

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

apiIntegration.ApiIntegration.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

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

apiIntegration.ApiIntegration.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

---

importFromId^Required

• Type: string

The id of the existing ApiIntegration that should be imported.

Refer to the {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/api_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 ApiIntegration 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.
apiAwsExternalId	string	No description.
apiAwsIamUserArn	string	No description.
azureConsentUrl	string	No description.
azureMultiTenantAppName	string	No description.
createdOn	string	No description.
apiAllowedPrefixesInput	string[]	No description.
apiAwsRoleArnInput	string	No description.
apiBlockedPrefixesInput	string[]	No description.
apiGcpServiceAccountInput	string	No description.
apiKeyInput	string	No description.
apiProviderInput	string	No description.
azureAdApplicationIdInput	string	No description.
azureTenantIdInput	string	No description.
commentInput	string	No description.
enabledInput	boolean | cdktf.IResolvable	No description.
googleAudienceInput	string	No description.
idInput	string	No description.
nameInput	string	No description.
apiAllowedPrefixes	string[]	No description.
apiAwsRoleArn	string	No description.
apiBlockedPrefixes	string[]	No description.
apiGcpServiceAccount	string	No description.
apiKey	string	No description.
apiProvider	string	No description.
azureAdApplicationId	string	No description.
azureTenantId	string	No description.
comment	string	No description.
enabled	boolean | cdktf.IResolvable	No description.
googleAudience	string	No description.
id	string	No description.
name	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[]

---

apiAwsExternalId^Required

public readonly apiAwsExternalId: string;

• Type: string

---

apiAwsIamUserArn^Required

public readonly apiAwsIamUserArn: string;

• Type: string

---

azureConsentUrl^Required

public readonly azureConsentUrl: string;

• Type: string

---

azureMultiTenantAppName^Required

public readonly azureMultiTenantAppName: string;

• Type: string

---

createdOn^Required

public readonly createdOn: string;

• Type: string

---

apiAllowedPrefixesInput^Optional

public readonly apiAllowedPrefixesInput: string[];

• Type: string[]

---

apiAwsRoleArnInput^Optional

public readonly apiAwsRoleArnInput: string;

• Type: string

---

apiBlockedPrefixesInput^Optional

public readonly apiBlockedPrefixesInput: string[];

• Type: string[]

---

apiGcpServiceAccountInput^Optional

public readonly apiGcpServiceAccountInput: string;

• Type: string

---

apiKeyInput^Optional

public readonly apiKeyInput: string;

• Type: string

---

apiProviderInput^Optional

public readonly apiProviderInput: string;

• Type: string

---

azureAdApplicationIdInput^Optional

public readonly azureAdApplicationIdInput: 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

---

googleAudienceInput^Optional

public readonly googleAudienceInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

nameInput^Optional

public readonly nameInput: string;

• Type: string

---

apiAllowedPrefixes^Required

public readonly apiAllowedPrefixes: string[];

• Type: string[]

---

apiAwsRoleArn^Required

public readonly apiAwsRoleArn: string;

• Type: string

---

apiBlockedPrefixes^Required

public readonly apiBlockedPrefixes: string[];

• Type: string[]

---

apiGcpServiceAccount^Required

public readonly apiGcpServiceAccount: string;

• Type: string

---

apiKey^Required

public readonly apiKey: string;

• Type: string

---

apiProvider^Required

public readonly apiProvider: string;

• Type: string

---

azureAdApplicationId^Required

public readonly azureAdApplicationId: 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

---

googleAudience^Required

public readonly googleAudience: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

name^Required

public readonly name: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

ApiIntegrationConfig

Initializer

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

const apiIntegrationConfig: apiIntegration.ApiIntegrationConfig = { ... }

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.
apiAllowedPrefixes	string[]	Explicitly limits external functions that use the integration to reference one or more HTTPS proxy service endpoints and resources within those proxies.
apiProvider	string	Specifies the HTTPS proxy service type.
name	string	Specifies the name of the API integration.
apiAwsRoleArn	string	ARN of a cloud platform role.
apiBlockedPrefixes	string[]	Lists the endpoints and resources in the HTTPS proxy service that are not allowed to be called from Snowflake.
apiGcpServiceAccount	string	The service account used for communication with the Google API Gateway.
apiKey	string	The API key (also called a “subscription key”).
azureAdApplicationId	string	The 'Application (client) id' of the Azure AD app for your remote service.
azureTenantId	string	Specifies the ID for your Office 365 tenant that all Azure API Management instances belong to.
comment	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/api_integration#comment ApiIntegration#comment}.
enabled	boolean | cdktf.IResolvable	Specifies whether this API integration is enabled or disabled.
googleAudience	string	The audience claim when generating the JWT (JSON Web Token) to authenticate to the Google API Gateway.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/api_integration#id ApiIntegration#id}.

---

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

---

apiAllowedPrefixes^Required

public readonly apiAllowedPrefixes: string[];

• Type: string[]

Explicitly limits external functions that use the integration to reference one or more HTTPS proxy service endpoints and resources within those proxies.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/api_integration#api_allowed_prefixes ApiIntegration#api_allowed_prefixes}

---

apiProvider^Required

public readonly apiProvider: string;

• Type: string

Specifies the HTTPS proxy service type.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/api_integration#api_provider ApiIntegration#api_provider}

---

name^Required

public readonly name: string;

• Type: string

Specifies the name of the API integration.

This name follows the rules for Object Identifiers. The name should be unique among api integrations in your account.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/api_integration#name ApiIntegration#name}

---

apiAwsRoleArn^Optional

public readonly apiAwsRoleArn: string;

• Type: string

ARN of a cloud platform role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/api_integration#api_aws_role_arn ApiIntegration#api_aws_role_arn}

---

apiBlockedPrefixes^Optional

public readonly apiBlockedPrefixes: string[];

• Type: string[]

Lists the endpoints and resources in the HTTPS proxy service that are not allowed to be called from Snowflake.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/api_integration#api_blocked_prefixes ApiIntegration#api_blocked_prefixes}

---

apiGcpServiceAccount^Optional

public readonly apiGcpServiceAccount: string;

• Type: string

The service account used for communication with the Google API Gateway.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/api_integration#api_gcp_service_account ApiIntegration#api_gcp_service_account}

---

apiKey^Optional

public readonly apiKey: string;

• Type: string

The API key (also called a “subscription key”).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/api_integration#api_key ApiIntegration#api_key}

---

azureAdApplicationId^Optional

public readonly azureAdApplicationId: string;

• Type: string

The 'Application (client) id' of the Azure AD app for your remote service.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/api_integration#azure_ad_application_id ApiIntegration#azure_ad_application_id}

---

azureTenantId^Optional

public readonly azureTenantId: string;

• Type: string

Specifies the ID for your Office 365 tenant that all Azure API Management instances belong to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/api_integration#azure_tenant_id ApiIntegration#azure_tenant_id}

---

comment^Optional

public readonly comment: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/api_integration#comment ApiIntegration#comment}.

---

enabled^Optional

public readonly enabled: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Specifies whether this API integration is enabled or disabled.

If the API integration is disabled, any external function that relies on it will not work.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/api_integration#enabled ApiIntegration#enabled}

---

googleAudience^Optional

public readonly googleAudience: string;

• Type: string

The audience claim when generating the JWT (JSON Web Token) to authenticate to the Google API Gateway.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/api_integration#google_audience ApiIntegration#google_audience}

---

id^Optional

public readonly id: string;

• Type: string

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

---