Class CfnDeliveryStream.SnowflakeDestinationConfigurationProperty.Builder
java.lang.Object
software.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStream.SnowflakeDestinationConfigurationProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDeliveryStream.SnowflakeDestinationConfigurationProperty>
- Enclosing interface:
CfnDeliveryStream.SnowflakeDestinationConfigurationProperty
@Stability(Stable)
public static final class CfnDeliveryStream.SnowflakeDestinationConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDeliveryStream.SnowflakeDestinationConfigurationProperty>
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaccountUrl
(String accountUrl) bufferingHints
(IResolvable bufferingHints) bufferingHints
(CfnDeliveryStream.SnowflakeBufferingHintsProperty bufferingHints) build()
Builds the configured instance.cloudWatchLoggingOptions
(IResolvable cloudWatchLoggingOptions) cloudWatchLoggingOptions
(CfnDeliveryStream.CloudWatchLoggingOptionsProperty cloudWatchLoggingOptions) contentColumnName
(String contentColumnName) dataLoadingOption
(String dataLoadingOption) keyPassphrase
(String keyPassphrase) metaDataColumnName
(String metaDataColumnName) privateKey
(String privateKey) processingConfiguration
(IResolvable processingConfiguration) processingConfiguration
(CfnDeliveryStream.ProcessingConfigurationProperty processingConfiguration) retryOptions
(IResolvable retryOptions) retryOptions
(CfnDeliveryStream.SnowflakeRetryOptionsProperty retryOptions) Sets the value ofCfnDeliveryStream.SnowflakeDestinationConfigurationProperty.getRoleArn()
s3BackupMode
(String s3BackupMode) s3Configuration
(IResolvable s3Configuration) s3Configuration
(CfnDeliveryStream.S3DestinationConfigurationProperty s3Configuration) Sets the value ofCfnDeliveryStream.SnowflakeDestinationConfigurationProperty.getSchema()
secretsManagerConfiguration
(IResolvable secretsManagerConfiguration) secretsManagerConfiguration
(CfnDeliveryStream.SecretsManagerConfigurationProperty secretsManagerConfiguration) snowflakeRoleConfiguration
(IResolvable snowflakeRoleConfiguration) snowflakeRoleConfiguration
(CfnDeliveryStream.SnowflakeRoleConfigurationProperty snowflakeRoleConfiguration) snowflakeVpcConfiguration
(IResolvable snowflakeVpcConfiguration) snowflakeVpcConfiguration
(CfnDeliveryStream.SnowflakeVpcConfigurationProperty snowflakeVpcConfiguration) Sets the value ofCfnDeliveryStream.SnowflakeDestinationConfigurationProperty.getTable()
Sets the value ofCfnDeliveryStream.SnowflakeDestinationConfigurationProperty.getUser()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
accountUrl
@Stability(Stable) public CfnDeliveryStream.SnowflakeDestinationConfigurationProperty.Builder accountUrl(String accountUrl) - Parameters:
accountUrl
- URL for accessing your Snowflake account. This parameter is required. This URL must include your account identifier . Note that the protocol (https://) and port number are optional.- Returns:
this
-
database
@Stability(Stable) public CfnDeliveryStream.SnowflakeDestinationConfigurationProperty.Builder database(String database) - Parameters:
database
- All data in Snowflake is maintained in databases. This parameter is required.- Returns:
this
-
roleArn
@Stability(Stable) public CfnDeliveryStream.SnowflakeDestinationConfigurationProperty.Builder roleArn(String roleArn) Sets the value ofCfnDeliveryStream.SnowflakeDestinationConfigurationProperty.getRoleArn()
- Parameters:
roleArn
- The Amazon Resource Name (ARN) of the Snowflake role. This parameter is required.- Returns:
this
-
s3Configuration
@Stability(Stable) public CfnDeliveryStream.SnowflakeDestinationConfigurationProperty.Builder s3Configuration(IResolvable s3Configuration) - Parameters:
s3Configuration
- the value to be set. This parameter is required.- Returns:
this
-
s3Configuration
@Stability(Stable) public CfnDeliveryStream.SnowflakeDestinationConfigurationProperty.Builder s3Configuration(CfnDeliveryStream.S3DestinationConfigurationProperty s3Configuration) - Parameters:
s3Configuration
- the value to be set. This parameter is required.- Returns:
this
-
schema
@Stability(Stable) public CfnDeliveryStream.SnowflakeDestinationConfigurationProperty.Builder schema(String schema) Sets the value ofCfnDeliveryStream.SnowflakeDestinationConfigurationProperty.getSchema()
- Parameters:
schema
- Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views. This parameter is required.- Returns:
this
-
table
@Stability(Stable) public CfnDeliveryStream.SnowflakeDestinationConfigurationProperty.Builder table(String table) Sets the value ofCfnDeliveryStream.SnowflakeDestinationConfigurationProperty.getTable()
- Parameters:
table
- All data in Snowflake is stored in database tables, logically structured as collections of columns and rows. This parameter is required.- Returns:
this
-
bufferingHints
@Stability(Stable) public CfnDeliveryStream.SnowflakeDestinationConfigurationProperty.Builder bufferingHints(IResolvable bufferingHints) - Parameters:
bufferingHints
- 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:
this
-
bufferingHints
@Stability(Stable) public CfnDeliveryStream.SnowflakeDestinationConfigurationProperty.Builder bufferingHints(CfnDeliveryStream.SnowflakeBufferingHintsProperty bufferingHints) - Parameters:
bufferingHints
- 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:
this
-
cloudWatchLoggingOptions
@Stability(Stable) public CfnDeliveryStream.SnowflakeDestinationConfigurationProperty.Builder cloudWatchLoggingOptions(IResolvable cloudWatchLoggingOptions) Sets the value ofCfnDeliveryStream.SnowflakeDestinationConfigurationProperty.getCloudWatchLoggingOptions()
- Parameters:
cloudWatchLoggingOptions
- the value to be set.- Returns:
this
-
cloudWatchLoggingOptions
@Stability(Stable) public CfnDeliveryStream.SnowflakeDestinationConfigurationProperty.Builder cloudWatchLoggingOptions(CfnDeliveryStream.CloudWatchLoggingOptionsProperty cloudWatchLoggingOptions) Sets the value ofCfnDeliveryStream.SnowflakeDestinationConfigurationProperty.getCloudWatchLoggingOptions()
- Parameters:
cloudWatchLoggingOptions
- the value to be set.- Returns:
this
-
contentColumnName
@Stability(Stable) public CfnDeliveryStream.SnowflakeDestinationConfigurationProperty.Builder contentColumnName(String contentColumnName) Sets the value ofCfnDeliveryStream.SnowflakeDestinationConfigurationProperty.getContentColumnName()
- Parameters:
contentColumnName
- The name of the record content column.- Returns:
this
-
dataLoadingOption
@Stability(Stable) public CfnDeliveryStream.SnowflakeDestinationConfigurationProperty.Builder dataLoadingOption(String dataLoadingOption) Sets the value ofCfnDeliveryStream.SnowflakeDestinationConfigurationProperty.getDataLoadingOption()
- Parameters:
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.- Returns:
this
-
keyPassphrase
@Stability(Stable) public CfnDeliveryStream.SnowflakeDestinationConfigurationProperty.Builder keyPassphrase(String keyPassphrase) - Parameters:
keyPassphrase
- Passphrase to decrypt the private key when the key is encrypted. For information, see Using Key Pair Authentication & Key Rotation .- Returns:
this
-
metaDataColumnName
@Stability(Stable) public CfnDeliveryStream.SnowflakeDestinationConfigurationProperty.Builder metaDataColumnName(String metaDataColumnName) Sets the value ofCfnDeliveryStream.SnowflakeDestinationConfigurationProperty.getMetaDataColumnName()
- Parameters:
metaDataColumnName
- 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" }
- Returns:
this
-
privateKey
@Stability(Stable) public CfnDeliveryStream.SnowflakeDestinationConfigurationProperty.Builder privateKey(String privateKey) - Parameters:
privateKey
- The private key used to encrypt your Snowflake client. For information, see Using Key Pair Authentication & Key Rotation .- Returns:
this
-
processingConfiguration
@Stability(Stable) public CfnDeliveryStream.SnowflakeDestinationConfigurationProperty.Builder processingConfiguration(IResolvable processingConfiguration) Sets the value ofCfnDeliveryStream.SnowflakeDestinationConfigurationProperty.getProcessingConfiguration()
- Parameters:
processingConfiguration
- Specifies configuration for Snowflake.- Returns:
this
-
processingConfiguration
@Stability(Stable) public CfnDeliveryStream.SnowflakeDestinationConfigurationProperty.Builder processingConfiguration(CfnDeliveryStream.ProcessingConfigurationProperty processingConfiguration) Sets the value ofCfnDeliveryStream.SnowflakeDestinationConfigurationProperty.getProcessingConfiguration()
- Parameters:
processingConfiguration
- Specifies configuration for Snowflake.- Returns:
this
-
retryOptions
@Stability(Stable) public CfnDeliveryStream.SnowflakeDestinationConfigurationProperty.Builder retryOptions(IResolvable retryOptions) - Parameters:
retryOptions
- The time period where Firehose will retry sending data to the chosen HTTP endpoint.- Returns:
this
-
retryOptions
@Stability(Stable) public CfnDeliveryStream.SnowflakeDestinationConfigurationProperty.Builder retryOptions(CfnDeliveryStream.SnowflakeRetryOptionsProperty retryOptions) - Parameters:
retryOptions
- The time period where Firehose will retry sending data to the chosen HTTP endpoint.- Returns:
this
-
s3BackupMode
@Stability(Stable) public CfnDeliveryStream.SnowflakeDestinationConfigurationProperty.Builder s3BackupMode(String s3BackupMode) - Parameters:
s3BackupMode
- Choose an S3 backup mode.- Returns:
this
-
secretsManagerConfiguration
@Stability(Stable) public CfnDeliveryStream.SnowflakeDestinationConfigurationProperty.Builder secretsManagerConfiguration(IResolvable secretsManagerConfiguration) Sets the value ofCfnDeliveryStream.SnowflakeDestinationConfigurationProperty.getSecretsManagerConfiguration()
- Parameters:
secretsManagerConfiguration
- The configuration that defines how you access secrets for Snowflake.- Returns:
this
-
secretsManagerConfiguration
@Stability(Stable) public CfnDeliveryStream.SnowflakeDestinationConfigurationProperty.Builder secretsManagerConfiguration(CfnDeliveryStream.SecretsManagerConfigurationProperty secretsManagerConfiguration) Sets the value ofCfnDeliveryStream.SnowflakeDestinationConfigurationProperty.getSecretsManagerConfiguration()
- Parameters:
secretsManagerConfiguration
- The configuration that defines how you access secrets for Snowflake.- Returns:
this
-
snowflakeRoleConfiguration
@Stability(Stable) public CfnDeliveryStream.SnowflakeDestinationConfigurationProperty.Builder snowflakeRoleConfiguration(IResolvable snowflakeRoleConfiguration) Sets the value ofCfnDeliveryStream.SnowflakeDestinationConfigurationProperty.getSnowflakeRoleConfiguration()
- Parameters:
snowflakeRoleConfiguration
- Optionally configure a Snowflake role. Otherwise the default user role will be used.- Returns:
this
-
snowflakeRoleConfiguration
@Stability(Stable) public CfnDeliveryStream.SnowflakeDestinationConfigurationProperty.Builder snowflakeRoleConfiguration(CfnDeliveryStream.SnowflakeRoleConfigurationProperty snowflakeRoleConfiguration) Sets the value ofCfnDeliveryStream.SnowflakeDestinationConfigurationProperty.getSnowflakeRoleConfiguration()
- Parameters:
snowflakeRoleConfiguration
- Optionally configure a Snowflake role. Otherwise the default user role will be used.- Returns:
this
-
snowflakeVpcConfiguration
@Stability(Stable) public CfnDeliveryStream.SnowflakeDestinationConfigurationProperty.Builder snowflakeVpcConfiguration(IResolvable snowflakeVpcConfiguration) Sets the value ofCfnDeliveryStream.SnowflakeDestinationConfigurationProperty.getSnowflakeVpcConfiguration()
- Parameters:
snowflakeVpcConfiguration
- 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:
this
-
snowflakeVpcConfiguration
@Stability(Stable) public CfnDeliveryStream.SnowflakeDestinationConfigurationProperty.Builder snowflakeVpcConfiguration(CfnDeliveryStream.SnowflakeVpcConfigurationProperty snowflakeVpcConfiguration) Sets the value ofCfnDeliveryStream.SnowflakeDestinationConfigurationProperty.getSnowflakeVpcConfiguration()
- Parameters:
snowflakeVpcConfiguration
- 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:
this
-
user
@Stability(Stable) public CfnDeliveryStream.SnowflakeDestinationConfigurationProperty.Builder user(String user) Sets the value ofCfnDeliveryStream.SnowflakeDestinationConfigurationProperty.getUser()
- Parameters:
user
- User login name for the Snowflake account.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnDeliveryStream.SnowflakeDestinationConfigurationProperty>
- Returns:
- a new instance of
CfnDeliveryStream.SnowflakeDestinationConfigurationProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-