FirehoseDeliveryStreamSnowflakeConfiguration

data class FirehoseDeliveryStreamSnowflakeConfiguration(val accountUrl: String, val bufferingInterval: Int? = null, val bufferingSize: Int? = null, val cloudwatchLoggingOptions: FirehoseDeliveryStreamSnowflakeConfigurationCloudwatchLoggingOptions? = null, val contentColumnName: String? = null, val dataLoadingOption: String? = null, val database: String, val keyPassphrase: String? = null, val metadataColumnName: String? = null, val privateKey: String? = null, val processingConfiguration: FirehoseDeliveryStreamSnowflakeConfigurationProcessingConfiguration? = null, val retryDuration: Int? = null, val roleArn: String, val s3BackupMode: String? = null, val s3Configuration: FirehoseDeliveryStreamSnowflakeConfigurationS3Configuration, val schema: String, val secretsManagerConfiguration: FirehoseDeliveryStreamSnowflakeConfigurationSecretsManagerConfiguration? = null, val snowflakeRoleConfiguration: FirehoseDeliveryStreamSnowflakeConfigurationSnowflakeRoleConfiguration? = null, val snowflakeVpcConfiguration: FirehoseDeliveryStreamSnowflakeConfigurationSnowflakeVpcConfiguration? = null, val table: String, val user: String? = null)

Constructors

constructor(accountUrl: String, bufferingInterval: Int? = null, bufferingSize: Int? = null, cloudwatchLoggingOptions: FirehoseDeliveryStreamSnowflakeConfigurationCloudwatchLoggingOptions? = null, contentColumnName: String? = null, dataLoadingOption: String? = null, database: String, keyPassphrase: String? = null, metadataColumnName: String? = null, privateKey: String? = null, processingConfiguration: FirehoseDeliveryStreamSnowflakeConfigurationProcessingConfiguration? = null, retryDuration: Int? = null, roleArn: String, s3BackupMode: String? = null, s3Configuration: FirehoseDeliveryStreamSnowflakeConfigurationS3Configuration, schema: String, secretsManagerConfiguration: FirehoseDeliveryStreamSnowflakeConfigurationSecretsManagerConfiguration? = null, snowflakeRoleConfiguration: FirehoseDeliveryStreamSnowflakeConfigurationSnowflakeRoleConfiguration? = null, snowflakeVpcConfiguration: FirehoseDeliveryStreamSnowflakeConfigurationSnowflakeVpcConfiguration? = null, table: String, user: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The URL of the Snowflake account. Format: https://account_identifier.snowflakecomputing.com.

Link copied to clipboard
val bufferingInterval: Int? = null

Buffer incoming data for the specified period of time, in seconds between 0 to 900, before delivering it to the destination. The default value is 0s.

Link copied to clipboard
val bufferingSize: Int? = null

Buffer incoming data to the specified size, in MBs between 1 to 128, before delivering it to the destination. The default value is 1MB.

Link copied to clipboard

The CloudWatch Logging Options for the delivery stream. See cloudwatch_logging_options block below for details.

Link copied to clipboard

The name of the content column.

Link copied to clipboard

The Snowflake database name.

Link copied to clipboard

The data loading option.

Link copied to clipboard
val keyPassphrase: String? = null

The passphrase for the private key.

Link copied to clipboard

The name of the metadata column.

Link copied to clipboard
val privateKey: String? = null

The private key for authentication. This value is required if secrets_manager_configuration is not provided.

Link copied to clipboard

The processing configuration. See processing_configuration block below for details.

Link copied to clipboard
val retryDuration: Int? = null

After an initial failure to deliver to Snowflake, the total amount of time, in seconds between 0 to 7200, during which Firehose re-attempts delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. The default value is 60s. There will be no retry if the value is 0.

Link copied to clipboard

The ARN of the IAM role.

Link copied to clipboard
val s3BackupMode: String? = null

The S3 backup mode.

Link copied to clipboard

The S3 configuration. See s3_configuration block below for details.

Link copied to clipboard

The Snowflake schema name.

Link copied to clipboard

The Secrets Manager configuration. See secrets_manager_configuration block below for details. This value is required if user and private_key are not provided.

Link copied to clipboard

The Snowflake table name.

Link copied to clipboard
val user: String? = null

The user for authentication. This value is required if secrets_manager_configuration is not provided.