1. Packages
  2. Airbyte Provider
  3. API Docs
  4. SourceSurveySparrow
airbyte 0.8.0-beta2 published on Thursday, Mar 27, 2025 by airbytehq

airbyte.SourceSurveySparrow

Explore with Pulumi AI

SourceSurveySparrow 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.SourceSurveySparrow;
import com.pulumi.airbyte.SourceSurveySparrowArgs;
import com.pulumi.airbyte.inputs.SourceSurveySparrowConfigurationArgs;
import com.pulumi.airbyte.inputs.SourceSurveySparrowConfigurationRegionArgs;
import com.pulumi.airbyte.inputs.SourceSurveySparrowConfigurationRegionEuBasedAccountArgs;
import com.pulumi.airbyte.inputs.SourceSurveySparrowConfigurationRegionGlobalAccountArgs;
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 mySourceSurveysparrow = new SourceSurveySparrow("mySourceSurveysparrow", SourceSurveySparrowArgs.builder()
            .configuration(SourceSurveySparrowConfigurationArgs.builder()
                .access_token("...my_access_token...")
                .region(SourceSurveySparrowConfigurationRegionArgs.builder()
                    .euBasedAccount()
                    .globalAccount()
                    .build())
                .survey_id("{ \"see\": \"documentation\" }")
                .build())
            .definitionId("48652e9c-9d9f-4b9a-bf9d-0a1aba720b52")
            .secretId("...my_secret_id...")
            .workspaceId("828bf4a5-ea2e-4e51-999c-c2b98bc413dd")
            .build());

    }
}
Copy
resources:
  mySourceSurveysparrow:
    type: airbyte:SourceSurveySparrow
    properties:
      configuration:
        access_token: '...my_access_token...'
        region:
          euBasedAccount: {}
          globalAccount: {}
        survey_id:
          - '{ "see": "documentation" }'
      definitionId: 48652e9c-9d9f-4b9a-bf9d-0a1aba720b52
      secretId: '...my_secret_id...'
      workspaceId: 828bf4a5-ea2e-4e51-999c-c2b98bc413dd
Copy

Create SourceSurveySparrow Resource

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

Constructor syntax

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

@overload
def SourceSurveySparrow(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        configuration: Optional[SourceSurveySparrowConfigurationArgs] = None,
                        workspace_id: Optional[str] = None,
                        definition_id: Optional[str] = None,
                        name: Optional[str] = None,
                        secret_id: Optional[str] = None)
func NewSourceSurveySparrow(ctx *Context, name string, args SourceSurveySparrowArgs, opts ...ResourceOption) (*SourceSurveySparrow, error)
public SourceSurveySparrow(string name, SourceSurveySparrowArgs args, CustomResourceOptions? opts = null)
public SourceSurveySparrow(String name, SourceSurveySparrowArgs args)
public SourceSurveySparrow(String name, SourceSurveySparrowArgs args, CustomResourceOptions options)
type: airbyte:SourceSurveySparrow
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. SourceSurveySparrowArgs
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. SourceSurveySparrowArgs
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. SourceSurveySparrowArgs
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. SourceSurveySparrowArgs
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. SourceSurveySparrowArgs
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 sourceSurveySparrowResource = new Airbyte.SourceSurveySparrow("sourceSurveySparrowResource", new()
{
    Configuration = new Airbyte.Inputs.SourceSurveySparrowConfigurationArgs
    {
        AccessToken = "string",
        Region = new Airbyte.Inputs.SourceSurveySparrowConfigurationRegionArgs
        {
            EuBasedAccount = null,
            GlobalAccount = null,
        },
        SurveyIds = new[]
        {
            "string",
        },
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});
Copy
example, err := airbyte.NewSourceSurveySparrow(ctx, "sourceSurveySparrowResource", &airbyte.SourceSurveySparrowArgs{
Configuration: &.SourceSurveySparrowConfigurationArgs{
AccessToken: pulumi.String("string"),
Region: &.SourceSurveySparrowConfigurationRegionArgs{
EuBasedAccount: &.SourceSurveySparrowConfigurationRegionEuBasedAccountArgs{
},
GlobalAccount: &.SourceSurveySparrowConfigurationRegionGlobalAccountArgs{
},
},
SurveyIds: pulumi.StringArray{
pulumi.String("string"),
},
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})
Copy
var sourceSurveySparrowResource = new SourceSurveySparrow("sourceSurveySparrowResource", SourceSurveySparrowArgs.builder()
    .configuration(SourceSurveySparrowConfigurationArgs.builder()
        .accessToken("string")
        .region(SourceSurveySparrowConfigurationRegionArgs.builder()
            .euBasedAccount()
            .globalAccount()
            .build())
        .surveyIds("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());
Copy
source_survey_sparrow_resource = airbyte.SourceSurveySparrow("sourceSurveySparrowResource",
    configuration={
        "access_token": "string",
        "region": {
            "eu_based_account": {},
            "global_account": {},
        },
        "survey_ids": ["string"],
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")
Copy
const sourceSurveySparrowResource = new airbyte.SourceSurveySparrow("sourceSurveySparrowResource", {
    configuration: {
        accessToken: "string",
        region: {
            euBasedAccount: {},
            globalAccount: {},
        },
        surveyIds: ["string"],
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});
Copy
type: airbyte:SourceSurveySparrow
properties:
    configuration:
        accessToken: string
        region:
            euBasedAccount: {}
            globalAccount: {}
        surveyIds:
            - string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string
Copy

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

Configuration This property is required. SourceSurveySparrowConfiguration
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. SourceSurveySparrowConfigurationArgs
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. SourceSurveySparrowConfiguration
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. SourceSurveySparrowConfiguration
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. SourceSurveySparrowConfigurationArgs
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 SourceSurveySparrow resource produces the following output properties:

CreatedAt double
Id string
The provider-assigned unique ID for this managed resource.
ResourceAllocation SourceSurveySparrowResourceAllocation
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 SourceSurveySparrowResourceAllocation
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 SourceSurveySparrowResourceAllocation
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 SourceSurveySparrowResourceAllocation
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 SourceSurveySparrowResourceAllocation
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 SourceSurveySparrow Resource

Get an existing SourceSurveySparrow 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?: SourceSurveySparrowState, opts?: CustomResourceOptions): SourceSurveySparrow
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceSurveySparrowConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        name: Optional[str] = None,
        resource_allocation: Optional[SourceSurveySparrowResourceAllocationArgs] = None,
        secret_id: Optional[str] = None,
        source_id: Optional[str] = None,
        source_type: Optional[str] = None,
        workspace_id: Optional[str] = None) -> SourceSurveySparrow
func GetSourceSurveySparrow(ctx *Context, name string, id IDInput, state *SourceSurveySparrowState, opts ...ResourceOption) (*SourceSurveySparrow, error)
public static SourceSurveySparrow Get(string name, Input<string> id, SourceSurveySparrowState? state, CustomResourceOptions? opts = null)
public static SourceSurveySparrow get(String name, Output<String> id, SourceSurveySparrowState state, CustomResourceOptions options)
resources:  _:    type: airbyte:SourceSurveySparrow    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 SourceSurveySparrowConfiguration
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 SourceSurveySparrowResourceAllocation
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 SourceSurveySparrowConfigurationArgs
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 SourceSurveySparrowResourceAllocationArgs
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 SourceSurveySparrowConfiguration
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 SourceSurveySparrowResourceAllocation
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 SourceSurveySparrowConfiguration
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 SourceSurveySparrowResourceAllocation
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 SourceSurveySparrowConfigurationArgs
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 SourceSurveySparrowResourceAllocationArgs
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

SourceSurveySparrowConfiguration
, SourceSurveySparrowConfigurationArgs

AccessToken This property is required. string
Your access token. See \n\nhere\n\n. The key is case sensitive.
Region SourceSurveySparrowConfigurationRegion
Is your account location is EU based? If yes, the base url to retrieve data will be different.
SurveyIds List<string>
A List of your survey ids for survey-specific stream
AccessToken This property is required. string
Your access token. See \n\nhere\n\n. The key is case sensitive.
Region SourceSurveySparrowConfigurationRegion
Is your account location is EU based? If yes, the base url to retrieve data will be different.
SurveyIds []string
A List of your survey ids for survey-specific stream
accessToken This property is required. String
Your access token. See \n\nhere\n\n. The key is case sensitive.
region SourceSurveySparrowConfigurationRegion
Is your account location is EU based? If yes, the base url to retrieve data will be different.
surveyIds List<String>
A List of your survey ids for survey-specific stream
accessToken This property is required. string
Your access token. See \n\nhere\n\n. The key is case sensitive.
region SourceSurveySparrowConfigurationRegion
Is your account location is EU based? If yes, the base url to retrieve data will be different.
surveyIds string[]
A List of your survey ids for survey-specific stream
access_token This property is required. str
Your access token. See \n\nhere\n\n. The key is case sensitive.
region SourceSurveySparrowConfigurationRegion
Is your account location is EU based? If yes, the base url to retrieve data will be different.
survey_ids Sequence[str]
A List of your survey ids for survey-specific stream
accessToken This property is required. String
Your access token. See \n\nhere\n\n. The key is case sensitive.
region Property Map
Is your account location is EU based? If yes, the base url to retrieve data will be different.
surveyIds List<String>
A List of your survey ids for survey-specific stream

SourceSurveySparrowConfigurationRegion
, SourceSurveySparrowConfigurationRegionArgs

SourceSurveySparrowResourceAllocation
, SourceSurveySparrowResourceAllocationArgs

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

SourceSurveySparrowResourceAllocationDefault
, SourceSurveySparrowResourceAllocationDefaultArgs

SourceSurveySparrowResourceAllocationJobSpecific
, SourceSurveySparrowResourceAllocationJobSpecificArgs

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 SourceSurveySparrowResourceAllocationJobSpecificResourceRequirements
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 SourceSurveySparrowResourceAllocationJobSpecificResourceRequirements
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 SourceSurveySparrowResourceAllocationJobSpecificResourceRequirements
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 SourceSurveySparrowResourceAllocationJobSpecificResourceRequirements
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 SourceSurveySparrowResourceAllocationJobSpecificResourceRequirements
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)

SourceSurveySparrowResourceAllocationJobSpecificResourceRequirements
, SourceSurveySparrowResourceAllocationJobSpecificResourceRequirementsArgs

Import

$ pulumi import airbyte:index/sourceSurveySparrow:SourceSurveySparrow my_airbyte_source_survey_sparrow ""
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.