Class SnowflakeDestinationConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<SnowflakeDestinationConfiguration.Builder,
SnowflakeDestinationConfiguration>
Configure Snowflake destination
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal String
URL for accessing your Snowflake account.final SnowflakeBufferingHints
Describes the buffering to perform before delivering data to the Snowflake destination.builder()
final CloudWatchLoggingOptions
Returns the value of the CloudWatchLoggingOptions property for this object.final String
The name of the record content columnfinal String
database()
All data in Snowflake is maintained in databases.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.final String
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.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
Passphrase to decrypt the private key when the key is encrypted.final String
The name of the record metadata columnfinal String
The private key used to encrypt your Snowflake client.final ProcessingConfiguration
Returns the value of the ProcessingConfiguration property for this object.final SnowflakeRetryOptions
The time period where Firehose will retry sending data to the chosen HTTP endpoint.final String
roleARN()
The Amazon Resource Name (ARN) of the Snowflake rolefinal SnowflakeS3BackupMode
Choose an S3 backup modefinal String
Choose an S3 backup modeReturns the value of the S3Configuration property for this object.final String
schema()
Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and viewsThe configuration that defines how you access secrets for Snowflake.static Class
<? extends SnowflakeDestinationConfiguration.Builder> Optionally configure a Snowflake role.The VPCE ID for Firehose to privately connect with Snowflake.final String
table()
All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
user()
User login name for the Snowflake account.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
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.
- Returns:
- URL for accessing your Snowflake account. This URL must include your account identifier. Note that the protocol (https://) and port number are optional.
-
privateKey
The private key used to encrypt your Snowflake client. For information, see Using Key Pair Authentication & Key Rotation.
- Returns:
- The private key used to encrypt your Snowflake client. For information, see Using Key Pair Authentication & Key Rotation.
-
keyPassphrase
Passphrase to decrypt the private key when the key is encrypted. For information, see Using Key Pair Authentication & Key Rotation.
- Returns:
- Passphrase to decrypt the private key when the key is encrypted. For information, see Using Key Pair Authentication & Key Rotation.
-
user
User login name for the Snowflake account.
- Returns:
- User login name for the Snowflake account.
-
database
All data in Snowflake is maintained in databases.
- Returns:
- All data in Snowflake is maintained in databases.
-
schema
Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views
- Returns:
- Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views
-
table
All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.
- Returns:
- All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.
-
snowflakeRoleConfiguration
Optionally configure a Snowflake role. Otherwise the default user role will be used.
- Returns:
- Optionally configure a Snowflake role. Otherwise the default user role will be used.
-
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.
If the service returns an enum value that is not available in the current SDK version,
dataLoadingOption
will returnSnowflakeDataLoadingOption.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdataLoadingOptionAsString()
.- Returns:
- 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:
-
dataLoadingOptionAsString
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.
If the service returns an enum value that is not available in the current SDK version,
dataLoadingOption
will returnSnowflakeDataLoadingOption.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdataLoadingOptionAsString()
.- Returns:
- 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:
-
metaDataColumnName
The name of the record metadata column
- Returns:
- The name of the record metadata column
-
contentColumnName
The name of the record content column
- Returns:
- The name of the record content column
-
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:
- 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
-
cloudWatchLoggingOptions
Returns the value of the CloudWatchLoggingOptions property for this object.- Returns:
- The value of the CloudWatchLoggingOptions property for this object.
-
processingConfiguration
Returns the value of the ProcessingConfiguration property for this object.- Returns:
- The value of the ProcessingConfiguration property for this object.
-
roleARN
The Amazon Resource Name (ARN) of the Snowflake role
- Returns:
- The Amazon Resource Name (ARN) of the Snowflake role
-
retryOptions
The time period where Firehose will retry sending data to the chosen HTTP endpoint.
- Returns:
- The time period where Firehose will retry sending data to the chosen HTTP endpoint.
-
s3BackupMode
Choose an S3 backup mode
If the service returns an enum value that is not available in the current SDK version,
s3BackupMode
will returnSnowflakeS3BackupMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available froms3BackupModeAsString()
.- Returns:
- Choose an S3 backup mode
- See Also:
-
s3BackupModeAsString
Choose an S3 backup mode
If the service returns an enum value that is not available in the current SDK version,
s3BackupMode
will returnSnowflakeS3BackupMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available froms3BackupModeAsString()
.- Returns:
- Choose an S3 backup mode
- See Also:
-
s3Configuration
Returns the value of the S3Configuration property for this object.- Returns:
- The value of the S3Configuration property for this object.
-
secretsManagerConfiguration
The configuration that defines how you access secrets for Snowflake.
- Returns:
- The configuration that defines how you access secrets for Snowflake.
-
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:
- Describes the buffering to perform before delivering data to the Snowflake destination. If you do not specify any value, Firehose uses the default values.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<SnowflakeDestinationConfiguration.Builder,
SnowflakeDestinationConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-