Class: Aws::Firehose::Types::SnowflakeDestinationDescription

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-firehose/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

Instance Attribute Details

#account_urlString

URL for accessing your Snowflake account. This URL must include your account identifier. Note that the protocol (https://) and port number are optional.

Returns:

  • (String)


4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4092

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_optionsTypes::CloudWatchLoggingOptions

Describes the Amazon CloudWatch logging options for your delivery stream.



4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4092

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_nameString

The name of the record content column

Returns:

  • (String)


4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4092

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_optionString

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)


4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4092

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

#databaseString

All data in Snowflake is maintained in databases.

Returns:

  • (String)


4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4092

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_nameString

The name of the record metadata column

Returns:

  • (String)


4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4092

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_configurationTypes::ProcessingConfiguration

Describes a data processing configuration.



4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4092

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_optionsTypes::SnowflakeRetryOptions

The time period where Firehose will retry sending data to the chosen HTTP endpoint.



4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4092

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_arnString

The Amazon Resource Name (ARN) of the Snowflake role

Returns:

  • (String)


4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4092

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_modeString

Choose an S3 backup mode

Returns:

  • (String)


4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4092

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_descriptionTypes::S3DestinationDescription

Describes a destination in Amazon S3.



4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4092

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

#schemaString

Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views

Returns:

  • (String)


4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4092

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_configurationTypes::SnowflakeRoleConfiguration

Optionally configure a Snowflake role. Otherwise the default user role will be used.



4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4092

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_configurationTypes::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



4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4092

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

#tableString

All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.

Returns:

  • (String)


4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4092

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

#userString

User login name for the Snowflake account.

Returns:

  • (String)


4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4092

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