Class: Aws::Firehose::Types::SnowflakeDestinationDescription
- Inherits:
-
Struct
- Object
- Struct
- Aws::Firehose::Types::SnowflakeDestinationDescription
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-firehose/types.rb
Overview
Optional Snowflake destination description
Constant Summary collapse
- SENSITIVE =
[:account_url, :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.
-
#meta_data_column_name ⇒ String
The name of the record metadata column.
-
#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_destination_description ⇒ Types::S3DestinationDescription
Describes 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
4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 |
# File 'lib/aws-sdk-firehose/types.rb', line 4139 class SnowflakeDestinationDescription < Struct.new( :account_url, :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_destination_description) SENSITIVE = [:account_url, :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.
4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 |
# File 'lib/aws-sdk-firehose/types.rb', line 4139 class SnowflakeDestinationDescription < Struct.new( :account_url, :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_destination_description) SENSITIVE = [:account_url, :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
4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 |
# File 'lib/aws-sdk-firehose/types.rb', line 4139 class SnowflakeDestinationDescription < Struct.new( :account_url, :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_destination_description) SENSITIVE = [:account_url, :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.
4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 |
# File 'lib/aws-sdk-firehose/types.rb', line 4139 class SnowflakeDestinationDescription < Struct.new( :account_url, :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_destination_description) SENSITIVE = [:account_url, :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.
4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 |
# File 'lib/aws-sdk-firehose/types.rb', line 4139 class SnowflakeDestinationDescription < Struct.new( :account_url, :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_destination_description) SENSITIVE = [:account_url, :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
4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 |
# File 'lib/aws-sdk-firehose/types.rb', line 4139 class SnowflakeDestinationDescription < Struct.new( :account_url, :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_destination_description) SENSITIVE = [:account_url, :user, :database, :schema, :table, :meta_data_column_name, :content_column_name] include Aws::Structure end |
#processing_configuration ⇒ Types::ProcessingConfiguration
Describes a data processing configuration.
4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 |
# File 'lib/aws-sdk-firehose/types.rb', line 4139 class SnowflakeDestinationDescription < Struct.new( :account_url, :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_destination_description) SENSITIVE = [:account_url, :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.
4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 |
# File 'lib/aws-sdk-firehose/types.rb', line 4139 class SnowflakeDestinationDescription < Struct.new( :account_url, :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_destination_description) SENSITIVE = [:account_url, :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
4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 |
# File 'lib/aws-sdk-firehose/types.rb', line 4139 class SnowflakeDestinationDescription < Struct.new( :account_url, :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_destination_description) SENSITIVE = [:account_url, :user, :database, :schema, :table, :meta_data_column_name, :content_column_name] include Aws::Structure end |
#s3_backup_mode ⇒ String
Choose an S3 backup mode
4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 |
# File 'lib/aws-sdk-firehose/types.rb', line 4139 class SnowflakeDestinationDescription < Struct.new( :account_url, :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_destination_description) SENSITIVE = [:account_url, :user, :database, :schema, :table, :meta_data_column_name, :content_column_name] include Aws::Structure end |
#s3_destination_description ⇒ Types::S3DestinationDescription
Describes a destination in Amazon S3.
4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 |
# File 'lib/aws-sdk-firehose/types.rb', line 4139 class SnowflakeDestinationDescription < Struct.new( :account_url, :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_destination_description) SENSITIVE = [:account_url, :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
4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 |
# File 'lib/aws-sdk-firehose/types.rb', line 4139 class SnowflakeDestinationDescription < Struct.new( :account_url, :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_destination_description) SENSITIVE = [:account_url, :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.
4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 |
# File 'lib/aws-sdk-firehose/types.rb', line 4139 class SnowflakeDestinationDescription < Struct.new( :account_url, :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_destination_description) SENSITIVE = [:account_url, :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
4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 |
# File 'lib/aws-sdk-firehose/types.rb', line 4139 class SnowflakeDestinationDescription < Struct.new( :account_url, :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_destination_description) SENSITIVE = [:account_url, :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.
4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 |
# File 'lib/aws-sdk-firehose/types.rb', line 4139 class SnowflakeDestinationDescription < Struct.new( :account_url, :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_destination_description) SENSITIVE = [:account_url, :user, :database, :schema, :table, :meta_data_column_name, :content_column_name] include Aws::Structure end |
#user ⇒ String
User login name for the Snowflake account.
4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 |
# File 'lib/aws-sdk-firehose/types.rb', line 4139 class SnowflakeDestinationDescription < Struct.new( :account_url, :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_destination_description) SENSITIVE = [:account_url, :user, :database, :schema, :table, :meta_data_column_name, :content_column_name] include Aws::Structure end |