Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Snowflake Provider
  3. API Docs
  4. Pipe
Snowflake v0.61.1 published on Thursday, Nov 14, 2024 by Pulumi
pulumi/pulumi-snowflake

snowflake.Pipe

Explore with Pulumi AI

snowflake logo
Snowflake v0.61.1 published on Thursday, Nov 14, 2024 by Pulumi
pulumi/pulumi-snowflake

    Import

    format is database name | schema name | pipe name

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

    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)
    public Pipe(String name, PipeArgs args)
public Pipe(String name, PipeArgs args, CustomResourceOptions options)

    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.

    Constructor 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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

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

    Outputs

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

    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    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.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    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.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    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.
    fullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    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.
    fully_qualified_name str
    Fully qualified name of the resource. For more information, see object name resolution.
    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.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    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.

    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,
        fully_qualified_name: 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)
    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.
    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.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    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.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    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.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    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.
    fullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    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.
    fully_qualified_name str
    Fully qualified name of the resource. For more information, see object name resolution.
    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.
    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.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    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.

    Package Details

    Repository
    Snowflake pulumi/pulumi-snowflake
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the snowflake Terraform Provider.
    snowflake logo
    Snowflake v0.61.1 published on Thursday, Nov 14, 2024 by Pulumi
    pulumi/pulumi-snowflake