Represents a {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/notification_integration snowflake_notification_integration}.
import { notificationIntegration } from '@cdktf/provider-snowflake'
new notificationIntegration.NotificationIntegration(scope: Construct, id: string, config: NotificationIntegrationConfig)
Name | Type | Description |
---|---|---|
scope |
constructs.Construct |
The scope in which to define this construct. |
id |
string |
The scoped construct ID. |
config |
NotificationIntegrationConfig |
No description. |
- Type: constructs.Construct
The scope in which to define this construct.
- Type: string
The scoped construct ID.
Must be unique amongst siblings in the same scope
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". |
resetAwsSnsRoleArn |
No description. |
resetAwsSnsTopicArn |
No description. |
resetAwsSqsArn |
No description. |
resetAwsSqsRoleArn |
No description. |
resetAzureStorageQueuePrimaryUri |
No description. |
resetAzureTenantId |
No description. |
resetComment |
No description. |
resetDirection |
No description. |
resetEnabled |
No description. |
resetGcpPubsubSubscriptionName |
No description. |
resetGcpPubsubTopicName |
No description. |
resetId |
No description. |
resetType |
No description. |
public toString(): string
Returns a string representation of this construct.
public addOverride(path: string, value: any): void
- Type: string
- Type: any
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
- Type: string
The new logical ID to use for this stack element.
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
public toHclTerraform(): any
public toMetadata(): any
public toTerraform(): any
Adds this resource to the terraform JSON output.
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.
- Type: string
The string move target that will correspond to this resource.
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
- Type: string
public getBooleanAttribute(terraformAttribute: string): IResolvable
- Type: string
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
- Type: string
public getListAttribute(terraformAttribute: string): string[]
- Type: string
public getNumberAttribute(terraformAttribute: string): number
- Type: string
public getNumberListAttribute(terraformAttribute: string): number[]
- Type: string
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
- Type: string
public getStringAttribute(terraformAttribute: string): string
- Type: string
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
- Type: string
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
public importFrom(id: string, provider?: TerraformProvider): void
- Type: string
- Type: cdktf.TerraformProvider
public interpolationForAttribute(terraformAttribute: string): IResolvable
- Type: string
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.
- Type: string
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
public moveTo(moveTarget: string, index?: string | number): void
Moves this resource to the target resource given by moveTarget.
- Type: string
The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.
- Type: string | number
Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.
public moveToId(id: string): void
Moves this resource to the resource corresponding to "id".
- Type: string
Full id of resource to move to, e.g. "aws_s3_bucket.example".
public resetAwsSnsRoleArn(): void
public resetAwsSnsTopicArn(): void
public resetAwsSqsArn(): void
public resetAwsSqsRoleArn(): void
public resetAzureStorageQueuePrimaryUri(): void
public resetAzureTenantId(): void
public resetComment(): void
public resetDirection(): void
public resetEnabled(): void
public resetGcpPubsubSubscriptionName(): void
public resetGcpPubsubTopicName(): void
public resetId(): void
public resetType(): void
Name | Description |
---|---|
isConstruct |
Checks if x is a construct. |
isTerraformElement |
No description. |
isTerraformResource |
No description. |
generateConfigForImport |
Generates CDKTF code for importing a NotificationIntegration resource upon running "cdktf plan ". |
import { notificationIntegration } from '@cdktf/provider-snowflake'
notificationIntegration.NotificationIntegration.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.
- Type: any
Any object.
import { notificationIntegration } from '@cdktf/provider-snowflake'
notificationIntegration.NotificationIntegration.isTerraformElement(x: any)
- Type: any
import { notificationIntegration } from '@cdktf/provider-snowflake'
notificationIntegration.NotificationIntegration.isTerraformResource(x: any)
- Type: any
import { notificationIntegration } from '@cdktf/provider-snowflake'
notificationIntegration.NotificationIntegration.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)
Generates CDKTF code for importing a NotificationIntegration resource upon running "cdktf plan ".
- Type: constructs.Construct
The scope in which to define this construct.
- Type: string
The construct id used in the generated config for the NotificationIntegration to import.
- Type: string
The id of the existing NotificationIntegration that should be imported.
Refer to the {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/notification_integration#import import section} in the documentation of this resource for the id to use
- Type: cdktf.TerraformProvider
? Optional instance of the provider where the NotificationIntegration to import is found.
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. |
awsSnsExternalId |
string |
No description. |
awsSnsIamUserArn |
string |
No description. |
awsSqsExternalId |
string |
No description. |
awsSqsIamUserArn |
string |
No description. |
createdOn |
string |
No description. |
gcpPubsubServiceAccount |
string |
No description. |
awsSnsRoleArnInput |
string |
No description. |
awsSnsTopicArnInput |
string |
No description. |
awsSqsArnInput |
string |
No description. |
awsSqsRoleArnInput |
string |
No description. |
azureStorageQueuePrimaryUriInput |
string |
No description. |
azureTenantIdInput |
string |
No description. |
commentInput |
string |
No description. |
directionInput |
string |
No description. |
enabledInput |
boolean | cdktf.IResolvable |
No description. |
gcpPubsubSubscriptionNameInput |
string |
No description. |
gcpPubsubTopicNameInput |
string |
No description. |
idInput |
string |
No description. |
nameInput |
string |
No description. |
notificationProviderInput |
string |
No description. |
typeInput |
string |
No description. |
awsSnsRoleArn |
string |
No description. |
awsSnsTopicArn |
string |
No description. |
awsSqsArn |
string |
No description. |
awsSqsRoleArn |
string |
No description. |
azureStorageQueuePrimaryUri |
string |
No description. |
azureTenantId |
string |
No description. |
comment |
string |
No description. |
direction |
string |
No description. |
enabled |
boolean | cdktf.IResolvable |
No description. |
gcpPubsubSubscriptionName |
string |
No description. |
gcpPubsubTopicName |
string |
No description. |
id |
string |
No description. |
name |
string |
No description. |
notificationProvider |
string |
No description. |
type |
string |
No description. |
public readonly node: Node;
- Type: constructs.Node
The tree node.
public readonly cdktfStack: TerraformStack;
- Type: cdktf.TerraformStack
public readonly fqn: string;
- Type: string
public readonly friendlyUniqueId: string;
- Type: string
public readonly terraformMetaArguments: {[ key: string ]: any};
- Type: {[ key: string ]: any}
public readonly terraformResourceType: string;
- Type: string
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
- Type: cdktf.TerraformProviderGeneratorMetadata
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
- Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
public readonly count: number | TerraformCount;
- Type: number | cdktf.TerraformCount
public readonly dependsOn: string[];
- Type: string[]
public readonly forEach: ITerraformIterator;
- Type: cdktf.ITerraformIterator
public readonly lifecycle: TerraformResourceLifecycle;
- Type: cdktf.TerraformResourceLifecycle
public readonly provider: TerraformProvider;
- Type: cdktf.TerraformProvider
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
- Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
public readonly awsSnsExternalId: string;
- Type: string
public readonly awsSnsIamUserArn: string;
- Type: string
public readonly awsSqsExternalId: string;
- Type: string
public readonly awsSqsIamUserArn: string;
- Type: string
public readonly createdOn: string;
- Type: string
public readonly gcpPubsubServiceAccount: string;
- Type: string
public readonly awsSnsRoleArnInput: string;
- Type: string
public readonly awsSnsTopicArnInput: string;
- Type: string
public readonly awsSqsArnInput: string;
- Type: string
public readonly awsSqsRoleArnInput: string;
- Type: string
public readonly azureStorageQueuePrimaryUriInput: string;
- Type: string
public readonly azureTenantIdInput: string;
- Type: string
public readonly commentInput: string;
- Type: string
public readonly directionInput: string;
- Type: string
public readonly enabledInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly gcpPubsubSubscriptionNameInput: string;
- Type: string
public readonly gcpPubsubTopicNameInput: string;
- Type: string
public readonly idInput: string;
- Type: string
public readonly nameInput: string;
- Type: string
public readonly notificationProviderInput: string;
- Type: string
public readonly typeInput: string;
- Type: string
public readonly awsSnsRoleArn: string;
- Type: string
public readonly awsSnsTopicArn: string;
- Type: string
public readonly awsSqsArn: string;
- Type: string
public readonly awsSqsRoleArn: string;
- Type: string
public readonly azureStorageQueuePrimaryUri: string;
- Type: string
public readonly azureTenantId: string;
- Type: string
public readonly comment: string;
- Type: string
public readonly direction: string;
- Type: string
public readonly enabled: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly gcpPubsubSubscriptionName: string;
- Type: string
public readonly gcpPubsubTopicName: string;
- Type: string
public readonly id: string;
- Type: string
public readonly name: string;
- Type: string
public readonly notificationProvider: string;
- Type: string
public readonly type: string;
- Type: string
Name | Type | Description |
---|---|---|
tfResourceType |
string |
No description. |
public readonly tfResourceType: string;
- Type: string
import { notificationIntegration } from '@cdktf/provider-snowflake'
const notificationIntegrationConfig: notificationIntegration.NotificationIntegrationConfig = { ... }
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/0.90.0/docs/resources/notification_integration#name NotificationIntegration#name}. |
notificationProvider |
string |
The third-party cloud message queuing service (supported values: AZURE_STORAGE_QUEUE, AWS_SNS, GCP_PUBSUB; |
awsSnsRoleArn |
string |
AWS IAM role ARN for notification integration to assume. Required for AWS_SNS provider. |
awsSnsTopicArn |
string |
AWS SNS Topic ARN for notification integration to connect to. Required for AWS_SNS provider. |
awsSqsArn |
string |
AWS SQS queue ARN for notification integration to connect to. |
awsSqsRoleArn |
string |
AWS IAM role ARN for notification integration to assume. |
azureStorageQueuePrimaryUri |
string |
The queue ID for the Azure Queue Storage queue created for Event Grid notifications. Required for AZURE_STORAGE_QUEUE provider. |
azureTenantId |
string |
The ID of the Azure Active Directory tenant used for identity management. Required for AZURE_STORAGE_QUEUE provider. |
comment |
string |
A comment for the integration. |
direction |
string |
Direction of the cloud messaging with respect to Snowflake (required only for error notifications). |
enabled |
boolean | cdktf.IResolvable |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/notification_integration#enabled NotificationIntegration#enabled}. |
gcpPubsubSubscriptionName |
string |
The subscription id that Snowflake will listen to when using the GCP_PUBSUB provider. |
gcpPubsubTopicName |
string |
The topic id that Snowflake will use to push notifications. |
id |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/notification_integration#id NotificationIntegration#id}. |
type |
string |
A type of integration. |
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
- Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
public readonly count: number | TerraformCount;
- Type: number | cdktf.TerraformCount
public readonly dependsOn: ITerraformDependable[];
- Type: cdktf.ITerraformDependable[]
public readonly forEach: ITerraformIterator;
- Type: cdktf.ITerraformIterator
public readonly lifecycle: TerraformResourceLifecycle;
- Type: cdktf.TerraformResourceLifecycle
public readonly provider: TerraformProvider;
- Type: cdktf.TerraformProvider
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
- Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
public readonly name: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/notification_integration#name NotificationIntegration#name}.
public readonly notificationProvider: string;
- Type: string
The third-party cloud message queuing service (supported values: AZURE_STORAGE_QUEUE, AWS_SNS, GCP_PUBSUB;
AWS_SQS is deprecated and will be removed in the future provider versions)
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/notification_integration#notification_provider NotificationIntegration#notification_provider}
public readonly awsSnsRoleArn: string;
- Type: string
AWS IAM role ARN for notification integration to assume. Required for AWS_SNS provider.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/notification_integration#aws_sns_role_arn NotificationIntegration#aws_sns_role_arn}
public readonly awsSnsTopicArn: string;
- Type: string
AWS SNS Topic ARN for notification integration to connect to. Required for AWS_SNS provider.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/notification_integration#aws_sns_topic_arn NotificationIntegration#aws_sns_topic_arn}
public readonly awsSqsArn: string;
- Type: string
AWS SQS queue ARN for notification integration to connect to.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/notification_integration#aws_sqs_arn NotificationIntegration#aws_sqs_arn}
public readonly awsSqsRoleArn: string;
- Type: string
AWS IAM role ARN for notification integration to assume.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/notification_integration#aws_sqs_role_arn NotificationIntegration#aws_sqs_role_arn}
public readonly azureStorageQueuePrimaryUri: string;
- Type: string
The queue ID for the Azure Queue Storage queue created for Event Grid notifications. Required for AZURE_STORAGE_QUEUE provider.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/notification_integration#azure_storage_queue_primary_uri NotificationIntegration#azure_storage_queue_primary_uri}
public readonly azureTenantId: string;
- Type: string
The ID of the Azure Active Directory tenant used for identity management. Required for AZURE_STORAGE_QUEUE provider.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/notification_integration#azure_tenant_id NotificationIntegration#azure_tenant_id}
public readonly comment: string;
- Type: string
A comment for the integration.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/notification_integration#comment NotificationIntegration#comment}
public readonly direction: string;
- Type: string
Direction of the cloud messaging with respect to Snowflake (required only for error notifications).
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/notification_integration#direction NotificationIntegration#direction}
public readonly enabled: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/notification_integration#enabled NotificationIntegration#enabled}.
public readonly gcpPubsubSubscriptionName: string;
- Type: string
The subscription id that Snowflake will listen to when using the GCP_PUBSUB provider.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/notification_integration#gcp_pubsub_subscription_name NotificationIntegration#gcp_pubsub_subscription_name}
public readonly gcpPubsubTopicName: string;
- Type: string
The topic id that Snowflake will use to push notifications.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/notification_integration#gcp_pubsub_topic_name NotificationIntegration#gcp_pubsub_topic_name}
public readonly id: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/notification_integration#id NotificationIntegration#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.
public readonly type: string;
- Type: string
A type of integration.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/notification_integration#type NotificationIntegration#type}