Class: Aws::Firehose::Types::SnowflakeDestinationConfiguration

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-firehose/types.rb

Overview

Configure Snowflake destination

See Also:

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

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

Returns:

  • (String) 


4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
 
# File 'lib/aws-sdk-firehose/types.rb', line 4717

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,
  :secrets_manager_configuration,
  :buffering_hints)
  SENSITIVE = [:account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :meta_data_column_name, :content_column_name]
  include Aws::Structure
end

#buffering_hints ⇒ Types::SnowflakeBufferingHints

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:



4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
 
# File 'lib/aws-sdk-firehose/types.rb', line 4717

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,
  :secrets_manager_configuration,
  :buffering_hints)
  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 Firehose stream.

Returns:



4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
 
# File 'lib/aws-sdk-firehose/types.rb', line 4717

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,
  :secrets_manager_configuration,
  :buffering_hints)
  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

Returns:

  • (String) 


4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
 
# File 'lib/aws-sdk-firehose/types.rb', line 4717

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,
  :secrets_manager_configuration,
  :buffering_hints)
  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.

Returns:

  • (String) 


4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
 
# File 'lib/aws-sdk-firehose/types.rb', line 4717

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,
  :secrets_manager_configuration,
  :buffering_hints)
  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.

Returns:

  • (String) 


4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
 
# File 'lib/aws-sdk-firehose/types.rb', line 4717

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,
  :secrets_manager_configuration,
  :buffering_hints)
  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 &amp; Key Rotation].

[1]: docs.snowflake.com/en/user-guide/data-load-snowpipe-streaming-configuration#using-key-pair-authentication-key-rotation

Returns:

  • (String) 


4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
 
# File 'lib/aws-sdk-firehose/types.rb', line 4717

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,
  :secrets_manager_configuration,
  :buffering_hints)
  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

Returns:

  • (String) 


4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
 
# File 'lib/aws-sdk-firehose/types.rb', line 4717

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,
  :secrets_manager_configuration,
  :buffering_hints)
  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 &amp; Key Rotation].

[1]: docs.snowflake.com/en/user-guide/data-load-snowpipe-streaming-configuration#using-key-pair-authentication-key-rotation

Returns:

  • (String) 


4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
 
# File 'lib/aws-sdk-firehose/types.rb', line 4717

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,
  :secrets_manager_configuration,
  :buffering_hints)
  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.

Returns:



4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
 
# File 'lib/aws-sdk-firehose/types.rb', line 4717

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,
  :secrets_manager_configuration,
  :buffering_hints)
  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.

Returns:



4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
 
# File 'lib/aws-sdk-firehose/types.rb', line 4717

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,
  :secrets_manager_configuration,
  :buffering_hints)
  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

Returns:

  • (String) 


4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
 
# File 'lib/aws-sdk-firehose/types.rb', line 4717

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,
  :secrets_manager_configuration,
  :buffering_hints)
  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

Returns:

  • (String) 


4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
 
# File 'lib/aws-sdk-firehose/types.rb', line 4717

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,
  :secrets_manager_configuration,
  :buffering_hints)
  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.

Returns:



4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
 
# File 'lib/aws-sdk-firehose/types.rb', line 4717

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,
  :secrets_manager_configuration,
  :buffering_hints)
  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

Returns:

  • (String) 


4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
 
# File 'lib/aws-sdk-firehose/types.rb', line 4717

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,
  :secrets_manager_configuration,
  :buffering_hints)
  SENSITIVE = [:account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :meta_data_column_name, :content_column_name]
  include Aws::Structure
end

#secrets_manager_configuration ⇒ Types::SecretsManagerConfiguration

The configuration that defines how you access secrets for Snowflake.

Returns:



4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
 
# File 'lib/aws-sdk-firehose/types.rb', line 4717

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,
  :secrets_manager_configuration,
  :buffering_hints)
  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.

Returns:



4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
 
# File 'lib/aws-sdk-firehose/types.rb', line 4717

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,
  :secrets_manager_configuration,
  :buffering_hints)
  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-&lt;&gt;. For more information, see [Amazon PrivateLink &amp; Snowflake]

[1]: docs.snowflake.com/en/user-guide/admin-security-privatelink

Returns:



4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
 
# File 'lib/aws-sdk-firehose/types.rb', line 4717

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,
  :secrets_manager_configuration,
  :buffering_hints)
  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.

Returns:

  • (String) 


4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
 
# File 'lib/aws-sdk-firehose/types.rb', line 4717

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,
  :secrets_manager_configuration,
  :buffering_hints)
  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.

Returns:

  • (String) 


4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
 
# File 'lib/aws-sdk-firehose/types.rb', line 4717

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,
  :secrets_manager_configuration,
  :buffering_hints)
  SENSITIVE = [:account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :meta_data_column_name, :content_column_name]
  include Aws::Structure
end