Docs
PackagesSnowflake v0.52.0 published on Thursday, Apr 18, 2024 by Pulumi
snowflake.Pipe
Explore with Pulumi AI
Example Usage
Coming soon!
Coming soon!
Coming soon!
Coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.snowflake.Pipe;
import com.pulumi.snowflake.PipeArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var pipe = new Pipe("pipe", PipeArgs.builder()
.autoIngest(false)
.awsSnsTopicArn("...")
.comment("A pipe.")
.copyStatement("copy into mytable from @mystage")
.database("db")
.notificationChannel("...")
.schema("schema")
.build());
}
}
resources:
pipe:
type: snowflake:Pipe
properties:
autoIngest: false
awsSnsTopicArn: '...'
comment: A pipe.
copyStatement: copy into mytable from @mystage
database: db
notificationChannel: '...'
schema: schema
Create Pipe Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Pipe(name: string, args: PipeArgs, opts?: CustomResourceOptions);@overload
def Pipe(resource_name: str,
args: PipeArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Pipe(resource_name: str,
opts: Optional[ResourceOptions] = None,
copy_statement: Optional[str] = None,
database: Optional[str] = None,
schema: Optional[str] = None,
auto_ingest: Optional[bool] = None,
aws_sns_topic_arn: Optional[str] = None,
comment: Optional[str] = None,
error_integration: Optional[str] = None,
integration: Optional[str] = None,
name: Optional[str] = None)func NewPipe(ctx *Context, name string, args PipeArgs, opts ...ResourceOption) (*Pipe, error)public Pipe(string name, PipeArgs args, CustomResourceOptions? opts = null)type: snowflake:Pipe
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- 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.
- name String
- The unique name of the resource.
- args PipeArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Example
The following reference example uses placeholder values for all input properties.
var pipeResource = new Snowflake.Pipe("pipeResource", new()
{
CopyStatement = "string",
Database = "string",
Schema = "string",
AutoIngest = false,
AwsSnsTopicArn = "string",
Comment = "string",
ErrorIntegration = "string",
Integration = "string",
Name = "string",
});
example, err := snowflake.NewPipe(ctx, "pipeResource", &snowflake.PipeArgs{
CopyStatement: pulumi.String("string"),
Database: pulumi.String("string"),
Schema: pulumi.String("string"),
AutoIngest: pulumi.Bool(false),
AwsSnsTopicArn: pulumi.String("string"),
Comment: pulumi.String("string"),
ErrorIntegration: pulumi.String("string"),
Integration: pulumi.String("string"),
Name: pulumi.String("string"),
})
var pipeResource = new Pipe("pipeResource", PipeArgs.builder()
.copyStatement("string")
.database("string")
.schema("string")
.autoIngest(false)
.awsSnsTopicArn("string")
.comment("string")
.errorIntegration("string")
.integration("string")
.name("string")
.build());
pipe_resource = snowflake.Pipe("pipeResource",
copy_statement="string",
database="string",
schema="string",
auto_ingest=False,
aws_sns_topic_arn="string",
comment="string",
error_integration="string",
integration="string",
name="string")
const pipeResource = new snowflake.Pipe("pipeResource", {
copyStatement: "string",
database: "string",
schema: "string",
autoIngest: false,
awsSnsTopicArn: "string",
comment: "string",
errorIntegration: "string",
integration: "string",
name: "string",
});
type: snowflake:Pipe
properties:
autoIngest: false
awsSnsTopicArn: string
comment: string
copyStatement: string
database: string
errorIntegration: string
integration: string
name: string
schema: string
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:
- Copy
Statement 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.
- Auto
Ingest bool - Specifies a auto_ingest param for the pipe.
- Aws
Sns stringTopic Arn - Specifies the Amazon Resource Name (ARN) for the SNS topic for your S3 bucket.
- Comment string
- Specifies a comment for the pipe.
- Error
Integration 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 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.
- Auto
Ingest bool - Specifies a auto_ingest param for the pipe.
- Aws
Sns stringTopic Arn - Specifies the Amazon Resource Name (ARN) for the SNS topic for your S3 bucket.
- Comment string
- Specifies a comment for the pipe.
- Error
Integration 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 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.
- auto
Ingest Boolean - Specifies a auto_ingest param for the pipe.
- aws
Sns StringTopic Arn - Specifies the Amazon Resource Name (ARN) for the SNS topic for your S3 bucket.
- comment String
- Specifies a comment for the pipe.
- error
Integration 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 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.
- auto
Ingest boolean - Specifies a auto_ingest param for the pipe.
- aws
Sns stringTopic Arn - Specifies the Amazon Resource Name (ARN) for the SNS topic for your S3 bucket.
- comment string
- Specifies a comment for the pipe.
- error
Integration 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_ strtopic_ arn - 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.
- copy
Statement 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.
- auto
Ingest Boolean - Specifies a auto_ingest param for the pipe.
- aws
Sns StringTopic Arn - Specifies the Amazon Resource Name (ARN) for the SNS topic for your S3 bucket.
- comment String
- Specifies a comment for the pipe.
- error
Integration 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.
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.
- Notification
Channel 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.
- Notification
Channel 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.
- notification
Channel 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.
- notification
Channel 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.
- id String
- The provider-assigned unique ID for this managed resource.
- notification
Channel 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.
Look up 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) -> Pipefunc 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)public static Pipe get(String name, Output<String> id, PipeState state, CustomResourceOptions options)Resource lookup is not supported in YAML- 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.
- 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.
- Auto
Ingest bool - Specifies a auto_ingest param for the pipe.
- Aws
Sns stringTopic Arn - Specifies the Amazon Resource Name (ARN) for the SNS topic for your S3 bucket.
- Comment string
- Specifies a comment for the pipe.
- Copy
Statement string - Specifies the copy statement for the pipe.
- Database string
- The database in which to create the pipe.
- Error
Integration 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.
- Notification
Channel 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 stringTopic Arn - Specifies the Amazon Resource Name (ARN) for the SNS topic for your S3 bucket.
- Comment string
- Specifies a comment for the pipe.
- Copy
Statement string - Specifies the copy statement for the pipe.
- Database string
- The database in which to create the pipe.
- Error
Integration 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.
- Notification
Channel 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 Boolean - Specifies a auto_ingest param for the pipe.
- aws
Sns StringTopic Arn - Specifies the Amazon Resource Name (ARN) for the SNS topic for your S3 bucket.
- comment String
- Specifies a comment for the pipe.
- copy
Statement String - Specifies the copy statement for the pipe.
- database String
- The database in which to create the pipe.
- error
Integration 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.
- notification
Channel 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 boolean - Specifies a auto_ingest param for the pipe.
- aws
Sns stringTopic Arn - Specifies the Amazon Resource Name (ARN) for the SNS topic for your S3 bucket.
- comment string
- Specifies a comment for the pipe.
- copy
Statement string - Specifies the copy statement for the pipe.
- database string
- The database in which to create the pipe.
- error
Integration 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.
- notification
Channel 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_ strtopic_ arn - 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.
- auto
Ingest Boolean - Specifies a auto_ingest param for the pipe.
- aws
Sns StringTopic Arn - Specifies the Amazon Resource Name (ARN) for the SNS topic for your S3 bucket.
- comment String
- Specifies a comment for the pipe.
- copy
Statement String - Specifies the copy statement for the pipe.
- database String
- The database in which to create the pipe.
- error
Integration 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.
- notification
Channel 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.
Import
format is database name | schema name | pipe name
$ pulumi import snowflake:index/pipe:Pipe example 'dbName|schemaName|pipeName'
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Snowflake pulumi/pulumi-snowflake
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
snowflakeTerraform Provider.