com.pulumi.awsnative.dynamodb.kotlin.DynamodbFunctions.kt Maven / Gradle / Ivy

Go to download
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.awsnative.dynamodb.kotlin

import com.pulumi.awsnative.dynamodb.DynamodbFunctions.getGlobalTablePlain
import com.pulumi.awsnative.dynamodb.DynamodbFunctions.getTablePlain
import com.pulumi.awsnative.dynamodb.kotlin.inputs.GetGlobalTablePlainArgs
import com.pulumi.awsnative.dynamodb.kotlin.inputs.GetGlobalTablePlainArgsBuilder
import com.pulumi.awsnative.dynamodb.kotlin.inputs.GetTablePlainArgs
import com.pulumi.awsnative.dynamodb.kotlin.inputs.GetTablePlainArgsBuilder
import com.pulumi.awsnative.dynamodb.kotlin.outputs.GetGlobalTableResult
import com.pulumi.awsnative.dynamodb.kotlin.outputs.GetTableResult
import kotlinx.coroutines.future.await
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import com.pulumi.awsnative.dynamodb.kotlin.outputs.GetGlobalTableResult.Companion.toKotlin as getGlobalTableResultToKotlin
import com.pulumi.awsnative.dynamodb.kotlin.outputs.GetTableResult.Companion.toKotlin as getTableResultToKotlin

public object DynamodbFunctions {
    /**
     * Version: None. Resource Type definition for AWS::DynamoDB::GlobalTable
     * @param argument null
     * @return null
     */
    public suspend fun getGlobalTable(argument: GetGlobalTablePlainArgs): GetGlobalTableResult =
        getGlobalTableResultToKotlin(getGlobalTablePlain(argument.toJava()).await())

    /**
     * @see [getGlobalTable].
     * @param tableName A name for the global table. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID as the table name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) .
     * > If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
     * @return null
     */
    public suspend fun getGlobalTable(tableName: String): GetGlobalTableResult {
        val argument = GetGlobalTablePlainArgs(
            tableName = tableName,
        )
        return getGlobalTableResultToKotlin(getGlobalTablePlain(argument.toJava()).await())
    }

    /**
     * @see [getGlobalTable].
     * @param argument Builder for [com.pulumi.awsnative.dynamodb.kotlin.inputs.GetGlobalTablePlainArgs].
     * @return null
     */
    public suspend fun getGlobalTable(argument: suspend GetGlobalTablePlainArgsBuilder.() -> Unit): GetGlobalTableResult {
        val builder = GetGlobalTablePlainArgsBuilder()
        builder.argument()
        val builtArgument = builder.build()
        return getGlobalTableResultToKotlin(getGlobalTablePlain(builtArgument.toJava()).await())
    }

    /**
     * The ``AWS::DynamoDB::Table`` resource creates a DDB table. For more information, see [CreateTable](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_CreateTable.html) in the *API Reference*.
     *  You should be aware of the following behaviors when working with DDB tables:
     *   +   CFNlong typically creates DDB tables in parallel. However, if your template includes multiple DDB tables with indexes, you must declare dependencies so that the tables are created sequentially. DDBlong limits the number of tables with secondary indexes that are in the creating state. If you create multiple tables with indexes at the same time, DDB returns an error and the stack operation fails. For an example, see [DynamoDB Table with a DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#aws-resource-dynamodb-table--examples--DynamoDB_Table_with_a_DependsOn_Attribute).
     *    Our guidance is to use the latest schema documented here for your CFNlong templates. This schema supports the provisioning of all table settings below. When using this schema in your CFNlong templates, please ensure that your Identity and Access Management (IAM) policies are updated with appropriate permissions to allow for the authorization of these setting changes.
     * @param argument null
     * @return null
     */
    public suspend fun getTable(argument: GetTablePlainArgs): GetTableResult =
        getTableResultToKotlin(getTablePlain(argument.toJava()).await())

    /**
     * @see [getTable].
     * @param tableName A name for the table. If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the table name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
     *   If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
     * @return null
     */
    public suspend fun getTable(tableName: String): GetTableResult {
        val argument = GetTablePlainArgs(
            tableName = tableName,
        )
        return getTableResultToKotlin(getTablePlain(argument.toJava()).await())
    }

    /**
     * @see [getTable].
     * @param argument Builder for [com.pulumi.awsnative.dynamodb.kotlin.inputs.GetTablePlainArgs].
     * @return null
     */
    public suspend fun getTable(argument: suspend GetTablePlainArgsBuilder.() -> Unit): GetTableResult {
        val builder = GetTablePlainArgsBuilder()
        builder.argument()
        val builtArgument = builder.build()
        return getTableResultToKotlin(getTablePlain(builtArgument.toJava()).await())
    }
}