com.pulumi.awsnative.dynamodb.kotlin.inputs.TableGlobalSecondaryIndexArgs.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-native-kotlin Show documentation
Show all versions of pulumi-aws-native-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.awsnative.dynamodb.kotlin.inputs
import com.pulumi.awsnative.dynamodb.inputs.TableGlobalSecondaryIndexArgs.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 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 TableGlobalSecondaryIndexArgs(
public val contributorInsightsSpecification: Output? =
null,
public val indexName: Output,
public val keySchema: Output>,
public val onDemandThroughput: Output? = null,
public val projection: Output,
public val provisionedThroughput: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.awsnative.dynamodb.inputs.TableGlobalSecondaryIndexArgs =
com.pulumi.awsnative.dynamodb.inputs.TableGlobalSecondaryIndexArgs.builder()
.contributorInsightsSpecification(
contributorInsightsSpecification?.applyValue({ args0 ->
args0.let({ args0 -> args0.toJava() })
}),
)
.indexName(indexName.applyValue({ args0 -> args0 }))
.keySchema(
keySchema.applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
})
}),
)
.onDemandThroughput(
onDemandThroughput?.applyValue({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
}),
)
.projection(projection.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
.provisionedThroughput(
provisionedThroughput?.applyValue({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
}),
).build()
}
/**
* Builder for [TableGlobalSecondaryIndexArgs].
*/
@PulumiTagMarker
public class TableGlobalSecondaryIndexArgsBuilder internal constructor() {
private var contributorInsightsSpecification: Output? =
null
private var indexName: Output? = null
private var keySchema: Output>? = null
private var onDemandThroughput: Output? = null
private var projection: Output? = null
private var provisionedThroughput: Output? = null
/**
* @param value The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index.
*/
@JvmName("pdsheetuiubawuix")
public suspend fun contributorInsightsSpecification(`value`: Output) {
this.contributorInsightsSpecification = value
}
/**
* @param value The name of the global secondary index. The name must be unique among all other indexes on this table.
*/
@JvmName("dxbmaakucibvefhd")
public suspend fun indexName(`value`: Output) {
this.indexName = value
}
/**
* @param value 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.
*/
@JvmName("fgnaqkxcvrspssuo")
public suspend fun keySchema(`value`: Output>) {
this.keySchema = value
}
@JvmName("iuhebojmofitqowg")
public suspend fun keySchema(vararg values: Output) {
this.keySchema = Output.all(values.asList())
}
/**
* @param values 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.
*/
@JvmName("hnfapjbbxmbnqcbw")
public suspend fun keySchema(values: List>) {
this.keySchema = Output.all(values)
}
/**
* @param value 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.
*/
@JvmName("jyelwaxsypxljyup")
public suspend fun onDemandThroughput(`value`: Output) {
this.onDemandThroughput = value
}
/**
* @param value 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.
*/
@JvmName("xxtmrmwkxdhrwoyl")
public suspend fun projection(`value`: Output) {
this.projection = value
}
/**
* @param value 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*.
*/
@JvmName("miydvaurmwyyoqti")
public suspend fun provisionedThroughput(`value`: Output) {
this.provisionedThroughput = value
}
/**
* @param value The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index.
*/
@JvmName("pymdeaonxhiedmea")
public suspend fun contributorInsightsSpecification(`value`: TableContributorInsightsSpecificationArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.contributorInsightsSpecification = mapped
}
/**
* @param argument The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index.
*/
@JvmName("ceasfygxjvvxygix")
public suspend fun contributorInsightsSpecification(argument: suspend TableContributorInsightsSpecificationArgsBuilder.() -> Unit) {
val toBeMapped = TableContributorInsightsSpecificationArgsBuilder().applySuspend {
argument()
}.build()
val mapped = of(toBeMapped)
this.contributorInsightsSpecification = mapped
}
/**
* @param value The name of the global secondary index. The name must be unique among all other indexes on this table.
*/
@JvmName("rbfodtpirynudysq")
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 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.
*/
@JvmName("mrbboofdtjboeigv")
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 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.
*/
@JvmName("tnbmbutreyjqscur")
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 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.
*/
@JvmName("hhhlafyktlcsaehj")
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 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.
*/
@JvmName("hsrykdpgbvvfqkdh")
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 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.
*/
@JvmName("wgyywfknjgbdoeiw")
public suspend fun keySchema(vararg values: TableKeySchemaArgs) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.keySchema = mapped
}
/**
* @param value 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.
*/
@JvmName("bwasvajbirwwccmo")
public suspend fun onDemandThroughput(`value`: TableOnDemandThroughputArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.onDemandThroughput = mapped
}
/**
* @param argument 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.
*/
@JvmName("fpvoxkotebnljpya")
public suspend fun onDemandThroughput(argument: suspend TableOnDemandThroughputArgsBuilder.() -> Unit) {
val toBeMapped = TableOnDemandThroughputArgsBuilder().applySuspend { argument() }.build()
val mapped = of(toBeMapped)
this.onDemandThroughput = mapped
}
/**
* @param value 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.
*/
@JvmName("pbcxjvooiqpuwnrt")
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 global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
*/
@JvmName("obqsnsgdvylolmfi")
public suspend fun projection(argument: suspend TableProjectionArgsBuilder.() -> Unit) {
val toBeMapped = TableProjectionArgsBuilder().applySuspend { argument() }.build()
val mapped = of(toBeMapped)
this.projection = mapped
}
/**
* @param value 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*.
*/
@JvmName("jkxgprebpxtvadmk")
public suspend fun provisionedThroughput(`value`: TableProvisionedThroughputArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.provisionedThroughput = mapped
}
/**
* @param argument 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*.
*/
@JvmName("brsdlhlxiggjgmyj")
public suspend fun provisionedThroughput(argument: suspend TableProvisionedThroughputArgsBuilder.() -> Unit) {
val toBeMapped = TableProvisionedThroughputArgsBuilder().applySuspend { argument() }.build()
val mapped = of(toBeMapped)
this.provisionedThroughput = mapped
}
internal fun build(): TableGlobalSecondaryIndexArgs = TableGlobalSecondaryIndexArgs(
contributorInsightsSpecification = contributorInsightsSpecification,
indexName = indexName ?: throw PulumiNullFieldException("indexName"),
keySchema = keySchema ?: throw PulumiNullFieldException("keySchema"),
onDemandThroughput = onDemandThroughput,
projection = projection ?: throw PulumiNullFieldException("projection"),
provisionedThroughput = provisionedThroughput,
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy