Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Airbyte Provider
  3. API Docs
  4. SourceEmploymentHero
airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq
airbytehq/terraform-provider-airbyte

airbyte.SourceEmploymentHero

Explore with Pulumi AI

airbyte logo
airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq
airbytehq/terraform-provider-airbyte

    SourceEmploymentHero 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.SourceEmploymentHero;
import com.pulumi.airbyte.SourceEmploymentHeroArgs;
import com.pulumi.airbyte.inputs.SourceEmploymentHeroConfigurationArgs;
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 mySourceEmploymenthero = new SourceEmploymentHero("mySourceEmploymenthero", SourceEmploymentHeroArgs.builder()
            .configuration(SourceEmploymentHeroConfigurationArgs.builder()
                .api_key("...my_api_key...")
                .employees_configids("{ \"see\": \"documentation\" }")
                .organization_configids("{ \"see\": \"documentation\" }")
                .build())
            .definitionId("54254f99-ed6c-4422-81b7-0e169eed9efe")
            .secretId("...my_secret_id...")
            .workspaceId("192c755c-19a3-4708-9bc6-03c6dcfb7dfb")
            .build());

    }
}

    resources:
  mySourceEmploymenthero:
    type: airbyte:SourceEmploymentHero
    properties:
      configuration:
        api_key: '...my_api_key...'
        employees_configids:
          - '{ "see": "documentation" }'
        organization_configids:
          - '{ "see": "documentation" }'
      definitionId: 54254f99-ed6c-4422-81b7-0e169eed9efe
      secretId: '...my_secret_id...'
      workspaceId: 192c755c-19a3-4708-9bc6-03c6dcfb7dfb

    Create SourceEmploymentHero Resource

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

    Constructor syntax

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

@overload
def SourceEmploymentHero(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         configuration: Optional[SourceEmploymentHeroConfigurationArgs] = None,
                         workspace_id: Optional[str] = None,
                         definition_id: Optional[str] = None,
                         name: Optional[str] = None,
                         secret_id: Optional[str] = None)
    func NewSourceEmploymentHero(ctx *Context, name string, args SourceEmploymentHeroArgs, opts ...ResourceOption) (*SourceEmploymentHero, error)
    public SourceEmploymentHero(string name, SourceEmploymentHeroArgs args, CustomResourceOptions? opts = null)
    public SourceEmploymentHero(String name, SourceEmploymentHeroArgs args)
public SourceEmploymentHero(String name, SourceEmploymentHeroArgs args, CustomResourceOptions options)

    type: airbyte:SourceEmploymentHero
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 SourceEmploymentHeroArgs
    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 SourceEmploymentHeroArgs
    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 SourceEmploymentHeroArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SourceEmploymentHeroArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SourceEmploymentHeroArgs
    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 sourceEmploymentHeroResource = new Airbyte.SourceEmploymentHero("sourceEmploymentHeroResource", new()
{
    Configuration = new Airbyte.Inputs.SourceEmploymentHeroConfigurationArgs
    {
        ApiKey = "string",
        EmployeesConfigids = new[]
        {
            "string",
        },
        OrganizationConfigids = new[]
        {
            "string",
        },
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

    example, err := airbyte.NewSourceEmploymentHero(ctx, "sourceEmploymentHeroResource", &airbyte.SourceEmploymentHeroArgs{
Configuration: &.SourceEmploymentHeroConfigurationArgs{
ApiKey: pulumi.String("string"),
EmployeesConfigids: pulumi.StringArray{
pulumi.String("string"),
},
OrganizationConfigids: pulumi.StringArray{
pulumi.String("string"),
},
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})

    var sourceEmploymentHeroResource = new SourceEmploymentHero("sourceEmploymentHeroResource", SourceEmploymentHeroArgs.builder()
    .configuration(SourceEmploymentHeroConfigurationArgs.builder()
        .apiKey("string")
        .employeesConfigids("string")
        .organizationConfigids("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

    source_employment_hero_resource = airbyte.SourceEmploymentHero("sourceEmploymentHeroResource",
    configuration={
        "api_key": "string",
        "employees_configids": ["string"],
        "organization_configids": ["string"],
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

    const sourceEmploymentHeroResource = new airbyte.SourceEmploymentHero("sourceEmploymentHeroResource", {
    configuration: {
        apiKey: "string",
        employeesConfigids: ["string"],
        organizationConfigids: ["string"],
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

    type: airbyte:SourceEmploymentHero
properties:
    configuration:
        apiKey: string
        employeesConfigids:
            - string
        organizationConfigids:
            - string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

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

    Configuration SourceEmploymentHeroConfiguration
    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 SourceEmploymentHeroConfigurationArgs
    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 SourceEmploymentHeroConfiguration
    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 SourceEmploymentHeroConfiguration
    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 SourceEmploymentHeroConfigurationArgs
    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 SourceEmploymentHero 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 SourceEmploymentHero Resource

    Get an existing SourceEmploymentHero 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?: SourceEmploymentHeroState, opts?: CustomResourceOptions): SourceEmploymentHero
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceEmploymentHeroConfigurationArgs] = 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) -> SourceEmploymentHero
    func GetSourceEmploymentHero(ctx *Context, name string, id IDInput, state *SourceEmploymentHeroState, opts ...ResourceOption) (*SourceEmploymentHero, error)
    public static SourceEmploymentHero Get(string name, Input<string> id, SourceEmploymentHeroState? state, CustomResourceOptions? opts = null)
    public static SourceEmploymentHero get(String name, Output<String> id, SourceEmploymentHeroState state, CustomResourceOptions options)
    resources:  _:    type: airbyte:SourceEmploymentHero    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 SourceEmploymentHeroConfiguration
    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 SourceEmploymentHeroConfigurationArgs
    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 SourceEmploymentHeroConfiguration
    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 SourceEmploymentHeroConfiguration
    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 SourceEmploymentHeroConfigurationArgs
    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

    SourceEmploymentHeroConfiguration, SourceEmploymentHeroConfigurationArgs

    ApiKey string
    EmployeesConfigids List<string>
    Employees IDs in the given organisation found in employees stream for passing to sub-streams
    OrganizationConfigids List<string>
    Organization ID which could be found as result of organizations stream to be used in other substreams
    ApiKey string
    EmployeesConfigids []string
    Employees IDs in the given organisation found in employees stream for passing to sub-streams
    OrganizationConfigids []string
    Organization ID which could be found as result of organizations stream to be used in other substreams
    apiKey String
    employeesConfigids List<String>
    Employees IDs in the given organisation found in employees stream for passing to sub-streams
    organizationConfigids List<String>
    Organization ID which could be found as result of organizations stream to be used in other substreams
    apiKey string
    employeesConfigids string[]
    Employees IDs in the given organisation found in employees stream for passing to sub-streams
    organizationConfigids string[]
    Organization ID which could be found as result of organizations stream to be used in other substreams
    api_key str
    employees_configids Sequence[str]
    Employees IDs in the given organisation found in employees stream for passing to sub-streams
    organization_configids Sequence[str]
    Organization ID which could be found as result of organizations stream to be used in other substreams
    apiKey String
    employeesConfigids List<String>
    Employees IDs in the given organisation found in employees stream for passing to sub-streams
    organizationConfigids List<String>
    Organization ID which could be found as result of organizations stream to be used in other substreams

    Import

    $ pulumi import airbyte:index/sourceEmploymentHero:SourceEmploymentHero my_airbyte_source_employment_hero ""

    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 logo
    airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq
    airbytehq/terraform-provider-airbyte