TableArgs class
The set of arguments for Table. The set of arguments for Table.
Constructors
-
TableArgs({Input<
List< ? attributes, Input<TableAttribute> ?>String?> ? billingMode, Input<bool?> ? deletionProtectionEnabled, Input<List< ? globalSecondaryIndexes, Input<TableGlobalSecondaryIndex> ?>TableGlobalTableWitness?> ? globalTableWitness, Input<String?> ? hashKey, Input<TableImportTable?> ? importTable, Input<List< ? localSecondaryIndexes, Input<TableLocalSecondaryIndex> ?>String?> ? name, Input<TableOnDemandThroughput?> ? onDemandThroughput, Input<TablePointInTimeRecovery?> ? pointInTimeRecovery, Input<String?> ? rangeKey, Input<int?> ? readCapacity, Input<String?> ? region, Input<List< ? replicas, Input<TableReplica> ?>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< ? tags, Input<String, String> ?>TableTtl?> ? ttl, Input<TableWarmThroughput?> ? warmThroughput, Input<int?> ? writeCapacity}) -
Creates a new TableArgs.
attributesSet of nested attribute definitions. Only required forhashKeyandrangeKeyattributes. See below.billingModeControls how you are charged for read and write throughput and how you manage capacity. The valid values arePROVISIONEDandPAY_PER_REQUEST. Defaults toPROVISIONED.deletionProtectionEnabledEnables deletion protection for table. Defaults tofalse.globalSecondaryIndexesDescribe a GSI for the table; subject to the normal limits on the number of GSIs, projected attributes, etc. See below.globalTableWitnessWitness Region in a Multi-Region Strong Consistency deployment. Note This must be used alongside a singlereplicawithconsistencyModeset toSTRONG. Other combinations will fail to provision. See below.hashKeyAttribute to use as the hash (partition) key. Must also be defined as anattribute. See below.importTableImport Amazon S3 data into a new table. See below.localSecondaryIndexesDescribe 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.nameUnique within a region name of the table.onDemandThroughputSets the maximum number of read and write units for the specified on-demand table. See below.pointInTimeRecoveryEnable point-in-time recovery options. See below.rangeKeyAttribute to use as the range (sort) key. Must also be defined as anattribute, see below.readCapacityNumber of read units for this table. If thebillingModeisPROVISIONED, this field is required.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.replicasConfiguration block(s) with DynamoDB Global Tables V2 (version 2019.11.21) replication configurations. See below.restoreBackupArnARN of backup to restore.restoreDateTimeTime of the point-in-time recovery point to restore.restoreSourceNameName of the table to restore. Must match the name of an existing table.restoreSourceTableArnARN of the source table to restore. Must be supplied for cross-region restores.restoreToLatestTimeIf set, restores table to the most recent point-in-time recovery point.serverSideEncryptionEncryption 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.streamEnabledWhether Streams are enabled.streamViewTypeWhen an item in the table is modified, StreamViewType determines what information is written to the table's stream.tableClassStorage class of the table.tagsA map of tags to populate on the created table. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.ttlConfiguration block for TTL. See below.warmThroughputSets the number of warm read and write units for the specified table. See below.writeCapacityNumber of write units for this table. If thebillingModeisPROVISIONED, 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
hashKeyandrangeKeyattributes. 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
PROVISIONEDandPAY_PER_REQUEST. Defaults toPROVISIONED.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
replicawithconsistencyModeset toSTRONG. 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
billingModeisPROVISIONED, 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 whenstreamEnabledis true.final -
tableClass
→ Input<
String?> ? -
Storage class of the table.
Valid values are
STANDARDandSTANDARD_INFREQUENT_ACCESS. Default value isSTANDARD.final -
A map of tags to populate on the created table. If configured with a provider
defaultTagsconfiguration 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
billingModeisPROVISIONED, 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