com.pulumi.awsnative.dynamodb.kotlin.outputs.GetGlobalTableResult.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

/**
 *
 * @property arn The Amazon Resource Name (ARN) of the DynamoDB table, such as `arn:aws:dynamodb:us-east-2:123456789012:table/myDynamoDBTable` . The ARN returned is that of the replica in the region the stack is deployed to.
 * @property attributeDefinitions A list of attributes that describe the key schema for the global table and indexes.
 * @property billingMode Specifies how you are charged for read and write throughput and how you manage capacity. Valid values are:
 * - `PAY_PER_REQUEST`
 * - `PROVISIONED`
 * All replicas in your global table will have the same billing mode. If you use `PROVISIONED` billing mode, you must provide an auto scaling configuration via the `WriteProvisionedThroughputSettings` property. The default value of this property is `PROVISIONED` .
 * @property globalSecondaryIndexes Global secondary indexes to be created on the global table. You can create up to 20 global secondary indexes. Each replica in your global table will have the same global secondary index settings. You can only create or delete one global secondary index in a single stack operation.
 * Since the backfilling of an index could take a long time, CloudFormation does not wait for the index to become active. If a stack operation rolls back, CloudFormation might not delete an index that has been added. In that case, you will need to delete the index manually.
 * @property replicas Specifies the list of replicas for your global table. The list must contain at least one element, the region where the stack defining the global table is deployed. For example, if you define your table in a stack deployed to us-east-1, you must have an entry in `Replicas` with the region us-east-1. You cannot remove the replica in the stack region.
 * > Adding a replica might take a few minutes for an empty table, or up to several hours for large tables. If you want to add or remove a replica, we recommend submitting an `UpdateStack` operation containing only that change.
 * >
 * > If you add or delete a replica during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new replica, you might need to manually delete the replica.
 * You can create a new global table with as many replicas as needed. You can add or remove replicas after table creation, but you can only add or remove a single replica in each update.
 * @property sseSpecification Specifies the settings to enable server-side encryption. These settings will be applied to all replicas. If you plan to use customer-managed KMS keys, you must provide a key for each replica using the `ReplicaSpecification.ReplicaSSESpecification` property.
 * @property streamArn The ARN of the DynamoDB stream, such as `arn:aws:dynamodb:us-east-1:123456789012:table/testddbstack-myDynamoDBTable-012A1SL7SMP5Q/stream/2015-11-30T20:10:00.000` . The `StreamArn` returned is that of the replica in the region the stack is deployed to.
 * > You must specify the `StreamSpecification` property to use this attribute.
 * @property streamSpecification Specifies the streams settings on your global table. You must provide a value for this property if your global table contains more than one replica. You can only change the streams settings if your global table has only one replica.
 * @property tableId Unique identifier for the table, such as `a123b456-01ab-23cd-123a-111222aaabbb` . The `TableId` returned is that of the replica in the region the stack is deployed to.
 * @property timeToLiveSpecification Specifies the time to live (TTL) settings for the table. This setting will be applied to all replicas.
 * @property writeOnDemandThroughputSettings Sets the write request settings for a global table or a global secondary index. You must specify this setting if you set the `BillingMode` to `PAY_PER_REQUEST` .
 * @property writeProvisionedThroughputSettings Specifies an auto scaling policy for write capacity. This policy will be applied to all replicas. This setting must be specified if `BillingMode` is set to `PROVISIONED` .
 */
public data class GetGlobalTableResult(
    public val arn: String? = null,
    public val attributeDefinitions: List? = null,
    public val billingMode: String? = null,
    public val globalSecondaryIndexes: List? = null,
    public val replicas: List? = null,
    public val sseSpecification: GlobalTableSseSpecification? = null,
    public val streamArn: String? = null,
    public val streamSpecification: GlobalTableStreamSpecification? = null,
    public val tableId: String? = null,
    public val timeToLiveSpecification: GlobalTableTimeToLiveSpecification? = null,
    public val writeOnDemandThroughputSettings: GlobalTableWriteOnDemandThroughputSettings? = null,
    public val writeProvisionedThroughputSettings: GlobalTableWriteProvisionedThroughputSettings? =
        null,
) {
    public companion object {
        public fun toKotlin(javaType: com.pulumi.awsnative.dynamodb.outputs.GetGlobalTableResult): GetGlobalTableResult = GetGlobalTableResult(
            arn = javaType.arn().map({ args0 -> args0 }).orElse(null),
            attributeDefinitions = javaType.attributeDefinitions().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.awsnative.dynamodb.kotlin.outputs.GlobalTableAttributeDefinition.Companion.toKotlin(args0)
                })
            }),
            billingMode = javaType.billingMode().map({ args0 -> args0 }).orElse(null),
            globalSecondaryIndexes = javaType.globalSecondaryIndexes().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.awsnative.dynamodb.kotlin.outputs.GlobalTableGlobalSecondaryIndex.Companion.toKotlin(args0)
                })
            }),
            replicas = javaType.replicas().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.awsnative.dynamodb.kotlin.outputs.GlobalTableReplicaSpecification.Companion.toKotlin(args0)
                })
            }),
            sseSpecification = javaType.sseSpecification().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.awsnative.dynamodb.kotlin.outputs.GlobalTableSseSpecification.Companion.toKotlin(args0)
                })
            }).orElse(null),
            streamArn = javaType.streamArn().map({ args0 -> args0 }).orElse(null),
            streamSpecification = javaType.streamSpecification().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.awsnative.dynamodb.kotlin.outputs.GlobalTableStreamSpecification.Companion.toKotlin(args0)
                })
            }).orElse(null),
            tableId = javaType.tableId().map({ args0 -> args0 }).orElse(null),
            timeToLiveSpecification = javaType.timeToLiveSpecification().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.awsnative.dynamodb.kotlin.outputs.GlobalTableTimeToLiveSpecification.Companion.toKotlin(args0)
                })
            }).orElse(null),
            writeOnDemandThroughputSettings = javaType.writeOnDemandThroughputSettings().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.awsnative.dynamodb.kotlin.outputs.GlobalTableWriteOnDemandThroughputSettings.Companion.toKotlin(args0)
                })
            }).orElse(null),
            writeProvisionedThroughputSettings = javaType.writeProvisionedThroughputSettings().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.awsnative.dynamodb.kotlin.outputs.GlobalTableWriteProvisionedThroughputSettings.Companion.toKotlin(args0)
                })
            }).orElse(null),
        )
    }
}