airbyte 0.7.0-beta2, Mar 7 25

airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

airbyte.SourcePocket

Explore with Pulumi AI

airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

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.SourcePocket;
import com.pulumi.airbyte.SourcePocketArgs;
import com.pulumi.airbyte.inputs.SourcePocketConfigurationArgs;
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 mySourcePocket = new SourcePocket("mySourcePocket", SourcePocketArgs.builder()
            .configuration(SourcePocketConfigurationArgs.builder()
                .access_token("...my_access_token...")
                .consumer_key("...my_consumer_key...")
                .content_type("image")
                .detail_type("simple")
                .domain("...my_domain...")
                .favorite(true)
                .search("...my_search...")
                .since("2022-10-20 14:14:14")
                .sort("title")
                .state("archive")
                .tag("...my_tag...")
                .build())
            .definitionId("537e02d4-7629-4bae-bbba-24c68990b750")
            .secretId("...my_secret_id...")
            .workspaceId("4765e165-8e0a-4041-b564-c1ddbd283535")
            .build());

    }
}

resources:
  mySourcePocket:
    type: airbyte:SourcePocket
    properties:
      configuration:
        access_token: '...my_access_token...'
        consumer_key: '...my_consumer_key...'
        content_type: image
        detail_type: simple
        domain: '...my_domain...'
        favorite: true
        search: '...my_search...'
        since: 2022-10-20 14:14:14
        sort: title
        state: archive
        tag: '...my_tag...'
      definitionId: 537e02d4-7629-4bae-bbba-24c68990b750
      secretId: '...my_secret_id...'
      workspaceId: 4765e165-8e0a-4041-b564-c1ddbd283535

Create SourcePocket Resource

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

Constructor syntax

new SourcePocket(name: string, args: SourcePocketArgs, opts?: CustomResourceOptions);

@overload
def SourcePocket(resource_name: str,
                 args: SourcePocketArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def SourcePocket(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 configuration: Optional[SourcePocketConfigurationArgs] = None,
                 workspace_id: Optional[str] = None,
                 definition_id: Optional[str] = None,
                 name: Optional[str] = None,
                 secret_id: Optional[str] = None)

func NewSourcePocket(ctx *Context, name string, args SourcePocketArgs, opts ...ResourceOption) (*SourcePocket, error)

public SourcePocket(string name, SourcePocketArgs args, CustomResourceOptions? opts = null)

public SourcePocket(String name, SourcePocketArgs args)
public SourcePocket(String name, SourcePocketArgs args, CustomResourceOptions options)

type: airbyte:SourcePocket
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 SourcePocketArgs: 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 SourcePocketArgs: 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 SourcePocketArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SourcePocketArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SourcePocketArgs: 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 sourcePocketResource = new Airbyte.SourcePocket("sourcePocketResource", new()
{
    Configuration = new Airbyte.Inputs.SourcePocketConfigurationArgs
    {
        AccessToken = "string",
        ConsumerKey = "string",
        ContentType = "string",
        DetailType = "string",
        Domain = "string",
        Favorite = false,
        Search = "string",
        Since = "string",
        Sort = "string",
        State = "string",
        Tag = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

example, err := airbyte.NewSourcePocket(ctx, "sourcePocketResource", &airbyte.SourcePocketArgs{
Configuration: &.SourcePocketConfigurationArgs{
AccessToken: pulumi.String("string"),
ConsumerKey: pulumi.String("string"),
ContentType: pulumi.String("string"),
DetailType: pulumi.String("string"),
Domain: pulumi.String("string"),
Favorite: pulumi.Bool(false),
Search: pulumi.String("string"),
Since: pulumi.String("string"),
Sort: pulumi.String("string"),
State: pulumi.String("string"),
Tag: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})

var sourcePocketResource = new SourcePocket("sourcePocketResource", SourcePocketArgs.builder()
    .configuration(SourcePocketConfigurationArgs.builder()
        .accessToken("string")
        .consumerKey("string")
        .contentType("string")
        .detailType("string")
        .domain("string")
        .favorite(false)
        .search("string")
        .since("string")
        .sort("string")
        .state("string")
        .tag("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

source_pocket_resource = airbyte.SourcePocket("sourcePocketResource",
    configuration={
        "access_token": "string",
        "consumer_key": "string",
        "content_type": "string",
        "detail_type": "string",
        "domain": "string",
        "favorite": False,
        "search": "string",
        "since": "string",
        "sort": "string",
        "state": "string",
        "tag": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

const sourcePocketResource = new airbyte.SourcePocket("sourcePocketResource", {
    configuration: {
        accessToken: "string",
        consumerKey: "string",
        contentType: "string",
        detailType: "string",
        domain: "string",
        favorite: false,
        search: "string",
        since: "string",
        sort: "string",
        state: "string",
        tag: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

type: airbyte:SourcePocket
properties:
    configuration:
        accessToken: string
        consumerKey: string
        contentType: string
        detailType: string
        domain: string
        favorite: false
        search: string
        since: string
        sort: string
        state: string
        tag: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

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

Configuration SourcePocketConfiguration
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 SourcePocketConfigurationArgs
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 SourcePocketConfiguration
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 SourcePocketConfiguration
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 SourcePocketConfigurationArgs
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 SourcePocket 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 SourcePocket Resource

Get an existing SourcePocket 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?: SourcePocketState, opts?: CustomResourceOptions): SourcePocket

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourcePocketConfigurationArgs] = 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) -> SourcePocket

func GetSourcePocket(ctx *Context, name string, id IDInput, state *SourcePocketState, opts ...ResourceOption) (*SourcePocket, error)

public static SourcePocket Get(string name, Input<string> id, SourcePocketState? state, CustomResourceOptions? opts = null)

public static SourcePocket get(String name, Output<String> id, SourcePocketState state, CustomResourceOptions options)

resources:  _:    type: airbyte:SourcePocket    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 SourcePocketConfiguration
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 SourcePocketConfigurationArgs
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 SourcePocketConfiguration
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 SourcePocketConfiguration
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 SourcePocketConfigurationArgs
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

SourcePocketConfiguration, SourcePocketConfigurationArgs

AccessToken string: The user's Pocket access token.
ConsumerKey string: Your application's Consumer Key.
ContentType string: Select the content type of the items to retrieve. must be one of ["article", "video", "image"]
DetailType string: Select the granularity of the information about each item. must be one of ["simple", "complete"]
Domain string: Only return items from a particular domain.
Favorite bool: Retrieve only favorited items. Default: false
Search string: Only return items whose title or url contain the search string.
Since string: Only return items modified since the given timestamp.
Sort string: Sort retrieved items by the given criteria. must be one of ["newest", "oldest", "title", "site"]
State string: Select the state of the items to retrieve. must be one of ["unread", "archive", "all"]
Tag string: Return only items tagged with this tag name. Use untagged for retrieving only untagged items.

AccessToken string: The user's Pocket access token.
ConsumerKey string: Your application's Consumer Key.
ContentType string: Select the content type of the items to retrieve. must be one of ["article", "video", "image"]
DetailType string: Select the granularity of the information about each item. must be one of ["simple", "complete"]
Domain string: Only return items from a particular domain.
Favorite bool: Retrieve only favorited items. Default: false
Search string: Only return items whose title or url contain the search string.
Since string: Only return items modified since the given timestamp.
Sort string: Sort retrieved items by the given criteria. must be one of ["newest", "oldest", "title", "site"]
State string: Select the state of the items to retrieve. must be one of ["unread", "archive", "all"]
Tag string: Return only items tagged with this tag name. Use untagged for retrieving only untagged items.

accessToken String: The user's Pocket access token.
consumerKey String: Your application's Consumer Key.
contentType String: Select the content type of the items to retrieve. must be one of ["article", "video", "image"]
detailType String: Select the granularity of the information about each item. must be one of ["simple", "complete"]
domain String: Only return items from a particular domain.
favorite Boolean: Retrieve only favorited items. Default: false
search String: Only return items whose title or url contain the search string.
since String: Only return items modified since the given timestamp.
sort String: Sort retrieved items by the given criteria. must be one of ["newest", "oldest", "title", "site"]
state String: Select the state of the items to retrieve. must be one of ["unread", "archive", "all"]
tag String: Return only items tagged with this tag name. Use untagged for retrieving only untagged items.

accessToken string: The user's Pocket access token.
consumerKey string: Your application's Consumer Key.
contentType string: Select the content type of the items to retrieve. must be one of ["article", "video", "image"]
detailType string: Select the granularity of the information about each item. must be one of ["simple", "complete"]
domain string: Only return items from a particular domain.
favorite boolean: Retrieve only favorited items. Default: false
search string: Only return items whose title or url contain the search string.
since string: Only return items modified since the given timestamp.
sort string: Sort retrieved items by the given criteria. must be one of ["newest", "oldest", "title", "site"]
state string: Select the state of the items to retrieve. must be one of ["unread", "archive", "all"]
tag string: Return only items tagged with this tag name. Use untagged for retrieving only untagged items.

access_token str: The user's Pocket access token.
consumer_key str: Your application's Consumer Key.
content_type str: Select the content type of the items to retrieve. must be one of ["article", "video", "image"]
detail_type str: Select the granularity of the information about each item. must be one of ["simple", "complete"]
domain str: Only return items from a particular domain.
favorite bool: Retrieve only favorited items. Default: false
search str: Only return items whose title or url contain the search string.
since str: Only return items modified since the given timestamp.
sort str: Sort retrieved items by the given criteria. must be one of ["newest", "oldest", "title", "site"]
state str: Select the state of the items to retrieve. must be one of ["unread", "archive", "all"]
tag str: Return only items tagged with this tag name. Use untagged for retrieving only untagged items.

accessToken String: The user's Pocket access token.
consumerKey String: Your application's Consumer Key.
contentType String: Select the content type of the items to retrieve. must be one of ["article", "video", "image"]
detailType String: Select the granularity of the information about each item. must be one of ["simple", "complete"]
domain String: Only return items from a particular domain.
favorite Boolean: Retrieve only favorited items. Default: false
search String: Only return items whose title or url contain the search string.
since String: Only return items modified since the given timestamp.
sort String: Sort retrieved items by the given criteria. must be one of ["newest", "oldest", "title", "site"]
state String: Select the state of the items to retrieve. must be one of ["unread", "archive", "all"]
tag String: Return only items tagged with this tag name. Use untagged for retrieving only untagged items.

Import

$ pulumi import airbyte:index/sourcePocket:SourcePocket my_airbyte_source_pocket ""

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 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

airbytehq/terraform-provider-airbyte

airbyte.SourcePocket

On this page

On this page

Example Usage

Create SourcePocket Resource

Constructor syntax

Parameters

Constructor example

SourcePocket Resource Properties

Inputs

Outputs

Look up Existing SourcePocket Resource

Supporting Types

SourcePocketConfiguration, SourcePocketConfigurationArgs

Import

Package Details

On this page

On this page