1. Packages
  2. Datadog Provider
  3. API Docs
  4. getReferenceTable
Datadog v4.61.0 published on Monday, Dec 22, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-datadog

datadog.getReferenceTable

datadog logo
Datadog v4.61.0 published on Monday, Dec 22, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-datadog

    Use this data source to retrieve information about an existing Datadog reference table. Query by either table_name or id (mutually exclusive). Supports all source types including cloud storage (S3, GCS, Azure) and external integrations (ServiceNow, Salesforce, Databricks, Snowflake, LOCAL_FILE).

    Using getReferenceTable

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getReferenceTable(args: GetReferenceTableArgs, opts?: InvokeOptions): Promise<GetReferenceTableResult>
function getReferenceTableOutput(args: GetReferenceTableOutputArgs, opts?: InvokeOptions): Output<GetReferenceTableResult>
    def get_reference_table(file_metadata: Optional[GetReferenceTableFileMetadata] = None,
                        id: Optional[str] = None,
                        schema: Optional[GetReferenceTableSchema] = None,
                        table_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetReferenceTableResult
def get_reference_table_output(file_metadata: Optional[pulumi.Input[GetReferenceTableFileMetadataArgs]] = None,
                        id: Optional[pulumi.Input[str]] = None,
                        schema: Optional[pulumi.Input[GetReferenceTableSchemaArgs]] = None,
                        table_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetReferenceTableResult]
    func LookupReferenceTable(ctx *Context, args *LookupReferenceTableArgs, opts ...InvokeOption) (*LookupReferenceTableResult, error)
func LookupReferenceTableOutput(ctx *Context, args *LookupReferenceTableOutputArgs, opts ...InvokeOption) LookupReferenceTableResultOutput

    > Note: This function is named LookupReferenceTable in the Go SDK.

    public static class GetReferenceTable 
{
    public static Task<GetReferenceTableResult> InvokeAsync(GetReferenceTableArgs args, InvokeOptions? opts = null)
    public static Output<GetReferenceTableResult> Invoke(GetReferenceTableInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetReferenceTableResult> getReferenceTable(GetReferenceTableArgs args, InvokeOptions options)
public static Output<GetReferenceTableResult> getReferenceTable(GetReferenceTableArgs args, InvokeOptions options)

    fn::invoke:
  function: datadog:index/getReferenceTable:getReferenceTable
  arguments:
    # arguments dictionary

    The following arguments are supported:

    FileMetadata GetReferenceTableFileMetadata
    File metadata for the reference table. Contains sync settings for cloud storage sources.
    Id string
    The UUID of the reference table. Either id or table_name must be specified, but not both.
    Schema GetReferenceTableSchema
    The schema definition for the reference table.
    TableName string
    The name of the reference table. Either id or table_name must be specified, but not both.
    FileMetadata GetReferenceTableFileMetadata
    File metadata for the reference table. Contains sync settings for cloud storage sources.
    Id string
    The UUID of the reference table. Either id or table_name must be specified, but not both.
    Schema GetReferenceTableSchema
    The schema definition for the reference table.
    TableName string
    The name of the reference table. Either id or table_name must be specified, but not both.
    fileMetadata GetReferenceTableFileMetadata
    File metadata for the reference table. Contains sync settings for cloud storage sources.
    id String
    The UUID of the reference table. Either id or table_name must be specified, but not both.
    schema GetReferenceTableSchema
    The schema definition for the reference table.
    tableName String
    The name of the reference table. Either id or table_name must be specified, but not both.
    fileMetadata GetReferenceTableFileMetadata
    File metadata for the reference table. Contains sync settings for cloud storage sources.
    id string
    The UUID of the reference table. Either id or table_name must be specified, but not both.
    schema GetReferenceTableSchema
    The schema definition for the reference table.
    tableName string
    The name of the reference table. Either id or table_name must be specified, but not both.
    file_metadata GetReferenceTableFileMetadata
    File metadata for the reference table. Contains sync settings for cloud storage sources.
    id str
    The UUID of the reference table. Either id or table_name must be specified, but not both.
    schema GetReferenceTableSchema
    The schema definition for the reference table.
    table_name str
    The name of the reference table. Either id or table_name must be specified, but not both.
    fileMetadata Property Map
    File metadata for the reference table. Contains sync settings for cloud storage sources.
    id String
    The UUID of the reference table. Either id or table_name must be specified, but not both.
    schema Property Map
    The schema definition for the reference table.
    tableName String
    The name of the reference table. Either id or table_name must be specified, but not both.

    getReferenceTable Result

    The following output properties are available:

    CreatedBy string
    UUID of the user who created the reference table.
    Description string
    The description of the reference table.
    Id string
    The UUID of the reference table. Either id or table_name must be specified, but not both.
    LastUpdatedBy string
    UUID of the user who last updated the reference table.
    RowCount int
    The number of successfully processed rows in the reference table.
    Source string
    The source type for the reference table (e.g., S3, GCS, AZURE, SERVICENOW, SALESFORCE, DATABRICKS, SNOWFLAKE, LOCAL_FILE).
    Status string
    The status of the reference table (e.g., DONE, PROCESSING, ERROR).
    TableName string
    The name of the reference table. Either id or table_name must be specified, but not both.
    Tags List<string>
    The tags associated with the reference table.
    UpdatedAt string
    The timestamp of the last update to the reference table in ISO 8601 format.
    FileMetadata GetReferenceTableFileMetadata
    File metadata for the reference table. Contains sync settings for cloud storage sources.
    Schema GetReferenceTableSchema
    The schema definition for the reference table.
    CreatedBy string
    UUID of the user who created the reference table.
    Description string
    The description of the reference table.
    Id string
    The UUID of the reference table. Either id or table_name must be specified, but not both.
    LastUpdatedBy string
    UUID of the user who last updated the reference table.
    RowCount int
    The number of successfully processed rows in the reference table.
    Source string
    The source type for the reference table (e.g., S3, GCS, AZURE, SERVICENOW, SALESFORCE, DATABRICKS, SNOWFLAKE, LOCAL_FILE).
    Status string
    The status of the reference table (e.g., DONE, PROCESSING, ERROR).
    TableName string
    The name of the reference table. Either id or table_name must be specified, but not both.
    Tags []string
    The tags associated with the reference table.
    UpdatedAt string
    The timestamp of the last update to the reference table in ISO 8601 format.
    FileMetadata GetReferenceTableFileMetadata
    File metadata for the reference table. Contains sync settings for cloud storage sources.
    Schema GetReferenceTableSchema
    The schema definition for the reference table.
    createdBy String
    UUID of the user who created the reference table.
    description String
    The description of the reference table.
    id String
    The UUID of the reference table. Either id or table_name must be specified, but not both.
    lastUpdatedBy String
    UUID of the user who last updated the reference table.
    rowCount Integer
    The number of successfully processed rows in the reference table.
    source String
    The source type for the reference table (e.g., S3, GCS, AZURE, SERVICENOW, SALESFORCE, DATABRICKS, SNOWFLAKE, LOCAL_FILE).
    status String
    The status of the reference table (e.g., DONE, PROCESSING, ERROR).
    tableName String
    The name of the reference table. Either id or table_name must be specified, but not both.
    tags List<String>
    The tags associated with the reference table.
    updatedAt String
    The timestamp of the last update to the reference table in ISO 8601 format.
    fileMetadata GetReferenceTableFileMetadata
    File metadata for the reference table. Contains sync settings for cloud storage sources.
    schema GetReferenceTableSchema
    The schema definition for the reference table.
    createdBy string
    UUID of the user who created the reference table.
    description string
    The description of the reference table.
    id string
    The UUID of the reference table. Either id or table_name must be specified, but not both.
    lastUpdatedBy string
    UUID of the user who last updated the reference table.
    rowCount number
    The number of successfully processed rows in the reference table.
    source string
    The source type for the reference table (e.g., S3, GCS, AZURE, SERVICENOW, SALESFORCE, DATABRICKS, SNOWFLAKE, LOCAL_FILE).
    status string
    The status of the reference table (e.g., DONE, PROCESSING, ERROR).
    tableName string
    The name of the reference table. Either id or table_name must be specified, but not both.
    tags string[]
    The tags associated with the reference table.
    updatedAt string
    The timestamp of the last update to the reference table in ISO 8601 format.
    fileMetadata GetReferenceTableFileMetadata
    File metadata for the reference table. Contains sync settings for cloud storage sources.
    schema GetReferenceTableSchema
    The schema definition for the reference table.
    created_by str
    UUID of the user who created the reference table.
    description str
    The description of the reference table.
    id str
    The UUID of the reference table. Either id or table_name must be specified, but not both.
    last_updated_by str
    UUID of the user who last updated the reference table.
    row_count int
    The number of successfully processed rows in the reference table.
    source str
    The source type for the reference table (e.g., S3, GCS, AZURE, SERVICENOW, SALESFORCE, DATABRICKS, SNOWFLAKE, LOCAL_FILE).
    status str
    The status of the reference table (e.g., DONE, PROCESSING, ERROR).
    table_name str
    The name of the reference table. Either id or table_name must be specified, but not both.
    tags Sequence[str]
    The tags associated with the reference table.
    updated_at str
    The timestamp of the last update to the reference table in ISO 8601 format.
    file_metadata GetReferenceTableFileMetadata
    File metadata for the reference table. Contains sync settings for cloud storage sources.
    schema GetReferenceTableSchema
    The schema definition for the reference table.
    createdBy String
    UUID of the user who created the reference table.
    description String
    The description of the reference table.
    id String
    The UUID of the reference table. Either id or table_name must be specified, but not both.
    lastUpdatedBy String
    UUID of the user who last updated the reference table.
    rowCount Number
    The number of successfully processed rows in the reference table.
    source String
    The source type for the reference table (e.g., S3, GCS, AZURE, SERVICENOW, SALESFORCE, DATABRICKS, SNOWFLAKE, LOCAL_FILE).
    status String
    The status of the reference table (e.g., DONE, PROCESSING, ERROR).
    tableName String
    The name of the reference table. Either id or table_name must be specified, but not both.
    tags List<String>
    The tags associated with the reference table.
    updatedAt String
    The timestamp of the last update to the reference table in ISO 8601 format.
    fileMetadata Property Map
    File metadata for the reference table. Contains sync settings for cloud storage sources.
    schema Property Map
    The schema definition for the reference table.

    Supporting Types

    GetReferenceTableFileMetadata

    ErrorMessage string
    Error message from the last sync attempt, if any.
    ErrorRowCount int
    The number of rows that failed to sync.
    ErrorType string
    The type of error that occurred during file processing. Only present for cloud storage sources.
    SyncEnabled bool
    Whether automatic sync is enabled for this table. Only present for cloud storage sources (S3, GCS, Azure).
    AccessDetails GetReferenceTableFileMetadataAccessDetails
    Cloud storage access configuration. Only present for cloud storage sources (S3, GCS, Azure).
    ErrorMessage string
    Error message from the last sync attempt, if any.
    ErrorRowCount int
    The number of rows that failed to sync.
    ErrorType string
    The type of error that occurred during file processing. Only present for cloud storage sources.
    SyncEnabled bool
    Whether automatic sync is enabled for this table. Only present for cloud storage sources (S3, GCS, Azure).
    AccessDetails GetReferenceTableFileMetadataAccessDetails
    Cloud storage access configuration. Only present for cloud storage sources (S3, GCS, Azure).
    errorMessage String
    Error message from the last sync attempt, if any.
    errorRowCount Integer
    The number of rows that failed to sync.
    errorType String
    The type of error that occurred during file processing. Only present for cloud storage sources.
    syncEnabled Boolean
    Whether automatic sync is enabled for this table. Only present for cloud storage sources (S3, GCS, Azure).
    accessDetails GetReferenceTableFileMetadataAccessDetails
    Cloud storage access configuration. Only present for cloud storage sources (S3, GCS, Azure).
    errorMessage string
    Error message from the last sync attempt, if any.
    errorRowCount number
    The number of rows that failed to sync.
    errorType string
    The type of error that occurred during file processing. Only present for cloud storage sources.
    syncEnabled boolean
    Whether automatic sync is enabled for this table. Only present for cloud storage sources (S3, GCS, Azure).
    accessDetails GetReferenceTableFileMetadataAccessDetails
    Cloud storage access configuration. Only present for cloud storage sources (S3, GCS, Azure).
    error_message str
    Error message from the last sync attempt, if any.
    error_row_count int
    The number of rows that failed to sync.
    error_type str
    The type of error that occurred during file processing. Only present for cloud storage sources.
    sync_enabled bool
    Whether automatic sync is enabled for this table. Only present for cloud storage sources (S3, GCS, Azure).
    access_details GetReferenceTableFileMetadataAccessDetails
    Cloud storage access configuration. Only present for cloud storage sources (S3, GCS, Azure).
    errorMessage String
    Error message from the last sync attempt, if any.
    errorRowCount Number
    The number of rows that failed to sync.
    errorType String
    The type of error that occurred during file processing. Only present for cloud storage sources.
    syncEnabled Boolean
    Whether automatic sync is enabled for this table. Only present for cloud storage sources (S3, GCS, Azure).
    accessDetails Property Map
    Cloud storage access configuration. Only present for cloud storage sources (S3, GCS, Azure).

    GetReferenceTableFileMetadataAccessDetails

    awsDetail Property Map
    AWS S3 access configuration.
    azureDetail Property Map
    Azure Blob Storage access configuration.
    gcpDetail Property Map
    Google Cloud Storage access configuration.

    GetReferenceTableFileMetadataAccessDetailsAwsDetail

    AwsAccountId string
    The ID of the AWS account.
    AwsBucketName string
    The name of the AWS S3 bucket.
    FilePath string
    The relative file path from the AWS S3 bucket root to the CSV file.
    AwsAccountId string
    The ID of the AWS account.
    AwsBucketName string
    The name of the AWS S3 bucket.
    FilePath string
    The relative file path from the AWS S3 bucket root to the CSV file.
    awsAccountId String
    The ID of the AWS account.
    awsBucketName String
    The name of the AWS S3 bucket.
    filePath String
    The relative file path from the AWS S3 bucket root to the CSV file.
    awsAccountId string
    The ID of the AWS account.
    awsBucketName string
    The name of the AWS S3 bucket.
    filePath string
    The relative file path from the AWS S3 bucket root to the CSV file.
    aws_account_id str
    The ID of the AWS account.
    aws_bucket_name str
    The name of the AWS S3 bucket.
    file_path str
    The relative file path from the AWS S3 bucket root to the CSV file.
    awsAccountId String
    The ID of the AWS account.
    awsBucketName String
    The name of the AWS S3 bucket.
    filePath String
    The relative file path from the AWS S3 bucket root to the CSV file.

    GetReferenceTableFileMetadataAccessDetailsAzureDetail

    AzureClientId string
    The Azure client ID (application ID).
    AzureContainerName string
    The name of the Azure container.
    AzureStorageAccountName string
    The name of the Azure storage account.
    AzureTenantId string
    The ID of the Azure tenant.
    FilePath string
    The relative file path from the Azure container root to the CSV file.
    AzureClientId string
    The Azure client ID (application ID).
    AzureContainerName string
    The name of the Azure container.
    AzureStorageAccountName string
    The name of the Azure storage account.
    AzureTenantId string
    The ID of the Azure tenant.
    FilePath string
    The relative file path from the Azure container root to the CSV file.
    azureClientId String
    The Azure client ID (application ID).
    azureContainerName String
    The name of the Azure container.
    azureStorageAccountName String
    The name of the Azure storage account.
    azureTenantId String
    The ID of the Azure tenant.
    filePath String
    The relative file path from the Azure container root to the CSV file.
    azureClientId string
    The Azure client ID (application ID).
    azureContainerName string
    The name of the Azure container.
    azureStorageAccountName string
    The name of the Azure storage account.
    azureTenantId string
    The ID of the Azure tenant.
    filePath string
    The relative file path from the Azure container root to the CSV file.
    azure_client_id str
    The Azure client ID (application ID).
    azure_container_name str
    The name of the Azure container.
    azure_storage_account_name str
    The name of the Azure storage account.
    azure_tenant_id str
    The ID of the Azure tenant.
    file_path str
    The relative file path from the Azure container root to the CSV file.
    azureClientId String
    The Azure client ID (application ID).
    azureContainerName String
    The name of the Azure container.
    azureStorageAccountName String
    The name of the Azure storage account.
    azureTenantId String
    The ID of the Azure tenant.
    filePath String
    The relative file path from the Azure container root to the CSV file.

    GetReferenceTableFileMetadataAccessDetailsGcpDetail

    FilePath string
    The relative file path from the GCS bucket root to the CSV file.
    GcpBucketName string
    The name of the GCP bucket.
    GcpProjectId string
    The ID of the GCP project.
    GcpServiceAccountEmail string
    The email of the GCP service account used to access the bucket.
    FilePath string
    The relative file path from the GCS bucket root to the CSV file.
    GcpBucketName string
    The name of the GCP bucket.
    GcpProjectId string
    The ID of the GCP project.
    GcpServiceAccountEmail string
    The email of the GCP service account used to access the bucket.
    filePath String
    The relative file path from the GCS bucket root to the CSV file.
    gcpBucketName String
    The name of the GCP bucket.
    gcpProjectId String
    The ID of the GCP project.
    gcpServiceAccountEmail String
    The email of the GCP service account used to access the bucket.
    filePath string
    The relative file path from the GCS bucket root to the CSV file.
    gcpBucketName string
    The name of the GCP bucket.
    gcpProjectId string
    The ID of the GCP project.
    gcpServiceAccountEmail string
    The email of the GCP service account used to access the bucket.
    file_path str
    The relative file path from the GCS bucket root to the CSV file.
    gcp_bucket_name str
    The name of the GCP bucket.
    gcp_project_id str
    The ID of the GCP project.
    gcp_service_account_email str
    The email of the GCP service account used to access the bucket.
    filePath String
    The relative file path from the GCS bucket root to the CSV file.
    gcpBucketName String
    The name of the GCP bucket.
    gcpProjectId String
    The ID of the GCP project.
    gcpServiceAccountEmail String
    The email of the GCP service account used to access the bucket.

    GetReferenceTableSchema

    PrimaryKeys List<string>
    List of field names that serve as primary keys for the table.
    Fields List<GetReferenceTableSchemaField>
    List of fields in the table schema.
    PrimaryKeys []string
    List of field names that serve as primary keys for the table.
    Fields []GetReferenceTableSchemaField
    List of fields in the table schema.
    primaryKeys List<String>
    List of field names that serve as primary keys for the table.
    fields List<GetReferenceTableSchemaField>
    List of fields in the table schema.
    primaryKeys string[]
    List of field names that serve as primary keys for the table.
    fields GetReferenceTableSchemaField[]
    List of fields in the table schema.
    primary_keys Sequence[str]
    List of field names that serve as primary keys for the table.
    fields Sequence[GetReferenceTableSchemaField]
    List of fields in the table schema.
    primaryKeys List<String>
    List of field names that serve as primary keys for the table.
    fields List<Property Map>
    List of fields in the table schema.

    GetReferenceTableSchemaField

    Name string
    The name of the field.
    Type string
    The data type of the field (e.g., STRING, INT32).
    Name string
    The name of the field.
    Type string
    The data type of the field (e.g., STRING, INT32).
    name String
    The name of the field.
    type String
    The data type of the field (e.g., STRING, INT32).
    name string
    The name of the field.
    type string
    The data type of the field (e.g., STRING, INT32).
    name str
    The name of the field.
    type str
    The data type of the field (e.g., STRING, INT32).
    name String
    The name of the field.
    type String
    The data type of the field (e.g., STRING, INT32).

    Package Details

    Repository
    Datadog pulumi/pulumi-datadog
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the datadog Terraform Provider.
    datadog logo
    Datadog v4.61.0 published on Monday, Dec 22, 2025 by Pulumi
    Schema (JSON)
    pulumi/pulumi-datadog
      Meet Neo: Your AI Platform Teammate