CodegenGenericDataRelationshipType - AmplifyUIBuilder

CodegenGenericDataRelationshipType

Describes the relationship between generic data models.

Contents

relatedModelName

The name of the related model in the data relationship.

Type: String

Required: Yes

type

The data relationship type.

Type: String

Valid Values: HAS_MANY | HAS_ONE | BELONGS_TO

Required: Yes

associatedFields

The associated fields of the data relationship.

Type: Array of strings

Required: No

belongsToFieldOnRelatedModel

The value of the belongsTo field on the related data model.

Type: String

Required: No

canUnlinkAssociatedModel

Specifies whether the relationship can unlink the associated model.

Type: Boolean

Required: No

isHasManyIndex

Specifies whether the @index directive is supported for a hasMany data relationship.

Type: Boolean

Required: No

relatedJoinFieldName

The name of the related join field in the data relationship.

Type: String

Required: No

relatedJoinTableName

The name of the related join table in the data relationship.

Type: String

Required: No

relatedModelFields

The related model fields in the data relationship.

Type: Array of strings

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: