Package software.amazon.awscdk.services.kinesisfirehose

Interface CfnDeliveryStream.SnowflakeDestinationConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeliveryStream.SnowflakeDestinationConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDeliveryStream

@Stability(Stable)
public static interface CfnDeliveryStream.SnowflakeDestinationConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Configure Snowflake destination.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.kinesisfirehose.*;
 SnowflakeDestinationConfigurationProperty snowflakeDestinationConfigurationProperty = SnowflakeDestinationConfigurationProperty.builder()
         .accountUrl("accountUrl")
         .database("database")
         .roleArn("roleArn")
         .s3Configuration(S3DestinationConfigurationProperty.builder()
                 .bucketArn("bucketArn")
                 .roleArn("roleArn")
                 // the properties below are optional
                 .bufferingHints(BufferingHintsProperty.builder()
                         .intervalInSeconds(123)
                         .sizeInMBs(123)
                         .build())
                 .cloudWatchLoggingOptions(CloudWatchLoggingOptionsProperty.builder()
                         .enabled(false)
                         .logGroupName("logGroupName")
                         .logStreamName("logStreamName")
                         .build())
                 .compressionFormat("compressionFormat")
                 .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                         .kmsEncryptionConfig(KMSEncryptionConfigProperty.builder()
                                 .awskmsKeyArn("awskmsKeyArn")
                                 .build())
                         .noEncryptionConfig("noEncryptionConfig")
                         .build())
                 .errorOutputPrefix("errorOutputPrefix")
                 .prefix("prefix")
                 .build())
         .schema("schema")
         .table("table")
         // the properties below are optional
         .bufferingHints(SnowflakeBufferingHintsProperty.builder()
                 .intervalInSeconds(123)
                 .sizeInMBs(123)
                 .build())
         .cloudWatchLoggingOptions(CloudWatchLoggingOptionsProperty.builder()
                 .enabled(false)
                 .logGroupName("logGroupName")
                 .logStreamName("logStreamName")
                 .build())
         .contentColumnName("contentColumnName")
         .dataLoadingOption("dataLoadingOption")
         .keyPassphrase("keyPassphrase")
         .metaDataColumnName("metaDataColumnName")
         .privateKey("privateKey")
         .processingConfiguration(ProcessingConfigurationProperty.builder()
                 .enabled(false)
                 .processors(List.of(ProcessorProperty.builder()
                         .type("type")
                         // the properties below are optional
                         .parameters(List.of(ProcessorParameterProperty.builder()
                                 .parameterName("parameterName")
                                 .parameterValue("parameterValue")
                                 .build()))
                         .build()))
                 .build())
         .retryOptions(SnowflakeRetryOptionsProperty.builder()
                 .durationInSeconds(123)
                 .build())
         .s3BackupMode("s3BackupMode")
         .secretsManagerConfiguration(SecretsManagerConfigurationProperty.builder()
                 .enabled(false)
                 // the properties below are optional
                 .roleArn("roleArn")
                 .secretArn("secretArn")
                 .build())
         .snowflakeRoleConfiguration(SnowflakeRoleConfigurationProperty.builder()
                 .enabled(false)
                 .snowflakeRole("snowflakeRole")
                 .build())
         .snowflakeVpcConfiguration(SnowflakeVpcConfigurationProperty.builder()
                 .privateLinkVpceId("privateLinkVpceId")
                 .build())
         .user("user")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDeliveryStream.SnowflakeDestinationConfigurationProperty.Builder	A builder for CfnDeliveryStream.SnowflakeDestinationConfigurationProperty
static final class	CfnDeliveryStream.SnowflakeDestinationConfigurationProperty.Jsii$Proxy	An implementation for CfnDeliveryStream.SnowflakeDestinationConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnDeliveryStream.SnowflakeDestinationConfigurationProperty.Builder	builder()
String	getAccountUrl()	URL for accessing your Snowflake account.
default Object	getBufferingHints()	Describes the buffering to perform before delivering data to the Snowflake destination.
default Object	getCloudWatchLoggingOptions()	Returns union: either IResolvable or CfnDeliveryStream.CloudWatchLoggingOptionsProperty
default String	getContentColumnName()	The name of the record content column.
String	getDatabase()	All data in Snowflake is maintained in databases.
default String	getDataLoadingOption()	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.
default String	getKeyPassphrase()	Passphrase to decrypt the private key when the key is encrypted.
default String	getMetaDataColumnName()	Specify a column name in the table, where the metadata information has to be loaded.
default String	getPrivateKey()	The private key used to encrypt your Snowflake client.
default Object	getProcessingConfiguration()	Returns union: either IResolvable or CfnDeliveryStream.ProcessingConfigurationProperty
default Object	getRetryOptions()	The time period where Firehose will retry sending data to the chosen HTTP endpoint.
String	getRoleArn()	The Amazon Resource Name (ARN) of the Snowflake role.
default String	getS3BackupMode()	Choose an S3 backup mode.
Object	getS3Configuration()	Returns union: either IResolvable or CfnDeliveryStream.S3DestinationConfigurationProperty
String	getSchema()	Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views.
default Object	getSecretsManagerConfiguration()	The configuration that defines how you access secrets for Snowflake.
default Object	getSnowflakeRoleConfiguration()	Optionally configure a Snowflake role.
default Object	getSnowflakeVpcConfiguration()	The VPCE ID for Firehose to privately connect with Snowflake.
String	getTable()	All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.
default String	getUser()	User login name for the Snowflake account.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccountUrl

@Stability(Stable)
@NotNull
String getAccountUrl()

URL for accessing your Snowflake account.

This URL must include your account identifier . Note that the protocol (https://) and port number are optional.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-accounturl

getDatabase

@Stability(Stable)
@NotNull
String getDatabase()

All data in Snowflake is maintained in databases.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-database

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

The Amazon Resource Name (ARN) of the Snowflake role.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-rolearn

getS3Configuration

@Stability(Stable)
@NotNull
Object getS3Configuration()

Returns union: either IResolvable or CfnDeliveryStream.S3DestinationConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-s3configuration

getSchema

@Stability(Stable)
@NotNull
String getSchema()

Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-schema

getTable

@Stability(Stable)
@NotNull
String getTable()

All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-table

getBufferingHints

@Stability(Stable)
@Nullable
default Object getBufferingHints()

Describes the buffering to perform before delivering data to the Snowflake destination.

If you do not specify any value, Firehose uses the default values.

Returns union: either IResolvable or CfnDeliveryStream.SnowflakeBufferingHintsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-bufferinghints

getCloudWatchLoggingOptions

@Stability(Stable)
@Nullable
default Object getCloudWatchLoggingOptions()

Returns union: either IResolvable or CfnDeliveryStream.CloudWatchLoggingOptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-cloudwatchloggingoptions

getContentColumnName

@Stability(Stable)
@Nullable
default String getContentColumnName()

The name of the record content column.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-contentcolumnname

getDataLoadingOption

@Stability(Stable)
@Nullable
default String getDataLoadingOption()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-dataloadingoption

getKeyPassphrase

@Stability(Stable)
@Nullable
default String getKeyPassphrase()

Passphrase to decrypt the private key when the key is encrypted.

For information, see Using Key Pair Authentication & Key Rotation .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-keypassphrase

getMetaDataColumnName

@Stability(Stable)
@Nullable
default String getMetaDataColumnName()

Specify a column name in the table, where the metadata information has to be loaded.

When you enable this field, you will see the following column in the snowflake table, which differs based on the source type.

For Direct PUT as source

{ "firehoseDeliveryStreamName" : "streamname", "IngestionTime" : "timestamp" }

For Kinesis Data Stream as source

"kinesisStreamName" : "streamname", "kinesisShardId" : "Id", "kinesisPartitionKey" : "key", "kinesisSequenceNumber" : "1234", "subsequenceNumber" : "2334", "IngestionTime" : "timestamp" }

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-metadatacolumnname

getPrivateKey

@Stability(Stable)
@Nullable
default String getPrivateKey()

The private key used to encrypt your Snowflake client.

For information, see Using Key Pair Authentication & Key Rotation .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-privatekey

getProcessingConfiguration

@Stability(Stable)
@Nullable
default Object getProcessingConfiguration()

Returns union: either IResolvable or CfnDeliveryStream.ProcessingConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-processingconfiguration

getRetryOptions

@Stability(Stable)
@Nullable
default Object getRetryOptions()

The time period where Firehose will retry sending data to the chosen HTTP endpoint.

Returns union: either IResolvable or CfnDeliveryStream.SnowflakeRetryOptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-retryoptions

getS3BackupMode

@Stability(Stable)
@Nullable
default String getS3BackupMode()

Choose an S3 backup mode.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-s3backupmode

getSecretsManagerConfiguration

@Stability(Stable)
@Nullable
default Object getSecretsManagerConfiguration()

The configuration that defines how you access secrets for Snowflake.

Returns union: either IResolvable or CfnDeliveryStream.SecretsManagerConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-secretsmanagerconfiguration

getSnowflakeRoleConfiguration

@Stability(Stable)
@Nullable
default Object getSnowflakeRoleConfiguration()

Optionally configure a Snowflake role.

Otherwise the default user role will be used.

Returns union: either IResolvable or CfnDeliveryStream.SnowflakeRoleConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-snowflakeroleconfiguration

getSnowflakeVpcConfiguration

@Stability(Stable)
@Nullable
default Object getSnowflakeVpcConfiguration()

The VPCE ID for Firehose to privately connect with Snowflake.

The ID format is com.amazonaws.vpce.[region].vpce-svc-<[id]>. For more information, see Amazon PrivateLink & Snowflake

Returns union: either IResolvable or CfnDeliveryStream.SnowflakeVpcConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-snowflakevpcconfiguration

getUser

@Stability(Stable)
@Nullable
default String getUser()

User login name for the Snowflake account.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-user

builder

@Stability(Stable)
static CfnDeliveryStream.SnowflakeDestinationConfigurationProperty.Builder builder()

Returns:

a CfnDeliveryStream.SnowflakeDestinationConfigurationProperty.Builder of CfnDeliveryStream.SnowflakeDestinationConfigurationProperty