Class: Aws::Firehose::Types::SnowflakeDestinationConfiguration
- Inherits:
-
Struct
- Object
- Struct
- Aws::Firehose::Types::SnowflakeDestinationConfiguration
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-firehose/types.rb
Overview
Configure Snowflake destination
Constant Summary collapse
- SENSITIVE =
[:account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :meta_data_column_name, :content_column_name]
Instance Attribute Summary collapse
-
#account_url ⇒ String
URL for accessing your Snowflake account.
-
#cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions
Describes the Amazon CloudWatch logging options for your delivery stream.
-
#content_column_name ⇒ String
The name of the record content column.
-
#data_loading_option ⇒ 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.
-
#database ⇒ String
All data in Snowflake is maintained in databases.
-
#key_passphrase ⇒ String
Passphrase to decrypt the private key when the key is encrypted.
-
#meta_data_column_name ⇒ String
The name of the record metadata column.
-
#private_key ⇒ String
The private key used to encrypt your Snowflake client.
-
#processing_configuration ⇒ Types::ProcessingConfiguration
Describes a data processing configuration.
-
#retry_options ⇒ Types::SnowflakeRetryOptions
The time period where Firehose will retry sending data to the chosen HTTP endpoint.
-
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the Snowflake role.
-
#s3_backup_mode ⇒ String
Choose an S3 backup mode.
-
#s3_configuration ⇒ Types::S3DestinationConfiguration
Describes the configuration of a destination in Amazon S3.
-
#schema ⇒ String
Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views.
-
#snowflake_role_configuration ⇒ Types::SnowflakeRoleConfiguration
Optionally configure a Snowflake role.
-
#snowflake_vpc_configuration ⇒ Types::SnowflakeVpcConfiguration
The VPCE ID for Firehose to privately connect with Snowflake.
-
#table ⇒ String
All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.
-
#user ⇒ String
User login name for the Snowflake account.
Instance Attribute Details
#account_url ⇒ String
URL for accessing your Snowflake account. This URL must include your [account identifier]. Note that the protocol (https://) and port number are optional.
[1]: docs.snowflake.com/en/user-guide/admin-account-identifier
3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 |
# File 'lib/aws-sdk-firehose/types.rb', line 3982 class SnowflakeDestinationConfiguration < Struct.new( :account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :snowflake_role_configuration, :data_loading_option, :meta_data_column_name, :content_column_name, :snowflake_vpc_configuration, :cloud_watch_logging_options, :processing_configuration, :role_arn, :retry_options, :s3_backup_mode, :s3_configuration) SENSITIVE = [:account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :meta_data_column_name, :content_column_name] include Aws::Structure end |
#cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions
Describes the Amazon CloudWatch logging options for your delivery stream.
3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 |
# File 'lib/aws-sdk-firehose/types.rb', line 3982 class SnowflakeDestinationConfiguration < Struct.new( :account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :snowflake_role_configuration, :data_loading_option, :meta_data_column_name, :content_column_name, :snowflake_vpc_configuration, :cloud_watch_logging_options, :processing_configuration, :role_arn, :retry_options, :s3_backup_mode, :s3_configuration) SENSITIVE = [:account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :meta_data_column_name, :content_column_name] include Aws::Structure end |
#content_column_name ⇒ String
The name of the record content column
3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 |
# File 'lib/aws-sdk-firehose/types.rb', line 3982 class SnowflakeDestinationConfiguration < Struct.new( :account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :snowflake_role_configuration, :data_loading_option, :meta_data_column_name, :content_column_name, :snowflake_vpc_configuration, :cloud_watch_logging_options, :processing_configuration, :role_arn, :retry_options, :s3_backup_mode, :s3_configuration) SENSITIVE = [:account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :meta_data_column_name, :content_column_name] include Aws::Structure end |
#data_loading_option ⇒ 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.
3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 |
# File 'lib/aws-sdk-firehose/types.rb', line 3982 class SnowflakeDestinationConfiguration < Struct.new( :account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :snowflake_role_configuration, :data_loading_option, :meta_data_column_name, :content_column_name, :snowflake_vpc_configuration, :cloud_watch_logging_options, :processing_configuration, :role_arn, :retry_options, :s3_backup_mode, :s3_configuration) SENSITIVE = [:account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :meta_data_column_name, :content_column_name] include Aws::Structure end |
#database ⇒ String
All data in Snowflake is maintained in databases.
3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 |
# File 'lib/aws-sdk-firehose/types.rb', line 3982 class SnowflakeDestinationConfiguration < Struct.new( :account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :snowflake_role_configuration, :data_loading_option, :meta_data_column_name, :content_column_name, :snowflake_vpc_configuration, :cloud_watch_logging_options, :processing_configuration, :role_arn, :retry_options, :s3_backup_mode, :s3_configuration) SENSITIVE = [:account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :meta_data_column_name, :content_column_name] include Aws::Structure end |
#key_passphrase ⇒ String
Passphrase to decrypt the private key when the key is encrypted. For information, see [Using Key Pair Authentication & Key Rotation].
3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 |
# File 'lib/aws-sdk-firehose/types.rb', line 3982 class SnowflakeDestinationConfiguration < Struct.new( :account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :snowflake_role_configuration, :data_loading_option, :meta_data_column_name, :content_column_name, :snowflake_vpc_configuration, :cloud_watch_logging_options, :processing_configuration, :role_arn, :retry_options, :s3_backup_mode, :s3_configuration) SENSITIVE = [:account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :meta_data_column_name, :content_column_name] include Aws::Structure end |
#meta_data_column_name ⇒ String
The name of the record metadata column
3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 |
# File 'lib/aws-sdk-firehose/types.rb', line 3982 class SnowflakeDestinationConfiguration < Struct.new( :account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :snowflake_role_configuration, :data_loading_option, :meta_data_column_name, :content_column_name, :snowflake_vpc_configuration, :cloud_watch_logging_options, :processing_configuration, :role_arn, :retry_options, :s3_backup_mode, :s3_configuration) SENSITIVE = [:account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :meta_data_column_name, :content_column_name] include Aws::Structure end |
#private_key ⇒ String
The private key used to encrypt your Snowflake client. For information, see [Using Key Pair Authentication & Key Rotation].
3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 |
# File 'lib/aws-sdk-firehose/types.rb', line 3982 class SnowflakeDestinationConfiguration < Struct.new( :account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :snowflake_role_configuration, :data_loading_option, :meta_data_column_name, :content_column_name, :snowflake_vpc_configuration, :cloud_watch_logging_options, :processing_configuration, :role_arn, :retry_options, :s3_backup_mode, :s3_configuration) SENSITIVE = [:account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :meta_data_column_name, :content_column_name] include Aws::Structure end |
#processing_configuration ⇒ Types::ProcessingConfiguration
Describes a data processing configuration.
3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 |
# File 'lib/aws-sdk-firehose/types.rb', line 3982 class SnowflakeDestinationConfiguration < Struct.new( :account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :snowflake_role_configuration, :data_loading_option, :meta_data_column_name, :content_column_name, :snowflake_vpc_configuration, :cloud_watch_logging_options, :processing_configuration, :role_arn, :retry_options, :s3_backup_mode, :s3_configuration) SENSITIVE = [:account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :meta_data_column_name, :content_column_name] include Aws::Structure end |
#retry_options ⇒ Types::SnowflakeRetryOptions
The time period where Firehose will retry sending data to the chosen HTTP endpoint.
3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 |
# File 'lib/aws-sdk-firehose/types.rb', line 3982 class SnowflakeDestinationConfiguration < Struct.new( :account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :snowflake_role_configuration, :data_loading_option, :meta_data_column_name, :content_column_name, :snowflake_vpc_configuration, :cloud_watch_logging_options, :processing_configuration, :role_arn, :retry_options, :s3_backup_mode, :s3_configuration) SENSITIVE = [:account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :meta_data_column_name, :content_column_name] include Aws::Structure end |
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the Snowflake role
3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 |
# File 'lib/aws-sdk-firehose/types.rb', line 3982 class SnowflakeDestinationConfiguration < Struct.new( :account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :snowflake_role_configuration, :data_loading_option, :meta_data_column_name, :content_column_name, :snowflake_vpc_configuration, :cloud_watch_logging_options, :processing_configuration, :role_arn, :retry_options, :s3_backup_mode, :s3_configuration) SENSITIVE = [:account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :meta_data_column_name, :content_column_name] include Aws::Structure end |
#s3_backup_mode ⇒ String
Choose an S3 backup mode
3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 |
# File 'lib/aws-sdk-firehose/types.rb', line 3982 class SnowflakeDestinationConfiguration < Struct.new( :account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :snowflake_role_configuration, :data_loading_option, :meta_data_column_name, :content_column_name, :snowflake_vpc_configuration, :cloud_watch_logging_options, :processing_configuration, :role_arn, :retry_options, :s3_backup_mode, :s3_configuration) SENSITIVE = [:account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :meta_data_column_name, :content_column_name] include Aws::Structure end |
#s3_configuration ⇒ Types::S3DestinationConfiguration
Describes the configuration of a destination in Amazon S3.
3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 |
# File 'lib/aws-sdk-firehose/types.rb', line 3982 class SnowflakeDestinationConfiguration < Struct.new( :account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :snowflake_role_configuration, :data_loading_option, :meta_data_column_name, :content_column_name, :snowflake_vpc_configuration, :cloud_watch_logging_options, :processing_configuration, :role_arn, :retry_options, :s3_backup_mode, :s3_configuration) SENSITIVE = [:account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :meta_data_column_name, :content_column_name] include Aws::Structure end |
#schema ⇒ String
Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views
3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 |
# File 'lib/aws-sdk-firehose/types.rb', line 3982 class SnowflakeDestinationConfiguration < Struct.new( :account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :snowflake_role_configuration, :data_loading_option, :meta_data_column_name, :content_column_name, :snowflake_vpc_configuration, :cloud_watch_logging_options, :processing_configuration, :role_arn, :retry_options, :s3_backup_mode, :s3_configuration) SENSITIVE = [:account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :meta_data_column_name, :content_column_name] include Aws::Structure end |
#snowflake_role_configuration ⇒ Types::SnowflakeRoleConfiguration
Optionally configure a Snowflake role. Otherwise the default user role will be used.
3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 |
# File 'lib/aws-sdk-firehose/types.rb', line 3982 class SnowflakeDestinationConfiguration < Struct.new( :account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :snowflake_role_configuration, :data_loading_option, :meta_data_column_name, :content_column_name, :snowflake_vpc_configuration, :cloud_watch_logging_options, :processing_configuration, :role_arn, :retry_options, :s3_backup_mode, :s3_configuration) SENSITIVE = [:account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :meta_data_column_name, :content_column_name] include Aws::Structure end |
#snowflake_vpc_configuration ⇒ Types::SnowflakeVpcConfiguration
The VPCE ID for Firehose to privately connect with Snowflake. The ID format is com.amazonaws.vpce..vpce-svc-<>. For more information, see [Amazon PrivateLink & Snowflake]
[1]: docs.snowflake.com/en/user-guide/admin-security-privatelink
3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 |
# File 'lib/aws-sdk-firehose/types.rb', line 3982 class SnowflakeDestinationConfiguration < Struct.new( :account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :snowflake_role_configuration, :data_loading_option, :meta_data_column_name, :content_column_name, :snowflake_vpc_configuration, :cloud_watch_logging_options, :processing_configuration, :role_arn, :retry_options, :s3_backup_mode, :s3_configuration) SENSITIVE = [:account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :meta_data_column_name, :content_column_name] include Aws::Structure end |
#table ⇒ String
All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.
3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 |
# File 'lib/aws-sdk-firehose/types.rb', line 3982 class SnowflakeDestinationConfiguration < Struct.new( :account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :snowflake_role_configuration, :data_loading_option, :meta_data_column_name, :content_column_name, :snowflake_vpc_configuration, :cloud_watch_logging_options, :processing_configuration, :role_arn, :retry_options, :s3_backup_mode, :s3_configuration) SENSITIVE = [:account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :meta_data_column_name, :content_column_name] include Aws::Structure end |
#user ⇒ String
User login name for the Snowflake account.
3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 |
# File 'lib/aws-sdk-firehose/types.rb', line 3982 class SnowflakeDestinationConfiguration < Struct.new( :account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :snowflake_role_configuration, :data_loading_option, :meta_data_column_name, :content_column_name, :snowflake_vpc_configuration, :cloud_watch_logging_options, :processing_configuration, :role_arn, :retry_options, :s3_backup_mode, :s3_configuration) SENSITIVE = [:account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :meta_data_column_name, :content_column_name] include Aws::Structure end |