1. Packages
  2. Airbyte Provider
  3. API Docs
  4. SourceYandexMetrica
airbyte 0.10.0 published on Monday, Apr 14, 2025 by airbytehq

airbyte.SourceYandexMetrica

Explore with Pulumi AI

SourceYandexMetrica Resource

Example Usage

Coming soon!
Coming soon!
Coming soon!
Coming soon!
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.airbyte.SourceYandexMetrica;
import com.pulumi.airbyte.SourceYandexMetricaArgs;
import com.pulumi.airbyte.inputs.SourceYandexMetricaConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var mySourceYandexmetrica = new SourceYandexMetrica("mySourceYandexmetrica", SourceYandexMetricaArgs.builder()
            .configuration(SourceYandexMetricaConfigurationArgs.builder()
                .auth_token("...my_auth_token...")
                .counter_id("...my_counter_id...")
                .end_date("2022-01-01")
                .start_date("2022-01-01")
                .build())
            .definitionId("eb3105d8-6ddb-4c0f-ba1f-af83c6db215c")
            .secretId("...my_secret_id...")
            .workspaceId("6c60bbf7-6432-4c67-b204-c66a226265d9")
            .build());

    }
}
Copy
resources:
  mySourceYandexmetrica:
    type: airbyte:SourceYandexMetrica
    properties:
      configuration:
        auth_token: '...my_auth_token...'
        counter_id: '...my_counter_id...'
        end_date: 2022-01-01
        start_date: 2022-01-01
      definitionId: eb3105d8-6ddb-4c0f-ba1f-af83c6db215c
      secretId: '...my_secret_id...'
      workspaceId: 6c60bbf7-6432-4c67-b204-c66a226265d9
Copy

Create SourceYandexMetrica Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new SourceYandexMetrica(name: string, args: SourceYandexMetricaArgs, opts?: CustomResourceOptions);
@overload
def SourceYandexMetrica(resource_name: str,
                        args: SourceYandexMetricaArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def SourceYandexMetrica(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        configuration: Optional[SourceYandexMetricaConfigurationArgs] = None,
                        workspace_id: Optional[str] = None,
                        definition_id: Optional[str] = None,
                        name: Optional[str] = None,
                        secret_id: Optional[str] = None)
func NewSourceYandexMetrica(ctx *Context, name string, args SourceYandexMetricaArgs, opts ...ResourceOption) (*SourceYandexMetrica, error)
public SourceYandexMetrica(string name, SourceYandexMetricaArgs args, CustomResourceOptions? opts = null)
public SourceYandexMetrica(String name, SourceYandexMetricaArgs args)
public SourceYandexMetrica(String name, SourceYandexMetricaArgs args, CustomResourceOptions options)
type: airbyte:SourceYandexMetrica
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SourceYandexMetricaArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SourceYandexMetricaArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SourceYandexMetricaArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SourceYandexMetricaArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SourceYandexMetricaArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var sourceYandexMetricaResource = new Airbyte.SourceYandexMetrica("sourceYandexMetricaResource", new()
{
    Configuration = new Airbyte.Inputs.SourceYandexMetricaConfigurationArgs
    {
        AuthToken = "string",
        CounterId = "string",
        StartDate = "string",
        EndDate = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});
Copy
example, err := airbyte.NewSourceYandexMetrica(ctx, "sourceYandexMetricaResource", &airbyte.SourceYandexMetricaArgs{
Configuration: &.SourceYandexMetricaConfigurationArgs{
AuthToken: pulumi.String("string"),
CounterId: pulumi.String("string"),
StartDate: pulumi.String("string"),
EndDate: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})
Copy
var sourceYandexMetricaResource = new SourceYandexMetrica("sourceYandexMetricaResource", SourceYandexMetricaArgs.builder()
    .configuration(SourceYandexMetricaConfigurationArgs.builder()
        .authToken("string")
        .counterId("string")
        .startDate("string")
        .endDate("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());
Copy
source_yandex_metrica_resource = airbyte.SourceYandexMetrica("sourceYandexMetricaResource",
    configuration={
        "auth_token": "string",
        "counter_id": "string",
        "start_date": "string",
        "end_date": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")
Copy
const sourceYandexMetricaResource = new airbyte.SourceYandexMetrica("sourceYandexMetricaResource", {
    configuration: {
        authToken: "string",
        counterId: "string",
        startDate: "string",
        endDate: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});
Copy
type: airbyte:SourceYandexMetrica
properties:
    configuration:
        authToken: string
        counterId: string
        endDate: string
        startDate: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string
Copy

SourceYandexMetrica Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The SourceYandexMetrica resource accepts the following input properties:

Configuration This property is required. SourceYandexMetricaConfiguration
WorkspaceId This property is required. string
DefinitionId string
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string
Name of the source e.g. dev-mysql-instance.
SecretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
Configuration This property is required. SourceYandexMetricaConfigurationArgs
WorkspaceId This property is required. string
DefinitionId string
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string
Name of the source e.g. dev-mysql-instance.
SecretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
configuration This property is required. SourceYandexMetricaConfiguration
workspaceId This property is required. String
definitionId String
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String
Name of the source e.g. dev-mysql-instance.
secretId String
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
configuration This property is required. SourceYandexMetricaConfiguration
workspaceId This property is required. string
definitionId string
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name string
Name of the source e.g. dev-mysql-instance.
secretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
configuration This property is required. SourceYandexMetricaConfigurationArgs
workspace_id This property is required. str
definition_id str
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name str
Name of the source e.g. dev-mysql-instance.
secret_id str
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
configuration This property is required. Property Map
workspaceId This property is required. String
definitionId String
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String
Name of the source e.g. dev-mysql-instance.
secretId String
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

Outputs

All input properties are implicitly available as output properties. Additionally, the SourceYandexMetrica resource produces the following output properties:

CreatedAt double
Id string
The provider-assigned unique ID for this managed resource.
ResourceAllocation SourceYandexMetricaResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
SourceId string
SourceType string
CreatedAt float64
Id string
The provider-assigned unique ID for this managed resource.
ResourceAllocation SourceYandexMetricaResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
SourceId string
SourceType string
createdAt Double
id String
The provider-assigned unique ID for this managed resource.
resourceAllocation SourceYandexMetricaResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
sourceId String
sourceType String
createdAt number
id string
The provider-assigned unique ID for this managed resource.
resourceAllocation SourceYandexMetricaResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
sourceId string
sourceType string
created_at float
id str
The provider-assigned unique ID for this managed resource.
resource_allocation SourceYandexMetricaResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
source_id str
source_type str
createdAt Number
id String
The provider-assigned unique ID for this managed resource.
resourceAllocation Property Map
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
sourceId String
sourceType String

Look up Existing SourceYandexMetrica Resource

Get an existing SourceYandexMetrica resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: SourceYandexMetricaState, opts?: CustomResourceOptions): SourceYandexMetrica
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceYandexMetricaConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        name: Optional[str] = None,
        resource_allocation: Optional[SourceYandexMetricaResourceAllocationArgs] = None,
        secret_id: Optional[str] = None,
        source_id: Optional[str] = None,
        source_type: Optional[str] = None,
        workspace_id: Optional[str] = None) -> SourceYandexMetrica
func GetSourceYandexMetrica(ctx *Context, name string, id IDInput, state *SourceYandexMetricaState, opts ...ResourceOption) (*SourceYandexMetrica, error)
public static SourceYandexMetrica Get(string name, Input<string> id, SourceYandexMetricaState? state, CustomResourceOptions? opts = null)
public static SourceYandexMetrica get(String name, Output<String> id, SourceYandexMetricaState state, CustomResourceOptions options)
resources:  _:    type: airbyte:SourceYandexMetrica    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Configuration SourceYandexMetricaConfiguration
CreatedAt double
DefinitionId string
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string
Name of the source e.g. dev-mysql-instance.
ResourceAllocation SourceYandexMetricaResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
SecretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string
Configuration SourceYandexMetricaConfigurationArgs
CreatedAt float64
DefinitionId string
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string
Name of the source e.g. dev-mysql-instance.
ResourceAllocation SourceYandexMetricaResourceAllocationArgs
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
SecretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string
configuration SourceYandexMetricaConfiguration
createdAt Double
definitionId String
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String
Name of the source e.g. dev-mysql-instance.
resourceAllocation SourceYandexMetricaResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
secretId String
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String
configuration SourceYandexMetricaConfiguration
createdAt number
definitionId string
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name string
Name of the source e.g. dev-mysql-instance.
resourceAllocation SourceYandexMetricaResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
secretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId string
sourceType string
workspaceId string
configuration SourceYandexMetricaConfigurationArgs
created_at float
definition_id str
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name str
Name of the source e.g. dev-mysql-instance.
resource_allocation SourceYandexMetricaResourceAllocationArgs
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
secret_id str
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
source_id str
source_type str
workspace_id str
configuration Property Map
createdAt Number
definitionId String
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String
Name of the source e.g. dev-mysql-instance.
resourceAllocation Property Map
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
secretId String
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String

Supporting Types

SourceYandexMetricaConfiguration
, SourceYandexMetricaConfigurationArgs

AuthToken This property is required. string
Your Yandex Metrica API access token
CounterId This property is required. string
Counter ID
StartDate This property is required. string
Starting point for your data replication, in format of "YYYY-MM-DD".
EndDate string
Starting point for your data replication, in format of "YYYY-MM-DD". If not provided will sync till most recent date.
AuthToken This property is required. string
Your Yandex Metrica API access token
CounterId This property is required. string
Counter ID
StartDate This property is required. string
Starting point for your data replication, in format of "YYYY-MM-DD".
EndDate string
Starting point for your data replication, in format of "YYYY-MM-DD". If not provided will sync till most recent date.
authToken This property is required. String
Your Yandex Metrica API access token
counterId This property is required. String
Counter ID
startDate This property is required. String
Starting point for your data replication, in format of "YYYY-MM-DD".
endDate String
Starting point for your data replication, in format of "YYYY-MM-DD". If not provided will sync till most recent date.
authToken This property is required. string
Your Yandex Metrica API access token
counterId This property is required. string
Counter ID
startDate This property is required. string
Starting point for your data replication, in format of "YYYY-MM-DD".
endDate string
Starting point for your data replication, in format of "YYYY-MM-DD". If not provided will sync till most recent date.
auth_token This property is required. str
Your Yandex Metrica API access token
counter_id This property is required. str
Counter ID
start_date This property is required. str
Starting point for your data replication, in format of "YYYY-MM-DD".
end_date str
Starting point for your data replication, in format of "YYYY-MM-DD". If not provided will sync till most recent date.
authToken This property is required. String
Your Yandex Metrica API access token
counterId This property is required. String
Counter ID
startDate This property is required. String
Starting point for your data replication, in format of "YYYY-MM-DD".
endDate String
Starting point for your data replication, in format of "YYYY-MM-DD". If not provided will sync till most recent date.

SourceYandexMetricaResourceAllocation
, SourceYandexMetricaResourceAllocationArgs

Default SourceYandexMetricaResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
JobSpecifics List<SourceYandexMetricaResourceAllocationJobSpecific>
Default SourceYandexMetricaResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
JobSpecifics []SourceYandexMetricaResourceAllocationJobSpecific
default_ SourceYandexMetricaResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics List<SourceYandexMetricaResourceAllocationJobSpecific>
default SourceYandexMetricaResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics SourceYandexMetricaResourceAllocationJobSpecific[]
default Property Map
optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics List<Property Map>

SourceYandexMetricaResourceAllocationDefault
, SourceYandexMetricaResourceAllocationDefaultArgs

SourceYandexMetricaResourceAllocationJobSpecific
, SourceYandexMetricaResourceAllocationJobSpecificArgs

JobType string
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
ResourceRequirements SourceYandexMetricaResourceAllocationJobSpecificResourceRequirements
optional resource requirements to run workers (blank for unbounded allocations)
JobType string
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
ResourceRequirements SourceYandexMetricaResourceAllocationJobSpecificResourceRequirements
optional resource requirements to run workers (blank for unbounded allocations)
jobType String
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resourceRequirements SourceYandexMetricaResourceAllocationJobSpecificResourceRequirements
optional resource requirements to run workers (blank for unbounded allocations)
jobType string
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resourceRequirements SourceYandexMetricaResourceAllocationJobSpecificResourceRequirements
optional resource requirements to run workers (blank for unbounded allocations)
job_type str
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resource_requirements SourceYandexMetricaResourceAllocationJobSpecificResourceRequirements
optional resource requirements to run workers (blank for unbounded allocations)
jobType String
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resourceRequirements Property Map
optional resource requirements to run workers (blank for unbounded allocations)

SourceYandexMetricaResourceAllocationJobSpecificResourceRequirements
, SourceYandexMetricaResourceAllocationJobSpecificResourceRequirementsArgs

Import

$ pulumi import airbyte:index/sourceYandexMetrica:SourceYandexMetrica my_airbyte_source_yandex_metrica ""
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
airbyte airbytehq/terraform-provider-airbyte
License
Notes
This Pulumi package is based on the airbyte Terraform Provider.