software.amazon.awscdk.services.appsync

Class EnumType

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.appsync.EnumType

All Implemented Interfaces:

IIntermediateType

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:51.517Z")
public class EnumType
extends software.amazon.jsii.JsiiObject
implements IIntermediateType

(experimental) Enum Types are abstract types that includes a set of fields that represent the strings this type can create.

Example:

 GraphqlApi api;
 EnumType episode = EnumType.Builder.create("Episode")
         .definition(List.of("NEWHOPE", "EMPIRE", "JEDI"))
         .build();
 api.addType(episode);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EnumType.Builder (experimental) A fluent builder for EnumType.

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.appsync.IIntermediateType

IIntermediateType.Jsii$Default, IIntermediateType.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EnumType(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	EnumType(software.amazon.jsii.JsiiObjectRef objRef)
	EnumType(java.lang.String name, EnumTypeOptions options)

Method Summary

Modifier and Type	Method and Description
void	addField(AddFieldOptions options) (experimental) Add a field to this Enum Type.
GraphqlType	attribute() (experimental) Create an GraphQL Type representing this Enum Type.
GraphqlType	attribute(BaseTypeOptions options) (experimental) Create an GraphQL Type representing this Enum Type.
java.util.Map<java.lang.String,IField>	getDefinition() (experimental) the attributes of this type.
protected java.util.List<AuthorizationType>	getModes() (experimental) the authorization modes for this intermediate type.
java.lang.String	getName() (experimental) the name of this type.
protected void	setModes(java.util.List<AuthorizationType> value) (experimental) the authorization modes for this intermediate type.
java.lang.String	toString() (experimental) Generate the string of this enum type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.services.appsync.IIntermediateType

getDirectives, getInterfaceTypes, getIntermediateType, getResolvers, setResolvers

Constructor Detail

EnumType

protected EnumType(software.amazon.jsii.JsiiObjectRef objRef)

EnumType

protected EnumType(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

EnumType

public EnumType(java.lang.String name,
                EnumTypeOptions options)

Parameters:

name - This parameter is required.

options - This parameter is required.

Method Detail

addField

public void addField(AddFieldOptions options)

(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.

Specified by:

addField in interface IIntermediateType

Parameters:

options - the options to add a field. This parameter is required.

attribute

public GraphqlType attribute(BaseTypeOptions options)

(experimental) Create an GraphQL Type representing this Enum Type.

Specified by:

attribute in interface IIntermediateType

Parameters:

options -

attribute

public GraphqlType attribute()

(experimental) Create an GraphQL Type representing this Enum Type.

Specified by:

attribute in interface IIntermediateType

toString

public java.lang.String toString()

(experimental) Generate the string of this enum type.

Specified by:

toString in interface IIntermediateType

getDefinition

public java.util.Map<java.lang.String,IField> getDefinition()

(experimental) the attributes of this type.

Specified by:

getDefinition in interface IIntermediateType

getName

public java.lang.String getName()

(experimental) the name of this type.

Specified by:

getName in interface IIntermediateType

getModes

protected java.util.List<AuthorizationType> getModes()

(experimental) the authorization modes for this intermediate type.

setModes

protected void setModes(java.util.List<AuthorizationType> value)

(experimental) the authorization modes for this intermediate type.