airbyte.SourceSmartsheets
Explore with Pulumi AI
SourceSmartsheets 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.SourceSmartsheets;
import com.pulumi.airbyte.SourceSmartsheetsArgs;
import com.pulumi.airbyte.inputs.SourceSmartsheetsConfigurationArgs;
import com.pulumi.airbyte.inputs.SourceSmartsheetsConfigurationCredentialsArgs;
import com.pulumi.airbyte.inputs.SourceSmartsheetsConfigurationCredentialsApiAccessTokenArgs;
import com.pulumi.airbyte.inputs.SourceSmartsheetsConfigurationCredentialsOAuth20Args;
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 mySourceSmartsheets = new SourceSmartsheets("mySourceSmartsheets", SourceSmartsheetsArgs.builder()
            .configuration(SourceSmartsheetsConfigurationArgs.builder()
                .credentials(SourceSmartsheetsConfigurationCredentialsArgs.builder()
                    .apiAccessToken(SourceSmartsheetsConfigurationCredentialsApiAccessTokenArgs.builder()
                        .accessToken("...my_access_token...")
                        .build())
                    .oAuth20(SourceSmartsheetsConfigurationCredentialsOAuth20Args.builder()
                        .accessToken("...my_access_token...")
                        .clientId("...my_client_id...")
                        .clientSecret("...my_client_secret...")
                        .refreshToken("...my_refresh_token...")
                        .tokenExpiryDate("2021-05-13T13:15:18.521Z")
                        .build())
                    .build())
                .is_report(false)
                .metadata_fields("row_expanded")
                .spreadsheet_id("...my_spreadsheet_id...")
                .build())
            .definitionId("002b9562-dfe0-4357-bd10-30c9f3cda4c7")
            .secretId("...my_secret_id...")
            .workspaceId("65f657d8-fd3b-49a9-af69-90fbc23c85f7")
            .build());
    }
}
resources:
  mySourceSmartsheets:
    type: airbyte:SourceSmartsheets
    properties:
      configuration:
        credentials:
          apiAccessToken:
            accessToken: '...my_access_token...'
          oAuth20:
            accessToken: '...my_access_token...'
            clientId: '...my_client_id...'
            clientSecret: '...my_client_secret...'
            refreshToken: '...my_refresh_token...'
            tokenExpiryDate: 2021-05-13T13:15:18.521Z
        is_report: false
        metadata_fields:
          - row_expanded
        spreadsheet_id: '...my_spreadsheet_id...'
      definitionId: 002b9562-dfe0-4357-bd10-30c9f3cda4c7
      secretId: '...my_secret_id...'
      workspaceId: 65f657d8-fd3b-49a9-af69-90fbc23c85f7
Create SourceSmartsheets Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SourceSmartsheets(name: string, args: SourceSmartsheetsArgs, opts?: CustomResourceOptions);@overload
def SourceSmartsheets(resource_name: str,
                      args: SourceSmartsheetsArgs,
                      opts: Optional[ResourceOptions] = None)
@overload
def SourceSmartsheets(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      configuration: Optional[SourceSmartsheetsConfigurationArgs] = None,
                      workspace_id: Optional[str] = None,
                      definition_id: Optional[str] = None,
                      name: Optional[str] = None,
                      secret_id: Optional[str] = None)func NewSourceSmartsheets(ctx *Context, name string, args SourceSmartsheetsArgs, opts ...ResourceOption) (*SourceSmartsheets, error)public SourceSmartsheets(string name, SourceSmartsheetsArgs args, CustomResourceOptions? opts = null)
public SourceSmartsheets(String name, SourceSmartsheetsArgs args)
public SourceSmartsheets(String name, SourceSmartsheetsArgs args, CustomResourceOptions options)
type: airbyte:SourceSmartsheets
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 SourceSmartsheetsArgs
- 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 SourceSmartsheetsArgs
- 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 SourceSmartsheetsArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SourceSmartsheetsArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SourceSmartsheetsArgs
- 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 sourceSmartsheetsResource = new Airbyte.SourceSmartsheets("sourceSmartsheetsResource", new()
{
    Configuration = new Airbyte.Inputs.SourceSmartsheetsConfigurationArgs
    {
        Credentials = new Airbyte.Inputs.SourceSmartsheetsConfigurationCredentialsArgs
        {
            ApiAccessToken = new Airbyte.Inputs.SourceSmartsheetsConfigurationCredentialsApiAccessTokenArgs
            {
                AccessToken = "string",
            },
            OAuth20 = new Airbyte.Inputs.SourceSmartsheetsConfigurationCredentialsOAuth20Args
            {
                AccessToken = "string",
                ClientId = "string",
                ClientSecret = "string",
                RefreshToken = "string",
                TokenExpiryDate = "string",
            },
        },
        SpreadsheetId = "string",
        IsReport = false,
        MetadataFields = new[]
        {
            "string",
        },
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});
example, err := airbyte.NewSourceSmartsheets(ctx, "sourceSmartsheetsResource", &airbyte.SourceSmartsheetsArgs{
Configuration: &.SourceSmartsheetsConfigurationArgs{
Credentials: &.SourceSmartsheetsConfigurationCredentialsArgs{
ApiAccessToken: &.SourceSmartsheetsConfigurationCredentialsApiAccessTokenArgs{
AccessToken: pulumi.String("string"),
},
OAuth20: &.SourceSmartsheetsConfigurationCredentialsOAuth20Args{
AccessToken: pulumi.String("string"),
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
RefreshToken: pulumi.String("string"),
TokenExpiryDate: pulumi.String("string"),
},
},
SpreadsheetId: pulumi.String("string"),
IsReport: pulumi.Bool(false),
MetadataFields: pulumi.StringArray{
pulumi.String("string"),
},
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})
var sourceSmartsheetsResource = new SourceSmartsheets("sourceSmartsheetsResource", SourceSmartsheetsArgs.builder()
    .configuration(SourceSmartsheetsConfigurationArgs.builder()
        .credentials(SourceSmartsheetsConfigurationCredentialsArgs.builder()
            .apiAccessToken(SourceSmartsheetsConfigurationCredentialsApiAccessTokenArgs.builder()
                .accessToken("string")
                .build())
            .oAuth20(SourceSmartsheetsConfigurationCredentialsOAuth20Args.builder()
                .accessToken("string")
                .clientId("string")
                .clientSecret("string")
                .refreshToken("string")
                .tokenExpiryDate("string")
                .build())
            .build())
        .spreadsheetId("string")
        .isReport(false)
        .metadataFields("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());
source_smartsheets_resource = airbyte.SourceSmartsheets("sourceSmartsheetsResource",
    configuration={
        "credentials": {
            "api_access_token": {
                "access_token": "string",
            },
            "o_auth20": {
                "access_token": "string",
                "client_id": "string",
                "client_secret": "string",
                "refresh_token": "string",
                "token_expiry_date": "string",
            },
        },
        "spreadsheet_id": "string",
        "is_report": False,
        "metadata_fields": ["string"],
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")
const sourceSmartsheetsResource = new airbyte.SourceSmartsheets("sourceSmartsheetsResource", {
    configuration: {
        credentials: {
            apiAccessToken: {
                accessToken: "string",
            },
            oAuth20: {
                accessToken: "string",
                clientId: "string",
                clientSecret: "string",
                refreshToken: "string",
                tokenExpiryDate: "string",
            },
        },
        spreadsheetId: "string",
        isReport: false,
        metadataFields: ["string"],
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});
type: airbyte:SourceSmartsheets
properties:
    configuration:
        credentials:
            apiAccessToken:
                accessToken: string
            oAuth20:
                accessToken: string
                clientId: string
                clientSecret: string
                refreshToken: string
                tokenExpiryDate: string
        isReport: false
        metadataFields:
            - string
        spreadsheetId: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string
SourceSmartsheets 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 SourceSmartsheets resource accepts the following input properties:
- Configuration
SourceSmartsheets Configuration 
- 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
SourceSmartsheets Configuration Args 
- 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
SourceSmartsheets Configuration 
- 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
SourceSmartsheets Configuration 
- 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
SourceSmartsheets Configuration Args 
- 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 SourceSmartsheets resource produces the following output properties:
- CreatedAt double
- Id string
- The provider-assigned unique ID for this managed resource.
- SourceId string
- SourceType string
- CreatedAt float64
- Id string
- The provider-assigned unique ID for this managed resource.
- SourceId string
- SourceType string
- createdAt Double
- id String
- The provider-assigned unique ID for this managed resource.
- sourceId String
- sourceType String
- createdAt number
- id string
- The provider-assigned unique ID for this managed resource.
- sourceId string
- sourceType string
- created_at float
- id str
- The provider-assigned unique ID for this managed resource.
- source_id str
- source_type str
- createdAt Number
- id String
- The provider-assigned unique ID for this managed resource.
- sourceId String
- sourceType String
Look up Existing SourceSmartsheets Resource
Get an existing SourceSmartsheets 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?: SourceSmartsheetsState, opts?: CustomResourceOptions): SourceSmartsheets@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceSmartsheetsConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        name: Optional[str] = None,
        secret_id: Optional[str] = None,
        source_id: Optional[str] = None,
        source_type: Optional[str] = None,
        workspace_id: Optional[str] = None) -> SourceSmartsheetsfunc GetSourceSmartsheets(ctx *Context, name string, id IDInput, state *SourceSmartsheetsState, opts ...ResourceOption) (*SourceSmartsheets, error)public static SourceSmartsheets Get(string name, Input<string> id, SourceSmartsheetsState? state, CustomResourceOptions? opts = null)public static SourceSmartsheets get(String name, Output<String> id, SourceSmartsheetsState state, CustomResourceOptions options)resources:  _:    type: airbyte:SourceSmartsheets    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.
- Configuration
SourceSmartsheets Configuration 
- CreatedAt double
- DefinitionId string
- The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
- Name string
- Name of the source e.g. dev-mysql-instance.
- SecretId string
- Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
- SourceId string
- SourceType string
- WorkspaceId string
- Configuration
SourceSmartsheets Configuration Args 
- CreatedAt float64
- DefinitionId string
- The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
- Name string
- Name of the source e.g. dev-mysql-instance.
- SecretId string
- Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
- SourceId string
- SourceType string
- WorkspaceId string
- configuration
SourceSmartsheets Configuration 
- createdAt Double
- definitionId String
- The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
- name String
- Name of the source e.g. dev-mysql-instance.
- secretId String
- Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
- sourceId String
- sourceType String
- workspaceId String
- configuration
SourceSmartsheets Configuration 
- createdAt number
- definitionId string
- The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
- name string
- Name of the source e.g. dev-mysql-instance.
- secretId string
- Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
- sourceId string
- sourceType string
- workspaceId string
- configuration
SourceSmartsheets Configuration Args 
- created_at float
- definition_id str
- The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
- name str
- Name of the source e.g. dev-mysql-instance.
- secret_id str
- Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
- source_id str
- source_type str
- workspace_id str
- configuration Property Map
- createdAt Number
- definitionId String
- The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
- name String
- Name of the source e.g. dev-mysql-instance.
- secretId String
- Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
- sourceId String
- sourceType String
- workspaceId String
Supporting Types
SourceSmartsheetsConfiguration, SourceSmartsheetsConfigurationArgs      
- Credentials
SourceSmartsheets Configuration Credentials 
- SpreadsheetId string
- The spreadsheet ID. Find it by opening the spreadsheet then navigating to File > Properties
- IsReport bool
- If true, the source will treat the provided sheetid as a report. If false, the source will treat the provided sheetid as a sheet. Default: false
- MetadataFields List<string>
- A List of available columns which metadata can be pulled from.
- Credentials
SourceSmartsheets Configuration Credentials 
- SpreadsheetId string
- The spreadsheet ID. Find it by opening the spreadsheet then navigating to File > Properties
- IsReport bool
- If true, the source will treat the provided sheetid as a report. If false, the source will treat the provided sheetid as a sheet. Default: false
- MetadataFields []string
- A List of available columns which metadata can be pulled from.
- credentials
SourceSmartsheets Configuration Credentials 
- spreadsheetId String
- The spreadsheet ID. Find it by opening the spreadsheet then navigating to File > Properties
- isReport Boolean
- If true, the source will treat the provided sheetid as a report. If false, the source will treat the provided sheetid as a sheet. Default: false
- metadataFields List<String>
- A List of available columns which metadata can be pulled from.
- credentials
SourceSmartsheets Configuration Credentials 
- spreadsheetId string
- The spreadsheet ID. Find it by opening the spreadsheet then navigating to File > Properties
- isReport boolean
- If true, the source will treat the provided sheetid as a report. If false, the source will treat the provided sheetid as a sheet. Default: false
- metadataFields string[]
- A List of available columns which metadata can be pulled from.
- credentials
SourceSmartsheets Configuration Credentials 
- spreadsheet_id str
- The spreadsheet ID. Find it by opening the spreadsheet then navigating to File > Properties
- is_report bool
- If true, the source will treat the provided sheetid as a report. If false, the source will treat the provided sheetid as a sheet. Default: false
- metadata_fields Sequence[str]
- A List of available columns which metadata can be pulled from.
- credentials Property Map
- spreadsheetId String
- The spreadsheet ID. Find it by opening the spreadsheet then navigating to File > Properties
- isReport Boolean
- If true, the source will treat the provided sheetid as a report. If false, the source will treat the provided sheetid as a sheet. Default: false
- metadataFields List<String>
- A List of available columns which metadata can be pulled from.
SourceSmartsheetsConfigurationCredentials, SourceSmartsheetsConfigurationCredentialsArgs        
SourceSmartsheetsConfigurationCredentialsApiAccessToken, SourceSmartsheetsConfigurationCredentialsApiAccessTokenArgs              
- AccessToken string
- The access token to use for accessing your data from Smartsheets. This access token must be generated by a user with at least read access to the data you'd like to replicate. Generate an access token in the Smartsheets main menu by clicking Account > Apps & Integrations > API Access. See the \n\nsetup guide\n\n for information on how to obtain this token.
- AccessToken string
- The access token to use for accessing your data from Smartsheets. This access token must be generated by a user with at least read access to the data you'd like to replicate. Generate an access token in the Smartsheets main menu by clicking Account > Apps & Integrations > API Access. See the \n\nsetup guide\n\n for information on how to obtain this token.
- accessToken String
- The access token to use for accessing your data from Smartsheets. This access token must be generated by a user with at least read access to the data you'd like to replicate. Generate an access token in the Smartsheets main menu by clicking Account > Apps & Integrations > API Access. See the \n\nsetup guide\n\n for information on how to obtain this token.
- accessToken string
- The access token to use for accessing your data from Smartsheets. This access token must be generated by a user with at least read access to the data you'd like to replicate. Generate an access token in the Smartsheets main menu by clicking Account > Apps & Integrations > API Access. See the \n\nsetup guide\n\n for information on how to obtain this token.
- access_token str
- The access token to use for accessing your data from Smartsheets. This access token must be generated by a user with at least read access to the data you'd like to replicate. Generate an access token in the Smartsheets main menu by clicking Account > Apps & Integrations > API Access. See the \n\nsetup guide\n\n for information on how to obtain this token.
- accessToken String
- The access token to use for accessing your data from Smartsheets. This access token must be generated by a user with at least read access to the data you'd like to replicate. Generate an access token in the Smartsheets main menu by clicking Account > Apps & Integrations > API Access. See the \n\nsetup guide\n\n for information on how to obtain this token.
SourceSmartsheetsConfigurationCredentialsOAuth20, SourceSmartsheetsConfigurationCredentialsOAuth20Args          
- AccessToken string
- Access Token for making authenticated requests.
- ClientId string
- The API ID of the SmartSheets developer application.
- ClientSecret string
- The API Secret the SmartSheets developer application.
- RefreshToken string
- The key to refresh the expired access_token.
- TokenExpiry stringDate 
- The date-time when the access token should be refreshed.
- AccessToken string
- Access Token for making authenticated requests.
- ClientId string
- The API ID of the SmartSheets developer application.
- ClientSecret string
- The API Secret the SmartSheets developer application.
- RefreshToken string
- The key to refresh the expired access_token.
- TokenExpiry stringDate 
- The date-time when the access token should be refreshed.
- accessToken String
- Access Token for making authenticated requests.
- clientId String
- The API ID of the SmartSheets developer application.
- clientSecret String
- The API Secret the SmartSheets developer application.
- refreshToken String
- The key to refresh the expired access_token.
- tokenExpiry StringDate 
- The date-time when the access token should be refreshed.
- accessToken string
- Access Token for making authenticated requests.
- clientId string
- The API ID of the SmartSheets developer application.
- clientSecret string
- The API Secret the SmartSheets developer application.
- refreshToken string
- The key to refresh the expired access_token.
- tokenExpiry stringDate 
- The date-time when the access token should be refreshed.
- access_token str
- Access Token for making authenticated requests.
- client_id str
- The API ID of the SmartSheets developer application.
- client_secret str
- The API Secret the SmartSheets developer application.
- refresh_token str
- The key to refresh the expired access_token.
- token_expiry_ strdate 
- The date-time when the access token should be refreshed.
- accessToken String
- Access Token for making authenticated requests.
- clientId String
- The API ID of the SmartSheets developer application.
- clientSecret String
- The API Secret the SmartSheets developer application.
- refreshToken String
- The key to refresh the expired access_token.
- tokenExpiry StringDate 
- The date-time when the access token should be refreshed.
Import
$ pulumi import airbyte:index/sourceSmartsheets:SourceSmartsheets my_airbyte_source_smartsheets ""
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 airbyteTerraform Provider.