Interface IBaseTypeOptions

(experimental) Base options for GraphQL Types.

Namespace: Amazon.CDK.AWS.AppSync

Assembly: Amazon.CDK.AWS.AppSync.dll

Syntax (csharp)

public interface IBaseTypeOptions

Syntax (vb)

Public Interface IBaseTypeOptions

Remarks

Stability: Experimental

Option: isRequiredList - is this attribute a non-nullable list

ExampleMetadata: infused

Examples

var api = new GraphqlApi(this, "Api", new GraphqlApiProps {
    Name = "demo"
});
var demo = new ObjectType("Demo", new ObjectTypeOptions {
    Definition = new Dictionary<string, IField> {
        { "id", GraphqlType.String(new BaseTypeOptions { IsRequired = true }) },
        { "version", GraphqlType.String(new BaseTypeOptions { IsRequired = true }) }
    }
});

api.AddType(demo);

Synopsis

Properties

IsList	(experimental) property determining if this attribute is a list i.e. if true, attribute would be [Type].
IsRequired	(experimental) property determining if this attribute is non-nullable i.e. if true, attribute would be Type!
IsRequiredList	(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! ]!

Properties

IsList

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

virtual Nullable<bool> IsList { get; }

Property Value

System.Nullable<System.Boolean>

Remarks

Default: - false

Stability: Experimental

IsRequired

(experimental) property determining if this attribute is non-nullable i.e. if true, attribute would be Type!

virtual Nullable<bool> IsRequired { get; }

Property Value

System.Nullable<System.Boolean>

Remarks

Default: - false

Stability: Experimental

IsRequiredList

(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! ]!

virtual Nullable<bool> IsRequiredList { get; }

Property Value

System.Nullable<System.Boolean>

Remarks

Default: - false

Stability: Experimental