AWS v6.74.0, Mar 26 25

AWS v6.74.0 published on Wednesday, Mar 26, 2025 by Pulumi

aws.dynamodb.getTable

Explore with Pulumi AI

AWS v6.74.0 published on Wednesday, Mar 26, 2025 by Pulumi

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/v6/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.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) {
        final var tableName = DynamodbFunctions.getTable(GetTableArgs.builder()
            .name("tableName")
            .build());

    }
}

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

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,
              server_side_encryption: Optional[GetTableServerSideEncryption] = None,
              tags: Optional[Mapping[str, str]] = None,
              opts: Optional[InvokeOptions] = None) -> GetTableResult
def get_table_output(name: Optional[pulumi.Input[str]] = None,
              server_side_encryption: Optional[pulumi.Input[GetTableServerSideEncryptionArgs]] = None,
              tags: Optional[pulumi.Input[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

The following arguments are supported:

Name string: Name of the DynamoDB table.
ServerSideEncryption GetTableServerSideEncryption
Tags Dictionary<string, string>

Name string: Name of the DynamoDB table.
ServerSideEncryption GetTableServerSideEncryption
Tags map[string]string

name String: Name of the DynamoDB table.
serverSideEncryption GetTableServerSideEncryption
tags Map<String,String>

name string: Name of the DynamoDB table.
serverSideEncryption GetTableServerSideEncryption
tags {[key: string]: string}

name str: Name of the DynamoDB table.
server_side_encryption GetTableServerSideEncryption
tags Mapping[str, str]

name String: Name of the DynamoDB table.
serverSideEncryption Property Map
tags Map<String>

getTable Result

The following output properties are available:

Arn string
Attributes List<GetTableAttribute>
BillingMode string
DeletionProtectionEnabled bool
GlobalSecondaryIndexes List<GetTableGlobalSecondaryIndex>
HashKey string
Id string: The provider-assigned unique ID for this managed resource.
LocalSecondaryIndexes List<GetTableLocalSecondaryIndex>
Name string
OnDemandThroughputs List<GetTableOnDemandThroughput>
PointInTimeRecovery GetTablePointInTimeRecovery
RangeKey string
ReadCapacity int
Replicas List<GetTableReplica>
ServerSideEncryption GetTableServerSideEncryption
StreamArn string
StreamEnabled bool
StreamLabel string
StreamViewType string
TableClass string
Tags Dictionary<string, string>
Ttl GetTableTtl
WriteCapacity int

Arn string
Attributes []GetTableAttribute
BillingMode string
DeletionProtectionEnabled bool
GlobalSecondaryIndexes []GetTableGlobalSecondaryIndex
HashKey string
Id string: The provider-assigned unique ID for this managed resource.
LocalSecondaryIndexes []GetTableLocalSecondaryIndex
Name string
OnDemandThroughputs []GetTableOnDemandThroughput
PointInTimeRecovery GetTablePointInTimeRecovery
RangeKey string
ReadCapacity int
Replicas []GetTableReplicaType
ServerSideEncryption GetTableServerSideEncryption
StreamArn string
StreamEnabled bool
StreamLabel string
StreamViewType string
TableClass string
Tags map[string]string
Ttl GetTableTtl
WriteCapacity int

arn String
attributes List<GetTableAttribute>
billingMode String
deletionProtectionEnabled Boolean
globalSecondaryIndexes List<GetTableGlobalSecondaryIndex>
hashKey String
id String: The provider-assigned unique ID for this managed resource.
localSecondaryIndexes List<GetTableLocalSecondaryIndex>
name String
onDemandThroughputs List<GetTableOnDemandThroughput>
pointInTimeRecovery GetTablePointInTimeRecovery
rangeKey String
readCapacity Integer
replicas List<GetTableReplica>
serverSideEncryption GetTableServerSideEncryption
streamArn String
streamEnabled Boolean
streamLabel String
streamViewType String
tableClass String
tags Map<String,String>
ttl GetTableTtl
writeCapacity Integer

arn string
attributes GetTableAttribute[]
billingMode string
deletionProtectionEnabled boolean
globalSecondaryIndexes GetTableGlobalSecondaryIndex[]
hashKey string
id string: The provider-assigned unique ID for this managed resource.
localSecondaryIndexes GetTableLocalSecondaryIndex[]
name string
onDemandThroughputs GetTableOnDemandThroughput[]
pointInTimeRecovery GetTablePointInTimeRecovery
rangeKey string
readCapacity number
replicas GetTableReplica[]
serverSideEncryption GetTableServerSideEncryption
streamArn string
streamEnabled boolean
streamLabel string
streamViewType string
tableClass string
tags {[key: string]: string}
ttl GetTableTtl
writeCapacity number

arn str
attributes Sequence[GetTableAttribute]
billing_mode str
deletion_protection_enabled bool
global_secondary_indexes Sequence[GetTableGlobalSecondaryIndex]
hash_key str
id str: The provider-assigned unique ID for this managed resource.
local_secondary_indexes Sequence[GetTableLocalSecondaryIndex]
name str
on_demand_throughputs Sequence[GetTableOnDemandThroughput]
point_in_time_recovery GetTablePointInTimeRecovery
range_key str
read_capacity int
replicas Sequence[GetTableReplica]
server_side_encryption GetTableServerSideEncryption
stream_arn str
stream_enabled bool
stream_label str
stream_view_type str
table_class str
tags Mapping[str, str]
ttl GetTableTtl
write_capacity int

arn String
attributes List<Property Map>
billingMode String
deletionProtectionEnabled Boolean
globalSecondaryIndexes List<Property Map>
hashKey String
id String: The provider-assigned unique ID for this managed resource.
localSecondaryIndexes List<Property Map>
name String
onDemandThroughputs List<Property Map>
pointInTimeRecovery Property Map
rangeKey String
readCapacity Number
replicas List<Property Map>
serverSideEncryption Property Map
streamArn String
streamEnabled Boolean
streamLabel String
streamViewType String
tableClass String
tags Map<String>
ttl Property Map
writeCapacity Number

Supporting Types

GetTableAttribute

Name string: Name of the DynamoDB table.
Type string

Name string: Name of the DynamoDB table.
Type string

name String: Name of the DynamoDB table.
type String

name string: Name of the DynamoDB table.
type string

name str: Name of the DynamoDB table.
type str

name String: Name of the DynamoDB table.
type String

GetTableGlobalSecondaryIndex

HashKey string
Name string: Name of the DynamoDB table.
NonKeyAttributes List<string>
OnDemandThroughputs List<GetTableGlobalSecondaryIndexOnDemandThroughput>
ProjectionType string
RangeKey string
ReadCapacity int
WriteCapacity int

HashKey string
Name string: Name of the DynamoDB table.
NonKeyAttributes []string
OnDemandThroughputs []GetTableGlobalSecondaryIndexOnDemandThroughput
ProjectionType string
RangeKey string
ReadCapacity int
WriteCapacity int

hashKey String
name String: Name of the DynamoDB table.
nonKeyAttributes List<String>
onDemandThroughputs List<GetTableGlobalSecondaryIndexOnDemandThroughput>
projectionType String
rangeKey String
readCapacity Integer
writeCapacity Integer

hashKey string
name string: Name of the DynamoDB table.
nonKeyAttributes string[]
onDemandThroughputs GetTableGlobalSecondaryIndexOnDemandThroughput[]
projectionType string
rangeKey string
readCapacity number
writeCapacity number

hash_key str
name str: Name of the DynamoDB table.
non_key_attributes Sequence[str]
on_demand_throughputs Sequence[GetTableGlobalSecondaryIndexOnDemandThroughput]
projection_type str
range_key str
read_capacity int
write_capacity int

hashKey String
name String: Name of the DynamoDB table.
nonKeyAttributes List<String>
onDemandThroughputs List<Property Map>
projectionType String
rangeKey String
readCapacity Number
writeCapacity Number

GetTableGlobalSecondaryIndexOnDemandThroughput

MaxReadRequestUnits int
MaxWriteRequestUnits int

MaxReadRequestUnits int
MaxWriteRequestUnits int

maxReadRequestUnits Integer
maxWriteRequestUnits Integer

maxReadRequestUnits number
maxWriteRequestUnits number

max_read_request_units int
max_write_request_units int

maxReadRequestUnits Number
maxWriteRequestUnits Number

GetTableLocalSecondaryIndex

Name string: Name of the DynamoDB table.
NonKeyAttributes List<string>
ProjectionType string
RangeKey string

Name string: Name of the DynamoDB table.
NonKeyAttributes []string
ProjectionType string
RangeKey string

name String: Name of the DynamoDB table.
nonKeyAttributes List<String>
projectionType String
rangeKey String

name string: Name of the DynamoDB table.
nonKeyAttributes string[]
projectionType string
rangeKey string

name str: Name of the DynamoDB table.
non_key_attributes Sequence[str]
projection_type str
range_key str

name String: Name of the DynamoDB table.
nonKeyAttributes List<String>
projectionType String
rangeKey String

MaxReadRequestUnits int
MaxWriteRequestUnits int

maxReadRequestUnits Integer
maxWriteRequestUnits Integer

maxReadRequestUnits number
maxWriteRequestUnits number

max_read_request_units int
max_write_request_units int

maxReadRequestUnits Number
maxWriteRequestUnits Number

GetTablePointInTimeRecovery

Enabled bool

Enabled bool

enabled Boolean

enabled boolean

enabled bool

enabled Boolean

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

AWS v6.74.0 published on Wednesday, Mar 26, 2025 by Pulumi

pulumi/pulumi-aws

aws.dynamodb.getTable

On this page

On this page

Example Usage

Using getTable

getTable Result

Supporting Types

GetTableAttribute

GetTableGlobalSecondaryIndex

GetTableGlobalSecondaryIndexOnDemandThroughput

GetTableLocalSecondaryIndex

GetTableOnDemandThroughput

GetTablePointInTimeRecovery

GetTableReplica

GetTableServerSideEncryption

GetTableTtl

Package Details

On this page

On this page