Class: Aws::Firehose::Types::SnowflakeDestinationUpdate

Inherits:

Struct

• Object
• Struct
• Aws::Firehose::Types::SnowflakeDestinationUpdate

Includes:

Structure

Defined in:

lib/aws-sdk-firehose/types.rb

Overview

Update to configuration settings

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:account_url, :private_key, :key_passphrase, :user, :database, :schema, :table, :meta_data_column_name, :content_column_name]

Instance Attribute Summary

• #account_url ⇒ String

  URL for accessing your Snowflake account.

• #buffering_hints ⇒ Types::SnowflakeBufferingHints

  Describes the buffering to perform before delivering data to the Snowflake destination.

• #cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions

  Describes the Amazon CloudWatch logging options for your Firehose stream.

• #content_column_name ⇒ String

  The name of the content metadata column.

• #data_loading_option ⇒ String

  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

  Specify how long Firehose retries sending data to the New Relic HTTP endpoint.

• #role_arn ⇒ String

  The Amazon Resource Name (ARN) of the Snowflake role.

• #s3_backup_mode ⇒ String

  Choose an S3 backup mode.

• #s3_update ⇒ Types::S3DestinationUpdate

  Describes an update for 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.

• #secrets_manager_configuration ⇒ Types::SecretsManagerConfiguration

  Describes the Secrets Manager configuration in Snowflake.

• #snowflake_role_configuration ⇒ Types::SnowflakeRoleConfiguration

  Optionally configure a Snowflake role.

• #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

Returns:

• (String)

# File 'lib/aws-sdk-firehose/types.rb', line 4985

class SnowflakeDestinationUpdate < 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,
  :cloud_watch_logging_options,
  :processing_configuration,
  :role_arn,
  :retry_options,
  :s3_backup_mode,
  :s3_update,
  :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.

Returns:

• (Types::SnowflakeBufferingHints)

# File 'lib/aws-sdk-firehose/types.rb', line 4985

class SnowflakeDestinationUpdate < 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,
  :cloud_watch_logging_options,
  :processing_configuration,
  :role_arn,
  :retry_options,
  :s3_backup_mode,
  :s3_update,
  :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:

• (Types::CloudWatchLoggingOptions)

# File 'lib/aws-sdk-firehose/types.rb', line 4985

class SnowflakeDestinationUpdate < 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,
  :cloud_watch_logging_options,
  :processing_configuration,
  :role_arn,
  :retry_options,
  :s3_backup_mode,
  :s3_update,
  :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 content metadata column

Returns:

• (String)

# File 'lib/aws-sdk-firehose/types.rb', line 4985

class SnowflakeDestinationUpdate < 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,
  :cloud_watch_logging_options,
  :processing_configuration,
  :role_arn,
  :retry_options,
  :s3_backup_mode,
  :s3_update,
  :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

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)

# File 'lib/aws-sdk-firehose/types.rb', line 4985

class SnowflakeDestinationUpdate < 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,
  :cloud_watch_logging_options,
  :processing_configuration,
  :role_arn,
  :retry_options,
  :s3_backup_mode,
  :s3_update,
  :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)

# File 'lib/aws-sdk-firehose/types.rb', line 4985

class SnowflakeDestinationUpdate < 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,
  :cloud_watch_logging_options,
  :processing_configuration,
  :role_arn,
  :retry_options,
  :s3_backup_mode,
  :s3_update,
  :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 & Key Rotation].

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

Returns:

• (String)

# File 'lib/aws-sdk-firehose/types.rb', line 4985

class SnowflakeDestinationUpdate < 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,
  :cloud_watch_logging_options,
  :processing_configuration,
  :role_arn,
  :retry_options,
  :s3_backup_mode,
  :s3_update,
  :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)

# File 'lib/aws-sdk-firehose/types.rb', line 4985

class SnowflakeDestinationUpdate < 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,
  :cloud_watch_logging_options,
  :processing_configuration,
  :role_arn,
  :retry_options,
  :s3_backup_mode,
  :s3_update,
  :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 & Key Rotation].

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

Returns:

• (String)

# File 'lib/aws-sdk-firehose/types.rb', line 4985

class SnowflakeDestinationUpdate < 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,
  :cloud_watch_logging_options,
  :processing_configuration,
  :role_arn,
  :retry_options,
  :s3_backup_mode,
  :s3_update,
  :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:

• (Types::ProcessingConfiguration)

# File 'lib/aws-sdk-firehose/types.rb', line 4985

class SnowflakeDestinationUpdate < 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,
  :cloud_watch_logging_options,
  :processing_configuration,
  :role_arn,
  :retry_options,
  :s3_backup_mode,
  :s3_update,
  :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

Specify how long Firehose retries sending data to the New Relic HTTP endpoint. After sending data, Firehose first waits for an acknowledgment from the HTTP endpoint. If an error occurs or the acknowledgment doesn’t arrive within the acknowledgment timeout period, Firehose starts the retry duration counter. It keeps retrying until the retry duration expires. After that, Firehose considers it a data delivery failure and backs up the data to your Amazon S3 bucket. Every time that Firehose sends data to the HTTP endpoint (either the initial attempt or a retry), it restarts the acknowledgement timeout counter and waits for an acknowledgement from the HTTP endpoint. Even if the retry duration expires, Firehose still waits for the acknowledgment until it receives it or the acknowledgement timeout period is reached. If the acknowledgment times out, Firehose determines whether there’s time left in the retry counter. If there is time left, it retries again and repeats the logic until it receives an acknowledgment or determines that the retry time has expired. If you don’t want Firehose to retry sending data, set this value to 0.

Returns:

• (Types::SnowflakeRetryOptions)

# File 'lib/aws-sdk-firehose/types.rb', line 4985

class SnowflakeDestinationUpdate < 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,
  :cloud_watch_logging_options,
  :processing_configuration,
  :role_arn,
  :retry_options,
  :s3_backup_mode,
  :s3_update,
  :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)

# File 'lib/aws-sdk-firehose/types.rb', line 4985

class SnowflakeDestinationUpdate < 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,
  :cloud_watch_logging_options,
  :processing_configuration,
  :role_arn,
  :retry_options,
  :s3_backup_mode,
  :s3_update,
  :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. Once you set the mode as ‘AllData`, you can not change it to `FailedDataOnly`.

Returns:

• (String)

# File 'lib/aws-sdk-firehose/types.rb', line 4985

class SnowflakeDestinationUpdate < 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,
  :cloud_watch_logging_options,
  :processing_configuration,
  :role_arn,
  :retry_options,
  :s3_backup_mode,
  :s3_update,
  :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_update ⇒ Types::S3DestinationUpdate

Describes an update for a destination in Amazon S3.

Returns:

• (Types::S3DestinationUpdate)

# File 'lib/aws-sdk-firehose/types.rb', line 4985

class SnowflakeDestinationUpdate < 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,
  :cloud_watch_logging_options,
  :processing_configuration,
  :role_arn,
  :retry_options,
  :s3_backup_mode,
  :s3_update,
  :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)

# File 'lib/aws-sdk-firehose/types.rb', line 4985

class SnowflakeDestinationUpdate < 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,
  :cloud_watch_logging_options,
  :processing_configuration,
  :role_arn,
  :retry_options,
  :s3_backup_mode,
  :s3_update,
  :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

Describes the Secrets Manager configuration in Snowflake.

Returns:

• (Types::SecretsManagerConfiguration)

# File 'lib/aws-sdk-firehose/types.rb', line 4985

class SnowflakeDestinationUpdate < 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,
  :cloud_watch_logging_options,
  :processing_configuration,
  :role_arn,
  :retry_options,
  :s3_backup_mode,
  :s3_update,
  :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:

• (Types::SnowflakeRoleConfiguration)

# File 'lib/aws-sdk-firehose/types.rb', line 4985

class SnowflakeDestinationUpdate < 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,
  :cloud_watch_logging_options,
  :processing_configuration,
  :role_arn,
  :retry_options,
  :s3_backup_mode,
  :s3_update,
  :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)

# File 'lib/aws-sdk-firehose/types.rb', line 4985

class SnowflakeDestinationUpdate < 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,
  :cloud_watch_logging_options,
  :processing_configuration,
  :role_arn,
  :retry_options,
  :s3_backup_mode,
  :s3_update,
  :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)

# File 'lib/aws-sdk-firehose/types.rb', line 4985

class SnowflakeDestinationUpdate < 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,
  :cloud_watch_logging_options,
  :processing_configuration,
  :role_arn,
  :retry_options,
  :s3_backup_mode,
  :s3_update,
  :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