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

datadog.ReferenceTable

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

    Provides a Datadog Reference Table resource for cloud storage sources (S3, GCS, Azure). This can be used to create and manage Datadog reference tables that sync data from cloud storage. For setup instructions including granting Datadog read access to your cloud storage bucket, see the Reference Tables documentation.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as datadog from "@pulumi/datadog";

// Create a reference table from an S3 bucket
const s3Table = new datadog.ReferenceTable("s3_table", {
    tableName: "products_catalog",
    description: "Product catalog synced from S3",
    source: "S3",
    fileMetadata: [{
        syncEnabled: true,
        accessDetails: [{
            awsDetail: [{
                awsAccountId: "123456789000",
                awsBucketName: "my-data-bucket",
                filePath: "reference-tables/products.csv",
            }],
        }],
    }],
    schema: [{
        primaryKeys: ["product_id"],
        fields: [
            {
                name: "product_id",
                type: "STRING",
            },
            {
                name: "product_name",
                type: "STRING",
            },
            {
                name: "category",
                type: "STRING",
            },
            {
                name: "price_cents",
                type: "INT32",
            },
        ],
    }],
    tags: [
        "source:s3",
        "team:catalog",
        "env:production",
    ],
});

    import pulumi
import pulumi_datadog as datadog

# Create a reference table from an S3 bucket
s3_table = datadog.ReferenceTable("s3_table",
    table_name="products_catalog",
    description="Product catalog synced from S3",
    source="S3",
    file_metadata=[{
        "syncEnabled": True,
        "accessDetails": [{
            "awsDetail": [{
                "awsAccountId": "123456789000",
                "awsBucketName": "my-data-bucket",
                "filePath": "reference-tables/products.csv",
            }],
        }],
    }],
    schema=[{
        "primaryKeys": ["product_id"],
        "fields": [
            {
                "name": "product_id",
                "type": "STRING",
            },
            {
                "name": "product_name",
                "type": "STRING",
            },
            {
                "name": "category",
                "type": "STRING",
            },
            {
                "name": "price_cents",
                "type": "INT32",
            },
        ],
    }],
    tags=[
        "source:s3",
        "team:catalog",
        "env:production",
    ])

    package main

import (
	"github.com/pulumi/pulumi-datadog/sdk/v4/go/datadog"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Create a reference table from an S3 bucket
		_, err := datadog.NewReferenceTable(ctx, "s3_table", &datadog.ReferenceTableArgs{
			TableName:   pulumi.String("products_catalog"),
			Description: pulumi.String("Product catalog synced from S3"),
			Source:      pulumi.String("S3"),
			FileMetadata: datadog.ReferenceTableFileMetadataArgs{
				map[string]interface{}{
					"syncEnabled": true,
					"accessDetails": []map[string]interface{}{
						map[string]interface{}{
							"awsDetail": []map[string]interface{}{
								map[string]interface{}{
									"awsAccountId":  "123456789000",
									"awsBucketName": "my-data-bucket",
									"filePath":      "reference-tables/products.csv",
								},
							},
						},
					},
				},
			},
			Schema: datadog.ReferenceTableSchemaArgs{
				map[string]interface{}{
					"primaryKeys": []string{
						"product_id",
					},
					"fields": []map[string]interface{}{
						map[string]interface{}{
							"name": "product_id",
							"type": "STRING",
						},
						map[string]interface{}{
							"name": "product_name",
							"type": "STRING",
						},
						map[string]interface{}{
							"name": "category",
							"type": "STRING",
						},
						map[string]interface{}{
							"name": "price_cents",
							"type": "INT32",
						},
					},
				},
			},
			Tags: pulumi.StringArray{
				pulumi.String("source:s3"),
				pulumi.String("team:catalog"),
				pulumi.String("env:production"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Datadog = Pulumi.Datadog;

return await Deployment.RunAsync(() => 
{
    // Create a reference table from an S3 bucket
    var s3Table = new Datadog.ReferenceTable("s3_table", new()
    {
        TableName = "products_catalog",
        Description = "Product catalog synced from S3",
        Source = "S3",
        FileMetadata = new[]
        {
            
            {
                { "syncEnabled", true },
                { "accessDetails", new[]
                {
                    
                    {
                        { "awsDetail", new[]
                        {
                            
                            {
                                { "awsAccountId", "123456789000" },
                                { "awsBucketName", "my-data-bucket" },
                                { "filePath", "reference-tables/products.csv" },
                            },
                        } },
                    },
                } },
            },
        },
        Schema = new[]
        {
            
            {
                { "primaryKeys", new[]
                {
                    "product_id",
                } },
                { "fields", new[]
                {
                    
                    {
                        { "name", "product_id" },
                        { "type", "STRING" },
                    },
                    
                    {
                        { "name", "product_name" },
                        { "type", "STRING" },
                    },
                    
                    {
                        { "name", "category" },
                        { "type", "STRING" },
                    },
                    
                    {
                        { "name", "price_cents" },
                        { "type", "INT32" },
                    },
                } },
            },
        },
        Tags = new[]
        {
            "source:s3",
            "team:catalog",
            "env:production",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.datadog.ReferenceTable;
import com.pulumi.datadog.ReferenceTableArgs;
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) {
        // Create a reference table from an S3 bucket
        var s3Table = new ReferenceTable("s3Table", ReferenceTableArgs.builder()
            .tableName("products_catalog")
            .description("Product catalog synced from S3")
            .source("S3")
            .fileMetadata(ReferenceTableFileMetadataArgs.builder()
                .syncEnabled(true)
                .accessDetails(ReferenceTableFileMetadataAccessDetailsArgs.builder()
                    .awsDetail(ReferenceTableFileMetadataAccessDetailsAwsDetailArgs.builder()
                        .awsAccountId("123456789000")
                        .awsBucketName("my-data-bucket")
                        .filePath("reference-tables/products.csv")
                        .build())
                    .build())
                .build())
            .schema(ReferenceTableSchemaArgs.builder()
                .primaryKeys("product_id")
                .fields(                
                    ReferenceTableSchemaFieldArgs.builder()
                        .name("product_id")
                        .type("STRING")
                        .build(),
                    ReferenceTableSchemaFieldArgs.builder()
                        .name("product_name")
                        .type("STRING")
                        .build(),
                    ReferenceTableSchemaFieldArgs.builder()
                        .name("category")
                        .type("STRING")
                        .build(),
                    ReferenceTableSchemaFieldArgs.builder()
                        .name("price_cents")
                        .type("INT32")
                        .build())
                .build())
            .tags(            
                "source:s3",
                "team:catalog",
                "env:production")
            .build());

    }
}

    resources:
  # Create a reference table from an S3 bucket
  s3Table:
    type: datadog:ReferenceTable
    name: s3_table
    properties:
      tableName: products_catalog
      description: Product catalog synced from S3
      source: S3
      fileMetadata:
        - syncEnabled: true
          accessDetails:
            - awsDetail:
                - awsAccountId: '123456789000'
                  awsBucketName: my-data-bucket
                  filePath: reference-tables/products.csv
      schema:
        - primaryKeys:
            - product_id
          fields:
            - name: product_id
              type: STRING
            - name: product_name
              type: STRING
            - name: category
              type: STRING
            - name: price_cents
              type: INT32
      tags:
        - source:s3
        - team:catalog
        - env:production

    Create ReferenceTable Resource

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

    Constructor syntax

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

@overload
def ReferenceTable(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   source: Optional[str] = None,
                   table_name: Optional[str] = None,
                   description: Optional[str] = None,
                   file_metadata: Optional[ReferenceTableFileMetadataArgs] = None,
                   schema: Optional[ReferenceTableSchemaArgs] = None,
                   tags: Optional[Sequence[str]] = None)
    func NewReferenceTable(ctx *Context, name string, args ReferenceTableArgs, opts ...ResourceOption) (*ReferenceTable, error)
    public ReferenceTable(string name, ReferenceTableArgs args, CustomResourceOptions? opts = null)
    public ReferenceTable(String name, ReferenceTableArgs args)
public ReferenceTable(String name, ReferenceTableArgs args, CustomResourceOptions options)

    type: datadog:ReferenceTable
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 ReferenceTableArgs
    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 ReferenceTableArgs
    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 ReferenceTableArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ReferenceTableArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ReferenceTableArgs
    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 referenceTableResource = new Datadog.ReferenceTable("referenceTableResource", new()
{
    Source = "string",
    TableName = "string",
    Description = "string",
    FileMetadata = new Datadog.Inputs.ReferenceTableFileMetadataArgs
    {
        SyncEnabled = false,
        AccessDetails = new Datadog.Inputs.ReferenceTableFileMetadataAccessDetailsArgs
        {
            AwsDetail = new Datadog.Inputs.ReferenceTableFileMetadataAccessDetailsAwsDetailArgs
            {
                AwsAccountId = "string",
                AwsBucketName = "string",
                FilePath = "string",
            },
            AzureDetail = new Datadog.Inputs.ReferenceTableFileMetadataAccessDetailsAzureDetailArgs
            {
                AzureClientId = "string",
                AzureContainerName = "string",
                AzureStorageAccountName = "string",
                AzureTenantId = "string",
                FilePath = "string",
            },
            GcpDetail = new Datadog.Inputs.ReferenceTableFileMetadataAccessDetailsGcpDetailArgs
            {
                FilePath = "string",
                GcpBucketName = "string",
                GcpProjectId = "string",
                GcpServiceAccountEmail = "string",
            },
        },
        ErrorMessage = "string",
        ErrorRowCount = 0,
        ErrorType = "string",
    },
    Schema = new Datadog.Inputs.ReferenceTableSchemaArgs
    {
        Fields = new[]
        {
            new Datadog.Inputs.ReferenceTableSchemaFieldArgs
            {
                Name = "string",
                Type = "string",
            },
        },
        PrimaryKeys = new[]
        {
            "string",
        },
    },
    Tags = new[]
    {
        "string",
    },
});

    example, err := datadog.NewReferenceTable(ctx, "referenceTableResource", &datadog.ReferenceTableArgs{
	Source:      pulumi.String("string"),
	TableName:   pulumi.String("string"),
	Description: pulumi.String("string"),
	FileMetadata: &datadog.ReferenceTableFileMetadataArgs{
		SyncEnabled: pulumi.Bool(false),
		AccessDetails: &datadog.ReferenceTableFileMetadataAccessDetailsArgs{
			AwsDetail: &datadog.ReferenceTableFileMetadataAccessDetailsAwsDetailArgs{
				AwsAccountId:  pulumi.String("string"),
				AwsBucketName: pulumi.String("string"),
				FilePath:      pulumi.String("string"),
			},
			AzureDetail: &datadog.ReferenceTableFileMetadataAccessDetailsAzureDetailArgs{
				AzureClientId:           pulumi.String("string"),
				AzureContainerName:      pulumi.String("string"),
				AzureStorageAccountName: pulumi.String("string"),
				AzureTenantId:           pulumi.String("string"),
				FilePath:                pulumi.String("string"),
			},
			GcpDetail: &datadog.ReferenceTableFileMetadataAccessDetailsGcpDetailArgs{
				FilePath:               pulumi.String("string"),
				GcpBucketName:          pulumi.String("string"),
				GcpProjectId:           pulumi.String("string"),
				GcpServiceAccountEmail: pulumi.String("string"),
			},
		},
		ErrorMessage:  pulumi.String("string"),
		ErrorRowCount: pulumi.Int(0),
		ErrorType:     pulumi.String("string"),
	},
	Schema: &datadog.ReferenceTableSchemaArgs{
		Fields: datadog.ReferenceTableSchemaFieldArray{
			&datadog.ReferenceTableSchemaFieldArgs{
				Name: pulumi.String("string"),
				Type: pulumi.String("string"),
			},
		},
		PrimaryKeys: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var referenceTableResource = new ReferenceTable("referenceTableResource", ReferenceTableArgs.builder()
    .source("string")
    .tableName("string")
    .description("string")
    .fileMetadata(ReferenceTableFileMetadataArgs.builder()
        .syncEnabled(false)
        .accessDetails(ReferenceTableFileMetadataAccessDetailsArgs.builder()
            .awsDetail(ReferenceTableFileMetadataAccessDetailsAwsDetailArgs.builder()
                .awsAccountId("string")
                .awsBucketName("string")
                .filePath("string")
                .build())
            .azureDetail(ReferenceTableFileMetadataAccessDetailsAzureDetailArgs.builder()
                .azureClientId("string")
                .azureContainerName("string")
                .azureStorageAccountName("string")
                .azureTenantId("string")
                .filePath("string")
                .build())
            .gcpDetail(ReferenceTableFileMetadataAccessDetailsGcpDetailArgs.builder()
                .filePath("string")
                .gcpBucketName("string")
                .gcpProjectId("string")
                .gcpServiceAccountEmail("string")
                .build())
            .build())
        .errorMessage("string")
        .errorRowCount(0)
        .errorType("string")
        .build())
    .schema(ReferenceTableSchemaArgs.builder()
        .fields(ReferenceTableSchemaFieldArgs.builder()
            .name("string")
            .type("string")
            .build())
        .primaryKeys("string")
        .build())
    .tags("string")
    .build());

    reference_table_resource = datadog.ReferenceTable("referenceTableResource",
    source="string",
    table_name="string",
    description="string",
    file_metadata={
        "sync_enabled": False,
        "access_details": {
            "aws_detail": {
                "aws_account_id": "string",
                "aws_bucket_name": "string",
                "file_path": "string",
            },
            "azure_detail": {
                "azure_client_id": "string",
                "azure_container_name": "string",
                "azure_storage_account_name": "string",
                "azure_tenant_id": "string",
                "file_path": "string",
            },
            "gcp_detail": {
                "file_path": "string",
                "gcp_bucket_name": "string",
                "gcp_project_id": "string",
                "gcp_service_account_email": "string",
            },
        },
        "error_message": "string",
        "error_row_count": 0,
        "error_type": "string",
    },
    schema={
        "fields": [{
            "name": "string",
            "type": "string",
        }],
        "primary_keys": ["string"],
    },
    tags=["string"])

    const referenceTableResource = new datadog.ReferenceTable("referenceTableResource", {
    source: "string",
    tableName: "string",
    description: "string",
    fileMetadata: {
        syncEnabled: false,
        accessDetails: {
            awsDetail: {
                awsAccountId: "string",
                awsBucketName: "string",
                filePath: "string",
            },
            azureDetail: {
                azureClientId: "string",
                azureContainerName: "string",
                azureStorageAccountName: "string",
                azureTenantId: "string",
                filePath: "string",
            },
            gcpDetail: {
                filePath: "string",
                gcpBucketName: "string",
                gcpProjectId: "string",
                gcpServiceAccountEmail: "string",
            },
        },
        errorMessage: "string",
        errorRowCount: 0,
        errorType: "string",
    },
    schema: {
        fields: [{
            name: "string",
            type: "string",
        }],
        primaryKeys: ["string"],
    },
    tags: ["string"],
});

    type: datadog:ReferenceTable
properties:
    description: string
    fileMetadata:
        accessDetails:
            awsDetail:
                awsAccountId: string
                awsBucketName: string
                filePath: string
            azureDetail:
                azureClientId: string
                azureContainerName: string
                azureStorageAccountName: string
                azureTenantId: string
                filePath: string
            gcpDetail:
                filePath: string
                gcpBucketName: string
                gcpProjectId: string
                gcpServiceAccountEmail: string
        errorMessage: string
        errorRowCount: 0
        errorType: string
        syncEnabled: false
    schema:
        fields:
            - name: string
              type: string
        primaryKeys:
            - string
    source: string
    tableName: string
    tags:
        - string

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

    Source string
    The source type for the reference table. Valid values are S3, GCS, AZURE.
    TableName string
    The name of the reference table. This must be unique within your organization.
    Description string
    The description of the reference table.
    FileMetadata ReferenceTableFileMetadata
    Configuration for cloud storage file access and sync settings.
    Schema ReferenceTableSchema
    The schema definition for the reference table, including field definitions and primary keys. Schema is only set on create; updates are derived from the file asynchronously.
    Tags List<string>
    A list of tags to associate with the reference table.
    Source string
    The source type for the reference table. Valid values are S3, GCS, AZURE.
    TableName string
    The name of the reference table. This must be unique within your organization.
    Description string
    The description of the reference table.
    FileMetadata ReferenceTableFileMetadataArgs
    Configuration for cloud storage file access and sync settings.
    Schema ReferenceTableSchemaArgs
    The schema definition for the reference table, including field definitions and primary keys. Schema is only set on create; updates are derived from the file asynchronously.
    Tags []string
    A list of tags to associate with the reference table.
    source String
    The source type for the reference table. Valid values are S3, GCS, AZURE.
    tableName String
    The name of the reference table. This must be unique within your organization.
    description String
    The description of the reference table.
    fileMetadata ReferenceTableFileMetadata
    Configuration for cloud storage file access and sync settings.
    schema ReferenceTableSchema
    The schema definition for the reference table, including field definitions and primary keys. Schema is only set on create; updates are derived from the file asynchronously.
    tags List<String>
    A list of tags to associate with the reference table.
    source string
    The source type for the reference table. Valid values are S3, GCS, AZURE.
    tableName string
    The name of the reference table. This must be unique within your organization.
    description string
    The description of the reference table.
    fileMetadata ReferenceTableFileMetadata
    Configuration for cloud storage file access and sync settings.
    schema ReferenceTableSchema
    The schema definition for the reference table, including field definitions and primary keys. Schema is only set on create; updates are derived from the file asynchronously.
    tags string[]
    A list of tags to associate with the reference table.
    source str
    The source type for the reference table. Valid values are S3, GCS, AZURE.
    table_name str
    The name of the reference table. This must be unique within your organization.
    description str
    The description of the reference table.
    file_metadata ReferenceTableFileMetadataArgs
    Configuration for cloud storage file access and sync settings.
    schema ReferenceTableSchemaArgs
    The schema definition for the reference table, including field definitions and primary keys. Schema is only set on create; updates are derived from the file asynchronously.
    tags Sequence[str]
    A list of tags to associate with the reference table.
    source String
    The source type for the reference table. Valid values are S3, GCS, AZURE.
    tableName String
    The name of the reference table. This must be unique within your organization.
    description String
    The description of the reference table.
    fileMetadata Property Map
    Configuration for cloud storage file access and sync settings.
    schema Property Map
    The schema definition for the reference table, including field definitions and primary keys. Schema is only set on create; updates are derived from the file asynchronously.
    tags List<String>
    A list of tags to associate with the reference table.

    Outputs

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

    CreatedBy string
    UUID of the user who created the reference table.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdatedBy string
    UUID of the user who last updated the reference table.
    RowCount int
    The number of successfully processed rows in the reference table.
    Status string
    The status of the reference table (e.g., DONE, PROCESSING, ERROR).
    UpdatedAt string
    The timestamp of the last update to the reference table in ISO 8601 format.
    CreatedBy string
    UUID of the user who created the reference table.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdatedBy string
    UUID of the user who last updated the reference table.
    RowCount int
    The number of successfully processed rows in the reference table.
    Status string
    The status of the reference table (e.g., DONE, PROCESSING, ERROR).
    UpdatedAt string
    The timestamp of the last update to the reference table in ISO 8601 format.
    createdBy String
    UUID of the user who created the reference table.
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdatedBy String
    UUID of the user who last updated the reference table.
    rowCount Integer
    The number of successfully processed rows in the reference table.
    status String
    The status of the reference table (e.g., DONE, PROCESSING, ERROR).
    updatedAt String
    The timestamp of the last update to the reference table in ISO 8601 format.
    createdBy string
    UUID of the user who created the reference table.
    id string
    The provider-assigned unique ID for this managed resource.
    lastUpdatedBy string
    UUID of the user who last updated the reference table.
    rowCount number
    The number of successfully processed rows in the reference table.
    status string
    The status of the reference table (e.g., DONE, PROCESSING, ERROR).
    updatedAt string
    The timestamp of the last update to the reference table in ISO 8601 format.
    created_by str
    UUID of the user who created the reference table.
    id str
    The provider-assigned unique ID for this managed resource.
    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.
    status str
    The status of the reference table (e.g., DONE, PROCESSING, ERROR).
    updated_at str
    The timestamp of the last update to the reference table in ISO 8601 format.
    createdBy String
    UUID of the user who created the reference table.
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdatedBy String
    UUID of the user who last updated the reference table.
    rowCount Number
    The number of successfully processed rows in the reference table.
    status String
    The status of the reference table (e.g., DONE, PROCESSING, ERROR).
    updatedAt String
    The timestamp of the last update to the reference table in ISO 8601 format.

    Look up Existing ReferenceTable Resource

    Get an existing ReferenceTable 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?: ReferenceTableState, opts?: CustomResourceOptions): ReferenceTable
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_by: Optional[str] = None,
        description: Optional[str] = None,
        file_metadata: Optional[ReferenceTableFileMetadataArgs] = None,
        last_updated_by: Optional[str] = None,
        row_count: Optional[int] = None,
        schema: Optional[ReferenceTableSchemaArgs] = None,
        source: Optional[str] = None,
        status: Optional[str] = None,
        table_name: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[str] = None) -> ReferenceTable
    func GetReferenceTable(ctx *Context, name string, id IDInput, state *ReferenceTableState, opts ...ResourceOption) (*ReferenceTable, error)
    public static ReferenceTable Get(string name, Input<string> id, ReferenceTableState? state, CustomResourceOptions? opts = null)
    public static ReferenceTable get(String name, Output<String> id, ReferenceTableState state, CustomResourceOptions options)
    resources:  _:    type: datadog:ReferenceTable    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.
    The following state arguments are supported:
    CreatedBy string
    UUID of the user who created the reference table.
    Description string
    The description of the reference table.
    FileMetadata ReferenceTableFileMetadata
    Configuration for cloud storage file access and sync settings.
    LastUpdatedBy string
    UUID of the user who last updated the reference table.
    RowCount int
    The number of successfully processed rows in the reference table.
    Schema ReferenceTableSchema
    The schema definition for the reference table, including field definitions and primary keys. Schema is only set on create; updates are derived from the file asynchronously.
    Source string
    The source type for the reference table. Valid values are S3, GCS, AZURE.
    Status string
    The status of the reference table (e.g., DONE, PROCESSING, ERROR).
    TableName string
    The name of the reference table. This must be unique within your organization.
    Tags List<string>
    A list of tags to associate with the reference table.
    UpdatedAt string
    The timestamp of the last update to the reference table in ISO 8601 format.
    CreatedBy string
    UUID of the user who created the reference table.
    Description string
    The description of the reference table.
    FileMetadata ReferenceTableFileMetadataArgs
    Configuration for cloud storage file access and sync settings.
    LastUpdatedBy string
    UUID of the user who last updated the reference table.
    RowCount int
    The number of successfully processed rows in the reference table.
    Schema ReferenceTableSchemaArgs
    The schema definition for the reference table, including field definitions and primary keys. Schema is only set on create; updates are derived from the file asynchronously.
    Source string
    The source type for the reference table. Valid values are S3, GCS, AZURE.
    Status string
    The status of the reference table (e.g., DONE, PROCESSING, ERROR).
    TableName string
    The name of the reference table. This must be unique within your organization.
    Tags []string
    A list of tags to associate with the reference table.
    UpdatedAt string
    The timestamp of the last update to the reference table in ISO 8601 format.
    createdBy String
    UUID of the user who created the reference table.
    description String
    The description of the reference table.
    fileMetadata ReferenceTableFileMetadata
    Configuration for cloud storage file access and sync settings.
    lastUpdatedBy String
    UUID of the user who last updated the reference table.
    rowCount Integer
    The number of successfully processed rows in the reference table.
    schema ReferenceTableSchema
    The schema definition for the reference table, including field definitions and primary keys. Schema is only set on create; updates are derived from the file asynchronously.
    source String
    The source type for the reference table. Valid values are S3, GCS, AZURE.
    status String
    The status of the reference table (e.g., DONE, PROCESSING, ERROR).
    tableName String
    The name of the reference table. This must be unique within your organization.
    tags List<String>
    A list of tags to associate with the reference table.
    updatedAt String
    The timestamp of the last update to the reference table in ISO 8601 format.
    createdBy string
    UUID of the user who created the reference table.
    description string
    The description of the reference table.
    fileMetadata ReferenceTableFileMetadata
    Configuration for cloud storage file access and sync settings.
    lastUpdatedBy string
    UUID of the user who last updated the reference table.
    rowCount number
    The number of successfully processed rows in the reference table.
    schema ReferenceTableSchema
    The schema definition for the reference table, including field definitions and primary keys. Schema is only set on create; updates are derived from the file asynchronously.
    source string
    The source type for the reference table. Valid values are S3, GCS, AZURE.
    status string
    The status of the reference table (e.g., DONE, PROCESSING, ERROR).
    tableName string
    The name of the reference table. This must be unique within your organization.
    tags string[]
    A list of tags to associate with the reference table.
    updatedAt string
    The timestamp of the last update to the reference table in ISO 8601 format.
    created_by str
    UUID of the user who created the reference table.
    description str
    The description of the reference table.
    file_metadata ReferenceTableFileMetadataArgs
    Configuration for cloud storage file access and sync settings.
    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.
    schema ReferenceTableSchemaArgs
    The schema definition for the reference table, including field definitions and primary keys. Schema is only set on create; updates are derived from the file asynchronously.
    source str
    The source type for the reference table. Valid values are S3, GCS, AZURE.
    status str
    The status of the reference table (e.g., DONE, PROCESSING, ERROR).
    table_name str
    The name of the reference table. This must be unique within your organization.
    tags Sequence[str]
    A list of tags to associate with the reference table.
    updated_at str
    The timestamp of the last update to the reference table in ISO 8601 format.
    createdBy String
    UUID of the user who created the reference table.
    description String
    The description of the reference table.
    fileMetadata Property Map
    Configuration for cloud storage file access and sync settings.
    lastUpdatedBy String
    UUID of the user who last updated the reference table.
    rowCount Number
    The number of successfully processed rows in the reference table.
    schema Property Map
    The schema definition for the reference table, including field definitions and primary keys. Schema is only set on create; updates are derived from the file asynchronously.
    source String
    The source type for the reference table. Valid values are S3, GCS, AZURE.
    status String
    The status of the reference table (e.g., DONE, PROCESSING, ERROR).
    tableName String
    The name of the reference table. This must be unique within your organization.
    tags List<String>
    A list of tags to associate with the reference table.
    updatedAt String
    The timestamp of the last update to the reference table in ISO 8601 format.

    Supporting Types

    ReferenceTableFileMetadata, ReferenceTableFileMetadataArgs

    SyncEnabled bool
    Whether this table should automatically sync with the cloud storage source.
    AccessDetails ReferenceTableFileMetadataAccessDetails
    Cloud storage access configuration. Exactly one of awsdetail, gcpdetail, or azure*detail must be specified.
    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.
    SyncEnabled bool
    Whether this table should automatically sync with the cloud storage source.
    AccessDetails ReferenceTableFileMetadataAccessDetails
    Cloud storage access configuration. Exactly one of awsdetail, gcpdetail, or azure*detail must be specified.
    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.
    syncEnabled Boolean
    Whether this table should automatically sync with the cloud storage source.
    accessDetails ReferenceTableFileMetadataAccessDetails
    Cloud storage access configuration. Exactly one of awsdetail, gcpdetail, or azure*detail must be specified.
    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.
    syncEnabled boolean
    Whether this table should automatically sync with the cloud storage source.
    accessDetails ReferenceTableFileMetadataAccessDetails
    Cloud storage access configuration. Exactly one of awsdetail, gcpdetail, or azure*detail must be specified.
    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.
    sync_enabled bool
    Whether this table should automatically sync with the cloud storage source.
    access_details ReferenceTableFileMetadataAccessDetails
    Cloud storage access configuration. Exactly one of awsdetail, gcpdetail, or azure*detail must be specified.
    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.
    syncEnabled Boolean
    Whether this table should automatically sync with the cloud storage source.
    accessDetails Property Map
    Cloud storage access configuration. Exactly one of awsdetail, gcpdetail, or azure*detail must be specified.
    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.

    ReferenceTableFileMetadataAccessDetails, ReferenceTableFileMetadataAccessDetailsArgs

    AwsDetail ReferenceTableFileMetadataAccessDetailsAwsDetail
    AWS S3 access configuration. Required when source is S3.
    AzureDetail ReferenceTableFileMetadataAccessDetailsAzureDetail
    Azure Blob Storage access configuration. Required when source is AZURE.
    GcpDetail ReferenceTableFileMetadataAccessDetailsGcpDetail
    Google Cloud Storage access configuration. Required when source is GCS.
    AwsDetail ReferenceTableFileMetadataAccessDetailsAwsDetail
    AWS S3 access configuration. Required when source is S3.
    AzureDetail ReferenceTableFileMetadataAccessDetailsAzureDetail
    Azure Blob Storage access configuration. Required when source is AZURE.
    GcpDetail ReferenceTableFileMetadataAccessDetailsGcpDetail
    Google Cloud Storage access configuration. Required when source is GCS.
    awsDetail ReferenceTableFileMetadataAccessDetailsAwsDetail
    AWS S3 access configuration. Required when source is S3.
    azureDetail ReferenceTableFileMetadataAccessDetailsAzureDetail
    Azure Blob Storage access configuration. Required when source is AZURE.
    gcpDetail ReferenceTableFileMetadataAccessDetailsGcpDetail
    Google Cloud Storage access configuration. Required when source is GCS.
    awsDetail ReferenceTableFileMetadataAccessDetailsAwsDetail
    AWS S3 access configuration. Required when source is S3.
    azureDetail ReferenceTableFileMetadataAccessDetailsAzureDetail
    Azure Blob Storage access configuration. Required when source is AZURE.
    gcpDetail ReferenceTableFileMetadataAccessDetailsGcpDetail
    Google Cloud Storage access configuration. Required when source is GCS.
    aws_detail ReferenceTableFileMetadataAccessDetailsAwsDetail
    AWS S3 access configuration. Required when source is S3.
    azure_detail ReferenceTableFileMetadataAccessDetailsAzureDetail
    Azure Blob Storage access configuration. Required when source is AZURE.
    gcp_detail ReferenceTableFileMetadataAccessDetailsGcpDetail
    Google Cloud Storage access configuration. Required when source is GCS.
    awsDetail Property Map
    AWS S3 access configuration. Required when source is S3.
    azureDetail Property Map
    Azure Blob Storage access configuration. Required when source is AZURE.
    gcpDetail Property Map
    Google Cloud Storage access configuration. Required when source is GCS.

    ReferenceTableFileMetadataAccessDetailsAwsDetail, ReferenceTableFileMetadataAccessDetailsAwsDetailArgs

    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.

    ReferenceTableFileMetadataAccessDetailsAzureDetail, ReferenceTableFileMetadataAccessDetailsAzureDetailArgs

    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.

    ReferenceTableFileMetadataAccessDetailsGcpDetail, ReferenceTableFileMetadataAccessDetailsGcpDetailArgs

    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.

    ReferenceTableSchema, ReferenceTableSchemaArgs

    Fields List<ReferenceTableSchemaField>
    List of fields in the table schema. Must include at least one field. Schema is only set on create.
    PrimaryKeys List<string>
    List of field names that serve as primary keys for the table. Currently only one primary key is supported.
    Fields []ReferenceTableSchemaField
    List of fields in the table schema. Must include at least one field. Schema is only set on create.
    PrimaryKeys []string
    List of field names that serve as primary keys for the table. Currently only one primary key is supported.
    fields List<ReferenceTableSchemaField>
    List of fields in the table schema. Must include at least one field. Schema is only set on create.
    primaryKeys List<String>
    List of field names that serve as primary keys for the table. Currently only one primary key is supported.
    fields ReferenceTableSchemaField[]
    List of fields in the table schema. Must include at least one field. Schema is only set on create.
    primaryKeys string[]
    List of field names that serve as primary keys for the table. Currently only one primary key is supported.
    fields Sequence[ReferenceTableSchemaField]
    List of fields in the table schema. Must include at least one field. Schema is only set on create.
    primary_keys Sequence[str]
    List of field names that serve as primary keys for the table. Currently only one primary key is supported.
    fields List<Property Map>
    List of fields in the table schema. Must include at least one field. Schema is only set on create.
    primaryKeys List<String>
    List of field names that serve as primary keys for the table. Currently only one primary key is supported.

    ReferenceTableSchemaField, ReferenceTableSchemaFieldArgs

    Name string
    The name of the field.
    Type string
    The data type of the field. Must be one of: STRING, INT32. Valid values are STRING, INT32.
    Name string
    The name of the field.
    Type string
    The data type of the field. Must be one of: STRING, INT32. Valid values are STRING, INT32.
    name String
    The name of the field.
    type String
    The data type of the field. Must be one of: STRING, INT32. Valid values are STRING, INT32.
    name string
    The name of the field.
    type string
    The data type of the field. Must be one of: STRING, INT32. Valid values are STRING, INT32.
    name str
    The name of the field.
    type str
    The data type of the field. Must be one of: STRING, INT32. Valid values are STRING, INT32.
    name String
    The name of the field.
    type String
    The data type of the field. Must be one of: STRING, INT32. Valid values are STRING, INT32.

    Import

    The pulumi import command can be used, for example:

    #!/bin/bash

    Import an existing reference table by its UUID

    $ pulumi import datadog:index/referenceTable:ReferenceTable imported_table "00000000-0000-0000-0000-000000000000"

    After importing, add the resource configuration to your .tf file:

    resource “datadog_reference_table” “imported_table” {

    table_name = “existing_table”

    description = “Previously created table”

    source = “S3” # or “GCS” or “AZURE”

    file_metadata {

    sync_enabled = true

access_details {

  aws_detail {

    aws_account_id  = "123456789000"

    aws_bucket_name = "existing-bucket"

    file_path       = "data/existing.csv"

  }

}

    }

    schema {

    primary_keys = ["id"]

fields {

  name = "id"

  type = "STRING"

}

fields {

  name = "value"

  type = "STRING"

}

    }

    tags = [“imported:true”]

    }

    To learn more about importing existing cloud resources, see Importing resources.

    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