GlobalSecondaryIndexState class

Input properties used for looking up and filtering GlobalSecondaryIndex resources.

Constructors

GlobalSecondaryIndexState({Input<String?>? arn, Input<String?>? indexName, Input<List<GlobalSecondaryIndexKeySchema>?>? keySchemas, Input<GlobalSecondaryIndexOnDemandThroughput?>? onDemandThroughput, Input<GlobalSecondaryIndexProjection?>? projection, Input<GlobalSecondaryIndexProvisionedThroughput?>? provisionedThroughput, Input<String?>? region, Input<String?>? tableName, Input<GlobalSecondaryIndexTimeouts?>? timeouts, Input<GlobalSecondaryIndexWarmThroughput?>? warmThroughput})
Creates a new GlobalSecondaryIndexState. arn ARN of the GSI. indexName Name of the index. keySchemas Set of nested attribute definitions. onDemandThroughput Sets the maximum number of read and write units for the index. projection Describes which attributes from the table are represented in the index. provisionedThroughput Provisioned throughput for the index. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. tableName Name of the table this index belongs to. timeouts Optional. warmThroughput Sets the number of warm read and write units for this index.
const
GlobalSecondaryIndexState.fromMap(Map<String, dynamic> map)
factory

Properties

arn → Input<String?>?
ARN of the GSI.
final
hashCode → int
The hash code for this object.
no setterinherited
indexName → Input<String?>?
Name of the index.
final
keySchemas → Input<List<GlobalSecondaryIndexKeySchema>?>?
Set of nested attribute definitions. At least 1 element defining a HASH is required. All elements with the keyType of HASH must precede elements with keyType of RANGE. Changing any values in keySchema will re-create the resource. See keySchema below.
final
onDemandThroughput → Input<GlobalSecondaryIndexOnDemandThroughput?>?
Sets the maximum number of read and write units for the index. See onDemandThroughput below. Only valid if the table's billingMode is PAY_PER_REQUEST.
final
projection → Input<GlobalSecondaryIndexProjection?>?
Describes which attributes from the table are represented in the index. See projection below.
final
provisionedThroughput → Input<GlobalSecondaryIndexProvisionedThroughput?>?
Provisioned throughput for the index. See provisionedThroughput below. Required if the table's billingMode is PROVISIONED.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tableName → Input<String?>?
Name of the table this index belongs to.
final
timeouts → Input<GlobalSecondaryIndexTimeouts?>?
final
warmThroughput → Input<GlobalSecondaryIndexWarmThroughput?>?
Sets the number of warm read and write units for this index. See warmThroughput below.
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