Package com.pulumi.aws.dynamodb.inputs

Class TableState

  • public final class TableState
extends com.pulumi.resources.ResourceArgs

    • Method Detail

      • arn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()
        Returns:
        ARN of the table * `replica.*.arn` - ARN of the replica * `replica.*.stream_arn` - ARN of the replica Table Stream. Only available when `streamEnabled = true`. * `replica.*.stream_label` - Timestamp, in ISO 8601 format, for the replica stream. Note that this timestamp is not a unique identifier for the stream on its own. However, the combination of AWS customer ID, table name and this field is guaranteed to be unique. It can be used for creating CloudWatch Alarms. Only available when `streamEnabled = true`.

      • attributes

        public java.util.Optional<com.pulumi.core.Output<java.util.List<TableAttributeArgs>>> attributes()
        Returns:
        Set of nested attribute definitions. Only required for `hashKey` and `rangeKey` attributes. See below.

      • billingMode

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> billingMode()
        Returns:
        Controls how you are charged for read and write throughput and how you manage capacity. The valid values are `PROVISIONED` and `PAY_PER_REQUEST`. Defaults to `PROVISIONED`.

      • deletionProtectionEnabled

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> deletionProtectionEnabled()
        Returns:
        Enables deletion protection for table. Defaults to `false`.

      • globalSecondaryIndexes

        public java.util.Optional<com.pulumi.core.Output<java.util.List<TableGlobalSecondaryIndexArgs>>> globalSecondaryIndexes()
        Returns:
        Describe a GSI for the table; subject to the normal limits on the number of GSIs, projected attributes, etc. See below.

      • globalTableWitness

        public java.util.Optional<com.pulumi.core.Output<TableGlobalTableWitnessArgs>> globalTableWitness()
        Returns:
        Witness Region in a Multi-Region Strong Consistency deployment. **Note** This must be used alongside a single `replica` with `consistencyMode` set to `STRONG`. Other combinations will fail to provision. See below.

      • hashKey

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> hashKey()
        Returns:
        Attribute to use as the hash (partition) key. Must also be defined as an `attribute`. See below.

      • importTable

        public java.util.Optional<com.pulumi.core.Output<TableImportTableArgs>> importTable()
        Returns:
        Import Amazon S3 data into a new table. See below.

      • localSecondaryIndexes

        public java.util.Optional<com.pulumi.core.Output<java.util.List<TableLocalSecondaryIndexArgs>>> localSecondaryIndexes()
        Returns:
        Describe an LSI on the table; these can only be allocated _at creation_ so you cannot change this definition after you have created the resource. See below.

      • name

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()
        Returns:
        Unique within a region name of the table. The following arguments are optional:

      • onDemandThroughput

        public java.util.Optional<com.pulumi.core.Output<TableOnDemandThroughputArgs>> onDemandThroughput()
        Returns:
        Sets the maximum number of read and write units for the specified on-demand table. See below.

      • pointInTimeRecovery

        public java.util.Optional<com.pulumi.core.Output<TablePointInTimeRecoveryArgs>> pointInTimeRecovery()
        Returns:
        Enable point-in-time recovery options. See below.

      • rangeKey

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> rangeKey()
        Returns:
        Attribute to use as the range (sort) key. Must also be defined as an `attribute`, see below.

      • readCapacity

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> readCapacity()
        Returns:
        Number of read units for this table. If the `billingMode` is `PROVISIONED`, this field is required.

      • region

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • replicas

        public java.util.Optional<com.pulumi.core.Output<java.util.List<TableReplicaArgs>>> replicas()
        Returns:
        Configuration block(s) with [DynamoDB Global Tables V2 (version 2019.11.21)](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) replication configurations. See below.

      • restoreBackupArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> restoreBackupArn()
        Returns:
        ARN of backup to restore.

      • restoreDateTime

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> restoreDateTime()
        Returns:
        Time of the point-in-time recovery point to restore.

      • restoreSourceName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> restoreSourceName()
        Returns:
        Name of the table to restore. Must match the name of an existing table.

      • restoreSourceTableArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> restoreSourceTableArn()
        Returns:
        ARN of the source table to restore. Must be supplied for cross-region restores.

      • restoreToLatestTime

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> restoreToLatestTime()
        Returns:
        If set, restores table to the most recent point-in-time recovery point.

      • serverSideEncryption

        public java.util.Optional<com.pulumi.core.Output<TableServerSideEncryptionArgs>> serverSideEncryption()
        Returns:
        Encryption at rest options. AWS DynamoDB tables are automatically encrypted at rest with an AWS-owned Customer Master Key if this argument isn't specified. Must be supplied for cross-region restores. See below.

      • streamArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> streamArn()
        Returns:
        ARN of the Table Stream. Only available when `streamEnabled = true`

      • streamEnabled

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> streamEnabled()
        Returns:
        Whether Streams are enabled.

      • streamLabel

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> streamLabel()
        Returns:
        Timestamp, in ISO 8601 format, for this stream. Note that this timestamp is not a unique identifier for the stream on its own. However, the combination of AWS customer ID, table name and this field is guaranteed to be unique. It can be used for creating CloudWatch Alarms. Only available when `streamEnabled = true`.

      • streamViewType

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> streamViewType()
        Returns:
        When an item in the table is modified, StreamViewType determines what information is written to the table's stream. Valid values are `KEYS_ONLY`, `NEW_IMAGE`, `OLD_IMAGE`, `NEW_AND_OLD_IMAGES`. Only valid when `streamEnabled` is true.

      • tableClass

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> tableClass()
        Returns:
        Storage class of the table. Valid values are `STANDARD` and `STANDARD_INFREQUENT_ACCESS`. Default value is `STANDARD`.

      • tags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        A map of tags to populate on the created table. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • ttl

        public java.util.Optional<com.pulumi.core.Output<TableTtlArgs>> ttl()
        Returns:
        Configuration block for TTL. See below.

      • warmThroughput

        public java.util.Optional<com.pulumi.core.Output<TableWarmThroughputArgs>> warmThroughput()
        Returns:
        Sets the number of warm read and write units for the specified table. See below.

      • writeCapacity

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> writeCapacity()
        Returns:
        Number of write units for this table. If the `billingMode` is `PROVISIONED`, this field is required.