1. Packages
  2. Airbyte Provider
  3. API Docs
  4. SourceYousign
airbyte 0.10.0 published on Monday, Apr 14, 2025 by airbytehq

airbyte.SourceYousign

Explore with Pulumi AI

airbyte logo
airbyte 0.10.0 published on Monday, Apr 14, 2025 by airbytehq

    SourceYousign 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.SourceYousign;
    import com.pulumi.airbyte.SourceYousignArgs;
    import com.pulumi.airbyte.inputs.SourceYousignConfigurationArgs;
    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 mySourceYousign = new SourceYousign("mySourceYousign", SourceYousignArgs.builder()
                .configuration(SourceYousignConfigurationArgs.builder()
                    .api_key("...my_api_key...")
                    .limit("...my_limit...")
                    .start_date("2021-05-21T21:07:21.613Z")
                    .subdomain("api-sandbox")
                    .build())
                .definitionId("5a78ec38-3a27-4695-8c44-7a6d7e5af928")
                .secretId("...my_secret_id...")
                .workspaceId("5867a7a3-cda1-42de-aa60-dea6430ea0d1")
                .build());
    
        }
    }
    
    resources:
      mySourceYousign:
        type: airbyte:SourceYousign
        properties:
          configuration:
            api_key: '...my_api_key...'
            limit: '...my_limit...'
            start_date: 2021-05-21T21:07:21.613Z
            subdomain: api-sandbox
          definitionId: 5a78ec38-3a27-4695-8c44-7a6d7e5af928
          secretId: '...my_secret_id...'
          workspaceId: 5867a7a3-cda1-42de-aa60-dea6430ea0d1
    

    Create SourceYousign Resource

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

    Constructor syntax

    new SourceYousign(name: string, args: SourceYousignArgs, opts?: CustomResourceOptions);
    @overload
    def SourceYousign(resource_name: str,
                      args: SourceYousignArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def SourceYousign(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      configuration: Optional[SourceYousignConfigurationArgs] = None,
                      workspace_id: Optional[str] = None,
                      definition_id: Optional[str] = None,
                      name: Optional[str] = None,
                      secret_id: Optional[str] = None)
    func NewSourceYousign(ctx *Context, name string, args SourceYousignArgs, opts ...ResourceOption) (*SourceYousign, error)
    public SourceYousign(string name, SourceYousignArgs args, CustomResourceOptions? opts = null)
    public SourceYousign(String name, SourceYousignArgs args)
    public SourceYousign(String name, SourceYousignArgs args, CustomResourceOptions options)
    
    type: airbyte:SourceYousign
    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 SourceYousignArgs
    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 SourceYousignArgs
    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 SourceYousignArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SourceYousignArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SourceYousignArgs
    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 sourceYousignResource = new Airbyte.SourceYousign("sourceYousignResource", new()
    {
        Configuration = new Airbyte.Inputs.SourceYousignConfigurationArgs
        {
            ApiKey = "string",
            StartDate = "string",
            Limit = "string",
            Subdomain = "string",
        },
        WorkspaceId = "string",
        DefinitionId = "string",
        Name = "string",
        SecretId = "string",
    });
    
    example, err := airbyte.NewSourceYousign(ctx, "sourceYousignResource", &airbyte.SourceYousignArgs{
    	Configuration: &airbyte.SourceYousignConfigurationArgs{
    		ApiKey:    pulumi.String("string"),
    		StartDate: pulumi.String("string"),
    		Limit:     pulumi.String("string"),
    		Subdomain: pulumi.String("string"),
    	},
    	WorkspaceId:  pulumi.String("string"),
    	DefinitionId: pulumi.String("string"),
    	Name:         pulumi.String("string"),
    	SecretId:     pulumi.String("string"),
    })
    
    var sourceYousignResource = new SourceYousign("sourceYousignResource", SourceYousignArgs.builder()
        .configuration(SourceYousignConfigurationArgs.builder()
            .apiKey("string")
            .startDate("string")
            .limit("string")
            .subdomain("string")
            .build())
        .workspaceId("string")
        .definitionId("string")
        .name("string")
        .secretId("string")
        .build());
    
    source_yousign_resource = airbyte.SourceYousign("sourceYousignResource",
        configuration={
            "api_key": "string",
            "start_date": "string",
            "limit": "string",
            "subdomain": "string",
        },
        workspace_id="string",
        definition_id="string",
        name="string",
        secret_id="string")
    
    const sourceYousignResource = new airbyte.SourceYousign("sourceYousignResource", {
        configuration: {
            apiKey: "string",
            startDate: "string",
            limit: "string",
            subdomain: "string",
        },
        workspaceId: "string",
        definitionId: "string",
        name: "string",
        secretId: "string",
    });
    
    type: airbyte:SourceYousign
    properties:
        configuration:
            apiKey: string
            limit: string
            startDate: string
            subdomain: string
        definitionId: string
        name: string
        secretId: string
        workspaceId: string
    

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

    Configuration SourceYousignConfiguration
    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 SourceYousignConfigurationArgs
    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 SourceYousignConfiguration
    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 SourceYousignConfiguration
    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 SourceYousignConfigurationArgs
    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 SourceYousign resource produces the following output properties:

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

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

    SourceYousignConfiguration, SourceYousignConfigurationArgs

    ApiKey string
    API key or access token
    StartDate string
    Limit string
    Limit for each response objects. Default: "10"
    Subdomain string
    The subdomain for the Yousign API environment, such as 'sandbox' or 'api'. Default: "api"; must be one of ["api-sandbox", "api"]
    ApiKey string
    API key or access token
    StartDate string
    Limit string
    Limit for each response objects. Default: "10"
    Subdomain string
    The subdomain for the Yousign API environment, such as 'sandbox' or 'api'. Default: "api"; must be one of ["api-sandbox", "api"]
    apiKey String
    API key or access token
    startDate String
    limit String
    Limit for each response objects. Default: "10"
    subdomain String
    The subdomain for the Yousign API environment, such as 'sandbox' or 'api'. Default: "api"; must be one of ["api-sandbox", "api"]
    apiKey string
    API key or access token
    startDate string
    limit string
    Limit for each response objects. Default: "10"
    subdomain string
    The subdomain for the Yousign API environment, such as 'sandbox' or 'api'. Default: "api"; must be one of ["api-sandbox", "api"]
    api_key str
    API key or access token
    start_date str
    limit str
    Limit for each response objects. Default: "10"
    subdomain str
    The subdomain for the Yousign API environment, such as 'sandbox' or 'api'. Default: "api"; must be one of ["api-sandbox", "api"]
    apiKey String
    API key or access token
    startDate String
    limit String
    Limit for each response objects. Default: "10"
    subdomain String
    The subdomain for the Yousign API environment, such as 'sandbox' or 'api'. Default: "api"; must be one of ["api-sandbox", "api"]

    SourceYousignResourceAllocation, SourceYousignResourceAllocationArgs

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

    SourceYousignResourceAllocationDefault, SourceYousignResourceAllocationDefaultArgs

    SourceYousignResourceAllocationJobSpecific, SourceYousignResourceAllocationJobSpecificArgs

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

    SourceYousignResourceAllocationJobSpecificResourceRequirements, SourceYousignResourceAllocationJobSpecificResourceRequirementsArgs

    Import

    $ pulumi import airbyte:index/sourceYousign:SourceYousign my_airbyte_source_yousign ""
    

    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.10.0 published on Monday, Apr 14, 2025 by airbytehq