TableArgs class

The set of arguments for Table. The set of arguments for Table.

Constructors

TableArgs({Input<List<TableAttribute>?>? attributes, Input<String?>? billingMode, Input<bool?>? deletionProtectionEnabled, Input<List<TableGlobalSecondaryIndex>?>? globalSecondaryIndexes, Input<TableGlobalTableWitness?>? globalTableWitness, Input<String?>? hashKey, Input<TableImportTable?>? importTable, Input<List<TableLocalSecondaryIndex>?>? localSecondaryIndexes, Input<String?>? name, Input<TableOnDemandThroughput?>? onDemandThroughput, Input<TablePointInTimeRecovery?>? pointInTimeRecovery, Input<String?>? rangeKey, Input<int?>? readCapacity, Input<String?>? region, Input<List<TableReplica>?>? replicas, Input<String?>? restoreBackupArn, Input<String?>? restoreDateTime, Input<String?>? restoreSourceName, Input<String?>? restoreSourceTableArn, Input<bool?>? restoreToLatestTime, Input<TableServerSideEncryption?>? serverSideEncryption, Input<bool?>? streamEnabled, Input<String?>? streamViewType, Input<String?>? tableClass, Input<Map<String, String>?>? tags, Input<TableTtl?>? ttl, Input<TableWarmThroughput?>? warmThroughput, Input<int?>? writeCapacity})
Creates a new TableArgs. attributes Set of nested attribute definitions. Only required for hashKey and rangeKey attributes. See below. billingMode 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 Enables deletion protection for table. Defaults to false. globalSecondaryIndexes Describe a GSI for the table; subject to the normal limits on the number of GSIs, projected attributes, etc. See below. globalTableWitness 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 Attribute to use as the hash (partition) key. Must also be defined as an attribute. See below. importTable Import Amazon S3 data into a new table. See below. localSecondaryIndexes 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 Unique within a region name of the table. onDemandThroughput Sets the maximum number of read and write units for the specified on-demand table. See below. pointInTimeRecovery Enable point-in-time recovery options. See below. rangeKey Attribute to use as the range (sort) key. Must also be defined as an attribute, see below. readCapacity Number of read units for this table. If the billingMode is PROVISIONED, this field is required. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. replicas Configuration block(s) with DynamoDB Global Tables V2 (version 2019.11.21) replication configurations. See below. restoreBackupArn ARN of backup to restore. restoreDateTime Time of the point-in-time recovery point to restore. restoreSourceName Name of the table to restore. Must match the name of an existing table. restoreSourceTableArn ARN of the source table to restore. Must be supplied for cross-region restores. restoreToLatestTime If set, restores table to the most recent point-in-time recovery point. serverSideEncryption 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. streamEnabled Whether Streams are enabled. streamViewType When an item in the table is modified, StreamViewType determines what information is written to the table's stream. tableClass Storage class of the table. tags 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. ttl Configuration block for TTL. See below. warmThroughput Sets the number of warm read and write units for the specified table. See below. writeCapacity Number of write units for this table. If the billingMode is PROVISIONED, this field is required.
const
TableArgs.fromMap(Map<String, dynamic> map)
factory

Properties

attributes → Input<List<TableAttribute>?>?
Set of nested attribute definitions. Only required for hashKey and rangeKey attributes. See below.
final
billingMode → Input<String?>?
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.
final
deletionProtectionEnabled → Input<bool?>?
Enables deletion protection for table. Defaults to false.
final
globalSecondaryIndexes → Input<List<TableGlobalSecondaryIndex>?>?
Describe a GSI for the table; subject to the normal limits on the number of GSIs, projected attributes, etc. See below.
final
globalTableWitness → Input<TableGlobalTableWitness?>?
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.
final
hashCode → int
The hash code for this object.
no setterinherited
hashKey → Input<String?>?
Attribute to use as the hash (partition) key. Must also be defined as an attribute. See below.
final
importTable → Input<TableImportTable?>?
Import Amazon S3 data into a new table. See below.
final
localSecondaryIndexes → Input<List<TableLocalSecondaryIndex>?>?
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.
final
name → Input<String?>?
Unique within a region name of the table.
final
onDemandThroughput → Input<TableOnDemandThroughput?>?
Sets the maximum number of read and write units for the specified on-demand table. See below.
final
pointInTimeRecovery → Input<TablePointInTimeRecovery?>?
Enable point-in-time recovery options. See below.
final
rangeKey → Input<String?>?
Attribute to use as the range (sort) key. Must also be defined as an attribute, see below.
final
readCapacity → Input<int?>?
Number of read units for this table. If the billingMode is PROVISIONED, this field is required.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
replicas → Input<List<TableReplica>?>?
Configuration block(s) with DynamoDB Global Tables V2 (version 2019.11.21) replication configurations. See below.
final
restoreBackupArn → Input<String?>?
ARN of backup to restore.
final
restoreDateTime → Input<String?>?
Time of the point-in-time recovery point to restore.
final
restoreSourceName → Input<String?>?
Name of the table to restore. Must match the name of an existing table.
final
restoreSourceTableArn → Input<String?>?
ARN of the source table to restore. Must be supplied for cross-region restores.
final
restoreToLatestTime → Input<bool?>?
If set, restores table to the most recent point-in-time recovery point.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
serverSideEncryption → Input<TableServerSideEncryption?>?
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.
final
streamEnabled → Input<bool?>?
Whether Streams are enabled.
final
streamViewType → Input<String?>?
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.
final
tableClass → Input<String?>?
Storage class of the table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS. Default value is STANDARD.
final
tags → Input<Map<String, String>?>?
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.
final
ttl → Input<TableTtl?>?
Configuration block for TTL. See below.
final
warmThroughput → Input<TableWarmThroughput?>?
Sets the number of warm read and write units for the specified table. See below.
final
writeCapacity → Input<int?>?
Number of write units for this table. If the billingMode is PROVISIONED, this field is required.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited