airbyte 0.8.0-beta2, Mar 27 25

airbyte 0.8.0-beta2 published on Thursday, Mar 27, 2025 by airbytehq

airbyte.SourceNewsApi

Explore with Pulumi AI

airbyte 0.8.0-beta2 published on Thursday, Mar 27, 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.SourceNewsApi;
import com.pulumi.airbyte.SourceNewsApiArgs;
import com.pulumi.airbyte.inputs.SourceNewsApiConfigurationArgs;
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 mySourceNewsapi = new SourceNewsApi("mySourceNewsapi", SourceNewsApiArgs.builder()
            .configuration(SourceNewsApiConfigurationArgs.builder()
                .api_key("...my_api_key...")
                .category("sports")
                .country("ve")
                .domains("...")
                .end_date("2021-01-01")
                .exclude_domains("...")
                .language("se")
                .search_in("description")
                .search_query("+bitcoin OR +crypto")
                .sort_by("relevancy")
                .sources("...")
                .start_date("2021-01-01")
                .build())
            .definitionId("2055c47d-96b3-45fb-b87b-ce89b41640c2")
            .secretId("...my_secret_id...")
            .workspaceId("0cb04faa-3d4c-4274-9b19-99c077dc3d83")
            .build());

    }
}

resources:
  mySourceNewsapi:
    type: airbyte:SourceNewsApi
    properties:
      configuration:
        api_key: '...my_api_key...'
        category: sports
        country: ve
        domains:
          - '...'
        end_date: 2021-01-01
        exclude_domains:
          - '...'
        language: se
        search_in:
          - description
        search_query: +bitcoin OR +crypto
        sort_by: relevancy
        sources:
          - '...'
        start_date: 2021-01-01
      definitionId: 2055c47d-96b3-45fb-b87b-ce89b41640c2
      secretId: '...my_secret_id...'
      workspaceId: 0cb04faa-3d4c-4274-9b19-99c077dc3d83

Create SourceNewsApi Resource

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

Constructor syntax

new SourceNewsApi(name: string, args: SourceNewsApiArgs, opts?: CustomResourceOptions);

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

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

func NewSourceNewsApi(ctx *Context, name string, args SourceNewsApiArgs, opts ...ResourceOption) (*SourceNewsApi, error)

public SourceNewsApi(string name, SourceNewsApiArgs args, CustomResourceOptions? opts = null)

public SourceNewsApi(String name, SourceNewsApiArgs args)
public SourceNewsApi(String name, SourceNewsApiArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args SourceNewsApiArgs: 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 sourceNewsApiResource = new Airbyte.SourceNewsApi("sourceNewsApiResource", new()
{
    Configuration = new Airbyte.Inputs.SourceNewsApiConfigurationArgs
    {
        ApiKey = "string",
        Category = "string",
        Country = "string",
        Domains = new[]
        {
            "string",
        },
        EndDate = "string",
        ExcludeDomains = new[]
        {
            "string",
        },
        Language = "string",
        SearchIns = new[]
        {
            "string",
        },
        SearchQuery = "string",
        SortBy = "string",
        Sources = new[]
        {
            "string",
        },
        StartDate = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

example, err := airbyte.NewSourceNewsApi(ctx, "sourceNewsApiResource", &airbyte.SourceNewsApiArgs{
Configuration: &.SourceNewsApiConfigurationArgs{
ApiKey: pulumi.String("string"),
Category: pulumi.String("string"),
Country: pulumi.String("string"),
Domains: pulumi.StringArray{
pulumi.String("string"),
},
EndDate: pulumi.String("string"),
ExcludeDomains: pulumi.StringArray{
pulumi.String("string"),
},
Language: pulumi.String("string"),
SearchIns: pulumi.StringArray{
pulumi.String("string"),
},
SearchQuery: pulumi.String("string"),
SortBy: pulumi.String("string"),
Sources: pulumi.StringArray{
pulumi.String("string"),
},
StartDate: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})

var sourceNewsApiResource = new SourceNewsApi("sourceNewsApiResource", SourceNewsApiArgs.builder()
    .configuration(SourceNewsApiConfigurationArgs.builder()
        .apiKey("string")
        .category("string")
        .country("string")
        .domains("string")
        .endDate("string")
        .excludeDomains("string")
        .language("string")
        .searchIns("string")
        .searchQuery("string")
        .sortBy("string")
        .sources("string")
        .startDate("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

source_news_api_resource = airbyte.SourceNewsApi("sourceNewsApiResource",
    configuration={
        "api_key": "string",
        "category": "string",
        "country": "string",
        "domains": ["string"],
        "end_date": "string",
        "exclude_domains": ["string"],
        "language": "string",
        "search_ins": ["string"],
        "search_query": "string",
        "sort_by": "string",
        "sources": ["string"],
        "start_date": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

const sourceNewsApiResource = new airbyte.SourceNewsApi("sourceNewsApiResource", {
    configuration: {
        apiKey: "string",
        category: "string",
        country: "string",
        domains: ["string"],
        endDate: "string",
        excludeDomains: ["string"],
        language: "string",
        searchIns: ["string"],
        searchQuery: "string",
        sortBy: "string",
        sources: ["string"],
        startDate: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

type: airbyte:SourceNewsApi
properties:
    configuration:
        apiKey: string
        category: string
        country: string
        domains:
            - string
        endDate: string
        excludeDomains:
            - string
        language: string
        searchIns:
            - string
        searchQuery: string
        sortBy: string
        sources:
            - string
        startDate: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

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

Configuration SourceNewsApiConfiguration
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 SourceNewsApiConfigurationArgs
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 SourceNewsApiConfiguration
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 SourceNewsApiConfiguration
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 SourceNewsApiConfigurationArgs
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 SourceNewsApi resource produces the following output properties:

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

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceNewsApiConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        name: Optional[str] = None,
        resource_allocation: Optional[SourceNewsApiResourceAllocationArgs] = None,
        secret_id: Optional[str] = None,
        source_id: Optional[str] = None,
        source_type: Optional[str] = None,
        workspace_id: Optional[str] = None) -> SourceNewsApi

func GetSourceNewsApi(ctx *Context, name string, id IDInput, state *SourceNewsApiState, opts ...ResourceOption) (*SourceNewsApi, error)

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

public static SourceNewsApi get(String name, Output<String> id, SourceNewsApiState state, CustomResourceOptions options)

resources:  _:    type: airbyte:SourceNewsApi    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 SourceNewsApiConfiguration
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 SourceNewsApiResourceAllocation: 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 SourceNewsApiConfigurationArgs
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 SourceNewsApiResourceAllocationArgs: 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 SourceNewsApiConfiguration
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 SourceNewsApiResourceAllocation: 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 SourceNewsApiConfiguration
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 SourceNewsApiResourceAllocation: 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 SourceNewsApiConfigurationArgs
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 SourceNewsApiResourceAllocationArgs: 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

SourceNewsApiConfiguration, SourceNewsApiConfigurationArgs

ApiKey string: API Key
Category string: The category you want to get top headlines for. Default: "business"; must be one of ["business", "entertainment", "general", "health", "science", "sports", "technology"]
Country string: The 2-letter ISO 3166-1 code of the country you want to get headlines for. You can't mix this with the sources parameter. Default: "us"; must be one of ["ae", "ar", "at", "au", "be", "bg", "br", "ca", "ch", "cn", "co", "cu", "cz", "de", "eg", "fr", "gb", "gr", "hk", "hu", "id", "ie", "il", "in", "it", "jp", "kr", "lt", "lv", "ma", "mx", "my", "ng", "nl", "no", "nz", "ph", "pl", "pt", "ro", "rs", "ru", "sa", "se", "sg", "si", "sk", "th", "tr", "tw", "ua", "us", "ve", "za"]
Domains List<string>: A comma-seperated string of domains (eg bbc.co.uk, techcrunch.com, engadget.com) to restrict the search to.
EndDate string: A date and optional time for the newest article allowed. This should be in ISO 8601 format.
ExcludeDomains List<string>: A comma-seperated string of domains (eg bbc.co.uk, techcrunch.com, engadget.com) to remove from the results.
Language string: The 2-letter ISO-639-1 code of the language you want to get headlines for. Possible options: ar de en es fr he it nl no pt ru se ud zh. must be one of ["ar", "de", "en", "es", "fr", "he", "it", "nl", "no", "pt", "ru", "se", "ud", "zh"]
SearchIns List<string>: Where to apply search query. Possible values are: title, description, content.
SearchQuery string: Search query. See https://newsapi.org/docs/endpoints/everything for information.
SortBy string: The order to sort the articles in. Possible options: relevancy, popularity, publishedAt. Default: "publishedAt"; must be one of ["relevancy", "popularity", "publishedAt"]
Sources List<string>: Identifiers (maximum 20) for the news sources or blogs you want headlines from. Use the /sources endpoint to locate these programmatically or look at the sources index: https://newsapi.com/sources. Will override both country and category.
StartDate string: A date and optional time for the oldest article allowed. This should be in ISO 8601 format.

ApiKey string: API Key
Category string: The category you want to get top headlines for. Default: "business"; must be one of ["business", "entertainment", "general", "health", "science", "sports", "technology"]
Country string: The 2-letter ISO 3166-1 code of the country you want to get headlines for. You can't mix this with the sources parameter. Default: "us"; must be one of ["ae", "ar", "at", "au", "be", "bg", "br", "ca", "ch", "cn", "co", "cu", "cz", "de", "eg", "fr", "gb", "gr", "hk", "hu", "id", "ie", "il", "in", "it", "jp", "kr", "lt", "lv", "ma", "mx", "my", "ng", "nl", "no", "nz", "ph", "pl", "pt", "ro", "rs", "ru", "sa", "se", "sg", "si", "sk", "th", "tr", "tw", "ua", "us", "ve", "za"]
Domains []string: A comma-seperated string of domains (eg bbc.co.uk, techcrunch.com, engadget.com) to restrict the search to.
EndDate string: A date and optional time for the newest article allowed. This should be in ISO 8601 format.
ExcludeDomains []string: A comma-seperated string of domains (eg bbc.co.uk, techcrunch.com, engadget.com) to remove from the results.
Language string: The 2-letter ISO-639-1 code of the language you want to get headlines for. Possible options: ar de en es fr he it nl no pt ru se ud zh. must be one of ["ar", "de", "en", "es", "fr", "he", "it", "nl", "no", "pt", "ru", "se", "ud", "zh"]
SearchIns []string: Where to apply search query. Possible values are: title, description, content.
SearchQuery string: Search query. See https://newsapi.org/docs/endpoints/everything for information.
SortBy string: The order to sort the articles in. Possible options: relevancy, popularity, publishedAt. Default: "publishedAt"; must be one of ["relevancy", "popularity", "publishedAt"]
Sources []string: Identifiers (maximum 20) for the news sources or blogs you want headlines from. Use the /sources endpoint to locate these programmatically or look at the sources index: https://newsapi.com/sources. Will override both country and category.
StartDate string: A date and optional time for the oldest article allowed. This should be in ISO 8601 format.

apiKey String: API Key
category String: The category you want to get top headlines for. Default: "business"; must be one of ["business", "entertainment", "general", "health", "science", "sports", "technology"]
country String: The 2-letter ISO 3166-1 code of the country you want to get headlines for. You can't mix this with the sources parameter. Default: "us"; must be one of ["ae", "ar", "at", "au", "be", "bg", "br", "ca", "ch", "cn", "co", "cu", "cz", "de", "eg", "fr", "gb", "gr", "hk", "hu", "id", "ie", "il", "in", "it", "jp", "kr", "lt", "lv", "ma", "mx", "my", "ng", "nl", "no", "nz", "ph", "pl", "pt", "ro", "rs", "ru", "sa", "se", "sg", "si", "sk", "th", "tr", "tw", "ua", "us", "ve", "za"]
domains List<String>: A comma-seperated string of domains (eg bbc.co.uk, techcrunch.com, engadget.com) to restrict the search to.
endDate String: A date and optional time for the newest article allowed. This should be in ISO 8601 format.
excludeDomains List<String>: A comma-seperated string of domains (eg bbc.co.uk, techcrunch.com, engadget.com) to remove from the results.
language String: The 2-letter ISO-639-1 code of the language you want to get headlines for. Possible options: ar de en es fr he it nl no pt ru se ud zh. must be one of ["ar", "de", "en", "es", "fr", "he", "it", "nl", "no", "pt", "ru", "se", "ud", "zh"]
searchIns List<String>: Where to apply search query. Possible values are: title, description, content.
searchQuery String: Search query. See https://newsapi.org/docs/endpoints/everything for information.
sortBy String: The order to sort the articles in. Possible options: relevancy, popularity, publishedAt. Default: "publishedAt"; must be one of ["relevancy", "popularity", "publishedAt"]
sources List<String>: Identifiers (maximum 20) for the news sources or blogs you want headlines from. Use the /sources endpoint to locate these programmatically or look at the sources index: https://newsapi.com/sources. Will override both country and category.
startDate String: A date and optional time for the oldest article allowed. This should be in ISO 8601 format.

apiKey string: API Key
category string: The category you want to get top headlines for. Default: "business"; must be one of ["business", "entertainment", "general", "health", "science", "sports", "technology"]
country string: The 2-letter ISO 3166-1 code of the country you want to get headlines for. You can't mix this with the sources parameter. Default: "us"; must be one of ["ae", "ar", "at", "au", "be", "bg", "br", "ca", "ch", "cn", "co", "cu", "cz", "de", "eg", "fr", "gb", "gr", "hk", "hu", "id", "ie", "il", "in", "it", "jp", "kr", "lt", "lv", "ma", "mx", "my", "ng", "nl", "no", "nz", "ph", "pl", "pt", "ro", "rs", "ru", "sa", "se", "sg", "si", "sk", "th", "tr", "tw", "ua", "us", "ve", "za"]
domains string[]: A comma-seperated string of domains (eg bbc.co.uk, techcrunch.com, engadget.com) to restrict the search to.
endDate string: A date and optional time for the newest article allowed. This should be in ISO 8601 format.
excludeDomains string[]: A comma-seperated string of domains (eg bbc.co.uk, techcrunch.com, engadget.com) to remove from the results.
language string: The 2-letter ISO-639-1 code of the language you want to get headlines for. Possible options: ar de en es fr he it nl no pt ru se ud zh. must be one of ["ar", "de", "en", "es", "fr", "he", "it", "nl", "no", "pt", "ru", "se", "ud", "zh"]
searchIns string[]: Where to apply search query. Possible values are: title, description, content.
searchQuery string: Search query. See https://newsapi.org/docs/endpoints/everything for information.
sortBy string: The order to sort the articles in. Possible options: relevancy, popularity, publishedAt. Default: "publishedAt"; must be one of ["relevancy", "popularity", "publishedAt"]
sources string[]: Identifiers (maximum 20) for the news sources or blogs you want headlines from. Use the /sources endpoint to locate these programmatically or look at the sources index: https://newsapi.com/sources. Will override both country and category.
startDate string: A date and optional time for the oldest article allowed. This should be in ISO 8601 format.

api_key str: API Key
category str: The category you want to get top headlines for. Default: "business"; must be one of ["business", "entertainment", "general", "health", "science", "sports", "technology"]
country str: The 2-letter ISO 3166-1 code of the country you want to get headlines for. You can't mix this with the sources parameter. Default: "us"; must be one of ["ae", "ar", "at", "au", "be", "bg", "br", "ca", "ch", "cn", "co", "cu", "cz", "de", "eg", "fr", "gb", "gr", "hk", "hu", "id", "ie", "il", "in", "it", "jp", "kr", "lt", "lv", "ma", "mx", "my", "ng", "nl", "no", "nz", "ph", "pl", "pt", "ro", "rs", "ru", "sa", "se", "sg", "si", "sk", "th", "tr", "tw", "ua", "us", "ve", "za"]
domains Sequence[str]: A comma-seperated string of domains (eg bbc.co.uk, techcrunch.com, engadget.com) to restrict the search to.
end_date str: A date and optional time for the newest article allowed. This should be in ISO 8601 format.
exclude_domains Sequence[str]: A comma-seperated string of domains (eg bbc.co.uk, techcrunch.com, engadget.com) to remove from the results.
language str: The 2-letter ISO-639-1 code of the language you want to get headlines for. Possible options: ar de en es fr he it nl no pt ru se ud zh. must be one of ["ar", "de", "en", "es", "fr", "he", "it", "nl", "no", "pt", "ru", "se", "ud", "zh"]
search_ins Sequence[str]: Where to apply search query. Possible values are: title, description, content.
search_query str: Search query. See https://newsapi.org/docs/endpoints/everything for information.
sort_by str: The order to sort the articles in. Possible options: relevancy, popularity, publishedAt. Default: "publishedAt"; must be one of ["relevancy", "popularity", "publishedAt"]
sources Sequence[str]: Identifiers (maximum 20) for the news sources or blogs you want headlines from. Use the /sources endpoint to locate these programmatically or look at the sources index: https://newsapi.com/sources. Will override both country and category.
start_date str: A date and optional time for the oldest article allowed. This should be in ISO 8601 format.

apiKey String: API Key
category String: The category you want to get top headlines for. Default: "business"; must be one of ["business", "entertainment", "general", "health", "science", "sports", "technology"]
country String: The 2-letter ISO 3166-1 code of the country you want to get headlines for. You can't mix this with the sources parameter. Default: "us"; must be one of ["ae", "ar", "at", "au", "be", "bg", "br", "ca", "ch", "cn", "co", "cu", "cz", "de", "eg", "fr", "gb", "gr", "hk", "hu", "id", "ie", "il", "in", "it", "jp", "kr", "lt", "lv", "ma", "mx", "my", "ng", "nl", "no", "nz", "ph", "pl", "pt", "ro", "rs", "ru", "sa", "se", "sg", "si", "sk", "th", "tr", "tw", "ua", "us", "ve", "za"]
domains List<String>: A comma-seperated string of domains (eg bbc.co.uk, techcrunch.com, engadget.com) to restrict the search to.
endDate String: A date and optional time for the newest article allowed. This should be in ISO 8601 format.
excludeDomains List<String>: A comma-seperated string of domains (eg bbc.co.uk, techcrunch.com, engadget.com) to remove from the results.
language String: The 2-letter ISO-639-1 code of the language you want to get headlines for. Possible options: ar de en es fr he it nl no pt ru se ud zh. must be one of ["ar", "de", "en", "es", "fr", "he", "it", "nl", "no", "pt", "ru", "se", "ud", "zh"]
searchIns List<String>: Where to apply search query. Possible values are: title, description, content.
searchQuery String: Search query. See https://newsapi.org/docs/endpoints/everything for information.
sortBy String: The order to sort the articles in. Possible options: relevancy, popularity, publishedAt. Default: "publishedAt"; must be one of ["relevancy", "popularity", "publishedAt"]
sources List<String>: Identifiers (maximum 20) for the news sources or blogs you want headlines from. Use the /sources endpoint to locate these programmatically or look at the sources index: https://newsapi.com/sources. Will override both country and category.
startDate String: A date and optional time for the oldest article allowed. This should be in ISO 8601 format.

SourceNewsApiResourceAllocation, SourceNewsApiResourceAllocationArgs

Default SourceNewsApiResourceAllocationDefault: optional resource requirements to run workers (blank for unbounded allocations)
JobSpecifics List<SourceNewsApiResourceAllocationJobSpecific>

Default SourceNewsApiResourceAllocationDefault: optional resource requirements to run workers (blank for unbounded allocations)
JobSpecifics []SourceNewsApiResourceAllocationJobSpecific

default_ SourceNewsApiResourceAllocationDefault: optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics List<SourceNewsApiResourceAllocationJobSpecific>

default SourceNewsApiResourceAllocationDefault: optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics SourceNewsApiResourceAllocationJobSpecific[]

default SourceNewsApiResourceAllocationDefault: optional resource requirements to run workers (blank for unbounded allocations)
job_specifics Sequence[SourceNewsApiResourceAllocationJobSpecific]

default Property Map: optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics List<Property Map>

SourceNewsApiResourceAllocationDefault, SourceNewsApiResourceAllocationDefaultArgs

CpuLimit string
CpuRequest string
EphemeralStorageLimit string
EphemeralStorageRequest string
MemoryLimit string
MemoryRequest string

CpuLimit string
CpuRequest string
EphemeralStorageLimit string
EphemeralStorageRequest string
MemoryLimit string
MemoryRequest string

cpuLimit String
cpuRequest String
ephemeralStorageLimit String
ephemeralStorageRequest String
memoryLimit String
memoryRequest String

cpuLimit string
cpuRequest string
ephemeralStorageLimit string
ephemeralStorageRequest string
memoryLimit string
memoryRequest string

cpu_limit str
cpu_request str
ephemeral_storage_limit str
ephemeral_storage_request str
memory_limit str
memory_request str

cpuLimit String
cpuRequest String
ephemeralStorageLimit String
ephemeralStorageRequest String
memoryLimit String
memoryRequest String

SourceNewsApiResourceAllocationJobSpecific, SourceNewsApiResourceAllocationJobSpecificArgs

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 SourceNewsApiResourceAllocationJobSpecificResourceRequirements: 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 SourceNewsApiResourceAllocationJobSpecificResourceRequirements: 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 SourceNewsApiResourceAllocationJobSpecificResourceRequirements: 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 SourceNewsApiResourceAllocationJobSpecificResourceRequirements: 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 SourceNewsApiResourceAllocationJobSpecificResourceRequirements: 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)

SourceNewsApiResourceAllocationJobSpecificResourceRequirements, SourceNewsApiResourceAllocationJobSpecificResourceRequirementsArgs

CpuLimit string
CpuRequest string
EphemeralStorageLimit string
EphemeralStorageRequest string
MemoryLimit string
MemoryRequest string

CpuLimit string
CpuRequest string
EphemeralStorageLimit string
EphemeralStorageRequest string
MemoryLimit string
MemoryRequest string

cpuLimit String
cpuRequest String
ephemeralStorageLimit String
ephemeralStorageRequest String
memoryLimit String
memoryRequest String

cpuLimit string
cpuRequest string
ephemeralStorageLimit string
ephemeralStorageRequest string
memoryLimit string
memoryRequest string

cpu_limit str
cpu_request str
ephemeral_storage_limit str
ephemeral_storage_request str
memory_limit str
memory_request str

cpuLimit String
cpuRequest String
ephemeralStorageLimit String
ephemeralStorageRequest String
memoryLimit String
memoryRequest String

Import

$ pulumi import airbyte:index/sourceNewsApi:SourceNewsApi my_airbyte_source_news_api ""

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.8.0-beta2 published on Thursday, Mar 27, 2025 by airbytehq

airbytehq/terraform-provider-airbyte

airbyte.SourceNewsApi

On this page

On this page

Example Usage

Create SourceNewsApi Resource

Constructor syntax

Parameters

Constructor example

SourceNewsApi Resource Properties

Inputs

Outputs

Look up Existing SourceNewsApi Resource

Supporting Types

SourceNewsApiConfiguration, SourceNewsApiConfigurationArgs

SourceNewsApiResourceAllocation, SourceNewsApiResourceAllocationArgs

SourceNewsApiResourceAllocationDefault, SourceNewsApiResourceAllocationDefaultArgs

SourceNewsApiResourceAllocationJobSpecific, SourceNewsApiResourceAllocationJobSpecificArgs

SourceNewsApiResourceAllocationJobSpecificResourceRequirements, SourceNewsApiResourceAllocationJobSpecificResourceRequirementsArgs

Import

Package Details

On this page

On this page