Class SnowflakeDestinationConfiguration

java.lang.Object
software.amazon.awssdk.services.firehose.model.SnowflakeDestinationConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SnowflakeDestinationConfiguration.Builder,SnowflakeDestinationConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class SnowflakeDestinationConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SnowflakeDestinationConfiguration.Builder,SnowflakeDestinationConfiguration>

Configure Snowflake destination

See Also:

  • Method Details

    • accountUrl

      public final 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.

      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

      public final String 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

      public final String 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

      public final String user()

      User login name for the Snowflake account.

      Returns:
      User login name for the Snowflake account.

    • database

      public final String database()

      All data in Snowflake is maintained in databases.

      Returns:
      All data in Snowflake is maintained in databases.

    • schema

      public final String 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

      public final String 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

      public final SnowflakeRoleConfiguration 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

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, dataLoadingOption will return SnowflakeDataLoadingOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataLoadingOptionAsString().

      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

      public final String 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 return SnowflakeDataLoadingOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataLoadingOptionAsString().

      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

      public final 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" }

      Returns:
      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" }

    • contentColumnName

      public final String contentColumnName()

      The name of the record content column.

      Returns:
      The name of the record content column.

    • snowflakeVpcConfiguration

      public final 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

      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

      public final CloudWatchLoggingOptions cloudWatchLoggingOptions()
      Returns the value of the CloudWatchLoggingOptions property for this object.
      Returns:
      The value of the CloudWatchLoggingOptions property for this object.

    • processingConfiguration

      public final ProcessingConfiguration processingConfiguration()
      Returns the value of the ProcessingConfiguration property for this object.
      Returns:
      The value of the ProcessingConfiguration property for this object.

    • roleARN

      public final String roleARN()

      The Amazon Resource Name (ARN) of the Snowflake role

      Returns:
      The Amazon Resource Name (ARN) of the Snowflake role

    • retryOptions

      public final SnowflakeRetryOptions 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

      public final SnowflakeS3BackupMode s3BackupMode()

      Choose an S3 backup mode

      If the service returns an enum value that is not available in the current SDK version, s3BackupMode will return SnowflakeS3BackupMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from s3BackupModeAsString().

      Returns:
      Choose an S3 backup mode
      See Also:

    • s3BackupModeAsString

      public final String s3BackupModeAsString()

      Choose an S3 backup mode

      If the service returns an enum value that is not available in the current SDK version, s3BackupMode will return SnowflakeS3BackupMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from s3BackupModeAsString().

      Returns:
      Choose an S3 backup mode
      See Also:

    • s3Configuration

      public final S3DestinationConfiguration s3Configuration()
      Returns the value of the S3Configuration property for this object.
      Returns:
      The value of the S3Configuration property for this object.

    • secretsManagerConfiguration

      public final SecretsManagerConfiguration secretsManagerConfiguration()

      The configuration that defines how you access secrets for Snowflake.

      Returns:
      The configuration that defines how you access secrets for Snowflake.

    • bufferingHints

      public final 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.

      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

      public SnowflakeDestinationConfiguration.Builder 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 interface ToCopyableBuilder<SnowflakeDestinationConfiguration.Builder,SnowflakeDestinationConfiguration>
      Returns:
      a builder for type T

    • builder

      public static SnowflakeDestinationConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SnowflakeDestinationConfiguration.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.