com.pulumi.awsnative.dynamodb.kotlin.outputs.TableGlobalSecondaryIndex.kt Maven / Gradle / Ivy

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

package com.pulumi.awsnative.dynamodb.kotlin.outputs

import kotlin.String
import kotlin.Suppress
import kotlin.collections.List

/**
 * Represents the properties of a global secondary index.
 * @property contributorInsightsSpecification The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index.
 * @property indexName The name of the global secondary index. The name must be unique among all other indexes on this table.
 * @property keySchema The complete key schema for a global secondary index, which consists 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 onDemandThroughput The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify ``MaxReadRequestUnits``, ``MaxWriteRequestUnits``, or both.
 * @property projection Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
 * @property provisionedThroughput Represents the provisioned throughput settings for the specified global secondary index.
 *  For current minimum and maximum provisioned throughput values, see [Service, Account, and Table Quotas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the *Amazon DynamoDB Developer Guide*.
 */
public data class TableGlobalSecondaryIndex(
    public val contributorInsightsSpecification: TableContributorInsightsSpecification? = null,
    public val indexName: String,
    public val keySchema: List,
    public val onDemandThroughput: TableOnDemandThroughput? = null,
    public val projection: TableProjection,
    public val provisionedThroughput: TableProvisionedThroughput? = null,
) {
    public companion object {
        public fun toKotlin(javaType: com.pulumi.awsnative.dynamodb.outputs.TableGlobalSecondaryIndex): TableGlobalSecondaryIndex = TableGlobalSecondaryIndex(
            contributorInsightsSpecification = javaType.contributorInsightsSpecification().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.awsnative.dynamodb.kotlin.outputs.TableContributorInsightsSpecification.Companion.toKotlin(args0)
                })
            }).orElse(null),
            indexName = javaType.indexName(),
            keySchema = javaType.keySchema().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.awsnative.dynamodb.kotlin.outputs.TableKeySchema.Companion.toKotlin(args0)
                })
            }),
            onDemandThroughput = javaType.onDemandThroughput().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.awsnative.dynamodb.kotlin.outputs.TableOnDemandThroughput.Companion.toKotlin(args0)
                })
            }).orElse(null),
            projection = javaType.projection().let({ args0 ->
                com.pulumi.awsnative.dynamodb.kotlin.outputs.TableProjection.Companion.toKotlin(args0)
            }),
            provisionedThroughput = javaType.provisionedThroughput().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.awsnative.dynamodb.kotlin.outputs.TableProvisionedThroughput.Companion.toKotlin(args0)
                })
            }).orElse(null),
        )
    }
}