airbyte 0.7.0-beta2, Mar 7 25

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

airbyte.SourceOnesignal

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.SourceOnesignal;
import com.pulumi.airbyte.SourceOnesignalArgs;
import com.pulumi.airbyte.inputs.SourceOnesignalConfigurationArgs;
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 mySourceOnesignal = new SourceOnesignal("mySourceOnesignal", SourceOnesignalArgs.builder()
            .configuration(SourceOnesignalConfigurationArgs.builder()
                .applications(SourceOnesignalConfigurationApplicationArgs.builder()
                    .appApiKey("...my_app_api_key...")
                    .appId("...my_app_id...")
                    .appName("...my_app_name...")
                    .build())
                .outcome_names("os__session_duration.count,os__click.count,CustomOutcomeName.sum")
                .start_date("2020-11-16T00:00:00Z")
                .user_auth_key("...my_user_auth_key...")
                .build())
            .definitionId("9608243e-fba5-4235-8589-eba62995ea27")
            .secretId("...my_secret_id...")
            .workspaceId("92405047-4f40-4ac1-b6d6-132d4ec3edbf")
            .build());

    }
}

resources:
  mySourceOnesignal:
    type: airbyte:SourceOnesignal
    properties:
      configuration:
        applications:
          - appApiKey: '...my_app_api_key...'
            appId: '...my_app_id...'
            appName: '...my_app_name...'
        outcome_names: os__session_duration.count,os__click.count,CustomOutcomeName.sum
        start_date: 2020-11-16T00:00:00Z
        user_auth_key: '...my_user_auth_key...'
      definitionId: 9608243e-fba5-4235-8589-eba62995ea27
      secretId: '...my_secret_id...'
      workspaceId: 92405047-4f40-4ac1-b6d6-132d4ec3edbf

Create SourceOnesignal Resource

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

Constructor syntax

new SourceOnesignal(name: string, args: SourceOnesignalArgs, opts?: CustomResourceOptions);

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

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

func NewSourceOnesignal(ctx *Context, name string, args SourceOnesignalArgs, opts ...ResourceOption) (*SourceOnesignal, error)

public SourceOnesignal(string name, SourceOnesignalArgs args, CustomResourceOptions? opts = null)

public SourceOnesignal(String name, SourceOnesignalArgs args)
public SourceOnesignal(String name, SourceOnesignalArgs args, CustomResourceOptions options)

type: airbyte:SourceOnesignal
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 SourceOnesignalArgs: 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 SourceOnesignalArgs: 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 SourceOnesignalArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args SourceOnesignalArgs: 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 sourceOnesignalResource = new Airbyte.SourceOnesignal("sourceOnesignalResource", new()
{
    Configuration = new Airbyte.Inputs.SourceOnesignalConfigurationArgs
    {
        Applications = new[]
        {
            new Airbyte.Inputs.SourceOnesignalConfigurationApplicationArgs
            {
                AppApiKey = "string",
                AppId = "string",
                AppName = "string",
            },
        },
        OutcomeNames = "string",
        StartDate = "string",
        UserAuthKey = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

example, err := airbyte.NewSourceOnesignal(ctx, "sourceOnesignalResource", &airbyte.SourceOnesignalArgs{
Configuration: &.SourceOnesignalConfigurationArgs{
Applications: .SourceOnesignalConfigurationApplicationArray{
&.SourceOnesignalConfigurationApplicationArgs{
AppApiKey: pulumi.String("string"),
AppId: pulumi.String("string"),
AppName: pulumi.String("string"),
},
},
OutcomeNames: pulumi.String("string"),
StartDate: pulumi.String("string"),
UserAuthKey: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})

var sourceOnesignalResource = new SourceOnesignal("sourceOnesignalResource", SourceOnesignalArgs.builder()
    .configuration(SourceOnesignalConfigurationArgs.builder()
        .applications(SourceOnesignalConfigurationApplicationArgs.builder()
            .appApiKey("string")
            .appId("string")
            .appName("string")
            .build())
        .outcomeNames("string")
        .startDate("string")
        .userAuthKey("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

source_onesignal_resource = airbyte.SourceOnesignal("sourceOnesignalResource",
    configuration={
        "applications": [{
            "app_api_key": "string",
            "app_id": "string",
            "app_name": "string",
        }],
        "outcome_names": "string",
        "start_date": "string",
        "user_auth_key": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

const sourceOnesignalResource = new airbyte.SourceOnesignal("sourceOnesignalResource", {
    configuration: {
        applications: [{
            appApiKey: "string",
            appId: "string",
            appName: "string",
        }],
        outcomeNames: "string",
        startDate: "string",
        userAuthKey: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

type: airbyte:SourceOnesignal
properties:
    configuration:
        applications:
            - appApiKey: string
              appId: string
              appName: string
        outcomeNames: string
        startDate: string
        userAuthKey: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

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

Configuration SourceOnesignalConfiguration
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 SourceOnesignalConfigurationArgs
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 SourceOnesignalConfiguration
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 SourceOnesignalConfiguration
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 SourceOnesignalConfigurationArgs
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 SourceOnesignal 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 SourceOnesignal Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceOnesignalConfigurationArgs] = 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) -> SourceOnesignal

func GetSourceOnesignal(ctx *Context, name string, id IDInput, state *SourceOnesignalState, opts ...ResourceOption) (*SourceOnesignal, error)

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

public static SourceOnesignal get(String name, Output<String> id, SourceOnesignalState state, CustomResourceOptions options)

resources:  _:    type: airbyte:SourceOnesignal    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 SourceOnesignalConfiguration
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 SourceOnesignalConfigurationArgs
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 SourceOnesignalConfiguration
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 SourceOnesignalConfiguration
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 SourceOnesignalConfigurationArgs
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

SourceOnesignalConfiguration, SourceOnesignalConfigurationArgs

Applications List<SourceOnesignalConfigurationApplication>: Applications keys, see the \n\ndocs\n\n for more information on how to obtain this data
OutcomeNames string: Comma-separated list of names and the value (sum/count) for the returned outcome data. See the \n\ndocs\n\n for more details
StartDate string: The date from which you'd like to replicate data for OneSignal API, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated.
UserAuthKey string: OneSignal User Auth Key, see the \n\ndocs\n\n for more information on how to obtain this key.

Applications []SourceOnesignalConfigurationApplication: Applications keys, see the \n\ndocs\n\n for more information on how to obtain this data
OutcomeNames string: Comma-separated list of names and the value (sum/count) for the returned outcome data. See the \n\ndocs\n\n for more details
StartDate string: The date from which you'd like to replicate data for OneSignal API, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated.
UserAuthKey string: OneSignal User Auth Key, see the \n\ndocs\n\n for more information on how to obtain this key.

applications List<SourceOnesignalConfigurationApplication>: Applications keys, see the \n\ndocs\n\n for more information on how to obtain this data
outcomeNames String: Comma-separated list of names and the value (sum/count) for the returned outcome data. See the \n\ndocs\n\n for more details
startDate String: The date from which you'd like to replicate data for OneSignal API, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated.
userAuthKey String: OneSignal User Auth Key, see the \n\ndocs\n\n for more information on how to obtain this key.

applications SourceOnesignalConfigurationApplication[]: Applications keys, see the \n\ndocs\n\n for more information on how to obtain this data
outcomeNames string: Comma-separated list of names and the value (sum/count) for the returned outcome data. See the \n\ndocs\n\n for more details
startDate string: The date from which you'd like to replicate data for OneSignal API, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated.
userAuthKey string: OneSignal User Auth Key, see the \n\ndocs\n\n for more information on how to obtain this key.

applications Sequence[SourceOnesignalConfigurationApplication]: Applications keys, see the \n\ndocs\n\n for more information on how to obtain this data
outcome_names str: Comma-separated list of names and the value (sum/count) for the returned outcome data. See the \n\ndocs\n\n for more details
start_date str: The date from which you'd like to replicate data for OneSignal API, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated.
user_auth_key str: OneSignal User Auth Key, see the \n\ndocs\n\n for more information on how to obtain this key.

applications List<Property Map>: Applications keys, see the \n\ndocs\n\n for more information on how to obtain this data
outcomeNames String: Comma-separated list of names and the value (sum/count) for the returned outcome data. See the \n\ndocs\n\n for more details
startDate String: The date from which you'd like to replicate data for OneSignal API, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated.
userAuthKey String: OneSignal User Auth Key, see the \n\ndocs\n\n for more information on how to obtain this key.

SourceOnesignalConfigurationApplication, SourceOnesignalConfigurationApplicationArgs

AppApiKey string
AppId string
AppName string

AppApiKey string
AppId string
AppName string

appApiKey String
appId String
appName String

appApiKey string
appId string
appName string

app_api_key str
app_id str
app_name str

appApiKey String
appId String
appName String

Import

$ pulumi import airbyte:index/sourceOnesignal:SourceOnesignal my_airbyte_source_onesignal ""

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.SourceOnesignal

On this page

On this page

Example Usage

Create SourceOnesignal Resource

Constructor syntax

Parameters

Constructor example

SourceOnesignal Resource Properties

Inputs

Outputs

Look up Existing SourceOnesignal Resource

Supporting Types

SourceOnesignalConfiguration, SourceOnesignalConfigurationArgs

SourceOnesignalConfigurationApplication, SourceOnesignalConfigurationApplicationArgs

Import

Package Details

On this page

On this page