GlobalSecondaryIndexState class
Input properties used for looking up and filtering GlobalSecondaryIndex resources.
Constructors
-
GlobalSecondaryIndexState({Input<
String?> ? arn, Input<String?> ? indexName, Input<List< ? keySchemas, Input<GlobalSecondaryIndexKeySchema> ?>GlobalSecondaryIndexOnDemandThroughput?> ? onDemandThroughput, Input<GlobalSecondaryIndexProjection?> ? projection, Input<GlobalSecondaryIndexProvisionedThroughput?> ? provisionedThroughput, Input<String?> ? region, Input<String?> ? tableName, Input<GlobalSecondaryIndexTimeouts?> ? timeouts, Input<GlobalSecondaryIndexWarmThroughput?> ? warmThroughput}) -
Creates a new GlobalSecondaryIndexState.
arnARN of the GSI.indexNameName of the index.keySchemasSet of nested attribute definitions.onDemandThroughputSets the maximum number of read and write units for the index.projectionDescribes which attributes from the table are represented in the index.provisionedThroughputProvisioned throughput for the index.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.tableNameName of the table this index belongs to.timeoutsOptional.warmThroughputSets 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
HASHis required. All elements with thekeyTypeofHASHmust precede elements withkeyTypeofRANGE. Changing any values inkeySchemawill re-create the resource. SeekeySchemabelow.final -
onDemandThroughput
→ Input<
GlobalSecondaryIndexOnDemandThroughput?> ? -
Sets the maximum number of read and write units for the index.
See
onDemandThroughputbelow. Only valid if the table'sbillingModeisPAY_PER_REQUEST.final -
projection
→ Input<
GlobalSecondaryIndexProjection?> ? -
Describes which attributes from the table are represented in the index.
See
projectionbelow.final -
provisionedThroughput
→ Input<
GlobalSecondaryIndexProvisionedThroughput?> ? -
Provisioned throughput for the index.
See
provisionedThroughputbelow. Required if the table'sbillingModeisPROVISIONED.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
warmThroughputbelow.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