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

airbyte.SourceFreshservice

Explore with Pulumi AI

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

    SourceFreshservice 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.SourceFreshservice;
import com.pulumi.airbyte.SourceFreshserviceArgs;
import com.pulumi.airbyte.inputs.SourceFreshserviceConfigurationArgs;
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 mySourceFreshservice = new SourceFreshservice("mySourceFreshservice", SourceFreshserviceArgs.builder()
            .configuration(SourceFreshserviceConfigurationArgs.builder()
                .api_key("...my_api_key...")
                .domain_name("mydomain.freshservice.com")
                .start_date("2020-10-01T00:00:00Z")
                .build())
            .definitionId("7323b15e-a556-41bf-9184-747295d9377c")
            .secretId("...my_secret_id...")
            .workspaceId("523a07d1-c20b-43f1-b999-23d34aaddfb9")
            .build());

    }
}

    resources:
  mySourceFreshservice:
    type: airbyte:SourceFreshservice
    properties:
      configuration:
        api_key: '...my_api_key...'
        domain_name: mydomain.freshservice.com
        start_date: 2020-10-01T00:00:00Z
      definitionId: 7323b15e-a556-41bf-9184-747295d9377c
      secretId: '...my_secret_id...'
      workspaceId: 523a07d1-c20b-43f1-b999-23d34aaddfb9

    Create SourceFreshservice Resource

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

    Constructor syntax

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

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

    type: airbyte:SourceFreshservice
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 SourceFreshserviceArgs
    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 SourceFreshserviceArgs
    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 SourceFreshserviceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SourceFreshserviceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SourceFreshserviceArgs
    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 sourceFreshserviceResource = new Airbyte.SourceFreshservice("sourceFreshserviceResource", new()
{
    Configuration = new Airbyte.Inputs.SourceFreshserviceConfigurationArgs
    {
        ApiKey = "string",
        DomainName = "string",
        StartDate = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

    example, err := airbyte.NewSourceFreshservice(ctx, "sourceFreshserviceResource", &airbyte.SourceFreshserviceArgs{
Configuration: &.SourceFreshserviceConfigurationArgs{
ApiKey: pulumi.String("string"),
DomainName: pulumi.String("string"),
StartDate: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})

    var sourceFreshserviceResource = new SourceFreshservice("sourceFreshserviceResource", SourceFreshserviceArgs.builder()
    .configuration(SourceFreshserviceConfigurationArgs.builder()
        .apiKey("string")
        .domainName("string")
        .startDate("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

    source_freshservice_resource = airbyte.SourceFreshservice("sourceFreshserviceResource",
    configuration={
        "api_key": "string",
        "domain_name": "string",
        "start_date": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

    const sourceFreshserviceResource = new airbyte.SourceFreshservice("sourceFreshserviceResource", {
    configuration: {
        apiKey: "string",
        domainName: "string",
        startDate: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

    type: airbyte:SourceFreshservice
properties:
    configuration:
        apiKey: string
        domainName: string
        startDate: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

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

    Configuration SourceFreshserviceConfiguration
    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 SourceFreshserviceConfigurationArgs
    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 SourceFreshserviceConfiguration
    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 SourceFreshserviceConfiguration
    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 SourceFreshserviceConfigurationArgs
    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 SourceFreshservice 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 SourceFreshservice Resource

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

    SourceFreshserviceConfiguration, SourceFreshserviceConfigurationArgs

    ApiKey string
    Freshservice API Key. See \n\nhere\n\n. The key is case sensitive.
    DomainName string
    The name of your Freshservice domain
    StartDate string
    UTC date and time in the format 2020-10-01T00:00:00Z. Any data before this date will not be replicated.
    ApiKey string
    Freshservice API Key. See \n\nhere\n\n. The key is case sensitive.
    DomainName string
    The name of your Freshservice domain
    StartDate string
    UTC date and time in the format 2020-10-01T00:00:00Z. Any data before this date will not be replicated.
    apiKey String
    Freshservice API Key. See \n\nhere\n\n. The key is case sensitive.
    domainName String
    The name of your Freshservice domain
    startDate String
    UTC date and time in the format 2020-10-01T00:00:00Z. Any data before this date will not be replicated.
    apiKey string
    Freshservice API Key. See \n\nhere\n\n. The key is case sensitive.
    domainName string
    The name of your Freshservice domain
    startDate string
    UTC date and time in the format 2020-10-01T00:00:00Z. Any data before this date will not be replicated.
    api_key str
    Freshservice API Key. See \n\nhere\n\n. The key is case sensitive.
    domain_name str
    The name of your Freshservice domain
    start_date str
    UTC date and time in the format 2020-10-01T00:00:00Z. Any data before this date will not be replicated.
    apiKey String
    Freshservice API Key. See \n\nhere\n\n. The key is case sensitive.
    domainName String
    The name of your Freshservice domain
    startDate String
    UTC date and time in the format 2020-10-01T00:00:00Z. Any data before this date will not be replicated.

    Import

    $ pulumi import airbyte:index/sourceFreshservice:SourceFreshservice my_airbyte_source_freshservice ""

    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