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

airbyte.SourceMention

Explore with Pulumi AI

SourceMention 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.SourceMention;
import com.pulumi.airbyte.SourceMentionArgs;
import com.pulumi.airbyte.inputs.SourceMentionConfigurationArgs;
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 mySourceMention = new SourceMention("mySourceMention", SourceMentionArgs.builder()
            .configuration(SourceMentionConfigurationArgs.builder()
                .api_key("...my_api_key...")
                .stats_end_date("2022-05-13")
                .stats_interval("P1D")
                .stats_start_date("2022-01-05T10:21:29.599Z")
                .build())
            .definitionId("07ad9325-90f1-4a3f-9610-b4d7e541abea")
            .secretId("...my_secret_id...")
            .workspaceId("a1f4e5ac-fef3-4693-ab2c-c34fd78362b3")
            .build());

    }
}
Copy
resources:
  mySourceMention:
    type: airbyte:SourceMention
    properties:
      configuration:
        api_key: '...my_api_key...'
        stats_end_date: 2022-05-13
        stats_interval: P1D
        stats_start_date: 2022-01-05T10:21:29.599Z
      definitionId: 07ad9325-90f1-4a3f-9610-b4d7e541abea
      secretId: '...my_secret_id...'
      workspaceId: a1f4e5ac-fef3-4693-ab2c-c34fd78362b3
Copy

Create SourceMention Resource

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

Constructor syntax

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

@overload
def SourceMention(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  configuration: Optional[SourceMentionConfigurationArgs] = None,
                  workspace_id: Optional[str] = None,
                  definition_id: Optional[str] = None,
                  name: Optional[str] = None,
                  secret_id: Optional[str] = None)
func NewSourceMention(ctx *Context, name string, args SourceMentionArgs, opts ...ResourceOption) (*SourceMention, error)
public SourceMention(string name, SourceMentionArgs args, CustomResourceOptions? opts = null)
public SourceMention(String name, SourceMentionArgs args)
public SourceMention(String name, SourceMentionArgs args, CustomResourceOptions options)
type: airbyte:SourceMention
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SourceMentionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SourceMentionArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SourceMentionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SourceMentionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SourceMentionArgs
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 sourceMentionResource = new Airbyte.SourceMention("sourceMentionResource", new()
{
    Configuration = new Airbyte.Inputs.SourceMentionConfigurationArgs
    {
        ApiKey = "string",
        StatsStartDate = "string",
        StatsEndDate = "string",
        StatsInterval = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});
Copy
example, err := airbyte.NewSourceMention(ctx, "sourceMentionResource", &airbyte.SourceMentionArgs{
	Configuration: &airbyte.SourceMentionConfigurationArgs{
		ApiKey:         pulumi.String("string"),
		StatsStartDate: pulumi.String("string"),
		StatsEndDate:   pulumi.String("string"),
		StatsInterval:  pulumi.String("string"),
	},
	WorkspaceId:  pulumi.String("string"),
	DefinitionId: pulumi.String("string"),
	Name:         pulumi.String("string"),
	SecretId:     pulumi.String("string"),
})
Copy
var sourceMentionResource = new SourceMention("sourceMentionResource", SourceMentionArgs.builder()
    .configuration(SourceMentionConfigurationArgs.builder()
        .apiKey("string")
        .statsStartDate("string")
        .statsEndDate("string")
        .statsInterval("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());
Copy
source_mention_resource = airbyte.SourceMention("sourceMentionResource",
    configuration={
        "api_key": "string",
        "stats_start_date": "string",
        "stats_end_date": "string",
        "stats_interval": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")
Copy
const sourceMentionResource = new airbyte.SourceMention("sourceMentionResource", {
    configuration: {
        apiKey: "string",
        statsStartDate: "string",
        statsEndDate: "string",
        statsInterval: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});
Copy
type: airbyte:SourceMention
properties:
    configuration:
        apiKey: string
        statsEndDate: string
        statsInterval: string
        statsStartDate: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string
Copy

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

Configuration This property is required. SourceMentionConfiguration
WorkspaceId This property is required. 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 This property is required. SourceMentionConfigurationArgs
WorkspaceId This property is required. 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 This property is required. SourceMentionConfiguration
workspaceId This property is required. 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 This property is required. SourceMentionConfiguration
workspaceId This property is required. 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 This property is required. SourceMentionConfigurationArgs
workspace_id This property is required. 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 This property is required. Property Map
workspaceId This property is required. 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 SourceMention resource produces the following output properties:

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

Get an existing SourceMention 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?: SourceMentionState, opts?: CustomResourceOptions): SourceMention
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceMentionConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        name: Optional[str] = None,
        resource_allocation: Optional[SourceMentionResourceAllocationArgs] = None,
        secret_id: Optional[str] = None,
        source_id: Optional[str] = None,
        source_type: Optional[str] = None,
        workspace_id: Optional[str] = None) -> SourceMention
func GetSourceMention(ctx *Context, name string, id IDInput, state *SourceMentionState, opts ...ResourceOption) (*SourceMention, error)
public static SourceMention Get(string name, Input<string> id, SourceMentionState? state, CustomResourceOptions? opts = null)
public static SourceMention get(String name, Output<String> id, SourceMentionState state, CustomResourceOptions options)
resources:  _:    type: airbyte:SourceMention    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 SourceMentionConfiguration
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 SourceMentionResourceAllocation
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 SourceMentionConfigurationArgs
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 SourceMentionResourceAllocationArgs
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 SourceMentionConfiguration
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 SourceMentionResourceAllocation
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 SourceMentionConfiguration
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 SourceMentionResourceAllocation
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 SourceMentionConfigurationArgs
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 SourceMentionResourceAllocationArgs
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

SourceMentionConfiguration
, SourceMentionConfigurationArgs

ApiKey This property is required. string
StatsStartDate This property is required. string
StatsEndDate string
StatsInterval string
Periodicity of statistics returned. it may be daily(P1D), weekly(P1W) or monthly(P1M). Default: "P1D"; must be one of ["P1D", "P1W", "P1M"]
ApiKey This property is required. string
StatsStartDate This property is required. string
StatsEndDate string
StatsInterval string
Periodicity of statistics returned. it may be daily(P1D), weekly(P1W) or monthly(P1M). Default: "P1D"; must be one of ["P1D", "P1W", "P1M"]
apiKey This property is required. String
statsStartDate This property is required. String
statsEndDate String
statsInterval String
Periodicity of statistics returned. it may be daily(P1D), weekly(P1W) or monthly(P1M). Default: "P1D"; must be one of ["P1D", "P1W", "P1M"]
apiKey This property is required. string
statsStartDate This property is required. string
statsEndDate string
statsInterval string
Periodicity of statistics returned. it may be daily(P1D), weekly(P1W) or monthly(P1M). Default: "P1D"; must be one of ["P1D", "P1W", "P1M"]
api_key This property is required. str
stats_start_date This property is required. str
stats_end_date str
stats_interval str
Periodicity of statistics returned. it may be daily(P1D), weekly(P1W) or monthly(P1M). Default: "P1D"; must be one of ["P1D", "P1W", "P1M"]
apiKey This property is required. String
statsStartDate This property is required. String
statsEndDate String
statsInterval String
Periodicity of statistics returned. it may be daily(P1D), weekly(P1W) or monthly(P1M). Default: "P1D"; must be one of ["P1D", "P1W", "P1M"]

SourceMentionResourceAllocation
, SourceMentionResourceAllocationArgs

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

SourceMentionResourceAllocationDefault
, SourceMentionResourceAllocationDefaultArgs

SourceMentionResourceAllocationJobSpecific
, SourceMentionResourceAllocationJobSpecificArgs

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

SourceMentionResourceAllocationJobSpecificResourceRequirements
, SourceMentionResourceAllocationJobSpecificResourceRequirementsArgs

Import

$ pulumi import airbyte:index/sourceMention:SourceMention my_airbyte_source_mention ""
Copy

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.