@pulumi/aws/dynamodb/getTable.d.ts

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * Provides information about a DynamoDB table.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const tableName = aws.dynamodb.getTable({
 *     name: "tableName",
 * });
 * ```
 */
export declare function getTable(args: GetTableArgs, opts?: pulumi.InvokeOptions): Promise<GetTableResult>;
/**
 * A collection of arguments for invoking getTable.
 */
export interface GetTableArgs {
    /**
     * Name of the DynamoDB table.
     */
    name: string;
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: string;
    serverSideEncryption?: inputs.dynamodb.GetTableServerSideEncryption;
    tags?: {
        [key: string]: string;
    };
}
/**
 * A collection of values returned by getTable.
 */
export interface GetTableResult {
    readonly arn: string;
    readonly attributes: outputs.dynamodb.GetTableAttribute[];
    readonly billingMode: string;
    readonly deletionProtectionEnabled: boolean;
    readonly globalSecondaryIndexes: outputs.dynamodb.GetTableGlobalSecondaryIndex[];
    readonly hashKey: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly localSecondaryIndexes: outputs.dynamodb.GetTableLocalSecondaryIndex[];
    readonly name: string;
    readonly onDemandThroughputs: outputs.dynamodb.GetTableOnDemandThroughput[];
    readonly pointInTimeRecovery: outputs.dynamodb.GetTablePointInTimeRecovery;
    readonly rangeKey: string;
    readonly readCapacity: number;
    readonly region: string;
    readonly replicas: outputs.dynamodb.GetTableReplica[];
    readonly serverSideEncryption: outputs.dynamodb.GetTableServerSideEncryption;
    readonly streamArn: string;
    readonly streamEnabled: boolean;
    readonly streamLabel: string;
    readonly streamViewType: string;
    readonly tableClass: string;
    readonly tags: {
        [key: string]: string;
    };
    readonly ttl: outputs.dynamodb.GetTableTtl;
    readonly writeCapacity: number;
}
/**
 * Provides information about a DynamoDB table.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const tableName = aws.dynamodb.getTable({
 *     name: "tableName",
 * });
 * ```
 */
export declare function getTableOutput(args: GetTableOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetTableResult>;
/**
 * A collection of arguments for invoking getTable.
 */
export interface GetTableOutputArgs {
    /**
     * Name of the DynamoDB table.
     */
    name: pulumi.Input<string>;
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: pulumi.Input<string>;
    serverSideEncryption?: pulumi.Input<inputs.dynamodb.GetTableServerSideEncryptionArgs>;
    tags?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
}