aws-native logo
AWS Native v0.54.0, Mar 21 23

aws-native.dynamodb.getTable

Version: None. Resource Type definition for AWS::DynamoDB::Table

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(table_name: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetTableResult
def get_table_output(table_name: Optional[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)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: aws-native:dynamodb:getTable
  arguments:
    # arguments dictionary

The following arguments are supported:

TableName string
TableName string
tableName String
tableName string
tableName String

getTable Result

The following output properties are available:

Arn string
AttributeDefinitions List<Pulumi.AwsNative.DynamoDB.Outputs.TableAttributeDefinition>
BillingMode string
ContributorInsightsSpecification Pulumi.AwsNative.DynamoDB.Outputs.TableContributorInsightsSpecification
DeletionProtectionEnabled bool
GlobalSecondaryIndexes List<Pulumi.AwsNative.DynamoDB.Outputs.TableGlobalSecondaryIndex>
KeySchema List<Pulumi.AwsNative.DynamoDB.Outputs.TableKeySchema> | object
KinesisStreamSpecification Pulumi.AwsNative.DynamoDB.Outputs.TableKinesisStreamSpecification
LocalSecondaryIndexes List<Pulumi.AwsNative.DynamoDB.Outputs.TableLocalSecondaryIndex>
PointInTimeRecoverySpecification Pulumi.AwsNative.DynamoDB.Outputs.TablePointInTimeRecoverySpecification
ProvisionedThroughput Pulumi.AwsNative.DynamoDB.Outputs.TableProvisionedThroughput
SSESpecification Pulumi.AwsNative.DynamoDB.Outputs.TableSSESpecification
StreamArn string
StreamSpecification Pulumi.AwsNative.DynamoDB.Outputs.TableStreamSpecification
TableClass string
Tags List<Pulumi.AwsNative.DynamoDB.Outputs.TableTag>
TimeToLiveSpecification Pulumi.AwsNative.DynamoDB.Outputs.TableTimeToLiveSpecification

Supporting Types

TableAttributeDefinition

TableContributorInsightsSpecification

Enabled bool
Enabled bool
enabled Boolean
enabled boolean
enabled bool
enabled Boolean

TableGlobalSecondaryIndex

TableKeySchema

AttributeName string
KeyType string
AttributeName string
KeyType string
attributeName String
keyType String
attributeName string
keyType string
attributeName String
keyType String

TableKinesisStreamSpecification

StreamArn string
StreamArn string
streamArn String
streamArn string
streamArn String

TableLocalSecondaryIndex

TablePointInTimeRecoverySpecification

TableProjection

NonKeyAttributes List<string>
ProjectionType string
nonKeyAttributes List<String>
projectionType String
nonKeyAttributes List<String>
projectionType String

TableProvisionedThroughput

TableSSESpecification

sSEEnabled Boolean
kMSMasterKeyId String
sSEType String
sSEEnabled boolean
kMSMasterKeyId string
sSEType string
sSEEnabled Boolean
kMSMasterKeyId String
sSEType String

TableStreamSpecification

TableTag

Key string
Value string
Key string
Value string
key String
value String
key string
value string
key str
value str
key String
value String

TableTimeToLiveSpecification

attributeName String
enabled Boolean
attributeName string
enabled boolean
attributeName String
enabled Boolean

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0