1. Packages
  2. Airbyte Provider
  3. API Docs
  4. DestinationFirestore
airbyte 0.9.0 published on Wednesday, Apr 9, 2025 by airbytehq

airbyte.DestinationFirestore

Explore with Pulumi AI

DestinationFirestore 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.DestinationFirestore;
import com.pulumi.airbyte.DestinationFirestoreArgs;
import com.pulumi.airbyte.inputs.DestinationFirestoreConfigurationArgs;
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 myDestinationFirestore = new DestinationFirestore("myDestinationFirestore", DestinationFirestoreArgs.builder()
            .configuration(DestinationFirestoreConfigurationArgs.builder()
                .credentials_json("...my_credentials_json...")
                .project_id("...my_project_id...")
                .build())
            .definitionId("8a7f4b51-c84b-4fb3-b2d3-f23e10cb143f")
            .workspaceId("9839a229-aa78-46ab-be29-301131283087")
            .build());

    }
}
Copy
resources:
  myDestinationFirestore:
    type: airbyte:DestinationFirestore
    properties:
      configuration:
        credentials_json: '...my_credentials_json...'
        project_id: '...my_project_id...'
      definitionId: 8a7f4b51-c84b-4fb3-b2d3-f23e10cb143f
      workspaceId: 9839a229-aa78-46ab-be29-301131283087
Copy

Create DestinationFirestore Resource

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

Constructor syntax

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

@overload
def DestinationFirestore(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         configuration: Optional[DestinationFirestoreConfigurationArgs] = None,
                         workspace_id: Optional[str] = None,
                         definition_id: Optional[str] = None,
                         name: Optional[str] = None)
func NewDestinationFirestore(ctx *Context, name string, args DestinationFirestoreArgs, opts ...ResourceOption) (*DestinationFirestore, error)
public DestinationFirestore(string name, DestinationFirestoreArgs args, CustomResourceOptions? opts = null)
public DestinationFirestore(String name, DestinationFirestoreArgs args)
public DestinationFirestore(String name, DestinationFirestoreArgs args, CustomResourceOptions options)
type: airbyte:DestinationFirestore
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. DestinationFirestoreArgs
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. DestinationFirestoreArgs
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. DestinationFirestoreArgs
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. DestinationFirestoreArgs
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. DestinationFirestoreArgs
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 destinationFirestoreResource = new Airbyte.DestinationFirestore("destinationFirestoreResource", new()
{
    Configuration = new Airbyte.Inputs.DestinationFirestoreConfigurationArgs
    {
        ProjectId = "string",
        CredentialsJson = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
});
Copy
example, err := airbyte.NewDestinationFirestore(ctx, "destinationFirestoreResource", &airbyte.DestinationFirestoreArgs{
Configuration: &.DestinationFirestoreConfigurationArgs{
ProjectId: pulumi.String("string"),
CredentialsJson: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
})
Copy
var destinationFirestoreResource = new DestinationFirestore("destinationFirestoreResource", DestinationFirestoreArgs.builder()
    .configuration(DestinationFirestoreConfigurationArgs.builder()
        .projectId("string")
        .credentialsJson("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .build());
Copy
destination_firestore_resource = airbyte.DestinationFirestore("destinationFirestoreResource",
    configuration={
        "project_id": "string",
        "credentials_json": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string")
Copy
const destinationFirestoreResource = new airbyte.DestinationFirestore("destinationFirestoreResource", {
    configuration: {
        projectId: "string",
        credentialsJson: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
});
Copy
type: airbyte:DestinationFirestore
properties:
    configuration:
        credentialsJson: string
        projectId: string
    definitionId: string
    name: string
    workspaceId: string
Copy

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

Configuration This property is required. DestinationFirestoreConfiguration
WorkspaceId This property is required. string
DefinitionId string
The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
Name string
Name of the destination e.g. dev-mysql-instance.
Configuration This property is required. DestinationFirestoreConfigurationArgs
WorkspaceId This property is required. string
DefinitionId string
The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
Name string
Name of the destination e.g. dev-mysql-instance.
configuration This property is required. DestinationFirestoreConfiguration
workspaceId This property is required. String
definitionId String
The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
name String
Name of the destination e.g. dev-mysql-instance.
configuration This property is required. DestinationFirestoreConfiguration
workspaceId This property is required. string
definitionId string
The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
name string
Name of the destination e.g. dev-mysql-instance.
configuration This property is required. DestinationFirestoreConfigurationArgs
workspace_id This property is required. str
definition_id str
The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
name str
Name of the destination e.g. dev-mysql-instance.
configuration This property is required. Property Map
workspaceId This property is required. String
definitionId String
The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
name String
Name of the destination e.g. dev-mysql-instance.

Outputs

All input properties are implicitly available as output properties. Additionally, the DestinationFirestore resource produces the following output properties:

CreatedAt double
DestinationId string
DestinationType string
Id string
The provider-assigned unique ID for this managed resource.
ResourceAllocation DestinationFirestoreResourceAllocation
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.
CreatedAt float64
DestinationId string
DestinationType string
Id string
The provider-assigned unique ID for this managed resource.
ResourceAllocation DestinationFirestoreResourceAllocation
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.
createdAt Double
destinationId String
destinationType String
id String
The provider-assigned unique ID for this managed resource.
resourceAllocation DestinationFirestoreResourceAllocation
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.
createdAt number
destinationId string
destinationType string
id string
The provider-assigned unique ID for this managed resource.
resourceAllocation DestinationFirestoreResourceAllocation
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.
created_at float
destination_id str
destination_type str
id str
The provider-assigned unique ID for this managed resource.
resource_allocation DestinationFirestoreResourceAllocation
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.
createdAt Number
destinationId String
destinationType String
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.

Look up Existing DestinationFirestore Resource

Get an existing DestinationFirestore 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?: DestinationFirestoreState, opts?: CustomResourceOptions): DestinationFirestore
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[DestinationFirestoreConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        destination_id: Optional[str] = None,
        destination_type: Optional[str] = None,
        name: Optional[str] = None,
        resource_allocation: Optional[DestinationFirestoreResourceAllocationArgs] = None,
        workspace_id: Optional[str] = None) -> DestinationFirestore
func GetDestinationFirestore(ctx *Context, name string, id IDInput, state *DestinationFirestoreState, opts ...ResourceOption) (*DestinationFirestore, error)
public static DestinationFirestore Get(string name, Input<string> id, DestinationFirestoreState? state, CustomResourceOptions? opts = null)
public static DestinationFirestore get(String name, Output<String> id, DestinationFirestoreState state, CustomResourceOptions options)
resources:  _:    type: airbyte:DestinationFirestore    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 DestinationFirestoreConfiguration
CreatedAt double
DefinitionId string
The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
DestinationId string
DestinationType string
Name string
Name of the destination e.g. dev-mysql-instance.
ResourceAllocation DestinationFirestoreResourceAllocation
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.
WorkspaceId string
Configuration DestinationFirestoreConfigurationArgs
CreatedAt float64
DefinitionId string
The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
DestinationId string
DestinationType string
Name string
Name of the destination e.g. dev-mysql-instance.
ResourceAllocation DestinationFirestoreResourceAllocationArgs
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.
WorkspaceId string
configuration DestinationFirestoreConfiguration
createdAt Double
definitionId String
The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
destinationId String
destinationType String
name String
Name of the destination e.g. dev-mysql-instance.
resourceAllocation DestinationFirestoreResourceAllocation
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.
workspaceId String
configuration DestinationFirestoreConfiguration
createdAt number
definitionId string
The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
destinationId string
destinationType string
name string
Name of the destination e.g. dev-mysql-instance.
resourceAllocation DestinationFirestoreResourceAllocation
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.
workspaceId string
configuration DestinationFirestoreConfigurationArgs
created_at float
definition_id str
The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
destination_id str
destination_type str
name str
Name of the destination e.g. dev-mysql-instance.
resource_allocation DestinationFirestoreResourceAllocationArgs
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.
workspace_id str
configuration Property Map
createdAt Number
definitionId String
The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
destinationId String
destinationType String
name String
Name of the destination 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.
workspaceId String

Supporting Types

DestinationFirestoreConfiguration
, DestinationFirestoreConfigurationArgs

ProjectId This property is required. string
The GCP project ID for the project containing the target BigQuery dataset.
CredentialsJson string
The contents of the JSON service account key. Check out the \n\ndocs\n\n if you need help generating this key. Default credentials will be used if this field is left empty.
ProjectId This property is required. string
The GCP project ID for the project containing the target BigQuery dataset.
CredentialsJson string
The contents of the JSON service account key. Check out the \n\ndocs\n\n if you need help generating this key. Default credentials will be used if this field is left empty.
projectId This property is required. String
The GCP project ID for the project containing the target BigQuery dataset.
credentialsJson String
The contents of the JSON service account key. Check out the \n\ndocs\n\n if you need help generating this key. Default credentials will be used if this field is left empty.
projectId This property is required. string
The GCP project ID for the project containing the target BigQuery dataset.
credentialsJson string
The contents of the JSON service account key. Check out the \n\ndocs\n\n if you need help generating this key. Default credentials will be used if this field is left empty.
project_id This property is required. str
The GCP project ID for the project containing the target BigQuery dataset.
credentials_json str
The contents of the JSON service account key. Check out the \n\ndocs\n\n if you need help generating this key. Default credentials will be used if this field is left empty.
projectId This property is required. String
The GCP project ID for the project containing the target BigQuery dataset.
credentialsJson String
The contents of the JSON service account key. Check out the \n\ndocs\n\n if you need help generating this key. Default credentials will be used if this field is left empty.

DestinationFirestoreResourceAllocation
, DestinationFirestoreResourceAllocationArgs

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

DestinationFirestoreResourceAllocationDefault
, DestinationFirestoreResourceAllocationDefaultArgs

DestinationFirestoreResourceAllocationJobSpecific
, DestinationFirestoreResourceAllocationJobSpecificArgs

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

DestinationFirestoreResourceAllocationJobSpecificResourceRequirements
, DestinationFirestoreResourceAllocationJobSpecificResourceRequirementsArgs

Import

$ pulumi import airbyte:index/destinationFirestore:DestinationFirestore my_airbyte_destination_firestore ""
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.