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

airbyte.SourceGitbook

Explore with Pulumi AI

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

    SourceGitbook 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.SourceGitbook;
import com.pulumi.airbyte.SourceGitbookArgs;
import com.pulumi.airbyte.inputs.SourceGitbookConfigurationArgs;
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 mySourceGitbook = new SourceGitbook("mySourceGitbook", SourceGitbookArgs.builder()
            .configuration(SourceGitbookConfigurationArgs.builder()
                .access_token("...my_access_token...")
                .space_id("...my_space_id...")
                .build())
            .definitionId("bd853e05-630d-4e28-852c-3ff9e84d219d")
            .secretId("...my_secret_id...")
            .workspaceId("a7f7be58-dede-4a51-8b06-e957318ad0a2")
            .build());

    }
}

    resources:
  mySourceGitbook:
    type: airbyte:SourceGitbook
    properties:
      configuration:
        access_token: '...my_access_token...'
        space_id: '...my_space_id...'
      definitionId: bd853e05-630d-4e28-852c-3ff9e84d219d
      secretId: '...my_secret_id...'
      workspaceId: a7f7be58-dede-4a51-8b06-e957318ad0a2

    Create SourceGitbook Resource

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

    Constructor syntax

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

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

    type: airbyte:SourceGitbook
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 SourceGitbookArgs
    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 SourceGitbookArgs
    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 SourceGitbookArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SourceGitbookArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SourceGitbookArgs
    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 sourceGitbookResource = new Airbyte.SourceGitbook("sourceGitbookResource", new()
{
    Configuration = new Airbyte.Inputs.SourceGitbookConfigurationArgs
    {
        AccessToken = "string",
        SpaceId = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

    example, err := airbyte.NewSourceGitbook(ctx, "sourceGitbookResource", &airbyte.SourceGitbookArgs{
Configuration: &.SourceGitbookConfigurationArgs{
AccessToken: pulumi.String("string"),
SpaceId: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})

    var sourceGitbookResource = new SourceGitbook("sourceGitbookResource", SourceGitbookArgs.builder()
    .configuration(SourceGitbookConfigurationArgs.builder()
        .accessToken("string")
        .spaceId("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

    source_gitbook_resource = airbyte.SourceGitbook("sourceGitbookResource",
    configuration={
        "access_token": "string",
        "space_id": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

    const sourceGitbookResource = new airbyte.SourceGitbook("sourceGitbookResource", {
    configuration: {
        accessToken: "string",
        spaceId: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

    type: airbyte:SourceGitbook
properties:
    configuration:
        accessToken: string
        spaceId: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

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

    Configuration SourceGitbookConfiguration
    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 SourceGitbookConfigurationArgs
    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 SourceGitbookConfiguration
    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 SourceGitbookConfiguration
    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 SourceGitbookConfigurationArgs
    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 SourceGitbook 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 SourceGitbook Resource

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

    SourceGitbookConfiguration, SourceGitbookConfigurationArgs

    AccessToken string
    Personal access token for authenticating with the GitBook API. You can view and manage your access tokens in the Developer settings of your GitBook user account.
    SpaceId string
    AccessToken string
    Personal access token for authenticating with the GitBook API. You can view and manage your access tokens in the Developer settings of your GitBook user account.
    SpaceId string
    accessToken String
    Personal access token for authenticating with the GitBook API. You can view and manage your access tokens in the Developer settings of your GitBook user account.
    spaceId String
    accessToken string
    Personal access token for authenticating with the GitBook API. You can view and manage your access tokens in the Developer settings of your GitBook user account.
    spaceId string
    access_token str
    Personal access token for authenticating with the GitBook API. You can view and manage your access tokens in the Developer settings of your GitBook user account.
    space_id str
    accessToken String
    Personal access token for authenticating with the GitBook API. You can view and manage your access tokens in the Developer settings of your GitBook user account.
    spaceId String

    Import

    $ pulumi import airbyte:index/sourceGitbook:SourceGitbook my_airbyte_source_gitbook ""

    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