airbyte 0.7.0-beta2, Mar 7 25

airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

airbyte.SourceAmplitude

Explore with Pulumi AI

airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

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.SourceAmplitude;
import com.pulumi.airbyte.SourceAmplitudeArgs;
import com.pulumi.airbyte.inputs.SourceAmplitudeConfigurationArgs;
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 mySourceAmplitude = new SourceAmplitude("mySourceAmplitude", SourceAmplitudeArgs.builder()
            .configuration(SourceAmplitudeConfigurationArgs.builder()
                .active_users_group_by_country(true)
                .api_key("...my_api_key...")
                .data_region("Standard Server")
                .request_time_range(8259)
                .secret_key("...my_secret_key...")
                .start_date("2021-01-25T00:00:00Z")
                .build())
            .definitionId("b1aed4fb-ea82-4954-b53a-577cd7c2a238")
            .secretId("...my_secret_id...")
            .workspaceId("a45cdcfa-7473-46e2-9daa-761557fbd83d")
            .build());

    }
}

resources:
  mySourceAmplitude:
    type: airbyte:SourceAmplitude
    properties:
      configuration:
        active_users_group_by_country: true
        api_key: '...my_api_key...'
        data_region: Standard Server
        request_time_range: 8259
        secret_key: '...my_secret_key...'
        start_date: 2021-01-25T00:00:00Z
      definitionId: b1aed4fb-ea82-4954-b53a-577cd7c2a238
      secretId: '...my_secret_id...'
      workspaceId: a45cdcfa-7473-46e2-9daa-761557fbd83d

Create SourceAmplitude Resource

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

Constructor syntax

new SourceAmplitude(name: string, args: SourceAmplitudeArgs, opts?: CustomResourceOptions);

@overload
def SourceAmplitude(resource_name: str,
                    args: SourceAmplitudeArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def SourceAmplitude(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    configuration: Optional[SourceAmplitudeConfigurationArgs] = None,
                    workspace_id: Optional[str] = None,
                    definition_id: Optional[str] = None,
                    name: Optional[str] = None,
                    secret_id: Optional[str] = None)

func NewSourceAmplitude(ctx *Context, name string, args SourceAmplitudeArgs, opts ...ResourceOption) (*SourceAmplitude, error)

public SourceAmplitude(string name, SourceAmplitudeArgs args, CustomResourceOptions? opts = null)

public SourceAmplitude(String name, SourceAmplitudeArgs args)
public SourceAmplitude(String name, SourceAmplitudeArgs args, CustomResourceOptions options)

type: airbyte:SourceAmplitude
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args SourceAmplitudeArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args SourceAmplitudeArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args SourceAmplitudeArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SourceAmplitudeArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SourceAmplitudeArgs: 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 sourceAmplitudeResource = new Airbyte.SourceAmplitude("sourceAmplitudeResource", new()
{
    Configuration = new Airbyte.Inputs.SourceAmplitudeConfigurationArgs
    {
        ApiKey = "string",
        SecretKey = "string",
        StartDate = "string",
        ActiveUsersGroupByCountry = false,
        DataRegion = "string",
        RequestTimeRange = 0,
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

example, err := airbyte.NewSourceAmplitude(ctx, "sourceAmplitudeResource", &airbyte.SourceAmplitudeArgs{
Configuration: &.SourceAmplitudeConfigurationArgs{
ApiKey: pulumi.String("string"),
SecretKey: pulumi.String("string"),
StartDate: pulumi.String("string"),
ActiveUsersGroupByCountry: pulumi.Bool(false),
DataRegion: pulumi.String("string"),
RequestTimeRange: pulumi.Float64(0),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})

var sourceAmplitudeResource = new SourceAmplitude("sourceAmplitudeResource", SourceAmplitudeArgs.builder()
    .configuration(SourceAmplitudeConfigurationArgs.builder()
        .apiKey("string")
        .secretKey("string")
        .startDate("string")
        .activeUsersGroupByCountry(false)
        .dataRegion("string")
        .requestTimeRange(0)
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

source_amplitude_resource = airbyte.SourceAmplitude("sourceAmplitudeResource",
    configuration={
        "api_key": "string",
        "secret_key": "string",
        "start_date": "string",
        "active_users_group_by_country": False,
        "data_region": "string",
        "request_time_range": 0,
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

const sourceAmplitudeResource = new airbyte.SourceAmplitude("sourceAmplitudeResource", {
    configuration: {
        apiKey: "string",
        secretKey: "string",
        startDate: "string",
        activeUsersGroupByCountry: false,
        dataRegion: "string",
        requestTimeRange: 0,
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

type: airbyte:SourceAmplitude
properties:
    configuration:
        activeUsersGroupByCountry: false
        apiKey: string
        dataRegion: string
        requestTimeRange: 0
        secretKey: string
        startDate: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

SourceAmplitude 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 SourceAmplitude resource accepts the following input properties:

Configuration SourceAmplitudeConfiguration
WorkspaceId 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 SourceAmplitudeConfigurationArgs
WorkspaceId 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 SourceAmplitudeConfiguration
workspaceId 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 SourceAmplitudeConfiguration
workspaceId 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 SourceAmplitudeConfigurationArgs
workspace_id 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 Property Map
workspaceId 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 SourceAmplitude resource produces the following output properties:

CreatedAt double
Id string: The provider-assigned unique ID for this managed resource.
SourceId string
SourceType string

CreatedAt float64
Id string: The provider-assigned unique ID for this managed resource.
SourceId string
SourceType string

createdAt Double
id String: The provider-assigned unique ID for this managed resource.
sourceId String
sourceType String

createdAt number
id string: The provider-assigned unique ID for this managed resource.
sourceId string
sourceType string

created_at float
id str: The provider-assigned unique ID for this managed resource.
source_id str
source_type str

createdAt Number
id String: The provider-assigned unique ID for this managed resource.
sourceId String
sourceType String

Look up Existing SourceAmplitude Resource

Get an existing SourceAmplitude 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?: SourceAmplitudeState, opts?: CustomResourceOptions): SourceAmplitude

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceAmplitudeConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        name: Optional[str] = None,
        secret_id: Optional[str] = None,
        source_id: Optional[str] = None,
        source_type: Optional[str] = None,
        workspace_id: Optional[str] = None) -> SourceAmplitude

func GetSourceAmplitude(ctx *Context, name string, id IDInput, state *SourceAmplitudeState, opts ...ResourceOption) (*SourceAmplitude, error)

public static SourceAmplitude Get(string name, Input<string> id, SourceAmplitudeState? state, CustomResourceOptions? opts = null)

public static SourceAmplitude get(String name, Output<String> id, SourceAmplitudeState state, CustomResourceOptions options)

resources:  _:    type: airbyte:SourceAmplitude    get:      id: ${id}

name: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: 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 SourceAmplitudeConfiguration
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.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string

Configuration SourceAmplitudeConfigurationArgs
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.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string

configuration SourceAmplitudeConfiguration
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.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String

configuration SourceAmplitudeConfiguration
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.
secretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId string
sourceType string
workspaceId string

configuration SourceAmplitudeConfigurationArgs
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.
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.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String

Supporting Types

SourceAmplitudeConfiguration, SourceAmplitudeConfigurationArgs

ApiKey string: Amplitude API Key. See the \n\nsetup guide\n\n for more information on how to obtain this key.
SecretKey string: Amplitude Secret Key. See the \n\nsetup guide\n\n for more information on how to obtain this key.
StartDate string: UTC date and time in the format 2021-01-25T00:00:00Z. Any data before this date will not be replicated.
ActiveUsersGroupByCountry bool: According to \n\nAmplitude documentation\n\n, grouping by Country is optional. If you face issues fetching the stream or checking the connection please set this field to False. Default: true
DataRegion string: Amplitude data region server. Default: "Standard Server"; must be one of ["Standard Server", "EU Residency Server"]
RequestTimeRange double: According to \n\nConsiderations\n\n too large of a time range in te request can cause a timeout error. In this case, please provide a shorter time interval in hours. Default: 24

ApiKey string: Amplitude API Key. See the \n\nsetup guide\n\n for more information on how to obtain this key.
SecretKey string: Amplitude Secret Key. See the \n\nsetup guide\n\n for more information on how to obtain this key.
StartDate string: UTC date and time in the format 2021-01-25T00:00:00Z. Any data before this date will not be replicated.
ActiveUsersGroupByCountry bool: According to \n\nAmplitude documentation\n\n, grouping by Country is optional. If you face issues fetching the stream or checking the connection please set this field to False. Default: true
DataRegion string: Amplitude data region server. Default: "Standard Server"; must be one of ["Standard Server", "EU Residency Server"]
RequestTimeRange float64: According to \n\nConsiderations\n\n too large of a time range in te request can cause a timeout error. In this case, please provide a shorter time interval in hours. Default: 24

apiKey String: Amplitude API Key. See the \n\nsetup guide\n\n for more information on how to obtain this key.
secretKey String: Amplitude Secret Key. See the \n\nsetup guide\n\n for more information on how to obtain this key.
startDate String: UTC date and time in the format 2021-01-25T00:00:00Z. Any data before this date will not be replicated.
activeUsersGroupByCountry Boolean: According to \n\nAmplitude documentation\n\n, grouping by Country is optional. If you face issues fetching the stream or checking the connection please set this field to False. Default: true
dataRegion String: Amplitude data region server. Default: "Standard Server"; must be one of ["Standard Server", "EU Residency Server"]
requestTimeRange Double: According to \n\nConsiderations\n\n too large of a time range in te request can cause a timeout error. In this case, please provide a shorter time interval in hours. Default: 24

apiKey string: Amplitude API Key. See the \n\nsetup guide\n\n for more information on how to obtain this key.
secretKey string: Amplitude Secret Key. See the \n\nsetup guide\n\n for more information on how to obtain this key.
startDate string: UTC date and time in the format 2021-01-25T00:00:00Z. Any data before this date will not be replicated.
activeUsersGroupByCountry boolean: According to \n\nAmplitude documentation\n\n, grouping by Country is optional. If you face issues fetching the stream or checking the connection please set this field to False. Default: true
dataRegion string: Amplitude data region server. Default: "Standard Server"; must be one of ["Standard Server", "EU Residency Server"]
requestTimeRange number: According to \n\nConsiderations\n\n too large of a time range in te request can cause a timeout error. In this case, please provide a shorter time interval in hours. Default: 24

api_key str: Amplitude API Key. See the \n\nsetup guide\n\n for more information on how to obtain this key.
secret_key str: Amplitude Secret Key. See the \n\nsetup guide\n\n for more information on how to obtain this key.
start_date str: UTC date and time in the format 2021-01-25T00:00:00Z. Any data before this date will not be replicated.
active_users_group_by_country bool: According to \n\nAmplitude documentation\n\n, grouping by Country is optional. If you face issues fetching the stream or checking the connection please set this field to False. Default: true
data_region str: Amplitude data region server. Default: "Standard Server"; must be one of ["Standard Server", "EU Residency Server"]
request_time_range float: According to \n\nConsiderations\n\n too large of a time range in te request can cause a timeout error. In this case, please provide a shorter time interval in hours. Default: 24

apiKey String: Amplitude API Key. See the \n\nsetup guide\n\n for more information on how to obtain this key.
secretKey String: Amplitude Secret Key. See the \n\nsetup guide\n\n for more information on how to obtain this key.
startDate String: UTC date and time in the format 2021-01-25T00:00:00Z. Any data before this date will not be replicated.
activeUsersGroupByCountry Boolean: According to \n\nAmplitude documentation\n\n, grouping by Country is optional. If you face issues fetching the stream or checking the connection please set this field to False. Default: true
dataRegion String: Amplitude data region server. Default: "Standard Server"; must be one of ["Standard Server", "EU Residency Server"]
requestTimeRange Number: According to \n\nConsiderations\n\n too large of a time range in te request can cause a timeout error. In this case, please provide a shorter time interval in hours. Default: 24

Import

$ pulumi import airbyte:index/sourceAmplitude:SourceAmplitude my_airbyte_source_amplitude ""

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.

airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

airbytehq/terraform-provider-airbyte

airbyte.SourceAmplitude

On this page

On this page

Example Usage

Create SourceAmplitude Resource

Constructor syntax

Parameters

Constructor example

SourceAmplitude Resource Properties

Inputs

Outputs

Look up Existing SourceAmplitude Resource

Supporting Types

SourceAmplitudeConfiguration, SourceAmplitudeConfigurationArgs

Import

Package Details

On this page

On this page