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

airbyte.SourceVitally

Explore with Pulumi AI

SourceVitally 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.SourceVitally;
import com.pulumi.airbyte.SourceVitallyArgs;
import com.pulumi.airbyte.inputs.SourceVitallyConfigurationArgs;
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 mySourceVitally = new SourceVitally("mySourceVitally", SourceVitallyArgs.builder()
            .configuration(SourceVitallyConfigurationArgs.builder()
                .basic_auth_header("...my_basic_auth_header...")
                .domain("...my_domain...")
                .secret_token("...my_secret_token...")
                .status("active")
                .build())
            .definitionId("4ccbdee7-a61d-46e5-a8de-2826c945689b")
            .secretId("...my_secret_id...")
            .workspaceId("7acaf484-b8ee-458f-8670-2faa57d0d719")
            .build());

    }
}
Copy
resources:
  mySourceVitally:
    type: airbyte:SourceVitally
    properties:
      configuration:
        basic_auth_header: '...my_basic_auth_header...'
        domain: '...my_domain...'
        secret_token: '...my_secret_token...'
        status: active
      definitionId: 4ccbdee7-a61d-46e5-a8de-2826c945689b
      secretId: '...my_secret_id...'
      workspaceId: 7acaf484-b8ee-458f-8670-2faa57d0d719
Copy

Create SourceVitally Resource

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

Constructor syntax

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

@overload
def SourceVitally(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  configuration: Optional[SourceVitallyConfigurationArgs] = None,
                  workspace_id: Optional[str] = None,
                  definition_id: Optional[str] = None,
                  name: Optional[str] = None,
                  secret_id: Optional[str] = None)
func NewSourceVitally(ctx *Context, name string, args SourceVitallyArgs, opts ...ResourceOption) (*SourceVitally, error)
public SourceVitally(string name, SourceVitallyArgs args, CustomResourceOptions? opts = null)
public SourceVitally(String name, SourceVitallyArgs args)
public SourceVitally(String name, SourceVitallyArgs args, CustomResourceOptions options)
type: airbyte:SourceVitally
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. SourceVitallyArgs
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. SourceVitallyArgs
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. SourceVitallyArgs
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. SourceVitallyArgs
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. SourceVitallyArgs
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 sourceVitallyResource = new Airbyte.SourceVitally("sourceVitallyResource", new()
{
    Configuration = new Airbyte.Inputs.SourceVitallyConfigurationArgs
    {
        Domain = "string",
        SecretToken = "string",
        Status = "string",
        BasicAuthHeader = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});
Copy
example, err := airbyte.NewSourceVitally(ctx, "sourceVitallyResource", &airbyte.SourceVitallyArgs{
	Configuration: &airbyte.SourceVitallyConfigurationArgs{
		Domain:          pulumi.String("string"),
		SecretToken:     pulumi.String("string"),
		Status:          pulumi.String("string"),
		BasicAuthHeader: pulumi.String("string"),
	},
	WorkspaceId:  pulumi.String("string"),
	DefinitionId: pulumi.String("string"),
	Name:         pulumi.String("string"),
	SecretId:     pulumi.String("string"),
})
Copy
var sourceVitallyResource = new SourceVitally("sourceVitallyResource", SourceVitallyArgs.builder()
    .configuration(SourceVitallyConfigurationArgs.builder()
        .domain("string")
        .secretToken("string")
        .status("string")
        .basicAuthHeader("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());
Copy
source_vitally_resource = airbyte.SourceVitally("sourceVitallyResource",
    configuration={
        "domain": "string",
        "secret_token": "string",
        "status": "string",
        "basic_auth_header": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")
Copy
const sourceVitallyResource = new airbyte.SourceVitally("sourceVitallyResource", {
    configuration: {
        domain: "string",
        secretToken: "string",
        status: "string",
        basicAuthHeader: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});
Copy
type: airbyte:SourceVitally
properties:
    configuration:
        basicAuthHeader: string
        domain: string
        secretToken: string
        status: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string
Copy

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

Configuration This property is required. SourceVitallyConfiguration
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. SourceVitallyConfigurationArgs
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. SourceVitallyConfiguration
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. SourceVitallyConfiguration
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. SourceVitallyConfigurationArgs
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 SourceVitally resource produces the following output properties:

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

Get an existing SourceVitally 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?: SourceVitallyState, opts?: CustomResourceOptions): SourceVitally
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceVitallyConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        name: Optional[str] = None,
        resource_allocation: Optional[SourceVitallyResourceAllocationArgs] = None,
        secret_id: Optional[str] = None,
        source_id: Optional[str] = None,
        source_type: Optional[str] = None,
        workspace_id: Optional[str] = None) -> SourceVitally
func GetSourceVitally(ctx *Context, name string, id IDInput, state *SourceVitallyState, opts ...ResourceOption) (*SourceVitally, error)
public static SourceVitally Get(string name, Input<string> id, SourceVitallyState? state, CustomResourceOptions? opts = null)
public static SourceVitally get(String name, Output<String> id, SourceVitallyState state, CustomResourceOptions options)
resources:  _:    type: airbyte:SourceVitally    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 SourceVitallyConfiguration
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 SourceVitallyResourceAllocation
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 SourceVitallyConfigurationArgs
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 SourceVitallyResourceAllocationArgs
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 SourceVitallyConfiguration
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 SourceVitallyResourceAllocation
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 SourceVitallyConfiguration
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 SourceVitallyResourceAllocation
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 SourceVitallyConfigurationArgs
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 SourceVitallyResourceAllocationArgs
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

SourceVitallyConfiguration
, SourceVitallyConfigurationArgs

Domain This property is required. string
Provide only the domain part, like https://{your-domain}.rest.vitally.io/. Keep empty if you don't have a subdomain.
SecretToken This property is required. string
sklivesecret_token
Status This property is required. string
Status of the Vitally accounts. One of the following values; active, churned, activeOrChurned. must be one of ["active", "churned", "activeOrChurned"]
BasicAuthHeader string
Basic Auth Header
Domain This property is required. string
Provide only the domain part, like https://{your-domain}.rest.vitally.io/. Keep empty if you don't have a subdomain.
SecretToken This property is required. string
sklivesecret_token
Status This property is required. string
Status of the Vitally accounts. One of the following values; active, churned, activeOrChurned. must be one of ["active", "churned", "activeOrChurned"]
BasicAuthHeader string
Basic Auth Header
domain This property is required. String
Provide only the domain part, like https://{your-domain}.rest.vitally.io/. Keep empty if you don't have a subdomain.
secretToken This property is required. String
sklivesecret_token
status This property is required. String
Status of the Vitally accounts. One of the following values; active, churned, activeOrChurned. must be one of ["active", "churned", "activeOrChurned"]
basicAuthHeader String
Basic Auth Header
domain This property is required. string
Provide only the domain part, like https://{your-domain}.rest.vitally.io/. Keep empty if you don't have a subdomain.
secretToken This property is required. string
sklivesecret_token
status This property is required. string
Status of the Vitally accounts. One of the following values; active, churned, activeOrChurned. must be one of ["active", "churned", "activeOrChurned"]
basicAuthHeader string
Basic Auth Header
domain This property is required. str
Provide only the domain part, like https://{your-domain}.rest.vitally.io/. Keep empty if you don't have a subdomain.
secret_token This property is required. str
sklivesecret_token
status This property is required. str
Status of the Vitally accounts. One of the following values; active, churned, activeOrChurned. must be one of ["active", "churned", "activeOrChurned"]
basic_auth_header str
Basic Auth Header
domain This property is required. String
Provide only the domain part, like https://{your-domain}.rest.vitally.io/. Keep empty if you don't have a subdomain.
secretToken This property is required. String
sklivesecret_token
status This property is required. String
Status of the Vitally accounts. One of the following values; active, churned, activeOrChurned. must be one of ["active", "churned", "activeOrChurned"]
basicAuthHeader String
Basic Auth Header

SourceVitallyResourceAllocation
, SourceVitallyResourceAllocationArgs

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

SourceVitallyResourceAllocationDefault
, SourceVitallyResourceAllocationDefaultArgs

SourceVitallyResourceAllocationJobSpecific
, SourceVitallyResourceAllocationJobSpecificArgs

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

SourceVitallyResourceAllocationJobSpecificResourceRequirements
, SourceVitallyResourceAllocationJobSpecificResourceRequirementsArgs

Import

$ pulumi import airbyte:index/sourceVitally:SourceVitally my_airbyte_source_vitally ""
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.