Type alias ModelType<T, UsedMethod>

Type declaration

• [brandSymbol]: typeof brandName

• authorization:function

  • authorization<AuthRuleType>(callback): ModelType<SetTypeSubArg<T, "authorization", AuthRuleType[]>, "authorization" | UsedMethod>

  • Configures authorization rules for public, signed-in user, per user, and per user group data access

    Type Parameters

    • AuthRuleType extends AnyAuthorization

    Parameters

    • callback: ((allow) => AuthRuleType | AuthRuleType[])

      A function that receives an allow modifier to define authorization rules

      • • (allow): AuthRuleType | AuthRuleType[]

        • Parameters

          • allow: BaseAllowModifier

          Returns AuthRuleType | AuthRuleType[]

    Returns ModelType<SetTypeSubArg<T, "authorization", AuthRuleType[]>, "authorization" | UsedMethod>

    A ModelType instance with updated authorization rules

    Example

    a.model().authorization((allow) => [
      allow.guest(),
      allow.publicApiKey(),
      allow.authenticated(),
    ])
    Copy

• disableOperations:function

  • disableOperations<const Ops>(ops): ModelType<SetTypeSubArg<T, "disabledOperations", Ops>, UsedMethod | "disableOperations">

  • Disables the specified operations for the model

    Type Parameters

    • const Ops extends readonly DisableOperationsOptions[]

    Parameters

    • ops: Ops

      A list of operations to be disabled

    Returns ModelType<SetTypeSubArg<T, "disabledOperations", Ops>, UsedMethod | "disableOperations">

    A ModelType instance with updated disabled operations

    Example

    a.model().disableOperations(['delete', 'update', 'queries', 'subscriptions'])
    Copy

    See

    Amplify Data documentation for supported operations

• identifier:function

  • identifier<PrimaryIndexFields, PrimaryIndexPool, const ID, const PrimaryIndexIR>(identifier): ModelType<SetTypeSubArg<T, "identifier", PrimaryIndexIR>, "identifier" | UsedMethod>

  • Defines single-field or composite identifiers, the fields must be marked required

    Type Parameters

    • PrimaryIndexFields = ExtractSecondaryIndexIRFields<T>

    • PrimaryIndexPool extends string = keyof PrimaryIndexFields & string

    • const ID extends readonly PrimaryIndexPool[] = readonly []

    • const PrimaryIndexIR extends PrimaryIndexIrShape = PrimaryIndexFieldsToIR<ID, PrimaryIndexFields>

    Parameters

    • identifier: ID

      A list of field names used as identifiers for the data model

    Returns ModelType<SetTypeSubArg<T, "identifier", PrimaryIndexIR>, "identifier" | UsedMethod>

    A ModelType instance with updated identifiers

    Example

    a.model({
     name: a.string().required(),
     email: a.string().required(),
     age: a.integer(),
    }).identifier(['name', 'email'])
    Copy

• secondaryIndexes:function

  • secondaryIndexes<const SecondaryIndexFields, const SecondaryIndexPKPool, const Indexes, const IndexesIR>(callback): ModelType<SetTypeSubArg<T, "secondaryIndexes", IndexesIR>, "secondaryIndexes" | UsedMethod>

  • Adds secondary index for a model, secondary index consists of a "hash key" and optionally, a "sort key"

    Type Parameters

    • const SecondaryIndexFields = ExtractSecondaryIndexIRFields<T>

    • const SecondaryIndexPKPool extends string = keyof SecondaryIndexFields & string

    • const Indexes extends readonly ModelIndexType<string, string, unknown, readonly [], any>[] = readonly []

    • const IndexesIR extends readonly any[] = SecondaryIndexToIR<Indexes, SecondaryIndexFields>

    Parameters

    • callback: ((index) => Indexes)

      A function that specifies "hash key" and "sort key"

      • • (index): Indexes

        • Parameters

          • index: (<PK>(pk) => ModelIndexType<SecondaryIndexPKPool, PK, readonly Exclude<SecondaryIndexPKPool, PK>[]>)

            • • <PK>(pk): ModelIndexType<SecondaryIndexPKPool, PK, readonly Exclude<SecondaryIndexPKPool, PK>[]>

              • Type Parameters

                • PK extends string

                Parameters

                • pk: PK

                Returns ModelIndexType<SecondaryIndexPKPool, PK, readonly Exclude<SecondaryIndexPKPool, PK>[]>

          Returns Indexes

    Returns ModelType<SetTypeSubArg<T, "secondaryIndexes", IndexesIR>, "secondaryIndexes" | UsedMethod>

    A ModelType instance with updated secondary index

    Example

    a.model().secondaryIndexes((index) => [index('type').sortKeys(['sort'])])
    Copy

    See

    • Amplify documentation for secondary indexes
    • Amazon DynamoDB documentation for secondary indexes