Welcome to Pulumi Registry, your window into the cloud. Read the announcement.

Snowflake

v0.2.1 published on Monday, Sep 27, 2021 by Pulumi

Pipe

Import

format is database name | schema name | pipe name

 $ pulumi import snowflake:index/pipe:Pipe example 'dbName|schemaName|pipeName'

Example Usage

Coming soon!

Coming soon!

Coming soon!

import * as pulumi from "@pulumi/pulumi";
import * as snowflake from "@pulumi/snowflake";

const pipe = new snowflake.Pipe("pipe", {
    autoIngest: false,
    awsSnsTopicArn: "...",
    comment: "A pipe.",
    copyStatement: "copy into mytable from @mystage",
    database: "db",
    notificationChannel: "...",
    owner: "role1",
    schema: "schema",
});

Create a Pipe Resource

new Pipe(name: string, args: PipeArgs, opts?: CustomResourceOptions);
@overload
def Pipe(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         auto_ingest: Optional[bool] = None,
         aws_sns_topic_arn: Optional[str] = None,
         comment: Optional[str] = None,
         copy_statement: Optional[str] = None,
         database: Optional[str] = None,
         error_integration: Optional[str] = None,
         integration: Optional[str] = None,
         name: Optional[str] = None,
         schema: Optional[str] = None)
@overload
def Pipe(resource_name: str,
         args: PipeArgs,
         opts: Optional[ResourceOptions] = None)
func NewPipe(ctx *Context, name string, args PipeArgs, opts ...ResourceOption) (*Pipe, error)
public Pipe(string name, PipeArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args PipeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args PipeArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args PipeArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args PipeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Pipe Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Pipe resource accepts the following input properties:

CopyStatement string
Specifies the copy statement for the pipe.
Database string
The database in which to create the pipe.
Schema string
The schema in which to create the pipe.
AutoIngest bool
Specifies a auto_ingest param for the pipe.
AwsSnsTopicArn string
Specifies the Amazon Resource Name (ARN) for the SNS topic for your S3 bucket.
Comment string
Specifies a comment for the pipe.
ErrorIntegration string
Specifies the name of the notification integration used for error notifications.
Integration string
Specifies an integration for the pipe.
Name string
Specifies the identifier for the pipe; must be unique for the database and schema in which the pipe is created.
CopyStatement string
Specifies the copy statement for the pipe.
Database string
The database in which to create the pipe.
Schema string
The schema in which to create the pipe.
AutoIngest bool
Specifies a auto_ingest param for the pipe.
AwsSnsTopicArn string
Specifies the Amazon Resource Name (ARN) for the SNS topic for your S3 bucket.
Comment string
Specifies a comment for the pipe.
ErrorIntegration string
Specifies the name of the notification integration used for error notifications.
Integration string
Specifies an integration for the pipe.
Name string
Specifies the identifier for the pipe; must be unique for the database and schema in which the pipe is created.
copyStatement string
Specifies the copy statement for the pipe.
database string
The database in which to create the pipe.
schema string
The schema in which to create the pipe.
autoIngest boolean
Specifies a auto_ingest param for the pipe.
awsSnsTopicArn string
Specifies the Amazon Resource Name (ARN) for the SNS topic for your S3 bucket.
comment string
Specifies a comment for the pipe.
errorIntegration string
Specifies the name of the notification integration used for error notifications.
integration string
Specifies an integration for the pipe.
name string
Specifies the identifier for the pipe; must be unique for the database and schema in which the pipe is created.
copy_statement str
Specifies the copy statement for the pipe.
database str
The database in which to create the pipe.
schema str
The schema in which to create the pipe.
auto_ingest bool
Specifies a auto_ingest param for the pipe.
aws_sns_topic_arn str
Specifies the Amazon Resource Name (ARN) for the SNS topic for your S3 bucket.
comment str
Specifies a comment for the pipe.
error_integration str
Specifies the name of the notification integration used for error notifications.
integration str
Specifies an integration for the pipe.
name str
Specifies the identifier for the pipe; must be unique for the database and schema in which the pipe is created.

Outputs

All input properties are implicitly available as output properties. Additionally, the Pipe resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
NotificationChannel string
Amazon Resource Name of the Amazon SQS queue for the stage named in the DEFINITION column.
Owner string
Name of the role that owns the pipe.
Id string
The provider-assigned unique ID for this managed resource.
NotificationChannel string
Amazon Resource Name of the Amazon SQS queue for the stage named in the DEFINITION column.
Owner string
Name of the role that owns the pipe.
id string
The provider-assigned unique ID for this managed resource.
notificationChannel string
Amazon Resource Name of the Amazon SQS queue for the stage named in the DEFINITION column.
owner string
Name of the role that owns the pipe.
id str
The provider-assigned unique ID for this managed resource.
notification_channel str
Amazon Resource Name of the Amazon SQS queue for the stage named in the DEFINITION column.
owner str
Name of the role that owns the pipe.

Look up an Existing Pipe Resource

Get an existing Pipe resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: PipeState, opts?: CustomResourceOptions): Pipe
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_ingest: Optional[bool] = None,
        aws_sns_topic_arn: Optional[str] = None,
        comment: Optional[str] = None,
        copy_statement: Optional[str] = None,
        database: Optional[str] = None,
        error_integration: Optional[str] = None,
        integration: Optional[str] = None,
        name: Optional[str] = None,
        notification_channel: Optional[str] = None,
        owner: Optional[str] = None,
        schema: Optional[str] = None) -> Pipe
func GetPipe(ctx *Context, name string, id IDInput, state *PipeState, opts ...ResourceOption) (*Pipe, error)
public static Pipe Get(string name, Input<string> id, PipeState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

AutoIngest bool
Specifies a auto_ingest param for the pipe.
AwsSnsTopicArn string
Specifies the Amazon Resource Name (ARN) for the SNS topic for your S3 bucket.
Comment string
Specifies a comment for the pipe.
CopyStatement string
Specifies the copy statement for the pipe.
Database string
The database in which to create the pipe.
ErrorIntegration string
Specifies the name of the notification integration used for error notifications.
Integration string
Specifies an integration for the pipe.
Name string
Specifies the identifier for the pipe; must be unique for the database and schema in which the pipe is created.
NotificationChannel string
Amazon Resource Name of the Amazon SQS queue for the stage named in the DEFINITION column.
Owner string
Name of the role that owns the pipe.
Schema string
The schema in which to create the pipe.
AutoIngest bool
Specifies a auto_ingest param for the pipe.
AwsSnsTopicArn string
Specifies the Amazon Resource Name (ARN) for the SNS topic for your S3 bucket.
Comment string
Specifies a comment for the pipe.
CopyStatement string
Specifies the copy statement for the pipe.
Database string
The database in which to create the pipe.
ErrorIntegration string
Specifies the name of the notification integration used for error notifications.
Integration string
Specifies an integration for the pipe.
Name string
Specifies the identifier for the pipe; must be unique for the database and schema in which the pipe is created.
NotificationChannel string
Amazon Resource Name of the Amazon SQS queue for the stage named in the DEFINITION column.
Owner string
Name of the role that owns the pipe.
Schema string
The schema in which to create the pipe.
autoIngest boolean
Specifies a auto_ingest param for the pipe.
awsSnsTopicArn string
Specifies the Amazon Resource Name (ARN) for the SNS topic for your S3 bucket.
comment string
Specifies a comment for the pipe.
copyStatement string
Specifies the copy statement for the pipe.
database string
The database in which to create the pipe.
errorIntegration string
Specifies the name of the notification integration used for error notifications.
integration string
Specifies an integration for the pipe.
name string
Specifies the identifier for the pipe; must be unique for the database and schema in which the pipe is created.
notificationChannel string
Amazon Resource Name of the Amazon SQS queue for the stage named in the DEFINITION column.
owner string
Name of the role that owns the pipe.
schema string
The schema in which to create the pipe.
auto_ingest bool
Specifies a auto_ingest param for the pipe.
aws_sns_topic_arn str
Specifies the Amazon Resource Name (ARN) for the SNS topic for your S3 bucket.
comment str
Specifies a comment for the pipe.
copy_statement str
Specifies the copy statement for the pipe.
database str
The database in which to create the pipe.
error_integration str
Specifies the name of the notification integration used for error notifications.
integration str
Specifies an integration for the pipe.
name str
Specifies the identifier for the pipe; must be unique for the database and schema in which the pipe is created.
notification_channel str
Amazon Resource Name of the Amazon SQS queue for the stage named in the DEFINITION column.
owner str
Name of the role that owns the pipe.
schema str
The schema in which to create the pipe.

Package Details

Repository
https://github.com/pulumi/pulumi-snowflake
License
Apache-2.0
Notes
This Pulumi package is based on the snowflake Terraform Provider.