getTable

AWS v7.30.0, May 14 26

Viewing docs for AWS v7.30.0
published on Thursday, May 14, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws

Viewing docs for AWS v7.30.0
published on Thursday, May 14, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws

Example Usage

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

const tableName = aws.dynamodb.getTable({
    name: "tableName",
});

import pulumi
import pulumi_aws as aws

table_name = aws.dynamodb.get_table(name="tableName")

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/dynamodb"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dynamodb.LookupTable(ctx, &dynamodb.LookupTableArgs{
			Name: "tableName",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var tableName = Aws.DynamoDB.GetTable.Invoke(new()
    {
        Name = "tableName",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.dynamodb.DynamodbFunctions;
import com.pulumi.aws.dynamodb.inputs.GetTableArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
        final var tableName = DynamodbFunctions.getTable(GetTableArgs.builder()
            .name("tableName")
            .build());

    }
}

variables:
  tableName:
    fn::invoke:
      function: aws:dynamodb:getTable
      arguments:
        name: tableName

Example coming soon!

Using getTable

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 getTable(args: GetTableArgs, opts?: InvokeOptions): Promise<GetTableResult>
function getTableOutput(args: GetTableOutputArgs, opts?: InvokeOptions): Output<GetTableResult>

def get_table(name: Optional[str] = None,
              region: Optional[str] = None,
              server_side_encryption: Optional[GetTableServerSideEncryption] = None,
              tags: Optional[Mapping[str, str]] = None,
              opts: Optional[InvokeOptions] = None) -> GetTableResult
def get_table_output(name: pulumi.Input[Optional[str]] = None,
              region: pulumi.Input[Optional[str]] = None,
              server_side_encryption: pulumi.Input[Optional[GetTableServerSideEncryptionArgs]] = None,
              tags: pulumi.Input[Optional[Mapping[str, pulumi.Input[str]]]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetTableResult]

func LookupTable(ctx *Context, args *LookupTableArgs, opts ...InvokeOption) (*LookupTableResult, error)
func LookupTableOutput(ctx *Context, args *LookupTableOutputArgs, opts ...InvokeOption) LookupTableResultOutput

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

public static class GetTable 
{
    public static Task<GetTableResult> InvokeAsync(GetTableArgs args, InvokeOptions? opts = null)
    public static Output<GetTableResult> Invoke(GetTableInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetTableResult> getTable(GetTableArgs args, InvokeOptions options)
public static Output<GetTableResult> getTable(GetTableArgs args, InvokeOptions options)

fn::invoke:
  function: aws:dynamodb/getTable:getTable
  arguments:
    # arguments dictionary

data "aws_dynamodb_gettable" "name" {
    # arguments
}

The following arguments are supported:

Name string: Name of the DynamoDB table.
Region string: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
ServerSideEncryption GetTableServerSideEncryption
Tags Dictionary<string, string>

Name string: Name of the DynamoDB table.
Region string: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
ServerSideEncryption GetTableServerSideEncryption
Tags map[string]string

name string: Name of the DynamoDB table.
region string: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
server_side_encryption object
tags map(string)

name String: Name of the DynamoDB table.
region String: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
serverSideEncryption GetTableServerSideEncryption
tags Map<String,String>

name string: Name of the DynamoDB table.
region string: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
serverSideEncryption GetTableServerSideEncryption
tags {[key: string]: string}

name str: Name of the DynamoDB table.
region str: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
server_side_encryption GetTableServerSideEncryption
tags Mapping[str, str]

name String: Name of the DynamoDB table.
region String: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
serverSideEncryption Property Map
tags Map<String>