1. Docs
  2. Reference
  3. API
  4. AWS
  5. dynamodb
  6. GetTable

GetTable

Provides information about a DynamoDB table.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var tableName = Output.Create(Aws.DynamoDB.GetTable.InvokeAsync(new Aws.DynamoDB.GetTableArgs
        {
            Name = "tableName",
        }));
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/dynamodb"
    "github.com/pulumi/pulumi/sdk/v2/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
    })
}
import pulumi
import pulumi_aws as aws

table_name = aws.dynamodb.get_table(name="tableName")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

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

Using GetTable

function getTable(args: GetTableArgs, opts?: InvokeOptions): Promise<GetTableResult>
function  get_table(name=None, server_side_encryption=None, tags=None, opts=None)
func LookupTable(ctx *Context, args *LookupTableArgs, opts ...InvokeOption) (*LookupTableResult, error)

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

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

The following arguments are supported:

Name string

The name of the DynamoDB table.

ServerSideEncryption GetTableServerSideEncryptionArgs
Tags Dictionary<string, string>
Name string

The name of the DynamoDB table.

ServerSideEncryption GetTableServerSideEncryption
Tags map[string]string
name string

The name of the DynamoDB table.

serverSideEncryption GetTableServerSideEncryption
tags {[key: string]: string}
name str

The name of the DynamoDB table.

server_side_encryption Dict[GetTableServerSideEncryption]
tags Dict[str, str]

GetTable Result

The following output properties are available:

Arn string
Attributes List<GetTableAttribute>
BillingMode string
GlobalSecondaryIndexes List<GetTableGlobalSecondaryIndex>
HashKey string
Id string

The provider-assigned unique ID for this managed resource.

LocalSecondaryIndexes List<GetTableLocalSecondaryIndex>
Name string
PointInTimeRecovery GetTablePointInTimeRecovery
RangeKey string
ReadCapacity int
Replicas List<GetTableReplica>
ServerSideEncryption GetTableServerSideEncryption
StreamArn string
StreamEnabled bool
StreamLabel string
StreamViewType string
Tags Dictionary<string, string>
Ttl GetTableTtl
WriteCapacity int
Arn string
Attributes []GetTableAttribute
BillingMode string
GlobalSecondaryIndexes []GetTableGlobalSecondaryIndex
HashKey string
Id string

The provider-assigned unique ID for this managed resource.

LocalSecondaryIndexes []GetTableLocalSecondaryIndex
Name string
PointInTimeRecovery GetTablePointInTimeRecovery
RangeKey string
ReadCapacity int
Replicas []GetTableReplica
ServerSideEncryption GetTableServerSideEncryption
StreamArn string
StreamEnabled bool
StreamLabel string
StreamViewType string
Tags map[string]string
Ttl GetTableTtl
WriteCapacity int
arn string
attributes GetTableAttribute[]
billingMode string
globalSecondaryIndexes GetTableGlobalSecondaryIndex[]
hashKey string
id string

The provider-assigned unique ID for this managed resource.

localSecondaryIndexes GetTableLocalSecondaryIndex[]
name string
pointInTimeRecovery GetTablePointInTimeRecovery
rangeKey string
readCapacity number
replicas GetTableReplica[]
serverSideEncryption GetTableServerSideEncryption
streamArn string
streamEnabled boolean
streamLabel string
streamViewType string
tags {[key: string]: string}
ttl GetTableTtl
writeCapacity number
arn str
attributes List[GetTableAttribute]
billing_mode str
global_secondary_indexes List[GetTableGlobalSecondaryIndex]
hash_key str
id str

The provider-assigned unique ID for this managed resource.

local_secondary_indexes List[GetTableLocalSecondaryIndex]
name str
point_in_time_recovery Dict[GetTablePointInTimeRecovery]
range_key str
read_capacity float
replicas List[GetTableReplica]
server_side_encryption Dict[GetTableServerSideEncryption]
stream_arn str
stream_enabled bool
stream_label str
stream_view_type str
tags Dict[str, str]
ttl Dict[GetTableTtl]
write_capacity float

Supporting Types

GetTableAttribute

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

Name string

The name of the DynamoDB table.

Type string
Name string

The name of the DynamoDB table.

Type string
name string

The name of the DynamoDB table.

type string
name str

The name of the DynamoDB table.

type str

GetTableGlobalSecondaryIndex

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

HashKey string
Name string

The name of the DynamoDB table.

NonKeyAttributes List<string>
ProjectionType string
RangeKey string
ReadCapacity int
WriteCapacity int
HashKey string
Name string

The name of the DynamoDB table.

NonKeyAttributes []string
ProjectionType string
RangeKey string
ReadCapacity int
WriteCapacity int
hashKey string
name string

The name of the DynamoDB table.

nonKeyAttributes string[]
projectionType string
rangeKey string
readCapacity number
writeCapacity number
hash_key str
name str

The name of the DynamoDB table.

nonKeyAttributes List[str]
projectionType str
range_key str
read_capacity float
write_capacity float

GetTableLocalSecondaryIndex

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

Name string

The name of the DynamoDB table.

NonKeyAttributes List<string>
ProjectionType string
RangeKey string
Name string

The name of the DynamoDB table.

NonKeyAttributes []string
ProjectionType string
RangeKey string
name string

The name of the DynamoDB table.

nonKeyAttributes string[]
projectionType string
rangeKey string
name str

The name of the DynamoDB table.

nonKeyAttributes List[str]
projectionType str
range_key str

GetTablePointInTimeRecovery

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

Enabled bool
Enabled bool
enabled boolean
enabled bool

GetTableReplica

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

RegionName string
RegionName string
regionName string
regionName str

GetTableServerSideEncryption

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Enabled bool
KmsKeyArn string
Enabled bool
KmsKeyArn string
enabled boolean
kmsKeyArn string
enabled bool
kms_key_arn str

GetTableTtl

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

AttributeName string
Enabled bool
AttributeName string
Enabled bool
attributeName string
enabled boolean
attributeName str
enabled bool

Package Details

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