Represents a {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/pipe snowflake_pipe}.
using HashiCorp.Cdktf.Providers.Snowflake;
new Pipe(Construct Scope, string Id, PipeConfig Config);
Name | Type | Description |
---|---|---|
Scope |
Constructs.Construct |
The scope in which to define this construct. |
Id |
string |
The scoped construct ID. |
Config |
PipeConfig |
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
- Type: PipeConfig
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". |
ResetAutoIngest |
No description. |
ResetAwsSnsTopicArn |
No description. |
ResetComment |
No description. |
ResetErrorIntegration |
No description. |
ResetId |
No description. |
ResetIntegration |
No description. |
private string ToString()
Returns a string representation of this construct.
private void AddOverride(string Path, object Value)
- Type: string
- Type: object
private void OverrideLogicalId(string NewLogicalId)
Overrides the auto-generated logical ID with a specific ID.
- Type: string
The new logical ID to use for this stack element.
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
private object ToHclTerraform()
private object ToMetadata()
private object ToTerraform()
Adds this resource to the terraform JSON output.
private void AddMoveTarget(string MoveTarget)
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.
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
- Type: string
private IResolvable GetBooleanAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
- Type: string
private string[] GetListAttribute(string TerraformAttribute)
- Type: string
private double GetNumberAttribute(string TerraformAttribute)
- Type: string
private double[] GetNumberListAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
- Type: string
private string GetStringAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
- Type: string
private object HasResourceMove()
private void ImportFrom(string Id, TerraformProvider Provider = null)
- Type: string
- Type: HashiCorp.Cdktf.TerraformProvider
private IResolvable InterpolationForAttribute(string TerraformAttribute)
- Type: string
private void MoveFromId(string Id)
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".
private void MoveTo(string MoveTarget, object Index = null)
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: object
Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.
private void MoveToId(string Id)
Moves this resource to the resource corresponding to "id".
- Type: string
Full id of resource to move to, e.g. "aws_s3_bucket.example".
private void ResetAutoIngest()
private void ResetAwsSnsTopicArn()
private void ResetComment()
private void ResetErrorIntegration()
private void ResetId()
private void ResetIntegration()
Name | Description |
---|---|
IsConstruct |
Checks if x is a construct. |
IsTerraformElement |
No description. |
IsTerraformResource |
No description. |
GenerateConfigForImport |
Generates CDKTF code for importing a Pipe resource upon running "cdktf plan ". |
using HashiCorp.Cdktf.Providers.Snowflake;
Pipe.IsConstruct(object X);
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: object
Any object.
using HashiCorp.Cdktf.Providers.Snowflake;
Pipe.IsTerraformElement(object X);
- Type: object
using HashiCorp.Cdktf.Providers.Snowflake;
Pipe.IsTerraformResource(object X);
- Type: object
using HashiCorp.Cdktf.Providers.Snowflake;
Pipe.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);
Generates CDKTF code for importing a Pipe 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 Pipe to import.
- Type: string
The id of the existing Pipe that should be imported.
Refer to the {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/pipe#import import section} in the documentation of this resource for the id to use
- Type: HashiCorp.Cdktf.TerraformProvider
? Optional instance of the provider where the Pipe to import is found.
Name | Type | Description |
---|---|---|
Node |
Constructs.Node |
The tree node. |
CdktfStack |
HashiCorp.Cdktf.TerraformStack |
No description. |
Fqn |
string |
No description. |
FriendlyUniqueId |
string |
No description. |
TerraformMetaArguments |
System.Collections.Generic.IDictionary<string, object> |
No description. |
TerraformResourceType |
string |
No description. |
TerraformGeneratorMetadata |
HashiCorp.Cdktf.TerraformProviderGeneratorMetadata |
No description. |
Connection |
object |
No description. |
Count |
object |
No description. |
DependsOn |
string[] |
No description. |
ForEach |
HashiCorp.Cdktf.ITerraformIterator |
No description. |
Lifecycle |
HashiCorp.Cdktf.TerraformResourceLifecycle |
No description. |
Provider |
HashiCorp.Cdktf.TerraformProvider |
No description. |
Provisioners |
object[] |
No description. |
NotificationChannel |
string |
No description. |
Owner |
string |
No description. |
AutoIngestInput |
object |
No description. |
AwsSnsTopicArnInput |
string |
No description. |
CommentInput |
string |
No description. |
CopyStatementInput |
string |
No description. |
DatabaseInput |
string |
No description. |
ErrorIntegrationInput |
string |
No description. |
IdInput |
string |
No description. |
IntegrationInput |
string |
No description. |
NameInput |
string |
No description. |
SchemaInput |
string |
No description. |
AutoIngest |
object |
No description. |
AwsSnsTopicArn |
string |
No description. |
Comment |
string |
No description. |
CopyStatement |
string |
No description. |
Database |
string |
No description. |
ErrorIntegration |
string |
No description. |
Id |
string |
No description. |
Integration |
string |
No description. |
Name |
string |
No description. |
Schema |
string |
No description. |
public Node Node { get; }
- Type: Constructs.Node
The tree node.
public TerraformStack CdktfStack { get; }
- Type: HashiCorp.Cdktf.TerraformStack
public string Fqn { get; }
- Type: string
public string FriendlyUniqueId { get; }
- Type: string
public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }
- Type: System.Collections.Generic.IDictionary<string, object>
public string TerraformResourceType { get; }
- Type: string
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
- Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata
public object Connection { get; }
- Type: object
public object Count { get; }
- Type: object
public string[] DependsOn { get; }
- Type: string[]
public ITerraformIterator ForEach { get; }
- Type: HashiCorp.Cdktf.ITerraformIterator
public TerraformResourceLifecycle Lifecycle { get; }
- Type: HashiCorp.Cdktf.TerraformResourceLifecycle
public TerraformProvider Provider { get; }
- Type: HashiCorp.Cdktf.TerraformProvider
public object[] Provisioners { get; }
- Type: object[]
public string NotificationChannel { get; }
- Type: string
public string Owner { get; }
- Type: string
public object AutoIngestInput { get; }
- Type: object
public string AwsSnsTopicArnInput { get; }
- Type: string
public string CommentInput { get; }
- Type: string
public string CopyStatementInput { get; }
- Type: string
public string DatabaseInput { get; }
- Type: string
public string ErrorIntegrationInput { get; }
- Type: string
public string IdInput { get; }
- Type: string
public string IntegrationInput { get; }
- Type: string
public string NameInput { get; }
- Type: string
public string SchemaInput { get; }
- Type: string
public object AutoIngest { get; }
- Type: object
public string AwsSnsTopicArn { get; }
- Type: string
public string Comment { get; }
- Type: string
public string CopyStatement { get; }
- Type: string
public string Database { get; }
- Type: string
public string ErrorIntegration { get; }
- Type: string
public string Id { get; }
- Type: string
public string Integration { get; }
- Type: string
public string Name { get; }
- Type: string
public string Schema { get; }
- Type: string
Name | Type | Description |
---|---|---|
TfResourceType |
string |
No description. |
public string TfResourceType { get; }
- Type: string
using HashiCorp.Cdktf.Providers.Snowflake;
new PipeConfig {
object Connection = null,
object Count = null,
ITerraformDependable[] DependsOn = null,
ITerraformIterator ForEach = null,
TerraformResourceLifecycle Lifecycle = null,
TerraformProvider Provider = null,
object[] Provisioners = null,
string CopyStatement,
string Database,
string Name,
string Schema,
object AutoIngest = null,
string AwsSnsTopicArn = null,
string Comment = null,
string ErrorIntegration = null,
string Id = null,
string Integration = null
};
Name | Type | Description |
---|---|---|
Connection |
object |
No description. |
Count |
object |
No description. |
DependsOn |
HashiCorp.Cdktf.ITerraformDependable[] |
No description. |
ForEach |
HashiCorp.Cdktf.ITerraformIterator |
No description. |
Lifecycle |
HashiCorp.Cdktf.TerraformResourceLifecycle |
No description. |
Provider |
HashiCorp.Cdktf.TerraformProvider |
No description. |
Provisioners |
object[] |
No description. |
CopyStatement |
string |
Specifies the copy statement for the pipe. |
Database |
string |
The database in which to create the pipe. |
Name |
string |
Specifies the identifier for the pipe; |
Schema |
string |
The schema in which to create the pipe. |
AutoIngest |
object |
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. |
Id |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/pipe#id Pipe#id}. |
Integration |
string |
Specifies an integration for the pipe. |
public object Connection { get; set; }
- Type: object
public object Count { get; set; }
- Type: object
public ITerraformDependable[] DependsOn { get; set; }
- Type: HashiCorp.Cdktf.ITerraformDependable[]
public ITerraformIterator ForEach { get; set; }
- Type: HashiCorp.Cdktf.ITerraformIterator
public TerraformResourceLifecycle Lifecycle { get; set; }
- Type: HashiCorp.Cdktf.TerraformResourceLifecycle
public TerraformProvider Provider { get; set; }
- Type: HashiCorp.Cdktf.TerraformProvider
public object[] Provisioners { get; set; }
- Type: object[]
public string CopyStatement { get; set; }
- Type: string
Specifies the copy statement for the pipe.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/pipe#copy_statement Pipe#copy_statement}
public string Database { get; set; }
- Type: string
The database in which to create the pipe.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/pipe#database Pipe#database}
public string Name { get; set; }
- Type: string
Specifies the identifier for the pipe;
must be unique for the database and schema in which the pipe is created.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/pipe#name Pipe#name}
public string Schema { get; set; }
- Type: string
The schema in which to create the pipe.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/pipe#schema Pipe#schema}
public object AutoIngest { get; set; }
- Type: object
Specifies a auto_ingest param for the pipe.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/pipe#auto_ingest Pipe#auto_ingest}
public string AwsSnsTopicArn { get; set; }
- Type: string
Specifies the Amazon Resource Name (ARN) for the SNS topic for your S3 bucket.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/pipe#aws_sns_topic_arn Pipe#aws_sns_topic_arn}
public string Comment { get; set; }
- Type: string
Specifies a comment for the pipe.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/pipe#comment Pipe#comment}
public string ErrorIntegration { get; set; }
- Type: string
Specifies the name of the notification integration used for error notifications.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/pipe#error_integration Pipe#error_integration}
public string Id { get; set; }
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/pipe#id Pipe#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 string Integration { get; set; }
- Type: string
Specifies an integration for the pipe.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/pipe#integration Pipe#integration}