ObjectType¶
-
class
aws_cdk.aws_appsync.
ObjectType
(name, *, interface_types=None, definition, directives=None)¶ Bases:
aws_cdk.aws_appsync.InterfaceType
(experimental) Object Types are types declared by you.
- Stability
experimental
- Parameters
name (
str
) –interface_types (
Optional
[List
[InterfaceType
]]) – (experimental) The Interface Types this Object Type implements. Default: - no interface typesdefinition (
Mapping
[str
,IField
]) – (experimental) the attributes of this type.directives (
Optional
[List
[Directive
]]) – (experimental) the directives for this object type. Default: - no directives
- Stability
experimental
Methods
-
add_field
(*, field=None, field_name=None)¶ (experimental) Add a field to this Object Type.
Object Types must have both fieldName and field options.
- Parameters
field (
Optional
[IField
]) – (experimental) The resolvable field to add. This option must be configured for Object, Interface, Input and Union Types. Default: - no IFieldfield_name (
Optional
[str
]) – (experimental) The name of the field. This option must be configured for Object, Interface, Input and Enum Types. Default: - no fieldName
- Stability
experimental
- Return type
None
-
attribute
(*, is_list=None, is_required=None, is_required_list=None)¶ (experimental) Create a GraphQL Type representing this Intermediate Type.
- Parameters
is_list (
Optional
[bool
]) – (experimental) property determining if this attribute is a list i.e. if true, attribute would be [Type]. Default: - falseis_required (
Optional
[bool
]) – (experimental) property determining if this attribute is non-nullable i.e. if true, attribute would be Type! Default: - falseis_required_list (
Optional
[bool
]) – (experimental) property determining if this attribute is a non-nullable list i.e. if true, attribute would be [ Type ]! or if isRequired true, attribe would be [ Type! ]! Default: - false
- Stability
experimental
- Return type
-
to_string
()¶ (experimental) Generate the string of this object type.
- Stability
experimental
- Return type
str
Attributes
-
definition
¶ (experimental) the attributes of this type.
- Stability
experimental
- Return type
Mapping
[str
,IField
]
-
directives
¶ (experimental) the directives for this object type.
- Default
no directives
- Stability
experimental
- Return type
Optional
[List
[Directive
]]
-
interface_types
¶ (experimental) The Interface Types this Object Type implements.
- Default
no interface types
- Stability
experimental
- Return type
Optional
[List
[InterfaceType
]]
-
name
¶ (experimental) the name of this type.
- Stability
experimental
- Return type
str