IField

class aws_cdk.aws_appsync.IField(*args, **kwds)

Bases: typing_extensions.Protocol

(experimental) A Graphql Field.

Stability

experimental

Methods

args_to_string()

(experimental) Generate the arguments for this field.

Stability

experimental

Return type

str

directives_to_string(modes=None)

(experimental) Generate the directives for this field.

Parameters

modes (Optional[List[AuthorizationType]]) – the authorization modes of the graphql api.

Default
  • no authorization modes

Stability

experimental

Return type

str

to_string()

(experimental) Generate the string for this attribute.

Stability

experimental

Return type

str

Attributes

field_options

(experimental) The options to make this field resolvable.

Default
  • not a resolvable field

Stability

experimental

Return type

Optional[ResolvableFieldOptions]

intermediate_type

(experimental) the intermediate type linked to this attribute (i.e. an interface or an object).

Default
  • no intermediate type

Stability

experimental

Return type

Optional[IIntermediateType]

is_list

(experimental) property determining if this attribute is a list i.e. if true, attribute would be [Type].

Default

false

Stability

experimental

Return type

bool

is_required

(experimental) property determining if this attribute is non-nullable i.e. if true, attribute would be Type! and this attribute must always have a value.

Default

false

Stability

experimental

Return type

bool

is_required_list

(experimental) property determining if this attribute is a non-nullable list i.e. if true, attribute would be [ Type ]! and this attribute’s list must always have a value.

Default

false

Stability

experimental

Return type

bool

type

(experimental) the type of attribute.

Stability

experimental

Return type

Type