Interface SnowflakeDestinationConfiguration.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<SnowflakeDestinationConfiguration.Builder,
,SnowflakeDestinationConfiguration> SdkBuilder<SnowflakeDestinationConfiguration.Builder,
,SnowflakeDestinationConfiguration> SdkPojo
- Enclosing class:
SnowflakeDestinationConfiguration
-
Method Summary
Modifier and TypeMethodDescriptionaccountUrl
(String accountUrl) URL for accessing your Snowflake account.cloudWatchLoggingOptions
(Consumer<CloudWatchLoggingOptions.Builder> cloudWatchLoggingOptions) Sets the value of the CloudWatchLoggingOptions property for this object.cloudWatchLoggingOptions
(CloudWatchLoggingOptions cloudWatchLoggingOptions) Sets the value of the CloudWatchLoggingOptions property for this object.contentColumnName
(String contentColumnName) The name of the record content columnAll data in Snowflake is maintained in databases.dataLoadingOption
(String 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.dataLoadingOption
(SnowflakeDataLoadingOption 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
(String keyPassphrase) Passphrase to decrypt the private key when the key is encrypted.metaDataColumnName
(String metaDataColumnName) The name of the record metadata columnprivateKey
(String privateKey) The private key used to encrypt your Snowflake client.processingConfiguration
(Consumer<ProcessingConfiguration.Builder> processingConfiguration) Sets the value of the ProcessingConfiguration property for this object.processingConfiguration
(ProcessingConfiguration processingConfiguration) Sets the value of the ProcessingConfiguration property for this object.retryOptions
(Consumer<SnowflakeRetryOptions.Builder> retryOptions) The time period where Firehose will retry sending data to the chosen HTTP endpoint.retryOptions
(SnowflakeRetryOptions retryOptions) The time period where Firehose will retry sending data to the chosen HTTP endpoint.The Amazon Resource Name (ARN) of the Snowflake roles3BackupMode
(String s3BackupMode) Choose an S3 backup modes3BackupMode
(SnowflakeS3BackupMode s3BackupMode) Choose an S3 backup modes3Configuration
(Consumer<S3DestinationConfiguration.Builder> s3Configuration) Sets the value of the S3Configuration property for this object.s3Configuration
(S3DestinationConfiguration s3Configuration) Sets the value of the S3Configuration property for this object.Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and viewssnowflakeRoleConfiguration
(Consumer<SnowflakeRoleConfiguration.Builder> snowflakeRoleConfiguration) Optionally configure a Snowflake role.snowflakeRoleConfiguration
(SnowflakeRoleConfiguration snowflakeRoleConfiguration) Optionally configure a Snowflake role.snowflakeVpcConfiguration
(Consumer<SnowflakeVpcConfiguration.Builder> snowflakeVpcConfiguration) The VPCE ID for Firehose to privately connect with Snowflake.snowflakeVpcConfiguration
(SnowflakeVpcConfiguration snowflakeVpcConfiguration) The VPCE ID for Firehose to privately connect with Snowflake.All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.User login name for the Snowflake account.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
accountUrl
URL for accessing your Snowflake account. This URL must include your account identifier. Note that the protocol (https://) and port number are optional.
- Parameters:
accountUrl
- URL for accessing your Snowflake account. This URL must include your account identifier. Note that the protocol (https://) and port number are optional.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
privateKey
The private key used to encrypt your Snowflake client. For information, see Using Key Pair Authentication & Key Rotation.
- Parameters:
privateKey
- The private key used to encrypt your Snowflake client. For information, see Using Key Pair Authentication & Key Rotation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
keyPassphrase
Passphrase to decrypt the private key when the key is encrypted. For information, see Using Key Pair Authentication & Key Rotation.
- Parameters:
keyPassphrase
- Passphrase to decrypt the private key when the key is encrypted. For information, see Using Key Pair Authentication & Key Rotation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
user
User login name for the Snowflake account.
- Parameters:
user
- User login name for the Snowflake account.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
database
All data in Snowflake is maintained in databases.
- Parameters:
database
- All data in Snowflake is maintained in databases.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
schema
Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views
- Parameters:
schema
- Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
table
All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.
- Parameters:
table
- All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
snowflakeRoleConfiguration
SnowflakeDestinationConfiguration.Builder snowflakeRoleConfiguration(SnowflakeRoleConfiguration snowflakeRoleConfiguration) Optionally configure a Snowflake role. Otherwise the default user role will be used.
- Parameters:
snowflakeRoleConfiguration
- Optionally configure a Snowflake role. Otherwise the default user role will be used.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
snowflakeRoleConfiguration
default SnowflakeDestinationConfiguration.Builder snowflakeRoleConfiguration(Consumer<SnowflakeRoleConfiguration.Builder> snowflakeRoleConfiguration) Optionally configure a Snowflake role. Otherwise the default user role will be used.
This is a convenience method that creates an instance of theSnowflakeRoleConfiguration.Builder
avoiding the need to create one manually viaSnowflakeRoleConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosnowflakeRoleConfiguration(SnowflakeRoleConfiguration)
.- Parameters:
snowflakeRoleConfiguration
- a consumer that will call methods onSnowflakeRoleConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- 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:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
dataLoadingOption
SnowflakeDestinationConfiguration.Builder dataLoadingOption(SnowflakeDataLoadingOption 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.
- 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:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
metaDataColumnName
The name of the record metadata column
- Parameters:
metaDataColumnName
- The name of the record metadata column- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
contentColumnName
The name of the record content column
- Parameters:
contentColumnName
- The name of the record content column- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
snowflakeVpcConfiguration
SnowflakeDestinationConfiguration.Builder snowflakeVpcConfiguration(SnowflakeVpcConfiguration 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
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
snowflakeVpcConfiguration
default SnowflakeDestinationConfiguration.Builder snowflakeVpcConfiguration(Consumer<SnowflakeVpcConfiguration.Builder> 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
This is a convenience method that creates an instance of theSnowflakeVpcConfiguration.Builder
avoiding the need to create one manually viaSnowflakeVpcConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosnowflakeVpcConfiguration(SnowflakeVpcConfiguration)
.- Parameters:
snowflakeVpcConfiguration
- a consumer that will call methods onSnowflakeVpcConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
cloudWatchLoggingOptions
SnowflakeDestinationConfiguration.Builder cloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions) Sets the value of the CloudWatchLoggingOptions property for this object.- Parameters:
cloudWatchLoggingOptions
- The new value for the CloudWatchLoggingOptions property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cloudWatchLoggingOptions
default SnowflakeDestinationConfiguration.Builder cloudWatchLoggingOptions(Consumer<CloudWatchLoggingOptions.Builder> cloudWatchLoggingOptions) Sets the value of the CloudWatchLoggingOptions property for this object. This is a convenience method that creates an instance of theCloudWatchLoggingOptions.Builder
avoiding the need to create one manually viaCloudWatchLoggingOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocloudWatchLoggingOptions(CloudWatchLoggingOptions)
.- Parameters:
cloudWatchLoggingOptions
- a consumer that will call methods onCloudWatchLoggingOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
processingConfiguration
SnowflakeDestinationConfiguration.Builder processingConfiguration(ProcessingConfiguration processingConfiguration) Sets the value of the ProcessingConfiguration property for this object.- Parameters:
processingConfiguration
- The new value for the ProcessingConfiguration property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
processingConfiguration
default SnowflakeDestinationConfiguration.Builder processingConfiguration(Consumer<ProcessingConfiguration.Builder> processingConfiguration) Sets the value of the ProcessingConfiguration property for this object. This is a convenience method that creates an instance of theProcessingConfiguration.Builder
avoiding the need to create one manually viaProcessingConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toprocessingConfiguration(ProcessingConfiguration)
.- Parameters:
processingConfiguration
- a consumer that will call methods onProcessingConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
roleARN
The Amazon Resource Name (ARN) of the Snowflake role
- Parameters:
roleARN
- The Amazon Resource Name (ARN) of the Snowflake role- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
retryOptions
The time period where Firehose will retry sending data to the chosen HTTP endpoint.
- Parameters:
retryOptions
- The time period where Firehose will retry sending data to the chosen HTTP endpoint.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
retryOptions
default SnowflakeDestinationConfiguration.Builder retryOptions(Consumer<SnowflakeRetryOptions.Builder> retryOptions) The time period where Firehose will retry sending data to the chosen HTTP endpoint.
This is a convenience method that creates an instance of theSnowflakeRetryOptions.Builder
avoiding the need to create one manually viaSnowflakeRetryOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toretryOptions(SnowflakeRetryOptions)
.- Parameters:
retryOptions
- a consumer that will call methods onSnowflakeRetryOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
s3BackupMode
Choose an S3 backup mode
- Parameters:
s3BackupMode
- Choose an S3 backup mode- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
s3BackupMode
Choose an S3 backup mode
- Parameters:
s3BackupMode
- Choose an S3 backup mode- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
s3Configuration
SnowflakeDestinationConfiguration.Builder s3Configuration(S3DestinationConfiguration s3Configuration) Sets the value of the S3Configuration property for this object.- Parameters:
s3Configuration
- The new value for the S3Configuration property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
s3Configuration
default SnowflakeDestinationConfiguration.Builder s3Configuration(Consumer<S3DestinationConfiguration.Builder> s3Configuration) Sets the value of the S3Configuration property for this object. This is a convenience method that creates an instance of theS3DestinationConfiguration.Builder
avoiding the need to create one manually viaS3DestinationConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tos3Configuration(S3DestinationConfiguration)
.- Parameters:
s3Configuration
- a consumer that will call methods onS3DestinationConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-