Skip to content

Latest commit

 

History

History
1471 lines (916 loc) · 66.2 KB

notificationIntegration.typescript.md

File metadata and controls

1471 lines (916 loc) · 66.2 KB

notificationIntegration Submodule

Constructs

NotificationIntegration

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

Initializers

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.

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

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


resetAwsSnsRoleArn
public resetAwsSnsRoleArn(): void
resetAwsSnsTopicArn
public resetAwsSnsTopicArn(): void
resetAwsSqsArn
public resetAwsSqsArn(): void
resetAwsSqsRoleArn
public resetAwsSqsRoleArn(): void
resetAzureStorageQueuePrimaryUri
public resetAzureStorageQueuePrimaryUri(): void
resetAzureTenantId
public resetAzureTenantId(): void
resetComment
public resetComment(): void
resetDirection
public resetDirection(): void
resetEnabled
public resetEnabled(): void
resetGcpPubsubSubscriptionName
public resetGcpPubsubSubscriptionName(): void
resetGcpPubsubTopicName
public resetGcpPubsubTopicName(): void
resetId
public resetId(): 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 NotificationIntegration resource upon running "cdktf plan ".

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

xRequired
  • Type: any

Any object.


isTerraformElement
import { notificationIntegration } from '@cdktf/provider-snowflake'

notificationIntegration.NotificationIntegration.isTerraformElement(x: any)
xRequired
  • Type: any

isTerraformResource
import { notificationIntegration } from '@cdktf/provider-snowflake'

notificationIntegration.NotificationIntegration.isTerraformResource(x: any)
xRequired
  • Type: any

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

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 NotificationIntegration to import.


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


providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the NotificationIntegration 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.
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.

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

awsSnsExternalIdRequired
public readonly awsSnsExternalId: string;
  • Type: string

awsSnsIamUserArnRequired
public readonly awsSnsIamUserArn: string;
  • Type: string

awsSqsExternalIdRequired
public readonly awsSqsExternalId: string;
  • Type: string

awsSqsIamUserArnRequired
public readonly awsSqsIamUserArn: string;
  • Type: string

createdOnRequired
public readonly createdOn: string;
  • Type: string

gcpPubsubServiceAccountRequired
public readonly gcpPubsubServiceAccount: string;
  • Type: string

awsSnsRoleArnInputOptional
public readonly awsSnsRoleArnInput: string;
  • Type: string

awsSnsTopicArnInputOptional
public readonly awsSnsTopicArnInput: string;
  • Type: string

awsSqsArnInputOptional
public readonly awsSqsArnInput: string;
  • Type: string

awsSqsRoleArnInputOptional
public readonly awsSqsRoleArnInput: string;
  • Type: string

azureStorageQueuePrimaryUriInputOptional
public readonly azureStorageQueuePrimaryUriInput: string;
  • Type: string

azureTenantIdInputOptional
public readonly azureTenantIdInput: string;
  • Type: string

commentInputOptional
public readonly commentInput: string;
  • Type: string

directionInputOptional
public readonly directionInput: string;
  • Type: string

enabledInputOptional
public readonly enabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

gcpPubsubSubscriptionNameInputOptional
public readonly gcpPubsubSubscriptionNameInput: string;
  • Type: string

gcpPubsubTopicNameInputOptional
public readonly gcpPubsubTopicNameInput: string;
  • Type: string

idInputOptional
public readonly idInput: string;
  • Type: string

nameInputOptional
public readonly nameInput: string;
  • Type: string

notificationProviderInputOptional
public readonly notificationProviderInput: string;
  • Type: string

typeInputOptional
public readonly typeInput: string;
  • Type: string

awsSnsRoleArnRequired
public readonly awsSnsRoleArn: string;
  • Type: string

awsSnsTopicArnRequired
public readonly awsSnsTopicArn: string;
  • Type: string

awsSqsArnRequired
public readonly awsSqsArn: string;
  • Type: string

awsSqsRoleArnRequired
public readonly awsSqsRoleArn: string;
  • Type: string

azureStorageQueuePrimaryUriRequired
public readonly azureStorageQueuePrimaryUri: string;
  • Type: string

azureTenantIdRequired
public readonly azureTenantId: string;
  • Type: string

commentRequired
public readonly comment: string;
  • Type: string

directionRequired
public readonly direction: string;
  • Type: string

enabledRequired
public readonly enabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

gcpPubsubSubscriptionNameRequired
public readonly gcpPubsubSubscriptionName: string;
  • Type: string

gcpPubsubTopicNameRequired
public readonly gcpPubsubTopicName: string;
  • Type: string

idRequired
public readonly id: string;
  • Type: string

nameRequired
public readonly name: string;
  • Type: string

notificationProviderRequired
public readonly notificationProvider: string;
  • Type: string

typeRequired
public readonly type: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

NotificationIntegrationConfig

Initializer

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

const notificationIntegrationConfig: notificationIntegration.NotificationIntegrationConfig = { ... }

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

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

nameRequired
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}.


notificationProviderRequired
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}


awsSnsRoleArnOptional
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}


awsSnsTopicArnOptional
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}


awsSqsArnOptional
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}


awsSqsRoleArnOptional
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}


azureStorageQueuePrimaryUriOptional
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}


azureTenantIdOptional
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}


commentOptional
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}


directionOptional
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}


enabledOptional
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}.


gcpPubsubSubscriptionNameOptional
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}


gcpPubsubTopicNameOptional
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}


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


typeOptional
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}