com.pulumi.awsnative.dynamodb.kotlin.inputs.TableLocalSecondaryIndexArgs.kt Maven / Gradle / Ivy

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

package com.pulumi.awsnative.dynamodb.kotlin.inputs

import com.pulumi.awsnative.dynamodb.inputs.TableLocalSecondaryIndexArgs.builder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiNullFieldException
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.jvm.JvmName

/**
 * Represents the properties of a local secondary index. A local secondary index can only be created when its parent table is created.
 * @property indexName The name of the local secondary index. The name must be unique among all other indexes on this table.
 * @property keySchema The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:
 *   +   ``HASH`` - partition key
 *   +   ``RANGE`` - sort key
 *   The partition key of an item is also known as its *hash attribute*. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
 *  The sort key of an item is also known as its *range attribute*. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
 * @property projection Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
 */
public data class TableLocalSecondaryIndexArgs(
    public val indexName: Output,
    public val keySchema: Output>,
    public val projection: Output,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.awsnative.dynamodb.inputs.TableLocalSecondaryIndexArgs =
        com.pulumi.awsnative.dynamodb.inputs.TableLocalSecondaryIndexArgs.builder()
            .indexName(indexName.applyValue({ args0 -> args0 }))
            .keySchema(
                keySchema.applyValue({ args0 ->
                    args0.map({ args0 ->
                        args0.let({ args0 ->
                            args0.toJava()
                        })
                    })
                }),
            )
            .projection(projection.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) })).build()
}

/**
 * Builder for [TableLocalSecondaryIndexArgs].
 */
@PulumiTagMarker
public class TableLocalSecondaryIndexArgsBuilder internal constructor() {
    private var indexName: Output? = null

    private var keySchema: Output>? = null

    private var projection: Output? = null

    /**
     * @param value The name of the local secondary index. The name must be unique among all other indexes on this table.
     */
    @JvmName("tupmfpytaecfvoab")
    public suspend fun indexName(`value`: Output) {
        this.indexName = value
    }

    /**
     * @param value The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:
     *   +   ``HASH`` - partition key
     *   +   ``RANGE`` - sort key
     *   The partition key of an item is also known as its *hash attribute*. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
     *  The sort key of an item is also known as its *range attribute*. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
     */
    @JvmName("qnwfiycfuqjtchee")
    public suspend fun keySchema(`value`: Output>) {
        this.keySchema = value
    }

    @JvmName("hdploxhbpemicxbh")
    public suspend fun keySchema(vararg values: Output) {
        this.keySchema = Output.all(values.asList())
    }

    /**
     * @param values The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:
     *   +   ``HASH`` - partition key
     *   +   ``RANGE`` - sort key
     *   The partition key of an item is also known as its *hash attribute*. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
     *  The sort key of an item is also known as its *range attribute*. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
     */
    @JvmName("woxeoapdmbawxgek")
    public suspend fun keySchema(values: List>) {
        this.keySchema = Output.all(values)
    }

    /**
     * @param value Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
     */
    @JvmName("abobymomiccueeon")
    public suspend fun projection(`value`: Output) {
        this.projection = value
    }

    /**
     * @param value The name of the local secondary index. The name must be unique among all other indexes on this table.
     */
    @JvmName("akmgyrrgawlqugww")
    public suspend fun indexName(`value`: String) {
        val toBeMapped = value
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.indexName = mapped
    }

    /**
     * @param value The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:
     *   +   ``HASH`` - partition key
     *   +   ``RANGE`` - sort key
     *   The partition key of an item is also known as its *hash attribute*. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
     *  The sort key of an item is also known as its *range attribute*. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
     */
    @JvmName("pfmbdmlawecmsqyl")
    public suspend fun keySchema(`value`: List) {
        val toBeMapped = value
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.keySchema = mapped
    }

    /**
     * @param argument The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:
     *   +   ``HASH`` - partition key
     *   +   ``RANGE`` - sort key
     *   The partition key of an item is also known as its *hash attribute*. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
     *  The sort key of an item is also known as its *range attribute*. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
     */
    @JvmName("mqtqnowihhankwav")
    public suspend fun keySchema(argument: List Unit>) {
        val toBeMapped = argument.toList().map {
            TableKeySchemaArgsBuilder().applySuspend {
                it()
            }.build()
        }
        val mapped = of(toBeMapped)
        this.keySchema = mapped
    }

    /**
     * @param argument The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:
     *   +   ``HASH`` - partition key
     *   +   ``RANGE`` - sort key
     *   The partition key of an item is also known as its *hash attribute*. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
     *  The sort key of an item is also known as its *range attribute*. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
     */
    @JvmName("aownuwprtxoltcra")
    public suspend fun keySchema(vararg argument: suspend TableKeySchemaArgsBuilder.() -> Unit) {
        val toBeMapped = argument.toList().map {
            TableKeySchemaArgsBuilder().applySuspend {
                it()
            }.build()
        }
        val mapped = of(toBeMapped)
        this.keySchema = mapped
    }

    /**
     * @param argument The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:
     *   +   ``HASH`` - partition key
     *   +   ``RANGE`` - sort key
     *   The partition key of an item is also known as its *hash attribute*. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
     *  The sort key of an item is also known as its *range attribute*. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
     */
    @JvmName("oxwldfukreubteik")
    public suspend fun keySchema(argument: suspend TableKeySchemaArgsBuilder.() -> Unit) {
        val toBeMapped = listOf(TableKeySchemaArgsBuilder().applySuspend { argument() }.build())
        val mapped = of(toBeMapped)
        this.keySchema = mapped
    }

    /**
     * @param values The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:
     *   +   ``HASH`` - partition key
     *   +   ``RANGE`` - sort key
     *   The partition key of an item is also known as its *hash attribute*. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
     *  The sort key of an item is also known as its *range attribute*. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
     */
    @JvmName("wqkiaxinuxtjigqj")
    public suspend fun keySchema(vararg values: TableKeySchemaArgs) {
        val toBeMapped = values.toList()
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.keySchema = mapped
    }

    /**
     * @param value Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
     */
    @JvmName("eeowjglnusybhbaj")
    public suspend fun projection(`value`: TableProjectionArgs) {
        val toBeMapped = value
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.projection = mapped
    }

    /**
     * @param argument Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
     */
    @JvmName("fffwupempeccjxpd")
    public suspend fun projection(argument: suspend TableProjectionArgsBuilder.() -> Unit) {
        val toBeMapped = TableProjectionArgsBuilder().applySuspend { argument() }.build()
        val mapped = of(toBeMapped)
        this.projection = mapped
    }

    internal fun build(): TableLocalSecondaryIndexArgs = TableLocalSecondaryIndexArgs(
        indexName = indexName ?: throw PulumiNullFieldException("indexName"),
        keySchema = keySchema ?: throw PulumiNullFieldException("keySchema"),
        projection = projection ?: throw PulumiNullFieldException("projection"),
    )
}