Interface SnowflakeDestinationConfiguration.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<SnowflakeDestinationConfiguration.Builder,SnowflakeDestinationConfiguration>,SdkBuilder<SnowflakeDestinationConfiguration.Builder,SnowflakeDestinationConfiguration>,SdkPojo
- Enclosing class:
- SnowflakeDestinationConfiguration
public static interface SnowflakeDestinationConfiguration.Builder extends SdkPojo, CopyableBuilder<SnowflakeDestinationConfiguration.Builder,SnowflakeDestinationConfiguration>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description SnowflakeDestinationConfiguration.BuilderaccountUrl(String accountUrl)URL for accessing your Snowflake account.default SnowflakeDestinationConfiguration.BuilderbufferingHints(Consumer<SnowflakeBufferingHints.Builder> bufferingHints)Describes the buffering to perform before delivering data to the Snowflake destination.SnowflakeDestinationConfiguration.BuilderbufferingHints(SnowflakeBufferingHints bufferingHints)Describes the buffering to perform before delivering data to the Snowflake destination.default SnowflakeDestinationConfiguration.BuildercloudWatchLoggingOptions(Consumer<CloudWatchLoggingOptions.Builder> cloudWatchLoggingOptions)Sets the value of the CloudWatchLoggingOptions property for this object.SnowflakeDestinationConfiguration.BuildercloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)Sets the value of the CloudWatchLoggingOptions property for this object.SnowflakeDestinationConfiguration.BuildercontentColumnName(String contentColumnName)The name of the record content column.SnowflakeDestinationConfiguration.Builderdatabase(String database)All data in Snowflake is maintained in databases.SnowflakeDestinationConfiguration.BuilderdataLoadingOption(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.SnowflakeDestinationConfiguration.BuilderdataLoadingOption(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.SnowflakeDestinationConfiguration.BuilderkeyPassphrase(String keyPassphrase)Passphrase to decrypt the private key when the key is encrypted.SnowflakeDestinationConfiguration.BuildermetaDataColumnName(String metaDataColumnName)Specify a column name in the table, where the metadata information has to be loaded.SnowflakeDestinationConfiguration.BuilderprivateKey(String privateKey)The private key used to encrypt your Snowflake client.default SnowflakeDestinationConfiguration.BuilderprocessingConfiguration(Consumer<ProcessingConfiguration.Builder> processingConfiguration)Sets the value of the ProcessingConfiguration property for this object.SnowflakeDestinationConfiguration.BuilderprocessingConfiguration(ProcessingConfiguration processingConfiguration)Sets the value of the ProcessingConfiguration property for this object.default SnowflakeDestinationConfiguration.BuilderretryOptions(Consumer<SnowflakeRetryOptions.Builder> retryOptions)The time period where Firehose will retry sending data to the chosen HTTP endpoint.SnowflakeDestinationConfiguration.BuilderretryOptions(SnowflakeRetryOptions retryOptions)The time period where Firehose will retry sending data to the chosen HTTP endpoint.SnowflakeDestinationConfiguration.BuilderroleARN(String roleARN)The Amazon Resource Name (ARN) of the Snowflake roleSnowflakeDestinationConfiguration.Builders3BackupMode(String s3BackupMode)Choose an S3 backup modeSnowflakeDestinationConfiguration.Builders3BackupMode(SnowflakeS3BackupMode s3BackupMode)Choose an S3 backup modedefault SnowflakeDestinationConfiguration.Builders3Configuration(Consumer<S3DestinationConfiguration.Builder> s3Configuration)Sets the value of the S3Configuration property for this object.SnowflakeDestinationConfiguration.Builders3Configuration(S3DestinationConfiguration s3Configuration)Sets the value of the S3Configuration property for this object.SnowflakeDestinationConfiguration.Builderschema(String schema)Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and viewsdefault SnowflakeDestinationConfiguration.BuildersecretsManagerConfiguration(Consumer<SecretsManagerConfiguration.Builder> secretsManagerConfiguration)The configuration that defines how you access secrets for Snowflake.SnowflakeDestinationConfiguration.BuildersecretsManagerConfiguration(SecretsManagerConfiguration secretsManagerConfiguration)The configuration that defines how you access secrets for Snowflake.default SnowflakeDestinationConfiguration.BuildersnowflakeRoleConfiguration(Consumer<SnowflakeRoleConfiguration.Builder> snowflakeRoleConfiguration)Optionally configure a Snowflake role.SnowflakeDestinationConfiguration.BuildersnowflakeRoleConfiguration(SnowflakeRoleConfiguration snowflakeRoleConfiguration)Optionally configure a Snowflake role.default SnowflakeDestinationConfiguration.BuildersnowflakeVpcConfiguration(Consumer<SnowflakeVpcConfiguration.Builder> snowflakeVpcConfiguration)The VPCE ID for Firehose to privately connect with Snowflake.SnowflakeDestinationConfiguration.BuildersnowflakeVpcConfiguration(SnowflakeVpcConfiguration snowflakeVpcConfiguration)The VPCE ID for Firehose to privately connect with Snowflake.SnowflakeDestinationConfiguration.Buildertable(String table)All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.SnowflakeDestinationConfiguration.Builderuser(String user)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, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
accountUrl
SnowflakeDestinationConfiguration.Builder accountUrl(String 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
SnowflakeDestinationConfiguration.Builder privateKey(String 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
SnowflakeDestinationConfiguration.Builder keyPassphrase(String 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
SnowflakeDestinationConfiguration.Builder user(String 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
SnowflakeDestinationConfiguration.Builder database(String 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
SnowflakeDestinationConfiguration.Builder schema(String 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
SnowflakeDestinationConfiguration.Builder table(String 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.Builderavoiding the need to create one manually viaSnowflakeRoleConfiguration.builder().When the
Consumercompletes,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:
snowflakeRoleConfiguration(SnowflakeRoleConfiguration)
-
dataLoadingOption
SnowflakeDestinationConfiguration.Builder 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.
- 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:
SnowflakeDataLoadingOption,SnowflakeDataLoadingOption
-
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:
SnowflakeDataLoadingOption,SnowflakeDataLoadingOption
-
metaDataColumnName
SnowflakeDestinationConfiguration.Builder metaDataColumnName(String 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" }- 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:
- Returns a reference to this object so that method calls can be chained together.
-
contentColumnName
SnowflakeDestinationConfiguration.Builder contentColumnName(String 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.Builderavoiding the need to create one manually viaSnowflakeVpcConfiguration.builder().When the
Consumercompletes,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:
snowflakeVpcConfiguration(SnowflakeVpcConfiguration)
-
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.Builderavoiding the need to create one manually viaCloudWatchLoggingOptions.builder().When the
Consumercompletes,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:
cloudWatchLoggingOptions(CloudWatchLoggingOptions)
-
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.Builderavoiding the need to create one manually viaProcessingConfiguration.builder().When the
Consumercompletes,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:
processingConfiguration(ProcessingConfiguration)
-
roleARN
SnowflakeDestinationConfiguration.Builder roleARN(String 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
SnowflakeDestinationConfiguration.Builder retryOptions(SnowflakeRetryOptions 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.Builderavoiding the need to create one manually viaSnowflakeRetryOptions.builder().When the
Consumercompletes,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:
retryOptions(SnowflakeRetryOptions)
-
s3BackupMode
SnowflakeDestinationConfiguration.Builder s3BackupMode(String 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:
SnowflakeS3BackupMode,SnowflakeS3BackupMode
-
s3BackupMode
SnowflakeDestinationConfiguration.Builder s3BackupMode(SnowflakeS3BackupMode 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:
SnowflakeS3BackupMode,SnowflakeS3BackupMode
-
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.Builderavoiding the need to create one manually viaS3DestinationConfiguration.builder().When the
Consumercompletes,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:
s3Configuration(S3DestinationConfiguration)
-
secretsManagerConfiguration
SnowflakeDestinationConfiguration.Builder secretsManagerConfiguration(SecretsManagerConfiguration secretsManagerConfiguration)
The configuration that defines how you access secrets for Snowflake.
- Parameters:
secretsManagerConfiguration- The configuration that defines how you access secrets for Snowflake.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
secretsManagerConfiguration
default SnowflakeDestinationConfiguration.Builder secretsManagerConfiguration(Consumer<SecretsManagerConfiguration.Builder> secretsManagerConfiguration)
The configuration that defines how you access secrets for Snowflake.
This is a convenience method that creates an instance of theSecretsManagerConfiguration.Builderavoiding the need to create one manually viaSecretsManagerConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tosecretsManagerConfiguration(SecretsManagerConfiguration).- Parameters:
secretsManagerConfiguration- a consumer that will call methods onSecretsManagerConfiguration.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
secretsManagerConfiguration(SecretsManagerConfiguration)
-
bufferingHints
SnowflakeDestinationConfiguration.Builder bufferingHints(SnowflakeBufferingHints 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.
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
bufferingHints
default SnowflakeDestinationConfiguration.Builder bufferingHints(Consumer<SnowflakeBufferingHints.Builder> 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.
This is a convenience method that creates an instance of theSnowflakeBufferingHints.Builderavoiding the need to create one manually viaSnowflakeBufferingHints.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tobufferingHints(SnowflakeBufferingHints).- Parameters:
bufferingHints- a consumer that will call methods onSnowflakeBufferingHints.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
bufferingHints(SnowflakeBufferingHints)
-
-