EnumType
- class aws_cdk.aws_appsync.EnumType(name, *, definition)
Bases:
object
(experimental) Enum Types are abstract types that includes a set of fields that represent the strings this type can create.
- Stability:
experimental
- ExampleMetadata:
infused
Example:
# api: appsync.GraphqlApi episode = appsync.EnumType("Episode", definition=["NEWHOPE", "EMPIRE", "JEDI" ] ) api.add_type(episode)
- Parameters:
name (
str
) –definition (
Sequence
[str
]) – (experimental) the attributes of this type.
- Stability:
experimental
Methods
- add_field(*, field=None, field_name=None)
(experimental) Add a field to this Enum Type.
To add a field to this Enum Type, you must only configure addField with the fieldName 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 an GraphQL Type representing this Enum 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 enum type.
- Stability:
experimental
- Return type:
str
Attributes
- definition
(experimental) the attributes of this type.
- Stability:
experimental
- name
(experimental) the name of this type.
- Stability:
experimental