Class CfnDeliveryStream.SnowflakeDestinationConfigurationProperty
Configure Snowflake destination.
Inheritance
Namespace: Amazon.CDK.AWS.KinesisFirehose
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class SnowflakeDestinationConfigurationProperty : Object, CfnDeliveryStream.ISnowflakeDestinationConfigurationProperty
Syntax (vb)
Public Class SnowflakeDestinationConfigurationProperty
Inherits Object
Implements CfnDeliveryStream.ISnowflakeDestinationConfigurationProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.KinesisFirehose;
var snowflakeDestinationConfigurationProperty = new SnowflakeDestinationConfigurationProperty {
AccountUrl = "accountUrl",
Database = "database",
PrivateKey = "privateKey",
RoleArn = "roleArn",
S3Configuration = new S3DestinationConfigurationProperty {
BucketArn = "bucketArn",
RoleArn = "roleArn",
// the properties below are optional
BufferingHints = new BufferingHintsProperty {
IntervalInSeconds = 123,
SizeInMBs = 123
},
CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
Enabled = false,
LogGroupName = "logGroupName",
LogStreamName = "logStreamName"
},
CompressionFormat = "compressionFormat",
EncryptionConfiguration = new EncryptionConfigurationProperty {
KmsEncryptionConfig = new KMSEncryptionConfigProperty {
AwskmsKeyArn = "awskmsKeyArn"
},
NoEncryptionConfig = "noEncryptionConfig"
},
ErrorOutputPrefix = "errorOutputPrefix",
Prefix = "prefix"
},
Schema = "schema",
Table = "table",
User = "user",
// the properties below are optional
CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
Enabled = false,
LogGroupName = "logGroupName",
LogStreamName = "logStreamName"
},
ContentColumnName = "contentColumnName",
DataLoadingOption = "dataLoadingOption",
KeyPassphrase = "keyPassphrase",
MetaDataColumnName = "metaDataColumnName",
ProcessingConfiguration = new ProcessingConfigurationProperty {
Enabled = false,
Processors = new [] { new ProcessorProperty {
Type = "type",
// the properties below are optional
Parameters = new [] { new ProcessorParameterProperty {
ParameterName = "parameterName",
ParameterValue = "parameterValue"
} }
} }
},
RetryOptions = new SnowflakeRetryOptionsProperty {
DurationInSeconds = 123
},
S3BackupMode = "s3BackupMode",
SnowflakeRoleConfiguration = new SnowflakeRoleConfigurationProperty {
Enabled = false,
SnowflakeRole = "snowflakeRole"
},
SnowflakeVpcConfiguration = new SnowflakeVpcConfigurationProperty {
PrivateLinkVpceId = "privateLinkVpceId"
}
};
Synopsis
Constructors
SnowflakeDestinationConfigurationProperty() |
Properties
AccountUrl | URL for accessing your Snowflake account. |
CloudWatchLoggingOptions | |
ContentColumnName | The name of the record content column. |
Database | All data in Snowflake is maintained in databases. |
DataLoadingOption | Choose to load JSON keys mapped to table column names or choose to split the JSON payload where content is mapped to a record content column and source metadata is mapped to a record metadata column. |
KeyPassphrase | Passphrase to decrypt the private key when the key is encrypted. |
MetaDataColumnName | The name of the record metadata column. |
PrivateKey | The private key used to encrypt your Snowflake client. |
ProcessingConfiguration | |
RetryOptions | The time period where Firehose will retry sending data to the chosen HTTP endpoint. |
RoleArn | The Amazon Resource Name (ARN) of the Snowflake role. |
S3BackupMode | Choose an S3 backup mode. |
S3Configuration | |
Schema | Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views. |
SnowflakeRoleConfiguration | Optionally configure a Snowflake role. |
SnowflakeVpcConfiguration | The VPCE ID for Firehose to privately connect with Snowflake. |
Table | All data in Snowflake is stored in database tables, logically structured as collections of columns and rows. |
User | User login name for the Snowflake account. |
Constructors
SnowflakeDestinationConfigurationProperty()
public SnowflakeDestinationConfigurationProperty()
Properties
AccountUrl
URL for accessing your Snowflake account.
public string AccountUrl { get; set; }
Property Value
System.String
Remarks
This URL must include your account identifier . Note that the protocol (https://) and port number are optional.
CloudWatchLoggingOptions
public object CloudWatchLoggingOptions { get; set; }
Property Value
System.Object
Remarks
ContentColumnName
The name of the record content column.
public string ContentColumnName { get; set; }
Property Value
System.String
Remarks
Database
All data in Snowflake is maintained in databases.
public string Database { get; set; }
Property Value
System.String
Remarks
DataLoadingOption
Choose to load JSON keys mapped to table column names or choose to split the JSON payload where content is mapped to a record content column and source metadata is mapped to a record metadata column.
public string DataLoadingOption { get; set; }
Property Value
System.String
Remarks
KeyPassphrase
Passphrase to decrypt the private key when the key is encrypted.
public string KeyPassphrase { get; set; }
Property Value
System.String
Remarks
For information, see Using Key Pair Authentication & Key Rotation .
MetaDataColumnName
The name of the record metadata column.
public string MetaDataColumnName { get; set; }
Property Value
System.String
Remarks
PrivateKey
The private key used to encrypt your Snowflake client.
public string PrivateKey { get; set; }
Property Value
System.String
Remarks
ProcessingConfiguration
public object ProcessingConfiguration { get; set; }
Property Value
System.Object
Remarks
RetryOptions
The time period where Firehose will retry sending data to the chosen HTTP endpoint.
public object RetryOptions { get; set; }
Property Value
System.Object
Remarks
RoleArn
The Amazon Resource Name (ARN) of the Snowflake role.
public string RoleArn { get; set; }
Property Value
System.String
Remarks
S3BackupMode
Choose an S3 backup mode.
public string S3BackupMode { get; set; }
Property Value
System.String
Remarks
S3Configuration
public object S3Configuration { get; set; }
Property Value
System.Object
Remarks
Schema
Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views.
public string Schema { get; set; }
Property Value
System.String
Remarks
SnowflakeRoleConfiguration
Optionally configure a Snowflake role.
public object SnowflakeRoleConfiguration { get; set; }
Property Value
System.Object
Remarks
SnowflakeVpcConfiguration
The VPCE ID for Firehose to privately connect with Snowflake.
public object SnowflakeVpcConfiguration { get; set; }
Property Value
System.Object
Remarks
The ID format is com.amazonaws.vpce.[region].vpce-svc-<[id]>. For more information, see Amazon PrivateLink & Snowflake
Table
All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.
public string Table { get; set; }
Property Value
System.String
Remarks
User
User login name for the Snowflake account.
public string User { get; set; }
Property Value
System.String