Yandex Cloud

Meltano Community

tap-yandex-cloud (data7m variant)

Open source connector supported by the Meltano Community, a growing community of over 5500+ data engineers.

Open source Join Slack community

The tap-yandex-cloud extractor pulls data from Yandex Cloud that can then be sent to a destination using a loader.

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

  1. Add the tap-yandex-cloud extractor to your project using 
    meltano add
     : 
    2. meltano add tap-yandex-cloud
  2. Configure the tap-yandex-cloud settings using 
    meltano config
     : 
    3. meltano config tap-yandex-cloud set --interactive
  3. Test that extractor settings are valid using 
    meltano config
     : 
    4. meltano config tap-yandex-cloud test

Next steps

If you run into any issues, learn how to get help.

Capabilities

The current capabilities for tap-yandex-cloud may have been automatically set when originally added to the Hub. Please review the capabilities when using this extractor. If you find they are out of date, please consider updating them by making a pull request to the YAML file that defines the capabilities for this extractor.

This plugin has the following capabilities:

  • about
  • activate-version
  • batch
  • catalog
  • discover
  • schema-flattening
  • state
  • stream-maps
  • structured-logging

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-yandex-cloud settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

You can also list these settings using 

meltano config
with the list subcommand: 

meltano config tap-yandex-cloud list

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

Aggregation Period (aggregation_period)

  • Environment variable: TAP_YANDEX_CLOUD_AGGREGATION_PERIOD
  • Default Value: DAY

Yandex Billing aggregation period. For the first version, use DAY.


Configure this setting directly using the following Meltano command:

meltano config tap-yandex-cloud set aggregation_period [value]

API Endpoint (api_endpoint)

  • Environment variable: TAP_YANDEX_CLOUD_API_ENDPOINT
  • Default Value: billing.api.cloud.yandex.net:443

Yandex Cloud Billing Usage gRPC API endpoint.


Configure this setting directly using the following Meltano command:

meltano config tap-yandex-cloud set api_endpoint [value]

Billing Account ID (billing_account_id)

  • Environment variable: TAP_YANDEX_CLOUD_BILLING_ACCOUNT_ID

Yandex Cloud billing account ID to fetch usage and cost data for.


Configure this setting directly using the following Meltano command:

meltano config tap-yandex-cloud set billing_account_id [value]

End Date (end_date)

  • Environment variable: TAP_YANDEX_CLOUD_END_DATE

Optional upper bound for usage data extraction. If omitted, the tap uses yesterday in UTC.


Configure this setting directly using the following Meltano command:

meltano config tap-yandex-cloud set end_date [value]

Max Key Length (flattening_max_key_length)

  • Environment variable: TAP_YANDEX_CLOUD_FLATTENING_MAX_KEY_LENGTH

The maximum length of a flattened key.


Configure this setting directly using the following Meltano command:

meltano config tap-yandex-cloud set flattening_max_key_length [value]

Flattening Separator (flattening_separator)

  • Environment variable: TAP_YANDEX_CLOUD_FLATTENING_SEPARATOR

The separator to use when flattening keys.


Configure this setting directly using the following Meltano command:

meltano config tap-yandex-cloud set flattening_separator [value]

IAM Token (iam_token)

  • Environment variable: TAP_YANDEX_CLOUD_IAM_TOKEN

Short-lived Yandex Cloud IAM token. Useful for local testing. For production, prefer service_account_key_json.


Configure this setting directly using the following Meltano command:

meltano config tap-yandex-cloud set iam_token [value]

Lookback Days (lookback_days)

  • Environment variable: TAP_YANDEX_CLOUD_LOOKBACK_DAYS
  • Default Value: 7

Number of days to re-read before the last saved state date to handle late billing adjustments.


Configure this setting directly using the following Meltano command:

meltano config tap-yandex-cloud set lookback_days [value]

Service Account Key JSON (service_account_key_json)

  • Environment variable: TAP_YANDEX_CLOUD_SERVICE_ACCOUNT_KEY_JSON

Yandex Cloud service account authorized key JSON. Used to authenticate automatically without manually rotating IAM tokens.


Configure this setting directly using the following Meltano command:

meltano config tap-yandex-cloud set service_account_key_json [value]

Start Date (start_date)

  • Environment variable: TAP_YANDEX_CLOUD_START_DATE

Lower bound for usage data extraction. Used as the initial start date before state exists.


Configure this setting directly using the following Meltano command:

meltano config tap-yandex-cloud set start_date [value]

Other streams (stream_maps.__else__)

  • Environment variable: TAP_YANDEX_CLOUD_STREAM_MAPS___ELSE__

Currently, only setting this to __NULL__ is supported. This will remove all other streams.


Configure this setting directly using the following Meltano command:

meltano config tap-yandex-cloud set stream_maps __else__ [value]
Expand To Show SDK Settings

Batch Compression Format (batch_config.encoding.compression)

  • Environment variable: TAP_YANDEX_CLOUD_BATCH_CONFIG_ENCODING_COMPRESSION

Compression format to use for batch files.


Configure this setting directly using the following Meltano command:

meltano config tap-yandex-cloud set batch_config encoding.compression [value]

Batch Encoding Format (batch_config.encoding.format)

  • Environment variable: TAP_YANDEX_CLOUD_BATCH_CONFIG_ENCODING_FORMAT

Format to use for batch files.


Configure this setting directly using the following Meltano command:

meltano config tap-yandex-cloud set batch_config encoding.format [value]

Batch Storage Prefix (batch_config.storage.prefix)

  • Environment variable: TAP_YANDEX_CLOUD_BATCH_CONFIG_STORAGE_PREFIX

Prefix to use when writing batch files.


Configure this setting directly using the following Meltano command:

meltano config tap-yandex-cloud set batch_config storage.prefix [value]

Batch Storage Root (batch_config.storage.root)

  • Environment variable: TAP_YANDEX_CLOUD_BATCH_CONFIG_STORAGE_ROOT

Root path to use when writing batch files.


Configure this setting directly using the following Meltano command:

meltano config tap-yandex-cloud set batch_config storage.root [value]

Faker Locale (faker_config.locale)

  • Environment variable: TAP_YANDEX_CLOUD_FAKER_CONFIG_LOCALE

One or more LCID locale strings to produce localized output for: https://faker.readthedocs.io/en/master/#localization


Configure this setting directly using the following Meltano command:

meltano config tap-yandex-cloud set faker_config locale [value]

Faker Seed (faker_config.seed)

  • Environment variable: TAP_YANDEX_CLOUD_FAKER_CONFIG_SEED

Value to seed the Faker generator for deterministic output: https://faker.readthedocs.io/en/master/#seeding-the-generator


Configure this setting directly using the following Meltano command:

meltano config tap-yandex-cloud set faker_config seed [value]

Enable Schema Flattening (flattening_enabled)

  • Environment variable: TAP_YANDEX_CLOUD_FLATTENING_ENABLED

'True' to enable schema flattening and automatically expand nested properties.


Configure this setting directly using the following Meltano command:

meltano config tap-yandex-cloud set flattening_enabled [value]

Max Flattening Depth (flattening_max_depth)

  • Environment variable: TAP_YANDEX_CLOUD_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.


Configure this setting directly using the following Meltano command:

meltano config tap-yandex-cloud set flattening_max_depth [value]

User Stream Map Configuration (stream_map_config)

  • Environment variable: TAP_YANDEX_CLOUD_STREAM_MAP_CONFIG

User-defined config values to be used within map expressions.


Configure this setting directly using the following Meltano command:

meltano config tap-yandex-cloud set stream_map_config [value]

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the tap-yandex-cloud extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the 
#plugins-general
channel.
Meltano Cloud

For ambitious analytics engineering teams that want an efficient, fully managed solution with personalised expert support, explore Meltano Cloud

  • No maintenance overhead
  • Rigorously tested
  • Expert support from Meltano
Learn more Book a demo

Install

meltano add tap-yandex-cloud

Maintenance Status

  • Maintenance Status
  • Built with the Meltano SDK

Repo

https://github.com/data7m/tap-yandex-cloud
  • Stars
  • Forks
  • Last Commit Date
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • data7m

PyPI Stats

  • PyPI Downloads
  • PyPI Package Version

Keywords

  • meltano_sdk