class GraphqlType 🔹

Language	Type name
.NET	Amazon.CDK.AWS.AppSync.GraphqlType
Java	software.amazon.awscdk.services.appsync.GraphqlType
Python	aws_cdk.aws_appsync.GraphqlType
TypeScript (source)	@aws-cdk/aws-appsync » GraphqlType

Implements IField

The GraphQL Types in AppSync's GraphQL.

GraphQL Types are the building blocks for object types, queries, mutations, etc. They are types like String, Int, Id or even Object Types you create.

i.e. String, String!, [String], [String!], [String]!

GraphQL Types are used to define the entirety of schema.

Example

declare const api: appsync.GraphqlApi;
declare const dummyRequest: appsync.MappingTemplate;
declare const dummyResponse: appsync.MappingTemplate;
const info = new appsync.ObjectType('Info', {
  definition: {
    node: new appsync.ResolvableField({
      returnType: appsync.GraphqlType.string(),
      args: {
        id: appsync.GraphqlType.string(),
      },
      dataSource: api.addNoneDataSource('none'),
      requestMappingTemplate: dummyRequest,
      responseMappingTemplate: dummyResponse,
    }),
  },
});

Initializer (protected)

super(type: Type, options?: GraphqlTypeOptions)

Parameters

• type Type
• options GraphqlTypeOptions

Properties

Name	Type	Description
isList🔹	boolean	property determining if this attribute is a list i.e. if true, attribute would be [Type].
isRequired🔹	boolean	property determining if this attribute is non-nullable i.e. if true, attribute would be Type! and this attribute must always have a value.
isRequiredList🔹	boolean	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.
type🔹	Type	the type of attribute.
intermediateType?🔹	IIntermediateType	the intermediate type linked to this attribute (i.e. an interface or an object).

---

isList🔹

Type: boolean

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

---

isRequired🔹

Type: boolean

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

---

isRequiredList🔹

Type: boolean

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.

---

type🔹

Type: Type

the type of attribute.

---

intermediateType?🔹

Type: IIntermediateType (optional, default: no intermediate type)

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

Methods

Name	Description
argsToString()🔹	Generate the arguments for this field.
directivesToString(_modes?)🔹	Generate the directives for this field.
toString()🔹	Generate the string for this attribute.
static awsDate(options?)🔹	AWSDate scalar type represents a valid extended ISO 8601 Date string.
static awsDateTime(options?)🔹	AWSDateTime scalar type represents a valid extended ISO 8601 DateTime string.
static awsEmail(options?)🔹	AWSEmail scalar type represents an email address string (i.e.username@example.com).
static awsIpAddress(options?)🔹	AWSIPAddress scalar type respresents a valid IPv4 of IPv6 address string.
static awsJson(options?)🔹	AWSJson scalar type represents a JSON string.
static awsPhone(options?)🔹	AWSPhone scalar type represents a valid phone number. Phone numbers maybe be whitespace delimited or hyphenated.
static awsTime(options?)🔹	AWSTime scalar type represents a valid extended ISO 8601 Time string.
static awsTimestamp(options?)🔹	AWSTimestamp scalar type represents the number of seconds since 1970-01-01T00:00Z.
static awsUrl(options?)🔹	AWSURL scalar type represetns a valid URL string.
static boolean(options?)🔹	Boolean scalar type is a boolean value: true or false.
static float(options?)🔹	Float scalar type is a signed double-precision fractional value.
static id(options?)🔹	ID scalar type is a unique identifier. ID type is serialized similar to String.
static int(options?)🔹	Int scalar type is a signed non-fractional numerical value.
static intermediate(options?)🔹	an intermediate type to be added as an attribute (i.e. an interface or an object type).
static string(options?)🔹	String scalar type is a free-form human-readable text.

---

argsToString()🔹

public argsToString(): string

Returns

• string

Generate the arguments for this field.

---

directivesToString(_modes?)🔹

public directivesToString(_modes?: AuthorizationType[]): string

Parameters

• _modes AuthorizationType[]

Returns

• string

Generate the directives for this field.

---

toString()🔹

public toString(): string

Returns

• string

Generate the string for this attribute.

---

static awsDate(options?)🔹

public static awsDate(options?: BaseTypeOptions): GraphqlType

Parameters

• options BaseTypeOptions — the options to configure this attribute - isList - isRequired - isRequiredList.

Returns

• GraphqlType

AWSDate scalar type represents a valid extended ISO 8601 Date string.

In other words, accepts date strings in the form of YYYY-MM-DD. It accepts time zone offsets.

---

static awsDateTime(options?)🔹

public static awsDateTime(options?: BaseTypeOptions): GraphqlType

Parameters

• options BaseTypeOptions — the options to configure this attribute - isList - isRequired - isRequiredList.

Returns

• GraphqlType

AWSDateTime scalar type represents a valid extended ISO 8601 DateTime string.

In other words, accepts date strings in the form of YYYY-MM-DDThh:mm:ss.sssZ. It accepts time zone offsets.

---

static awsEmail(options?)🔹

public static awsEmail(options?: BaseTypeOptions): GraphqlType

Parameters

• options BaseTypeOptions — the options to configure this attribute - isList - isRequired - isRequiredList.

Returns

• GraphqlType

AWSEmail scalar type represents an email address string (i.e.username@example.com).

---

static awsIpAddress(options?)🔹

public static awsIpAddress(options?: BaseTypeOptions): GraphqlType

Parameters

• options BaseTypeOptions — the options to configure this attribute - isList - isRequired - isRequiredList.

Returns

• GraphqlType

AWSIPAddress scalar type respresents a valid IPv4 of IPv6 address string.

---

static awsJson(options?)🔹

public static awsJson(options?: BaseTypeOptions): GraphqlType

Parameters

• options BaseTypeOptions — the options to configure this attribute - isList - isRequired - isRequiredList.

Returns

• GraphqlType

AWSJson scalar type represents a JSON string.

---

static awsPhone(options?)🔹

public static awsPhone(options?: BaseTypeOptions): GraphqlType

Parameters

• options BaseTypeOptions — the options to configure this attribute - isList - isRequired - isRequiredList.

Returns

• GraphqlType

AWSPhone scalar type represents a valid phone number. Phone numbers maybe be whitespace delimited or hyphenated.

The number can specify a country code at the beginning, but is not required for US phone numbers.

---

static awsTime(options?)🔹

public static awsTime(options?: BaseTypeOptions): GraphqlType

Parameters

• options BaseTypeOptions — the options to configure this attribute - isList - isRequired - isRequiredList.

Returns

• GraphqlType

AWSTime scalar type represents a valid extended ISO 8601 Time string.

In other words, accepts date strings in the form of hh:mm:ss.sss. It accepts time zone offsets.

---

static awsTimestamp(options?)🔹

public static awsTimestamp(options?: BaseTypeOptions): GraphqlType

Parameters

• options BaseTypeOptions — the options to configure this attribute - isList - isRequired - isRequiredList.

Returns

• GraphqlType

AWSTimestamp scalar type represents the number of seconds since 1970-01-01T00:00Z.

Timestamps are serialized and deserialized as numbers.

---

static awsUrl(options?)🔹

public static awsUrl(options?: BaseTypeOptions): GraphqlType

Parameters

• options BaseTypeOptions — the options to configure this attribute - isList - isRequired - isRequiredList.

Returns

• GraphqlType

AWSURL scalar type represetns a valid URL string.

URLs wihtout schemes or contain double slashes are considered invalid.

---

static boolean(options?)🔹

public static boolean(options?: BaseTypeOptions): GraphqlType

Parameters

• options BaseTypeOptions — the options to configure this attribute - isList - isRequired - isRequiredList.

Returns

• GraphqlType

Boolean scalar type is a boolean value: true or false.

---

static float(options?)🔹

public static float(options?: BaseTypeOptions): GraphqlType

Parameters

• options BaseTypeOptions — the options to configure this attribute - isList - isRequired - isRequiredList.

Returns

• GraphqlType

Float scalar type is a signed double-precision fractional value.

---

static id(options?)🔹

public static id(options?: BaseTypeOptions): GraphqlType

Parameters

• options BaseTypeOptions — the options to configure this attribute - isList - isRequired - isRequiredList.

Returns

• GraphqlType

ID scalar type is a unique identifier. ID type is serialized similar to String.

Often used as a key for a cache and not intended to be human-readable.

---

static int(options?)🔹

public static int(options?: BaseTypeOptions): GraphqlType

Parameters

• options BaseTypeOptions — the options to configure this attribute - isList - isRequired - isRequiredList.

Returns

• GraphqlType

Int scalar type is a signed non-fractional numerical value.

---

static intermediate(options?)🔹

public static intermediate(options?: GraphqlTypeOptions): GraphqlType

Parameters

• options GraphqlTypeOptions — the options to configure this attribute - isList - isRequired - isRequiredList - intermediateType.

Returns

• GraphqlType

an intermediate type to be added as an attribute (i.e. an interface or an object type).

---

static string(options?)🔹

public static string(options?: BaseTypeOptions): GraphqlType

Parameters

• options BaseTypeOptions — the options to configure this attribute - isList - isRequired - isRequiredList.

Returns

• GraphqlType

String scalar type is a free-form human-readable text.