awscdkappsyncalpha

package module
v2.0.0-alpha.10 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 26, 2021 License: Apache-2.0 Imports: 14 Imported by: 1

README

AWS AppSync Construct Library

The APIs of higher level constructs in this module are experimental and under active development. They are subject to non-backward compatible changes or removal in any future version. These are not subject to the Semantic Versioning model and breaking changes will be announced in the release notes. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.

The @aws-cdk/aws-appsync package contains constructs for building flexible APIs that use GraphQL.

import * as appsync from '@aws-cdk/aws-appsync-alpha';

Example

DynamoDB

Example of a GraphQL API with AWS_IAM authorization resolving into a DynamoDb backend data source.

GraphQL schema file schema.graphql:

type demo {
  id: String!
  version: String!
}
type Query {
  getDemos: [ demo! ]
}
input DemoInput {
  version: String!
}
type Mutation {
  addDemo(input: DemoInput!): demo
}

CDK stack file app-stack.ts:

const api = new appsync.GraphqlApi(this, 'Api', {
  name: 'demo',
  schema: appsync.Schema.fromAsset(path.join(__dirname, 'schema.graphql')),
  authorizationConfig: {
    defaultAuthorization: {
      authorizationType: appsync.AuthorizationType.IAM,
    },
  },
  xrayEnabled: true,
});

const demoTable = new dynamodb.Table(this, 'DemoTable', {
  partitionKey: {
    name: 'id',
    type: dynamodb.AttributeType.STRING,
  },
});

const demoDS = api.addDynamoDbDataSource('demoDataSource', demoTable);

// Resolver for the Query "getDemos" that scans the DynamoDb table and returns the entire list.
demoDS.createResolver({
  typeName: 'Query',
  fieldName: 'getDemos',
  requestMappingTemplate: appsync.MappingTemplate.dynamoDbScanTable(),
  responseMappingTemplate: appsync.MappingTemplate.dynamoDbResultList(),
});

// Resolver for the Mutation "addDemo" that puts the item into the DynamoDb table.
demoDS.createResolver({
  typeName: 'Mutation',
  fieldName: 'addDemo',
  requestMappingTemplate: appsync.MappingTemplate.dynamoDbPutItem(
    appsync.PrimaryKey.partition('id').auto(),
    appsync.Values.projecting('input'),
  ),
  responseMappingTemplate: appsync.MappingTemplate.dynamoDbResultItem(),
});
Aurora Serverless

AppSync provides a data source for executing SQL commands against Amazon Aurora Serverless clusters. You can use AppSync resolvers to execute SQL statements against the Data API with GraphQL queries, mutations, and subscriptions.

// Create username and password secret for DB Cluster
const secret = new rds.DatabaseSecret(this, 'AuroraSecret', {
  username: 'clusteradmin',
});

// The VPC to place the cluster in
const vpc = new ec2.Vpc(this, 'AuroraVpc');

// Create the serverless cluster, provide all values needed to customise the database.
const cluster = new rds.ServerlessCluster(this, 'AuroraCluster', {
  engine: rds.DatabaseClusterEngine.AURORA_MYSQL,
  vpc,
  credentials: { username: 'clusteradmin' },
  clusterIdentifier: 'db-endpoint-test',
  defaultDatabaseName: 'demos',
});

// Build a data source for AppSync to access the database.
declare const api: appsync.GraphqlApi;
const rdsDS = api.addRdsDataSource('rds', cluster, secret, 'demos');

// Set up a resolver for an RDS query.
rdsDS.createResolver({
  typeName: 'Query',
  fieldName: 'getDemosRds',
  requestMappingTemplate: appsync.MappingTemplate.fromString(`
  {
    "version": "2018-05-29",
    "statements": [
      "SELECT * FROM demos"
    ]
  }
  `),
  responseMappingTemplate: appsync.MappingTemplate.fromString(`
    $utils.toJson($utils.rds.toJsonObject($ctx.result)[0])
  `),
});

// Set up a resolver for an RDS mutation.
rdsDS.createResolver({
  typeName: 'Mutation',
  fieldName: 'addDemoRds',
  requestMappingTemplate: appsync.MappingTemplate.fromString(`
  {
    "version": "2018-05-29",
    "statements": [
      "INSERT INTO demos VALUES (:id, :version)",
      "SELECT * WHERE id = :id"
    ],
    "variableMap": {
      ":id": $util.toJson($util.autoId()),
      ":version": $util.toJson($ctx.args.version)
    }
  }
  `),
  responseMappingTemplate: appsync.MappingTemplate.fromString(`
    $utils.toJson($utils.rds.toJsonObject($ctx.result)[1][0])
  `),
});
HTTP Endpoints

GraphQL schema file schema.graphql:

type job {
  id: String!
  version: String!
}

input DemoInput {
  version: String!
}

type Mutation {
  callStepFunction(input: DemoInput!): job
}

GraphQL request mapping template request.vtl:

{
  "version": "2018-05-29",
  "method": "POST",
  "resourcePath": "/",
  "params": {
    "headers": {
      "content-type": "application/x-amz-json-1.0",
      "x-amz-target":"AWSStepFunctions.StartExecution"
    },
    "body": {
      "stateMachineArn": "<your step functions arn>",
      "input": "{ \"id\": \"$context.arguments.id\" }"
    }
  }
}

GraphQL response mapping template response.vtl:

{
  "id": "${context.result.id}"
}

CDK stack file app-stack.ts:

const api = new appsync.GraphqlApi(this, 'api', {
  name: 'api',
  schema: appsync.Schema.fromAsset(path.join(__dirname, 'schema.graphql')),
});

const httpDs = api.addHttpDataSource(
  'ds',
  'https://states.amazonaws.com',
  {
    name: 'httpDsWithStepF',
    description: 'from appsync to StepFunctions Workflow',
    authorizationConfig: {
      signingRegion: 'us-east-1',
      signingServiceName: 'states',
    }
  }
);

httpDs.createResolver({
  typeName: 'Mutation',
  fieldName: 'callStepFunction',
  requestMappingTemplate: appsync.MappingTemplate.fromFile('request.vtl'),
  responseMappingTemplate: appsync.MappingTemplate.fromFile('response.vtl'),
});
Elasticsearch

AppSync has builtin support for Elasticsearch from domains that are provisioned through your AWS account. You can use AppSync resolvers to perform GraphQL operations such as queries, mutations, and subscriptions.

import * as es from 'aws-cdk-lib/aws-elasticsearch';

const user = new iam.User(this, 'User');
const domain = new es.Domain(this, 'Domain', {
  version: es.ElasticsearchVersion.V7_1,
  removalPolicy: RemovalPolicy.DESTROY,
  fineGrainedAccessControl: { masterUserArn: user.userArn },
  encryptionAtRest: { enabled: true },
  nodeToNodeEncryption: true,
  enforceHttps: true,
});

declare const api: appsync.GraphqlApi;
const ds = api.addElasticsearchDataSource('ds', domain);

ds.createResolver({
  typeName: 'Query',
  fieldName: 'getTests',
  requestMappingTemplate: appsync.MappingTemplate.fromString(JSON.stringify({
    version: '2017-02-28',
    operation: 'GET',
    path: '/id/post/_search',
    params: {
      headers: {},
      queryString: {},
      body: { from: 0, size: 50 },
    },
  })),
  responseMappingTemplate: appsync.MappingTemplate.fromString(`[
    #foreach($entry in $context.result.hits.hits)
    #if( $velocityCount > 1 ) , #end
    $utils.toJson($entry.get("_source"))
    #end
  ]`),
});

Schema

Every GraphQL Api needs a schema to define the Api. CDK offers appsync.Schema for static convenience methods for various types of schema declaration: code-first or schema-first.

Code-First

When declaring your GraphQL Api, CDK defaults to a code-first approach if the schema property is not configured.

const api = new appsync.GraphqlApi(this, 'api', { name: 'myApi' });

CDK will declare a Schema class that will give your Api access functions to define your schema code-first: addType, addToSchema, etc.

You can also declare your Schema class outside of your CDK stack, to define your schema externally.

const schema = new appsync.Schema();
schema.addType(new appsync.ObjectType('demo', {
  definition: { id: appsync.GraphqlType.id() },
}));
const api = new appsync.GraphqlApi(this, 'api', {
  name: 'myApi',
  schema,
});

See the code-first schema section for more details.

Schema-First

You can define your GraphQL Schema from a file on disk. For convenience, use the appsync.Schema.fromAsset to specify the file representing your schema.

const api = new appsync.GraphqlApi(this, 'api', {
  name: 'myApi',
  schema: appsync.Schema.fromAsset(path.join(__dirname, 'schema.graphl')),
});

Imports

Any GraphQL Api that has been created outside the stack can be imported from another stack into your CDK app. Utilizing the fromXxx function, you have the ability to add data sources and resolvers through a IGraphqlApi interface.

declare const api: appsync.GraphqlApi;
declare const table: dynamodb.Table;
const importedApi = appsync.GraphqlApi.fromGraphqlApiAttributes(this, 'IApi', {
  graphqlApiId: api.apiId,
  graphqlApiArn: api.arn,
});
importedApi.addDynamoDbDataSource('TableDataSource', table);

If you don't specify graphqlArn in fromXxxAttributes, CDK will autogenerate the expected arn for the imported api, given the apiId. For creating data sources and resolvers, an apiId is sufficient.

Authorization

There are multiple authorization types available for GraphQL API to cater to different access use cases. They are:

  • API Keys (AuthorizationType.API_KEY)
  • Amazon Cognito User Pools (AuthorizationType.USER_POOL)
  • OpenID Connect (AuthorizationType.OPENID_CONNECT)
  • AWS Identity and Access Management (AuthorizationType.AWS_IAM)
  • AWS Lambda (AuthorizationType.AWS_LAMBDA)

These types can be used simultaneously in a single API, allowing different types of clients to access data. When you specify an authorization type, you can also specify the corresponding authorization mode to finish defining your authorization. For example, this is a GraphQL API with AWS Lambda Authorization.

import * as lambda from 'aws-cdk-lib/aws-lambda';
declare const authFunction: lambda.Function;

new appsync.GraphqlApi(this, 'api', {
  name: 'api',
  schema: appsync.Schema.fromAsset(path.join(__dirname, 'appsync.test.graphql')),
  authorizationConfig: {
    defaultAuthorization: {
      authorizationType: appsync.AuthorizationType.LAMBDA,
      lambdaAuthorizerConfig: {
        handler: authFunction,
        // can also specify `resultsCacheTtl` and `validationRegex`.
      },
    },
  },
});

Permissions

When using AWS_IAM as the authorization type for GraphQL API, an IAM Role with correct permissions must be used for access to API.

When configuring permissions, you can specify specific resources to only be accessible by IAM authorization. For example, if you want to only allow mutability for IAM authorized access you would configure the following.

In schema.graphql:

type Mutation {
  updateExample(...): ...
    @aws_iam
}

In IAM:

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "appsync:GraphQL"
      ],
      "Resource": [
        "arn:aws:appsync:REGION:ACCOUNT_ID:apis/GRAPHQL_ID/types/Mutation/fields/updateExample"
      ]
    }
  ]
}

See documentation for more details.

To make this easier, CDK provides grant API.

Use the grant function for more granular authorization.

const role = new iam.Role(this, 'Role', {
  assumedBy: new iam.ServicePrincipal('lambda.amazonaws.com'),
});
declare const api: appsync.GraphqlApi;

api.grant(role, appsync.IamResource.custom('types/Mutation/fields/updateExample'), 'appsync:GraphQL');
IamResource

In order to use the grant functions, you need to use the class IamResource.

  • IamResource.custom(...arns) permits custom ARNs and requires an argument.

  • IamResouce.ofType(type, ...fields) permits ARNs for types and their fields.

  • IamResource.all() permits ALL resources.

Generic Permissions

Alternatively, you can use more generic grant functions to accomplish the same usage.

These include:

  • grantMutation (use to grant access to Mutation fields)
  • grantQuery (use to grant access to Query fields)
  • grantSubscription (use to grant access to Subscription fields)
declare const api: appsync.GraphqlApi;
declare const role: iam.Role;

// For generic types
api.grantMutation(role, 'updateExample');

// For custom types and granular design
api.grant(role, appsync.IamResource.ofType('Mutation', 'updateExample'), 'appsync:GraphQL');

Pipeline Resolvers and AppSync Functions

AppSync Functions are local functions that perform certain operations onto a backend data source. Developers can compose operations (Functions) and execute them in sequence with Pipeline Resolvers.

declare const api: appsync.GraphqlApi;

const appsyncFunction = new appsync.AppsyncFunction(this, 'function', {
  name: 'appsync_function',
  api,
  dataSource: api.addNoneDataSource('none'),
  requestMappingTemplate: appsync.MappingTemplate.fromFile('request.vtl'),
  responseMappingTemplate: appsync.MappingTemplate.fromFile('response.vtl'),
});

AppSync Functions are used in tandem with pipeline resolvers to compose multiple operations.

declare const api: appsync.GraphqlApi;
declare const appsyncFunction: appsync.AppsyncFunction;

const pipelineResolver = new appsync.Resolver(this, 'pipeline', {
  api,
  dataSource: api.addNoneDataSource('none'),
  typeName: 'typeName',
  fieldName: 'fieldName',
  requestMappingTemplate: appsync.MappingTemplate.fromFile('beforeRequest.vtl'),
  pipelineConfig: [appsyncFunction],
  responseMappingTemplate: appsync.MappingTemplate.fromFile('afterResponse.vtl'),
});

Learn more about Pipeline Resolvers and AppSync Functions here.

Code-First Schema

CDK offers the ability to generate your schema in a code-first approach. A code-first approach offers a developer workflow with:

  • modularity: organizing schema type definitions into different files
  • reusability: simplifying down boilerplate/repetitive code
  • consistency: resolvers and schema definition will always be synced

The code-first approach allows for dynamic schema generation. You can generate your schema based on variables and templates to reduce code duplication.

Code-First Example

To showcase the code-first approach. Let's try to model the following schema segment.

interface Node {
  id: String
}

type Query {
  allFilms(after: String, first: Int, before: String, last: Int): FilmConnection
}

type FilmNode implements Node {
  filmName: String
}

type FilmConnection {
  edges: [FilmEdge]
  films: [Film]
  totalCount: Int
}

type FilmEdge {
  node: Film
  cursor: String
}

Above we see a schema that allows for generating paginated responses. For example, we can query allFilms(first: 100) since FilmConnection acts as an intermediary for holding FilmEdges we can write a resolver to return the first 100 films.

In a separate file, we can declare our object types and related functions. We will call this file object-types.ts and we will have created it in a way that allows us to generate other XxxConnection and XxxEdges in the future.

import * as appsync from '@aws-cdk/aws-appsync-alpha';
const pluralize = require('pluralize');

export const args = {
  after: appsync.GraphqlType.string(),
  first: appsync.GraphqlType.int(),
  before: appsync.GraphqlType.string(),
  last: appsync.GraphqlType.int(),
};

export const Node = new appsync.InterfaceType('Node', {
  definition: { id: appsync.GraphqlType.string() }
});
export const FilmNode = new appsync.ObjectType('FilmNode', {
  interfaceTypes: [Node],
  definition: { filmName: appsync.GraphqlType.string() }
});

export function generateEdgeAndConnection(base: appsync.ObjectType) {
  const edge = new appsync.ObjectType(`${base.name}Edge`, {
    definition: { node: base.attribute(), cursor: appsync.GraphqlType.string() }
  });
  const connection = new appsync.ObjectType(`${base.name}Connection`, {
    definition: {
      edges: edge.attribute({ isList: true }),
      [pluralize(base.name)]: base.attribute({ isList: true }),
      totalCount: appsync.GraphqlType.int(),
    }
  });
  return { edge: edge, connection: connection };
}

Finally, we will go to our cdk-stack and combine everything together to generate our schema.

declare const dummyRequest: appsync.MappingTemplate;
declare const dummyResponse: appsync.MappingTemplate;

const api = new appsync.GraphqlApi(this, 'Api', {
  name: 'demo',
});

const objectTypes = [ Node, FilmNode ];

const filmConnections = generateEdgeAndConnection(FilmNode);

api.addQuery('allFilms', new appsync.ResolvableField({
  returnType: filmConnections.connection.attribute(),
  args: args,
  dataSource: api.addNoneDataSource('none'),
  requestMappingTemplate: dummyRequest,
  responseMappingTemplate: dummyResponse,
}));

api.addType(Node);
api.addType(FilmNode);
api.addType(filmConnections.edge);
api.addType(filmConnections.connection);

Notice how we can utilize the generateEdgeAndConnection function to generate Object Types. In the future, if we wanted to create more Object Types, we can simply create the base Object Type (i.e. Film) and from there we can generate its respective Connections and Edges.

Check out a more in-depth example here.

GraphQL Types

One of the benefits of GraphQL is its strongly typed nature. We define the types within an object, query, mutation, interface, etc. as GraphQL Types.

GraphQL Types are the building blocks of types, whether they are scalar, objects, interfaces, etc. GraphQL Types can be:

  • Scalar Types: Id, Int, String, AWSDate, etc.
  • Object Types: types that you generate (i.e. demo from the example above)
  • Interface Types: abstract types that define the base implementation of other Intermediate Types

More concretely, GraphQL Types are simply the types appended to variables. Referencing the object type Demo in the previous example, the GraphQL Types is String! and is applied to both the names id and version.

Directives

Directives are attached to a field or type and affect the execution of queries, mutations, and types. With AppSync, we use Directives to configure authorization. CDK provides static functions to add directives to your Schema.

  • Directive.iam() sets a type or field's authorization to be validated through Iam
  • Directive.apiKey() sets a type or field's authorization to be validated through a Api Key
  • Directive.oidc() sets a type or field's authorization to be validated through OpenID Connect
  • Directive.cognito(...groups: string[]) sets a type or field's authorization to be validated through Cognito User Pools
    • groups the name of the cognito groups to give access

To learn more about authorization and directives, read these docs here.

Field and Resolvable Fields

While GraphqlType is a base implementation for GraphQL fields, we have abstractions on top of GraphqlType that provide finer grain support.

Field

Field extends GraphqlType and will allow you to define arguments. Interface Types are not resolvable and this class will allow you to define arguments, but not its resolvers.

For example, if we want to create the following type:

type Node {
  test(argument: string): String
}

The CDK code required would be:

const field = new appsync.Field({
  returnType: appsync.GraphqlType.string(),
  args: {
    argument: appsync.GraphqlType.string(),
  },
});
const type = new appsync.InterfaceType('Node', {
  definition: { test: field },
});
Resolvable Fields

ResolvableField extends Field and will allow you to define arguments and its resolvers. Object Types can have fields that resolve and perform operations on your backend.

You can also create resolvable fields for object types.

type Info {
  node(id: String): String
}

The CDK code required would be:

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,
    }),
  },
});

To nest resolvers, we can also create top level query types that call upon other types. Building off the previous example, if we want the following graphql type definition:

type Query {
  get(argument: string): Info
}

The CDK code required would be:

declare const api: appsync.GraphqlApi;
declare const dummyRequest: appsync.MappingTemplate;
declare const dummyResponse: appsync.MappingTemplate;
const query = new appsync.ObjectType('Query', {
  definition: {
    get: new appsync.ResolvableField({
      returnType: appsync.GraphqlType.string(),
      args: {
        argument: appsync.GraphqlType.string(),
      },
      dataSource: api.addNoneDataSource('none'),
      requestMappingTemplate: dummyRequest,
      responseMappingTemplate: dummyResponse,
    }),
  },
});

Learn more about fields and resolvers here.

Intermediate Types

Intermediate Types are defined by Graphql Types and Fields. They have a set of defined fields, where each field corresponds to another type in the system. Intermediate Types will be the meat of your GraphQL Schema as they are the types defined by you.

Intermediate Types include:

Interface Types

Interface Types are abstract types that define the implementation of other intermediate types. They are useful for eliminating duplication and can be used to generate Object Types with less work.

You can create Interface Types externally.

const node = new appsync.InterfaceType('Node', {
  definition: {
    id: appsync.GraphqlType.string({ isRequired: true }),
  },
});

To learn more about Interface Types, read the docs here.

Object Types

Object Types are types that you declare. For example, in the code-first example the demo variable is an Object Type. Object Types are defined by GraphQL Types and are only usable when linked to a GraphQL Api.

You can create Object Types in two ways:

  1. Object Types can be created externally.

    const api = new appsync.GraphqlApi(this, 'Api', {
  name: 'demo',
});
const demo = new appsync.ObjectType('Demo', {
  definition: {
    id: appsync.GraphqlType.string({ isRequired: true }),
    version: appsync.GraphqlType.string({ isRequired: true }),
  },
});

api.addType(demo);

    This method allows for reusability and modularity, ideal for larger projects. For example, imagine moving all Object Type definition outside the stack.

    object-types.ts - a file for object type definitions

    import * as appsync from '@aws-cdk/aws-appsync-alpha';
export const demo = new appsync.ObjectType('Demo', {
  definition: {
    id: appsync.GraphqlType.string({ isRequired: true }),
    version: appsync.GraphqlType.string({ isRequired: true }),
  },
});

    cdk-stack.ts - a file containing our cdk stack

    declare const api: appsync.GraphqlApi;
api.addType(demo);

  2. Object Types can be created externally from an Interface Type.

    const node = new appsync.InterfaceType('Node', {
  definition: {
    id: appsync.GraphqlType.string({ isRequired: true }),
  },
});
const demo = new appsync.ObjectType('Demo', {
  interfaceTypes: [ node ],
  definition: {
    version: appsync.GraphqlType.string({ isRequired: true }),
  },
});

    This method allows for reusability and modularity, ideal for reducing code duplication.

To learn more about Object Types, read the docs here.

Enum Types

Enum Types are a special type of Intermediate Type. They restrict a particular set of allowed values for other Intermediate Types.

enum Episode {
  NEWHOPE
  EMPIRE
  JEDI
}

This means that wherever we use the type Episode in our schema, we expect it to be exactly one of NEWHOPE, EMPIRE, or JEDI.

The above GraphQL Enumeration Type can be expressed in CDK as the following:

declare const api: appsync.GraphqlApi;
const episode = new appsync.EnumType('Episode', {
  definition: [
    'NEWHOPE',
    'EMPIRE',
    'JEDI',
  ],
});
api.addType(episode);

To learn more about Enum Types, read the docs here.

Input Types

Input Types are special types of Intermediate Types. They give users an easy way to pass complex objects for top level Mutation and Queries.

input Review {
  stars: Int!
  commentary: String
}

The above GraphQL Input Type can be expressed in CDK as the following:

declare const api: appsync.GraphqlApi;
const review = new appsync.InputType('Review', {
  definition: {
    stars: appsync.GraphqlType.int({ isRequired: true }),
    commentary: appsync.GraphqlType.string(),
  },
});
api.addType(review);

To learn more about Input Types, read the docs here.

Union Types

Union Types are a special type of Intermediate Type. They are similar to Interface Types, but they cannot specify any common fields between types.

Note: the fields of a union type need to be Object Types. In other words, you can't create a union type out of interfaces, other unions, or inputs.

union Search = Human | Droid | Starship

The above GraphQL Union Type encompasses the Object Types of Human, Droid and Starship. It can be expressed in CDK as the following:

declare const api: appsync.GraphqlApi;
const string = appsync.GraphqlType.string();
const human = new appsync.ObjectType('Human', { definition: { name: string } });
const droid = new appsync.ObjectType('Droid', { definition: { name: string } });
const starship = new appsync.ObjectType('Starship', { definition: { name: string } }););
const search = new appsync.UnionType('Search', {
  definition: [ human, droid, starship ],
});
api.addType(search);

To learn more about Union Types, read the docs here.

Query

Every schema requires a top level Query type. By default, the schema will look for the Object Type named Query. The top level Query is the only exposed type that users can access to perform GET operations on your Api.

To add fields for these queries, we can simply run the addQuery function to add to the schema's Query type.

declare const api: appsync.GraphqlApi;
declare const filmConnection: appsync.InterfaceType;
declare const dummyRequest: appsync.MappingTemplate;
declare const dummyResponse: appsync.MappingTemplate;

const string = appsync.GraphqlType.string();
const int = appsync.GraphqlType.int();
api.addQuery('allFilms', new appsync.ResolvableField({
  returnType: filmConnection.attribute(),
  args: { after: string, first: int, before: string, last: int},
  dataSource: api.addNoneDataSource('none'),
  requestMappingTemplate: dummyRequest,
  responseMappingTemplate: dummyResponse,
}));

To learn more about top level operations, check out the docs here.

Mutation

Every schema can have a top level Mutation type. By default, the schema will look for the ObjectType named Mutation. The top level Mutation Type is the only exposed type that users can access to perform mutable operations on your Api.

To add fields for these mutations, we can simply run the addMutation function to add to the schema's Mutation type.

declare const api: appsync.GraphqlApi;
declare const filmNode: appsync.ObjectType;
declare const dummyRequest: appsync.MappingTemplate;
declare const dummyResponse: appsync.MappingTemplate;

const string = appsync.GraphqlType.string();
const int = appsync.GraphqlType.int();
api.addMutation('addFilm', new appsync.ResolvableField({
  returnType: filmNode.attribute(),
  args: { name: string, film_number: int },
  dataSource: api.addNoneDataSource('none'),
  requestMappingTemplate: dummyRequest,
  responseMappingTemplate: dummyResponse,
}));

To learn more about top level operations, check out the docs here.

Subscription

Every schema can have a top level Subscription type. The top level Subscription Type is the only exposed type that users can access to invoke a response to a mutation. Subscriptions notify users when a mutation specific mutation is called. This means you can make any data source real time by specify a GraphQL Schema directive on a mutation.

Note: The AWS AppSync client SDK automatically handles subscription connection management.

To add fields for these subscriptions, we can simply run the addSubscription function to add to the schema's Subscription type.

declare const api: appsync.GraphqlApi;
declare const film: appsync.InterfaceType;

api.addSubscription('addedFilm', new appsync.Field({
  returnType: film.attribute(),
  args: { id: appsync.GraphqlType.id({ isRequired: true }) },
  directives: [appsync.Directive.subscribe('addFilm')],
}));

To learn more about top level operations, check out the docs here.

Documentation

Overview

The CDK Construct Library for AWS::AppSync

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AppsyncFunction_IsConstruct 

func AppsyncFunction_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func AppsyncFunction_IsResource 

func AppsyncFunction_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func BackedDataSource_IsConstruct 

func BackedDataSource_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func BaseDataSource_IsConstruct 

func BaseDataSource_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func DynamoDbDataSource_IsConstruct 

func DynamoDbDataSource_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func ElasticsearchDataSource_IsConstruct 

func ElasticsearchDataSource_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func GraphqlApiBase_IsConstruct 

func GraphqlApiBase_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func GraphqlApiBase_IsResource 

func GraphqlApiBase_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func GraphqlApi_IsConstruct 

func GraphqlApi_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func GraphqlApi_IsResource 

func GraphqlApi_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func HttpDataSource_IsConstruct 

func HttpDataSource_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func LambdaDataSource_IsConstruct 

func LambdaDataSource_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewAppsyncFunction_Override 

func NewAppsyncFunction_Override(a AppsyncFunction, scope constructs.Construct, id *string, props *AppsyncFunctionProps)

Experimental.

func NewAssign_Override 

func NewAssign_Override(a Assign, attr *string, arg *string)

Experimental.

func NewAttributeValuesStep_Override 

func NewAttributeValuesStep_Override(a AttributeValuesStep, attr *string, container *string, assignments *[]Assign)

Experimental.

func NewAttributeValues_Override 

func NewAttributeValues_Override(a AttributeValues, container *string, assignments *[]Assign)

Experimental.

func NewBackedDataSource_Override 

func NewBackedDataSource_Override(b BackedDataSource, scope constructs.Construct, id *string, props *BackedDataSourceProps, extended *ExtendedDataSourceProps)

Experimental.

func NewBaseDataSource_Override 

func NewBaseDataSource_Override(b BaseDataSource, scope constructs.Construct, id *string, props *BackedDataSourceProps, extended *ExtendedDataSourceProps)

Experimental.

func NewDynamoDbDataSource_Override 

func NewDynamoDbDataSource_Override(d DynamoDbDataSource, scope constructs.Construct, id *string, props *DynamoDbDataSourceProps)

Experimental.

func NewElasticsearchDataSource_Override 

func NewElasticsearchDataSource_Override(e ElasticsearchDataSource, scope constructs.Construct, id *string, props *ElasticsearchDataSourceProps)

Experimental.

func NewEnumType_Override 

func NewEnumType_Override(e EnumType, name *string, options *EnumTypeOptions)

Experimental.

func NewField_Override 

func NewField_Override(f Field, options *FieldOptions)

Experimental.

func NewGraphqlApiBase_Override 

func NewGraphqlApiBase_Override(g GraphqlApiBase, scope constructs.Construct, id *string, props *awscdk.ResourceProps)

Experimental.

func NewGraphqlApi_Override 

func NewGraphqlApi_Override(g GraphqlApi, scope constructs.Construct, id *string, props *GraphqlApiProps)

Experimental.

func NewGraphqlType_Override 

func NewGraphqlType_Override(g GraphqlType, type_ Type, options *GraphqlTypeOptions)

Experimental.

func NewHttpDataSource_Override 

func NewHttpDataSource_Override(h HttpDataSource, scope constructs.Construct, id *string, props *HttpDataSourceProps)

Experimental.

func NewInputType_Override 

func NewInputType_Override(i InputType, name *string, props *IntermediateTypeOptions)

Experimental.

func NewInterfaceType_Override 

func NewInterfaceType_Override(i InterfaceType, name *string, props *IntermediateTypeOptions)

Experimental.

func NewLambdaDataSource_Override 

func NewLambdaDataSource_Override(l LambdaDataSource, scope constructs.Construct, id *string, props *LambdaDataSourceProps)

Experimental.

func NewMappingTemplate_Override 

func NewMappingTemplate_Override(m MappingTemplate)

Experimental.

func NewNoneDataSource_Override 

func NewNoneDataSource_Override(n NoneDataSource, scope constructs.Construct, id *string, props *NoneDataSourceProps)

Experimental.

func NewObjectType_Override 

func NewObjectType_Override(o ObjectType, name *string, props *ObjectTypeOptions)

Experimental.

func NewPartitionKeyStep_Override 

func NewPartitionKeyStep_Override(p PartitionKeyStep, key *string)

Experimental.

func NewPartitionKey_Override 

func NewPartitionKey_Override(p PartitionKey, pkey Assign)

Experimental.

func NewPrimaryKey_Override 

func NewPrimaryKey_Override(p PrimaryKey, pkey Assign, skey Assign)

Experimental.

func NewRdsDataSource_Override 

func NewRdsDataSource_Override(r RdsDataSource, scope constructs.Construct, id *string, props *RdsDataSourceProps)

Experimental.

func NewResolvableField_Override 

func NewResolvableField_Override(r ResolvableField, options *ResolvableFieldOptions)

Experimental.

func NewResolver_Override 

func NewResolver_Override(r Resolver, scope constructs.Construct, id *string, props *ResolverProps)

Experimental.

func NewSchema_Override 

func NewSchema_Override(s Schema, options *SchemaOptions)

Experimental.

func NewSortKeyStep_Override 

func NewSortKeyStep_Override(s SortKeyStep, pkey Assign, skey *string)

Experimental.

func NewUnionType_Override 

func NewUnionType_Override(u UnionType, name *string, options *UnionTypeOptions)

Experimental.

func NewValues_Override 

func NewValues_Override(v Values)

Experimental.

func NoneDataSource_IsConstruct 

func NoneDataSource_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func RdsDataSource_IsConstruct 

func RdsDataSource_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func Resolver_IsConstruct 

func Resolver_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

Types

type AddFieldOptions 

type AddFieldOptions struct {
	// The resolvable field to add.
	//
	// This option must be configured for Object, Interface,
	// Input and Union Types.
	// Experimental.
	Field IField `json:"field"`
	// The name of the field.
	//
	// This option must be configured for Object, Interface,
	// Input and Enum Types.
	// Experimental.
	FieldName *string `json:"fieldName"`
}

The options to add a field to an Intermediate Type.

TODO: EXAMPLE

Experimental.

type ApiKeyConfig 

type ApiKeyConfig struct {
	// Description of API key.
	// Experimental.
	Description *string `json:"description"`
	// The time from creation time after which the API key expires.
	//
	// It must be a minimum of 1 day and a maximum of 365 days from date of creation.
	// Rounded down to the nearest hour.
	// Experimental.
	Expires awscdk.Expiration `json:"expires"`
	// Unique name of the API Key.
	// Experimental.
	Name *string `json:"name"`
}

Configuration for API Key authorization in AppSync.

TODO: EXAMPLE

Experimental.

type AppsyncFunction 

type AppsyncFunction interface {
	awscdk.Resource
	IAppsyncFunction
	DataSource() BaseDataSource
	Env() *awscdk.ResourceEnvironment
	FunctionArn() *string
	FunctionId() *string
	FunctionName() *string
	Node() constructs.Node
	PhysicalName() *string
	Stack() awscdk.Stack
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	ToString() *string
}

AppSync Functions are local functions that perform certain operations onto a backend data source.

Developers can compose operations (Functions) and execute them in sequence with Pipeline Resolvers.

TODO: EXAMPLE

Experimental.

func NewAppsyncFunction 

func NewAppsyncFunction(scope constructs.Construct, id *string, props *AppsyncFunctionProps) AppsyncFunction

Experimental.

type AppsyncFunctionAttributes 

type AppsyncFunctionAttributes struct {
	// the ARN of the AppSync function.
	// Experimental.
	FunctionArn *string `json:"functionArn"`
}

The attributes for imported AppSync Functions.

TODO: EXAMPLE

Experimental.

type AppsyncFunctionProps 

type AppsyncFunctionProps struct {
	// the description for this AppSync Function.
	// Experimental.
	Description *string `json:"description"`
	// the name of the AppSync Function.
	// Experimental.
	Name *string `json:"name"`
	// the request mapping template for the AppSync Function.
	// Experimental.
	RequestMappingTemplate MappingTemplate `json:"requestMappingTemplate"`
	// the response mapping template for the AppSync Function.
	// Experimental.
	ResponseMappingTemplate MappingTemplate `json:"responseMappingTemplate"`
	// the GraphQL Api linked to this AppSync Function.
	// Experimental.
	Api IGraphqlApi `json:"api"`
	// the data source linked to this AppSync Function.
	// Experimental.
	DataSource BaseDataSource `json:"dataSource"`
}

the CDK properties for AppSync Functions.

TODO: EXAMPLE

Experimental.

type Assign 

type Assign interface {
	PutInMap(map_ *string) *string
	RenderAsAssignment() *string
}

Utility class representing the assigment of a value to an attribute.

TODO: EXAMPLE

Experimental.

func NewAssign 

func NewAssign(attr *string, arg *string) Assign

Experimental.

type AttributeValues 

type AttributeValues interface {
	Attribute(attr *string) AttributeValuesStep
	RenderTemplate() *string
	RenderVariables() *string
}

Specifies the attribute value assignments.

TODO: EXAMPLE

Experimental.

func NewAttributeValues 

func NewAttributeValues(container *string, assignments *[]Assign) AttributeValues

Experimental.

func Values_Projecting 

func Values_Projecting(arg *string) AttributeValues

Treats the specified object as a map of assignments, where the property names represent attribute names.

It’s opinionated about how it represents some of the nested objects: e.g., it will use lists (“L”) rather than sets (“SS”, “NS”, “BS”). By default it projects the argument container ("$ctx.args"). Experimental.

type AttributeValuesStep 

type AttributeValuesStep interface {
	Is(val *string) AttributeValues
}

Utility class to allow assigning a value to an attribute.

TODO: EXAMPLE

Experimental.

func NewAttributeValuesStep 

func NewAttributeValuesStep(attr *string, container *string, assignments *[]Assign) AttributeValuesStep

Experimental.

func Values_Attribute 

func Values_Attribute(attr *string) AttributeValuesStep

Allows assigning a value to the specified attribute. Experimental.

type AuthorizationConfig 

type AuthorizationConfig struct {
	// Additional authorization modes.
	// Experimental.
	AdditionalAuthorizationModes *[]*AuthorizationMode `json:"additionalAuthorizationModes"`
	// Optional authorization configuration.
	// Experimental.
	DefaultAuthorization *AuthorizationMode `json:"defaultAuthorization"`
}

Configuration of the API authorization modes.

TODO: EXAMPLE

Experimental.

type AuthorizationMode 

type AuthorizationMode struct {
	// One of possible four values AppSync supports.
	// See: https://docs.aws.amazon.com/appsync/latest/devguide/security.html
	//
	// Experimental.
	AuthorizationType AuthorizationType `json:"authorizationType"`
	// If authorizationType is `AuthorizationType.API_KEY`, this option can be configured.
	// Experimental.
	ApiKeyConfig *ApiKeyConfig `json:"apiKeyConfig"`
	// If authorizationType is `AuthorizationType.LAMBDA`, this option is required.
	// Experimental.
	LambdaAuthorizerConfig *LambdaAuthorizerConfig `json:"lambdaAuthorizerConfig"`
	// If authorizationType is `AuthorizationType.OIDC`, this option is required.
	// Experimental.
	OpenIdConnectConfig *OpenIdConnectConfig `json:"openIdConnectConfig"`
	// If authorizationType is `AuthorizationType.USER_POOL`, this option is required.
	// Experimental.
	UserPoolConfig *UserPoolConfig `json:"userPoolConfig"`
}

Interface to specify default or additional authorization(s).

TODO: EXAMPLE

Experimental.

type AuthorizationType 

type AuthorizationType string

enum with all possible values for AppSync authorization type.

TODO: EXAMPLE

Experimental. 

const (
	AuthorizationType_API_KEY   AuthorizationType = "API_KEY"
	AuthorizationType_IAM       AuthorizationType = "IAM"
	AuthorizationType_LAMBDA    AuthorizationType = "LAMBDA"
	AuthorizationType_OIDC      AuthorizationType = "OIDC"
	AuthorizationType_USER_POOL AuthorizationType = "USER_POOL"
)

type AwsIamConfig 

type AwsIamConfig struct {
	// The signing region for AWS IAM authorization.
	// Experimental.
	SigningRegion *string `json:"signingRegion"`
	// The signing service name for AWS IAM authorization.
	// Experimental.
	SigningServiceName *string `json:"signingServiceName"`
}

The authorization config in case the HTTP endpoint requires authorization.

TODO: EXAMPLE

Experimental.

type BackedDataSource 

type BackedDataSource interface {
	BaseDataSource
	awsiam.IGrantable
	Api() IGraphqlApi
	SetApi(val IGraphqlApi)
	Ds() awsappsync.CfnDataSource
	GrantPrincipal() awsiam.IPrincipal
	Name() *string
	Node() constructs.Node
	ServiceRole() awsiam.IRole
	SetServiceRole(val awsiam.IRole)
	CreateFunction(props *BaseAppsyncFunctionProps) AppsyncFunction
	CreateResolver(props *BaseResolverProps) Resolver
	ToString() *string
}

Abstract AppSync datasource implementation.

Do not use directly but use subclasses for resource backed datasources Experimental.

type BackedDataSourceProps 

type BackedDataSourceProps struct {
	// The API to attach this data source to.
	// Experimental.
	Api IGraphqlApi `json:"api"`
	// the description of the data source.
	// Experimental.
	Description *string `json:"description"`
	// The name of the data source.
	// Experimental.
	Name *string `json:"name"`
	// The IAM service role to be assumed by AppSync to interact with the data source.
	// Experimental.
	ServiceRole awsiam.IRole `json:"serviceRole"`
}

properties for an AppSync datasource backed by a resource.

TODO: EXAMPLE

Experimental.

type BaseAppsyncFunctionProps 

type BaseAppsyncFunctionProps struct {
	// the description for this AppSync Function.
	// Experimental.
	Description *string `json:"description"`
	// the name of the AppSync Function.
	// Experimental.
	Name *string `json:"name"`
	// the request mapping template for the AppSync Function.
	// Experimental.
	RequestMappingTemplate MappingTemplate `json:"requestMappingTemplate"`
	// the response mapping template for the AppSync Function.
	// Experimental.
	ResponseMappingTemplate MappingTemplate `json:"responseMappingTemplate"`
}

the base properties for AppSync Functions.

TODO: EXAMPLE

Experimental.

type BaseDataSource 

type BaseDataSource interface {
	constructs.Construct
	Api() IGraphqlApi
	SetApi(val IGraphqlApi)
	Ds() awsappsync.CfnDataSource
	Name() *string
	Node() constructs.Node
	ServiceRole() awsiam.IRole
	SetServiceRole(val awsiam.IRole)
	CreateFunction(props *BaseAppsyncFunctionProps) AppsyncFunction
	CreateResolver(props *BaseResolverProps) Resolver
	ToString() *string
}

Abstract AppSync datasource implementation.

Do not use directly but use subclasses for concrete datasources

TODO: EXAMPLE

Experimental.

type BaseDataSourceProps 

type BaseDataSourceProps struct {
	// The API to attach this data source to.
	// Experimental.
	Api IGraphqlApi `json:"api"`
	// the description of the data source.
	// Experimental.
	Description *string `json:"description"`
	// The name of the data source.
	// Experimental.
	Name *string `json:"name"`
}

Base properties for an AppSync datasource.

TODO: EXAMPLE

Experimental.

type BaseResolverProps 

type BaseResolverProps struct {
	// name of the GraphQL field in the given type this resolver is attached to.
	// Experimental.
	FieldName *string `json:"fieldName"`
	// configuration of the pipeline resolver.
	// Experimental.
	PipelineConfig *[]IAppsyncFunction `json:"pipelineConfig"`
	// The request mapping template for this resolver.
	// Experimental.
	RequestMappingTemplate MappingTemplate `json:"requestMappingTemplate"`
	// The response mapping template for this resolver.
	// Experimental.
	ResponseMappingTemplate MappingTemplate `json:"responseMappingTemplate"`
	// name of the GraphQL type this resolver is attached to.
	// Experimental.
	TypeName *string `json:"typeName"`
}

Basic properties for an AppSync resolver.

TODO: EXAMPLE

Experimental.

type BaseTypeOptions 

type BaseTypeOptions struct {
	// property determining if this attribute is a list i.e. if true, attribute would be [Type].
	// Experimental.
	IsList *bool `json:"isList"`
	// property determining if this attribute is non-nullable i.e. if true, attribute would be Type!
	// Experimental.
	IsRequired *bool `json:"isRequired"`
	// 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! ]!
	// Experimental.
	IsRequiredList *bool `json:"isRequiredList"`
}

Base options for GraphQL Types.

TODO: EXAMPLE

Experimental.

type DataSourceOptions 

type DataSourceOptions struct {
	// The description of the data source.
	// Experimental.
	Description *string `json:"description"`
	// The name of the data source, overrides the id given by cdk.
	// Experimental.
	Name *string `json:"name"`
}

Optional configuration for data sources.

TODO: EXAMPLE

Experimental.

type Directive 

type Directive interface {
	Mode() AuthorizationType
	Modes() *[]AuthorizationType
	SetModes(val *[]AuthorizationType)
	MutationFields() *[]*string
	ToString() *string
}

Directives for types.

i.e. @aws_iam or @aws_subscribe

TODO: EXAMPLE

Experimental.

func Directive_ApiKey 

func Directive_ApiKey() Directive

Add the @aws_api_key directive. Experimental.

func Directive_Cognito 

func Directive_Cognito(groups ...*string) Directive

Add the @aws_auth or @aws_cognito_user_pools directive. Experimental.

func Directive_Custom 

func Directive_Custom(statement *string) Directive

Add a custom directive. Experimental.

func Directive_Iam 

func Directive_Iam() Directive

Add the @aws_iam directive. Experimental.

func Directive_Oidc 

func Directive_Oidc() Directive

Add the @aws_oidc directive. Experimental.

func Directive_Subscribe 

func Directive_Subscribe(mutations ...*string) Directive

Add the @aws_subscribe directive.

Only use for top level Subscription type. Experimental.

type DynamoDbDataSource 

type DynamoDbDataSource interface {
	BackedDataSource
	Api() IGraphqlApi
	SetApi(val IGraphqlApi)
	Ds() awsappsync.CfnDataSource
	GrantPrincipal() awsiam.IPrincipal
	Name() *string
	Node() constructs.Node
	ServiceRole() awsiam.IRole
	SetServiceRole(val awsiam.IRole)
	CreateFunction(props *BaseAppsyncFunctionProps) AppsyncFunction
	CreateResolver(props *BaseResolverProps) Resolver
	ToString() *string
}

An AppSync datasource backed by a DynamoDB table.

TODO: EXAMPLE

Experimental.

func NewDynamoDbDataSource 

func NewDynamoDbDataSource(scope constructs.Construct, id *string, props *DynamoDbDataSourceProps) DynamoDbDataSource

Experimental.

type DynamoDbDataSourceProps 

type DynamoDbDataSourceProps struct {
	// The API to attach this data source to.
	// Experimental.
	Api IGraphqlApi `json:"api"`
	// the description of the data source.
	// Experimental.
	Description *string `json:"description"`
	// The name of the data source.
	// Experimental.
	Name *string `json:"name"`
	// The IAM service role to be assumed by AppSync to interact with the data source.
	// Experimental.
	ServiceRole awsiam.IRole `json:"serviceRole"`
	// Specify whether this DS is read only or has read and write permissions to the DynamoDB table.
	// Experimental.
	ReadOnlyAccess *bool `json:"readOnlyAccess"`
	// The DynamoDB table backing this data source.
	// Experimental.
	Table awsdynamodb.ITable `json:"table"`
	// use credentials of caller to access DynamoDB.
	// Experimental.
	UseCallerCredentials *bool `json:"useCallerCredentials"`
}

Properties for an AppSync DynamoDB datasource.

TODO: EXAMPLE

Experimental.

type ElasticsearchDataSource 

type ElasticsearchDataSource interface {
	BackedDataSource
	Api() IGraphqlApi
	SetApi(val IGraphqlApi)
	Ds() awsappsync.CfnDataSource
	GrantPrincipal() awsiam.IPrincipal
	Name() *string
	Node() constructs.Node
	ServiceRole() awsiam.IRole
	SetServiceRole(val awsiam.IRole)
	CreateFunction(props *BaseAppsyncFunctionProps) AppsyncFunction
	CreateResolver(props *BaseResolverProps) Resolver
	ToString() *string
}

An Appsync datasource backed by Elasticsearch.

TODO: EXAMPLE

Experimental.

func NewElasticsearchDataSource 

func NewElasticsearchDataSource(scope constructs.Construct, id *string, props *ElasticsearchDataSourceProps) ElasticsearchDataSource

Experimental.

type ElasticsearchDataSourceProps 

type ElasticsearchDataSourceProps struct {
	// The API to attach this data source to.
	// Experimental.
	Api IGraphqlApi `json:"api"`
	// the description of the data source.
	// Experimental.
	Description *string `json:"description"`
	// The name of the data source.
	// Experimental.
	Name *string `json:"name"`
	// The IAM service role to be assumed by AppSync to interact with the data source.
	// Experimental.
	ServiceRole awsiam.IRole `json:"serviceRole"`
	// The elasticsearch domain containing the endpoint for the data source.
	// Experimental.
	Domain awselasticsearch.IDomain `json:"domain"`
}

Properities for the Elasticsearch Data Source.

TODO: EXAMPLE

Experimental.

type EnumType 

type EnumType interface {
	IIntermediateType
	Definition() *map[string]IField
	Modes() *[]AuthorizationType
	SetModes(val *[]AuthorizationType)
	Name() *string
	AddField(options *AddFieldOptions)
	Attribute(options *BaseTypeOptions) GraphqlType
	ToString() *string
}

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

TODO: EXAMPLE

Experimental.

func NewEnumType 

func NewEnumType(name *string, options *EnumTypeOptions) EnumType

Experimental.

type EnumTypeOptions 

type EnumTypeOptions struct {
	// the attributes of this type.
	// Experimental.
	Definition *[]*string `json:"definition"`
}

Properties for configuring an Enum Type.

TODO: EXAMPLE

Experimental.

type ExtendedDataSourceProps 

type ExtendedDataSourceProps struct {
	// configuration for DynamoDB Datasource.
	// Experimental.
	DynamoDbConfig interface{} `json:"dynamoDbConfig"`
	// configuration for Elasticsearch Datasource.
	// Experimental.
	ElasticsearchConfig interface{} `json:"elasticsearchConfig"`
	// configuration for HTTP Datasource.
	// Experimental.
	HttpConfig interface{} `json:"httpConfig"`
	// configuration for Lambda Datasource.
	// Experimental.
	LambdaConfig interface{} `json:"lambdaConfig"`
	// configuration for RDS Datasource.
	// Experimental.
	RelationalDatabaseConfig interface{} `json:"relationalDatabaseConfig"`
	// the type of the AppSync datasource.
	// Experimental.
	Type *string `json:"type"`
}

props used by implementations of BaseDataSource to provide configuration.

Should not be used directly.

TODO: EXAMPLE

Experimental.

type ExtendedResolverProps 

type ExtendedResolverProps struct {
	// name of the GraphQL field in the given type this resolver is attached to.
	// Experimental.
	FieldName *string `json:"fieldName"`
	// configuration of the pipeline resolver.
	// Experimental.
	PipelineConfig *[]IAppsyncFunction `json:"pipelineConfig"`
	// The request mapping template for this resolver.
	// Experimental.
	RequestMappingTemplate MappingTemplate `json:"requestMappingTemplate"`
	// The response mapping template for this resolver.
	// Experimental.
	ResponseMappingTemplate MappingTemplate `json:"responseMappingTemplate"`
	// name of the GraphQL type this resolver is attached to.
	// Experimental.
	TypeName *string `json:"typeName"`
	// The data source this resolver is using.
	// Experimental.
	DataSource BaseDataSource `json:"dataSource"`
}

Additional property for an AppSync resolver for data source reference.

TODO: EXAMPLE

Experimental.

type Field 

type Field interface {
	GraphqlType
	IField
	FieldOptions() *ResolvableFieldOptions
	IntermediateType() IIntermediateType
	IsList() *bool
	IsRequired() *bool
	IsRequiredList() *bool
	Type() Type
	ArgsToString() *string
	DirectivesToString(modes *[]AuthorizationType) *string
	ToString() *string
}

Fields build upon Graphql Types and provide typing and arguments.

TODO: EXAMPLE

Experimental.

func NewField 

func NewField(options *FieldOptions) Field

Experimental.

type FieldLogLevel 

type FieldLogLevel string

log-level for fields in AppSync. Experimental. 

const (
	FieldLogLevel_ALL   FieldLogLevel = "ALL"
	FieldLogLevel_ERROR FieldLogLevel = "ERROR"
	FieldLogLevel_NONE  FieldLogLevel = "NONE"
)

type FieldOptions 

type FieldOptions struct {
	// The arguments for this field.
	//
	// i.e. type Example (first: String second: String) {}
	// - where 'first' and 'second' are key values for args
	// and 'String' is the GraphqlType
	// Experimental.
	Args *map[string]GraphqlType `json:"args"`
	// the directives for this field.
	// Experimental.
	Directives *[]Directive `json:"directives"`
	// The return type for this field.
	// Experimental.
	ReturnType GraphqlType `json:"returnType"`
}

Properties for configuring a field.

TODO: EXAMPLE

Experimental.

type GraphqlApi 

type GraphqlApi interface {
	GraphqlApiBase
	ApiId() *string
	ApiKey() *string
	Arn() *string
	Env() *awscdk.ResourceEnvironment
	GraphqlUrl() *string
	Modes() *[]AuthorizationType
	Name() *string
	Node() constructs.Node
	PhysicalName() *string
	Schema() Schema
	Stack() awscdk.Stack
	AddDynamoDbDataSource(id *string, table awsdynamodb.ITable, options *DataSourceOptions) DynamoDbDataSource
	AddElasticsearchDataSource(id *string, domain awselasticsearch.IDomain, options *DataSourceOptions) ElasticsearchDataSource
	AddHttpDataSource(id *string, endpoint *string, options *HttpDataSourceOptions) HttpDataSource
	AddLambdaDataSource(id *string, lambdaFunction awslambda.IFunction, options *DataSourceOptions) LambdaDataSource
	AddMutation(fieldName *string, field ResolvableField) ObjectType
	AddNoneDataSource(id *string, options *DataSourceOptions) NoneDataSource
	AddQuery(fieldName *string, field ResolvableField) ObjectType
	AddRdsDataSource(id *string, serverlessCluster awsrds.IServerlessCluster, secretStore awssecretsmanager.ISecret, databaseName *string, options *DataSourceOptions) RdsDataSource
	AddSchemaDependency(construct awscdk.CfnResource) *bool
	AddSubscription(fieldName *string, field ResolvableField) ObjectType
	AddToSchema(addition *string, delimiter *string)
	AddType(type_ IIntermediateType) IIntermediateType
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	CreateResolver(props *ExtendedResolverProps) Resolver
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	Grant(grantee awsiam.IGrantable, resources IamResource, actions ...*string) awsiam.Grant
	GrantMutation(grantee awsiam.IGrantable, fields ...*string) awsiam.Grant
	GrantQuery(grantee awsiam.IGrantable, fields ...*string) awsiam.Grant
	GrantSubscription(grantee awsiam.IGrantable, fields ...*string) awsiam.Grant
	ToString() *string
}

An AppSync GraphQL API.

TODO: EXAMPLE

Experimental.

func NewGraphqlApi 

func NewGraphqlApi(scope constructs.Construct, id *string, props *GraphqlApiProps) GraphqlApi

Experimental.

type GraphqlApiAttributes 

type GraphqlApiAttributes struct {
	// an unique AWS AppSync GraphQL API identifier i.e. 'lxz775lwdrgcndgz3nurvac7oa'.
	// Experimental.
	GraphqlApiId *string `json:"graphqlApiId"`
	// the arn for the GraphQL Api.
	// Experimental.
	GraphqlApiArn *string `json:"graphqlApiArn"`
}

Attributes for GraphQL imports.

TODO: EXAMPLE

Experimental.

type GraphqlApiBase 

type GraphqlApiBase interface {
	awscdk.Resource
	IGraphqlApi
	ApiId() *string
	Arn() *string
	Env() *awscdk.ResourceEnvironment
	Node() constructs.Node
	PhysicalName() *string
	Stack() awscdk.Stack
	AddDynamoDbDataSource(id *string, table awsdynamodb.ITable, options *DataSourceOptions) DynamoDbDataSource
	AddElasticsearchDataSource(id *string, domain awselasticsearch.IDomain, options *DataSourceOptions) ElasticsearchDataSource
	AddHttpDataSource(id *string, endpoint *string, options *HttpDataSourceOptions) HttpDataSource
	AddLambdaDataSource(id *string, lambdaFunction awslambda.IFunction, options *DataSourceOptions) LambdaDataSource
	AddNoneDataSource(id *string, options *DataSourceOptions) NoneDataSource
	AddRdsDataSource(id *string, serverlessCluster awsrds.IServerlessCluster, secretStore awssecretsmanager.ISecret, databaseName *string, options *DataSourceOptions) RdsDataSource
	AddSchemaDependency(construct awscdk.CfnResource) *bool
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	CreateResolver(props *ExtendedResolverProps) Resolver
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	ToString() *string
}

Base Class for GraphQL API. Experimental.

type GraphqlApiProps 

type GraphqlApiProps struct {
	// the name of the GraphQL API.
	// Experimental.
	Name *string `json:"name"`
	// Optional authorization configuration.
	// Experimental.
	AuthorizationConfig *AuthorizationConfig `json:"authorizationConfig"`
	// Logging configuration for this api.
	// Experimental.
	LogConfig *LogConfig `json:"logConfig"`
	// GraphQL schema definition. Specify how you want to define your schema.
	//
	// Schema.fromFile(filePath: string) allows schema definition through schema.graphql file
	// Experimental.
	Schema Schema `json:"schema"`
	// A flag indicating whether or not X-Ray tracing is enabled for the GraphQL API.
	// Experimental.
	XrayEnabled *bool `json:"xrayEnabled"`
}

Properties for an AppSync GraphQL API.

TODO: EXAMPLE

Experimental.

type GraphqlType 

type GraphqlType interface {
	IField
	IntermediateType() IIntermediateType
	IsList() *bool
	IsRequired() *bool
	IsRequiredList() *bool
	Type() Type
	ArgsToString() *string
	DirectivesToString(_modes *[]AuthorizationType) *string
	ToString() *string
}

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.

TODO: EXAMPLE

Experimental.

func Field_AwsDate 

func Field_AwsDate(options *BaseTypeOptions) 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. Experimental.

func Field_AwsDateTime 

func Field_AwsDateTime(options *BaseTypeOptions) 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. Experimental.

func Field_AwsEmail 

func Field_AwsEmail(options *BaseTypeOptions) GraphqlType

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

func Field_AwsIpAddress 

func Field_AwsIpAddress(options *BaseTypeOptions) GraphqlType

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

func Field_AwsJson 

func Field_AwsJson(options *BaseTypeOptions) GraphqlType

`AWSJson` scalar type represents a JSON string. Experimental.

func Field_AwsPhone 

func Field_AwsPhone(options *BaseTypeOptions) 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. Experimental.

func Field_AwsTime 

func Field_AwsTime(options *BaseTypeOptions) 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. Experimental.

func Field_AwsTimestamp 

func Field_AwsTimestamp(options *BaseTypeOptions) GraphqlType

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

Timestamps are serialized and deserialized as numbers. Experimental.

func Field_AwsUrl 

func Field_AwsUrl(options *BaseTypeOptions) GraphqlType

`AWSURL` scalar type represetns a valid URL string.

URLs wihtout schemes or contain double slashes are considered invalid. Experimental.

func Field_Boolean 

func Field_Boolean(options *BaseTypeOptions) GraphqlType

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

func Field_Float 

func Field_Float(options *BaseTypeOptions) GraphqlType

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

func Field_Id 

func Field_Id(options *BaseTypeOptions) 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. Experimental.

func Field_Int 

func Field_Int(options *BaseTypeOptions) GraphqlType

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

func Field_Intermediate 

func Field_Intermediate(options *GraphqlTypeOptions) GraphqlType

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

func Field_String 

func Field_String(options *BaseTypeOptions) GraphqlType

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

func GraphqlType_AwsDate 

func GraphqlType_AwsDate(options *BaseTypeOptions) 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. Experimental.

func GraphqlType_AwsDateTime 

func GraphqlType_AwsDateTime(options *BaseTypeOptions) 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. Experimental.

func GraphqlType_AwsEmail 

func GraphqlType_AwsEmail(options *BaseTypeOptions) GraphqlType

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

func GraphqlType_AwsIpAddress 

func GraphqlType_AwsIpAddress(options *BaseTypeOptions) GraphqlType

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

func GraphqlType_AwsJson 

func GraphqlType_AwsJson(options *BaseTypeOptions) GraphqlType

`AWSJson` scalar type represents a JSON string. Experimental.

func GraphqlType_AwsPhone 

func GraphqlType_AwsPhone(options *BaseTypeOptions) 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. Experimental.

func GraphqlType_AwsTime 

func GraphqlType_AwsTime(options *BaseTypeOptions) 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. Experimental.

func GraphqlType_AwsTimestamp 

func GraphqlType_AwsTimestamp(options *BaseTypeOptions) GraphqlType

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

Timestamps are serialized and deserialized as numbers. Experimental.

func GraphqlType_AwsUrl 

func GraphqlType_AwsUrl(options *BaseTypeOptions) GraphqlType

`AWSURL` scalar type represetns a valid URL string.

URLs wihtout schemes or contain double slashes are considered invalid. Experimental.

func GraphqlType_Boolean 

func GraphqlType_Boolean(options *BaseTypeOptions) GraphqlType

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

func GraphqlType_Float 

func GraphqlType_Float(options *BaseTypeOptions) GraphqlType

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

func GraphqlType_Id 

func GraphqlType_Id(options *BaseTypeOptions) 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. Experimental.

func GraphqlType_Int 

func GraphqlType_Int(options *BaseTypeOptions) GraphqlType

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

func GraphqlType_Intermediate 

func GraphqlType_Intermediate(options *GraphqlTypeOptions) GraphqlType

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

func GraphqlType_String 

func GraphqlType_String(options *BaseTypeOptions) GraphqlType

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

func NewGraphqlType 

func NewGraphqlType(type_ Type, options *GraphqlTypeOptions) GraphqlType

Experimental.

func ResolvableField_AwsDate 

func ResolvableField_AwsDate(options *BaseTypeOptions) 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. Experimental.

func ResolvableField_AwsDateTime 

func ResolvableField_AwsDateTime(options *BaseTypeOptions) 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. Experimental.

func ResolvableField_AwsEmail 

func ResolvableField_AwsEmail(options *BaseTypeOptions) GraphqlType

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

func ResolvableField_AwsIpAddress 

func ResolvableField_AwsIpAddress(options *BaseTypeOptions) GraphqlType

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

func ResolvableField_AwsJson 

func ResolvableField_AwsJson(options *BaseTypeOptions) GraphqlType

`AWSJson` scalar type represents a JSON string. Experimental.

func ResolvableField_AwsPhone 

func ResolvableField_AwsPhone(options *BaseTypeOptions) 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. Experimental.

func ResolvableField_AwsTime 

func ResolvableField_AwsTime(options *BaseTypeOptions) 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. Experimental.

func ResolvableField_AwsTimestamp 

func ResolvableField_AwsTimestamp(options *BaseTypeOptions) GraphqlType

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

Timestamps are serialized and deserialized as numbers. Experimental.

func ResolvableField_AwsUrl 

func ResolvableField_AwsUrl(options *BaseTypeOptions) GraphqlType

`AWSURL` scalar type represetns a valid URL string.

URLs wihtout schemes or contain double slashes are considered invalid. Experimental.

func ResolvableField_Boolean 

func ResolvableField_Boolean(options *BaseTypeOptions) GraphqlType

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

func ResolvableField_Float 

func ResolvableField_Float(options *BaseTypeOptions) GraphqlType

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

func ResolvableField_Id 

func ResolvableField_Id(options *BaseTypeOptions) 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. Experimental.

func ResolvableField_Int 

func ResolvableField_Int(options *BaseTypeOptions) GraphqlType

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

func ResolvableField_Intermediate 

func ResolvableField_Intermediate(options *GraphqlTypeOptions) GraphqlType

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

func ResolvableField_String 

func ResolvableField_String(options *BaseTypeOptions) GraphqlType

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

type GraphqlTypeOptions 

type GraphqlTypeOptions struct {
	// property determining if this attribute is a list i.e. if true, attribute would be [Type].
	// Experimental.
	IsList *bool `json:"isList"`
	// property determining if this attribute is non-nullable i.e. if true, attribute would be Type!
	// Experimental.
	IsRequired *bool `json:"isRequired"`
	// 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! ]!
	// Experimental.
	IsRequiredList *bool `json:"isRequiredList"`
	// the intermediate type linked to this attribute.
	// Experimental.
	IntermediateType IIntermediateType `json:"intermediateType"`
}

Options for GraphQL Types.

TODO: EXAMPLE

Experimental.

type HttpDataSource 

type HttpDataSource interface {
	BackedDataSource
	Api() IGraphqlApi
	SetApi(val IGraphqlApi)
	Ds() awsappsync.CfnDataSource
	GrantPrincipal() awsiam.IPrincipal
	Name() *string
	Node() constructs.Node
	ServiceRole() awsiam.IRole
	SetServiceRole(val awsiam.IRole)
	CreateFunction(props *BaseAppsyncFunctionProps) AppsyncFunction
	CreateResolver(props *BaseResolverProps) Resolver
	ToString() *string
}

An AppSync datasource backed by a http endpoint.

TODO: EXAMPLE

Experimental.

func NewHttpDataSource 

func NewHttpDataSource(scope constructs.Construct, id *string, props *HttpDataSourceProps) HttpDataSource

Experimental.

type HttpDataSourceOptions 

type HttpDataSourceOptions struct {
	// The description of the data source.
	// Experimental.
	Description *string `json:"description"`
	// The name of the data source, overrides the id given by cdk.
	// Experimental.
	Name *string `json:"name"`
	// The authorization config in case the HTTP endpoint requires authorization.
	// Experimental.
	AuthorizationConfig *AwsIamConfig `json:"authorizationConfig"`
}

Optional configuration for Http data sources.

TODO: EXAMPLE

Experimental.

type HttpDataSourceProps 

type HttpDataSourceProps struct {
	// The API to attach this data source to.
	// Experimental.
	Api IGraphqlApi `json:"api"`
	// the description of the data source.
	// Experimental.
	Description *string `json:"description"`
	// The name of the data source.
	// Experimental.
	Name *string `json:"name"`
	// The authorization config in case the HTTP endpoint requires authorization.
	// Experimental.
	AuthorizationConfig *AwsIamConfig `json:"authorizationConfig"`
	// The http endpoint.
	// Experimental.
	Endpoint *string `json:"endpoint"`
}

Properties for an AppSync http datasource.

TODO: EXAMPLE

Experimental.

type IAppsyncFunction 

type IAppsyncFunction interface {
	awscdk.IResource
	// the ARN of the AppSync function.
	// Experimental.
	FunctionArn() *string
	// the name of this AppSync Function.
	// Experimental.
	FunctionId() *string
}

Interface for AppSync Functions. Experimental.

func AppsyncFunction_FromAppsyncFunctionAttributes 

func AppsyncFunction_FromAppsyncFunctionAttributes(scope constructs.Construct, id *string, attrs *AppsyncFunctionAttributes) IAppsyncFunction

Import Appsync Function from arn. Experimental.

type IField 

type IField interface {
	// Generate the arguments for this field.
	// Experimental.
	ArgsToString() *string
	// Generate the directives for this field.
	// Experimental.
	DirectivesToString(modes *[]AuthorizationType) *string
	// Generate the string for this attribute.
	// Experimental.
	ToString() *string
	// The options to make this field resolvable.
	// Experimental.
	FieldOptions() *ResolvableFieldOptions
	// the intermediate type linked to this attribute (i.e. an interface or an object).
	// Experimental.
	IntermediateType() IIntermediateType
	// property determining if this attribute is a list i.e. if true, attribute would be `[Type]`.
	// Experimental.
	IsList() *bool
	// property determining if this attribute is non-nullable i.e. if true, attribute would be `Type!` and this attribute must always have a value.
	// Experimental.
	IsRequired() *bool
	// 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.
	// Experimental.
	IsRequiredList() *bool
	// the type of attribute.
	// Experimental.
	Type() Type
}

A Graphql Field. Experimental.

type IGraphqlApi 

type IGraphqlApi interface {
	awscdk.IResource
	// add a new DynamoDB data source to this API.
	// Experimental.
	AddDynamoDbDataSource(id *string, table awsdynamodb.ITable, options *DataSourceOptions) DynamoDbDataSource
	// add a new elasticsearch data source to this API.
	// Experimental.
	AddElasticsearchDataSource(id *string, domain awselasticsearch.IDomain, options *DataSourceOptions) ElasticsearchDataSource
	// add a new http data source to this API.
	// Experimental.
	AddHttpDataSource(id *string, endpoint *string, options *HttpDataSourceOptions) HttpDataSource
	// add a new Lambda data source to this API.
	// Experimental.
	AddLambdaDataSource(id *string, lambdaFunction awslambda.IFunction, options *DataSourceOptions) LambdaDataSource
	// add a new dummy data source to this API.
	//
	// Useful for pipeline resolvers
	// and for backend changes that don't require a data source.
	// Experimental.
	AddNoneDataSource(id *string, options *DataSourceOptions) NoneDataSource
	// add a new Rds data source to this API.
	// Experimental.
	AddRdsDataSource(id *string, serverlessCluster awsrds.IServerlessCluster, secretStore awssecretsmanager.ISecret, databaseName *string, options *DataSourceOptions) RdsDataSource
	// Add schema dependency if not imported.
	// Experimental.
	AddSchemaDependency(construct awscdk.CfnResource) *bool
	// creates a new resolver for this datasource and API using the given properties.
	// Experimental.
	CreateResolver(props *ExtendedResolverProps) Resolver
	// an unique AWS AppSync GraphQL API identifier i.e. 'lxz775lwdrgcndgz3nurvac7oa'.
	// Experimental.
	ApiId() *string
	// the ARN of the API.
	// Experimental.
	Arn() *string
}

Interface for GraphQL. Experimental.

func GraphqlApi_FromGraphqlApiAttributes 

func GraphqlApi_FromGraphqlApiAttributes(scope constructs.Construct, id *string, attrs *GraphqlApiAttributes) IGraphqlApi

Import a GraphQL API through this function. Experimental.

type IIntermediateType 

type IIntermediateType interface {
	// Add a field to this Intermediate Type.
	// Experimental.
	AddField(options *AddFieldOptions)
	// Create an GraphQL Type representing this Intermediate Type.
	// Experimental.
	Attribute(options *BaseTypeOptions) GraphqlType
	// Generate the string of this object type.
	// Experimental.
	ToString() *string
	// the attributes of this type.
	// Experimental.
	Definition() *map[string]IField
	// the directives for this object type.
	// Experimental.
	Directives() *[]Directive
	// The Interface Types this Intermediate Type implements.
	// Experimental.
	InterfaceTypes() *[]InterfaceType
	// the intermediate type linked to this attribute (i.e. an interface or an object).
	// Experimental.
	IntermediateType() IIntermediateType
	// the name of this type.
	// Experimental.
	Name() *string
	// The resolvers linked to this data source.
	// Experimental.
	Resolvers() *[]Resolver
	// The resolvers linked to this data source.
	// Experimental.
	SetResolvers(r *[]Resolver)
}

Intermediate Types are types that includes a certain set of fields that define the entirety of your schema. Experimental.

type IamResource 

type IamResource interface {
	ResourceArns(api GraphqlApi) *[]*string
}

A class used to generate resource arns for AppSync.

TODO: EXAMPLE

Experimental.

func IamResource_All 

func IamResource_All() IamResource

Generate the resource names that accepts all types: `*`. Experimental.

func IamResource_Custom 

func IamResource_Custom(arns ...*string) IamResource

Generate the resource names given custom arns. Experimental.

func IamResource_OfType 

func IamResource_OfType(type_ *string, fields ...*string) IamResource

Generate the resource names given a type and fields. Experimental.

type InputType 

type InputType interface {
	IIntermediateType
	Definition() *map[string]IField
	Modes() *[]AuthorizationType
	SetModes(val *[]AuthorizationType)
	Name() *string
	AddField(options *AddFieldOptions)
	Attribute(options *BaseTypeOptions) GraphqlType
	ToString() *string
}

Input Types are abstract types that define complex objects.

They are used in arguments to represent

TODO: EXAMPLE

Experimental.

func NewInputType 

func NewInputType(name *string, props *IntermediateTypeOptions) InputType

Experimental.

type InterfaceType 

type InterfaceType interface {
	IIntermediateType
	Definition() *map[string]IField
	Directives() *[]Directive
	Modes() *[]AuthorizationType
	SetModes(val *[]AuthorizationType)
	Name() *string
	AddField(options *AddFieldOptions)
	Attribute(options *BaseTypeOptions) GraphqlType
	ToString() *string
}

Interface Types are abstract types that includes a certain set of fields that other types must include if they implement the interface.

TODO: EXAMPLE

Experimental.

func NewInterfaceType 

func NewInterfaceType(name *string, props *IntermediateTypeOptions) InterfaceType

Experimental.

type IntermediateTypeOptions 

type IntermediateTypeOptions struct {
	// the attributes of this type.
	// Experimental.
	Definition *map[string]IField `json:"definition"`
	// the directives for this object type.
	// Experimental.
	Directives *[]Directive `json:"directives"`
}

Properties for configuring an Intermediate Type.

TODO: EXAMPLE

Experimental.

type KeyCondition 

type KeyCondition interface {
	And(keyCond KeyCondition) KeyCondition
	RenderTemplate() *string
}

Factory class for DynamoDB key conditions.

TODO: EXAMPLE

Experimental.

func KeyCondition_BeginsWith 

func KeyCondition_BeginsWith(keyName *string, arg *string) KeyCondition

Condition (k, arg).

True if the key attribute k begins with the Query argument. Experimental.

func KeyCondition_Between 

func KeyCondition_Between(keyName *string, arg1 *string, arg2 *string) KeyCondition

Condition k BETWEEN arg1 AND arg2, true if k >= arg1 and k <= arg2. Experimental.

func KeyCondition_Eq 

func KeyCondition_Eq(keyName *string, arg *string) KeyCondition

Condition k = arg, true if the key attribute k is equal to the Query argument. Experimental.

func KeyCondition_Ge 

func KeyCondition_Ge(keyName *string, arg *string) KeyCondition

Condition k >= arg, true if the key attribute k is greater or equal to the Query argument. Experimental.

func KeyCondition_Gt 

func KeyCondition_Gt(keyName *string, arg *string) KeyCondition

Condition k > arg, true if the key attribute k is greater than the the Query argument. Experimental.

func KeyCondition_Le 

func KeyCondition_Le(keyName *string, arg *string) KeyCondition

Condition k <= arg, true if the key attribute k is less than or equal to the Query argument. Experimental.

func KeyCondition_Lt 

func KeyCondition_Lt(keyName *string, arg *string) KeyCondition

Condition k < arg, true if the key attribute k is less than the Query argument. Experimental.

type LambdaAuthorizerConfig 

type LambdaAuthorizerConfig struct {
	// The authorizer lambda function.
	//
	// Note: This Lambda function must have the following resource-based policy assigned to it.
	// When configuring Lambda authorizers in the console, this is done for you.
	// To do so with the AWS CLI, run the following:
	//
	// `aws lambda add-permission --function-name "arn:aws:lambda:us-east-2:111122223333:function:my-function" --statement-id "appsync" --principal appsync.amazonaws.com --action lambda:InvokeFunction`
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-lambdaauthorizerconfig.html
	//
	// Experimental.
	Handler awslambda.IFunction `json:"handler"`
	// How long the results are cached.
	//
	// Disable caching by setting this to 0.
	// Experimental.
	ResultsCacheTtl awscdk.Duration `json:"resultsCacheTtl"`
	// A regular expression for validation of tokens before the Lambda function is called.
	// Experimental.
	ValidationRegex *string `json:"validationRegex"`
}

Configuration for Lambda authorization in AppSync.

Note that you can only have a single AWS Lambda function configured to authorize your API.

TODO: EXAMPLE

Experimental.

type LambdaDataSource 

type LambdaDataSource interface {
	BackedDataSource
	Api() IGraphqlApi
	SetApi(val IGraphqlApi)
	Ds() awsappsync.CfnDataSource
	GrantPrincipal() awsiam.IPrincipal
	Name() *string
	Node() constructs.Node
	ServiceRole() awsiam.IRole
	SetServiceRole(val awsiam.IRole)
	CreateFunction(props *BaseAppsyncFunctionProps) AppsyncFunction
	CreateResolver(props *BaseResolverProps) Resolver
	ToString() *string
}

An AppSync datasource backed by a Lambda function.

TODO: EXAMPLE

Experimental.

func NewLambdaDataSource 

func NewLambdaDataSource(scope constructs.Construct, id *string, props *LambdaDataSourceProps) LambdaDataSource

Experimental.

type LambdaDataSourceProps 

type LambdaDataSourceProps struct {
	// The API to attach this data source to.
	// Experimental.
	Api IGraphqlApi `json:"api"`
	// the description of the data source.
	// Experimental.
	Description *string `json:"description"`
	// The name of the data source.
	// Experimental.
	Name *string `json:"name"`
	// The IAM service role to be assumed by AppSync to interact with the data source.
	// Experimental.
	ServiceRole awsiam.IRole `json:"serviceRole"`
	// The Lambda function to call to interact with this data source.
	// Experimental.
	LambdaFunction awslambda.IFunction `json:"lambdaFunction"`
}

Properties for an AppSync Lambda datasource.

TODO: EXAMPLE

Experimental.

type LogConfig 

type LogConfig struct {
	// exclude verbose content.
	// Experimental.
	ExcludeVerboseContent interface{} `json:"excludeVerboseContent"`
	// log level for fields.
	// Experimental.
	FieldLogLevel FieldLogLevel `json:"fieldLogLevel"`
	// The role for CloudWatch Logs.
	// Experimental.
	Role awsiam.IRole `json:"role"`
}

Logging configuration for AppSync.

TODO: EXAMPLE

Experimental.

type MappingTemplate 

type MappingTemplate interface {
	RenderTemplate() *string
}

MappingTemplates for AppSync resolvers.

TODO: EXAMPLE

Experimental.

func MappingTemplate_DynamoDbDeleteItem 

func MappingTemplate_DynamoDbDeleteItem(keyName *string, idArg *string) MappingTemplate

Mapping template to delete a single item from a DynamoDB table. Experimental.

func MappingTemplate_DynamoDbGetItem 

func MappingTemplate_DynamoDbGetItem(keyName *string, idArg *string) MappingTemplate

Mapping template to get a single item from a DynamoDB table. Experimental.

func MappingTemplate_DynamoDbPutItem 

func MappingTemplate_DynamoDbPutItem(key PrimaryKey, values AttributeValues) MappingTemplate

Mapping template to save a single item to a DynamoDB table. Experimental.

func MappingTemplate_DynamoDbQuery 

func MappingTemplate_DynamoDbQuery(cond KeyCondition, indexName *string) MappingTemplate

Mapping template to query a set of items from a DynamoDB table. Experimental.

func MappingTemplate_DynamoDbResultItem 

func MappingTemplate_DynamoDbResultItem() MappingTemplate

Mapping template for a single result item from DynamoDB. Experimental.

func MappingTemplate_DynamoDbResultList 

func MappingTemplate_DynamoDbResultList() MappingTemplate

Mapping template for a result list from DynamoDB. Experimental.

func MappingTemplate_DynamoDbScanTable 

func MappingTemplate_DynamoDbScanTable() MappingTemplate

Mapping template to scan a DynamoDB table to fetch all entries. Experimental.

func MappingTemplate_FromFile 

func MappingTemplate_FromFile(fileName *string) MappingTemplate

Create a mapping template from the given file. Experimental.

func MappingTemplate_FromString 

func MappingTemplate_FromString(template *string) MappingTemplate

Create a mapping template from the given string. Experimental.

func MappingTemplate_LambdaRequest 

func MappingTemplate_LambdaRequest(payload *string, operation *string) MappingTemplate

Mapping template to invoke a Lambda function. Experimental.

func MappingTemplate_LambdaResult 

func MappingTemplate_LambdaResult() MappingTemplate

Mapping template to return the Lambda result to the caller. Experimental.

type NoneDataSource 

type NoneDataSource interface {
	BaseDataSource
	Api() IGraphqlApi
	SetApi(val IGraphqlApi)
	Ds() awsappsync.CfnDataSource
	Name() *string
	Node() constructs.Node
	ServiceRole() awsiam.IRole
	SetServiceRole(val awsiam.IRole)
	CreateFunction(props *BaseAppsyncFunctionProps) AppsyncFunction
	CreateResolver(props *BaseResolverProps) Resolver
	ToString() *string
}

An AppSync dummy datasource.

TODO: EXAMPLE

Experimental.

func NewNoneDataSource 

func NewNoneDataSource(scope constructs.Construct, id *string, props *NoneDataSourceProps) NoneDataSource

Experimental.

type NoneDataSourceProps 

type NoneDataSourceProps struct {
	// The API to attach this data source to.
	// Experimental.
	Api IGraphqlApi `json:"api"`
	// the description of the data source.
	// Experimental.
	Description *string `json:"description"`
	// The name of the data source.
	// Experimental.
	Name *string `json:"name"`
}

Properties for an AppSync dummy datasource.

TODO: EXAMPLE

Experimental.

type ObjectType 

type ObjectType interface {
	InterfaceType
	IIntermediateType
	Definition() *map[string]IField
	Directives() *[]Directive
	InterfaceTypes() *[]InterfaceType
	Modes() *[]AuthorizationType
	SetModes(val *[]AuthorizationType)
	Name() *string
	Resolvers() *[]Resolver
	SetResolvers(val *[]Resolver)
	AddField(options *AddFieldOptions)
	Attribute(options *BaseTypeOptions) GraphqlType
	GenerateResolver(api IGraphqlApi, fieldName *string, options *ResolvableFieldOptions) Resolver
	ToString() *string
}

Object Types are types declared by you.

TODO: EXAMPLE

Experimental.

func NewObjectType 

func NewObjectType(name *string, props *ObjectTypeOptions) ObjectType

Experimental.

type ObjectTypeOptions 

type ObjectTypeOptions struct {
	// the attributes of this type.
	// Experimental.
	Definition *map[string]IField `json:"definition"`
	// the directives for this object type.
	// Experimental.
	Directives *[]Directive `json:"directives"`
	// The Interface Types this Object Type implements.
	// Experimental.
	InterfaceTypes *[]InterfaceType `json:"interfaceTypes"`
}

Properties for configuring an Object Type.

TODO: EXAMPLE

Experimental.

type OpenIdConnectConfig 

type OpenIdConnectConfig struct {
	// The client identifier of the Relying party at the OpenID identity provider.
	//
	// A regular expression can be specified so AppSync can validate against multiple client identifiers at a time.
	//
	// TODO: EXAMPLE
	//
	// Experimental.
	ClientId *string `json:"clientId"`
	// The issuer for the OIDC configuration.
	//
	// The issuer returned by discovery must exactly match the value of `iss` in the OIDC token.
	// Experimental.
	OidcProvider *string `json:"oidcProvider"`
	// The number of milliseconds an OIDC token is valid after being authenticated by OIDC provider.
	//
	// `auth_time` claim in OIDC token is required for this validation to work.
	// Experimental.
	TokenExpiryFromAuth *float64 `json:"tokenExpiryFromAuth"`
	// The number of milliseconds an OIDC token is valid after being issued to a user.
	//
	// This validation uses `iat` claim of OIDC token.
	// Experimental.
	TokenExpiryFromIssue *float64 `json:"tokenExpiryFromIssue"`
}

Configuration for OpenID Connect authorization in AppSync.

TODO: EXAMPLE

Experimental.

type PartitionKey 

type PartitionKey interface {
	PrimaryKey
	Pkey() Assign
	RenderTemplate() *string
	Sort(key *string) SortKeyStep
}

Specifies the assignment to the partition key.

It can be enhanced with the assignment of the sort key.

TODO: EXAMPLE

Experimental.

func NewPartitionKey 

func NewPartitionKey(pkey Assign) PartitionKey

Experimental.

type PartitionKeyStep 

type PartitionKeyStep interface {
	Auto() PartitionKey
	Is(val *string) PartitionKey
}

Utility class to allow assigning a value or an auto-generated id to a partition key.

TODO: EXAMPLE

Experimental.

func NewPartitionKeyStep 

func NewPartitionKeyStep(key *string) PartitionKeyStep

Experimental.

func PartitionKey_Partition 

func PartitionKey_Partition(key *string) PartitionKeyStep

Allows assigning a value to the partition key. Experimental.

func PrimaryKey_Partition 

func PrimaryKey_Partition(key *string) PartitionKeyStep

Allows assigning a value to the partition key. Experimental.

type PrimaryKey 

type PrimaryKey interface {
	Pkey() Assign
	RenderTemplate() *string
}

Specifies the assignment to the primary key.

It either contains the full primary key or only the partition key.

TODO: EXAMPLE

Experimental.

func NewPrimaryKey 

func NewPrimaryKey(pkey Assign, skey Assign) PrimaryKey

Experimental.

type RdsDataSource 

type RdsDataSource interface {
	BackedDataSource
	Api() IGraphqlApi
	SetApi(val IGraphqlApi)
	Ds() awsappsync.CfnDataSource
	GrantPrincipal() awsiam.IPrincipal
	Name() *string
	Node() constructs.Node
	ServiceRole() awsiam.IRole
	SetServiceRole(val awsiam.IRole)
	CreateFunction(props *BaseAppsyncFunctionProps) AppsyncFunction
	CreateResolver(props *BaseResolverProps) Resolver
	ToString() *string
}

An AppSync datasource backed by RDS.

TODO: EXAMPLE

Experimental.

func NewRdsDataSource 

func NewRdsDataSource(scope constructs.Construct, id *string, props *RdsDataSourceProps) RdsDataSource

Experimental.

type RdsDataSourceProps 

type RdsDataSourceProps struct {
	// The API to attach this data source to.
	// Experimental.
	Api IGraphqlApi `json:"api"`
	// the description of the data source.
	// Experimental.
	Description *string `json:"description"`
	// The name of the data source.
	// Experimental.
	Name *string `json:"name"`
	// The IAM service role to be assumed by AppSync to interact with the data source.
	// Experimental.
	ServiceRole awsiam.IRole `json:"serviceRole"`
	// The name of the database to use within the cluster.
	// Experimental.
	DatabaseName *string `json:"databaseName"`
	// The secret containing the credentials for the database.
	// Experimental.
	SecretStore awssecretsmanager.ISecret `json:"secretStore"`
	// The serverless cluster to call to interact with this data source.
	// Experimental.
	ServerlessCluster awsrds.IServerlessCluster `json:"serverlessCluster"`
}

Properties for an AppSync RDS datasource.

TODO: EXAMPLE

Experimental.

type ResolvableField 

type ResolvableField interface {
	Field
	IField
	FieldOptions() *ResolvableFieldOptions
	IntermediateType() IIntermediateType
	IsList() *bool
	IsRequired() *bool
	IsRequiredList() *bool
	Type() Type
	ArgsToString() *string
	DirectivesToString(modes *[]AuthorizationType) *string
	ToString() *string
}

Resolvable Fields build upon Graphql Types and provide fields that can resolve into operations on a data source.

TODO: EXAMPLE

Experimental.

func NewResolvableField 

func NewResolvableField(options *ResolvableFieldOptions) ResolvableField

Experimental.

type ResolvableFieldOptions 

type ResolvableFieldOptions struct {
	// The arguments for this field.
	//
	// i.e. type Example (first: String second: String) {}
	// - where 'first' and 'second' are key values for args
	// and 'String' is the GraphqlType
	// Experimental.
	Args *map[string]GraphqlType `json:"args"`
	// the directives for this field.
	// Experimental.
	Directives *[]Directive `json:"directives"`
	// The return type for this field.
	// Experimental.
	ReturnType GraphqlType `json:"returnType"`
	// The data source creating linked to this resolvable field.
	// Experimental.
	DataSource BaseDataSource `json:"dataSource"`
	// configuration of the pipeline resolver.
	// Experimental.
	PipelineConfig *[]IAppsyncFunction `json:"pipelineConfig"`
	// The request mapping template for this resolver.
	// Experimental.
	RequestMappingTemplate MappingTemplate `json:"requestMappingTemplate"`
	// The response mapping template for this resolver.
	// Experimental.
	ResponseMappingTemplate MappingTemplate `json:"responseMappingTemplate"`
}

Properties for configuring a resolvable field.

TODO: EXAMPLE

Experimental.

type Resolver 

type Resolver interface {
	constructs.Construct
	Arn() *string
	Node() constructs.Node
	ToString() *string
}

An AppSync resolver.

TODO: EXAMPLE

Experimental.

func NewResolver 

func NewResolver(scope constructs.Construct, id *string, props *ResolverProps) Resolver

Experimental.

type ResolverProps 

type ResolverProps struct {
	// name of the GraphQL field in the given type this resolver is attached to.
	// Experimental.
	FieldName *string `json:"fieldName"`
	// configuration of the pipeline resolver.
	// Experimental.
	PipelineConfig *[]IAppsyncFunction `json:"pipelineConfig"`
	// The request mapping template for this resolver.
	// Experimental.
	RequestMappingTemplate MappingTemplate `json:"requestMappingTemplate"`
	// The response mapping template for this resolver.
	// Experimental.
	ResponseMappingTemplate MappingTemplate `json:"responseMappingTemplate"`
	// name of the GraphQL type this resolver is attached to.
	// Experimental.
	TypeName *string `json:"typeName"`
	// The data source this resolver is using.
	// Experimental.
	DataSource BaseDataSource `json:"dataSource"`
	// The API this resolver is attached to.
	// Experimental.
	Api IGraphqlApi `json:"api"`
}

Additional property for an AppSync resolver for GraphQL API reference.

TODO: EXAMPLE

Experimental.

type Schema 

type Schema interface {
	Definition() *string
	SetDefinition(val *string)
	AddMutation(fieldName *string, field ResolvableField) ObjectType
	AddQuery(fieldName *string, field ResolvableField) ObjectType
	AddSubscription(fieldName *string, field Field) ObjectType
	AddToSchema(addition *string, delimiter *string)
	AddType(type_ IIntermediateType) IIntermediateType
	Bind(api GraphqlApi) awsappsync.CfnGraphQLSchema
}

The Schema for a GraphQL Api.

If no options are configured, schema will be generated code-first.

TODO: EXAMPLE

Experimental.

func NewSchema 

func NewSchema(options *SchemaOptions) Schema

Experimental.

func Schema_FromAsset 

func Schema_FromAsset(filePath *string) Schema

Generate a Schema from file.

Returns: `SchemaAsset` with immutable schema defintion Experimental.

type SchemaOptions 

type SchemaOptions struct {
	// The file path for the schema.
	//
	// When this option is
	// configured, then the schema will be generated from an
	// existing file from disk.
	// Experimental.
	FilePath *string `json:"filePath"`
}

The options for configuring a schema.

If no options are specified, then the schema will be generated code-first.

TODO: EXAMPLE

Experimental.

type SortKeyStep 

type SortKeyStep interface {
	Auto() PrimaryKey
	Is(val *string) PrimaryKey
}

Utility class to allow assigning a value or an auto-generated id to a sort key.

TODO: EXAMPLE

Experimental.

func NewSortKeyStep 

func NewSortKeyStep(pkey Assign, skey *string) SortKeyStep

Experimental.

type Type 

type Type string

Enum containing the Types that can be used to define ObjectTypes. Experimental. 

const (
	Type_AWS_DATE       Type = "AWS_DATE"
	Type_AWS_DATE_TIME  Type = "AWS_DATE_TIME"
	Type_AWS_EMAIL      Type = "AWS_EMAIL"
	Type_AWS_IP_ADDRESS Type = "AWS_IP_ADDRESS"
	Type_AWS_JSON       Type = "AWS_JSON"
	Type_AWS_PHONE      Type = "AWS_PHONE"
	Type_AWS_TIME       Type = "AWS_TIME"
	Type_AWS_TIMESTAMP  Type = "AWS_TIMESTAMP"
	Type_AWS_URL        Type = "AWS_URL"
	Type_BOOLEAN        Type = "BOOLEAN"
	Type_FLOAT          Type = "FLOAT"
	Type_ID             Type = "ID"
	Type_INT            Type = "INT"
	Type_INTERMEDIATE   Type = "INTERMEDIATE"
	Type_STRING         Type = "STRING"
)

type UnionType 

type UnionType interface {
	IIntermediateType
	Definition() *map[string]IField
	Modes() *[]AuthorizationType
	SetModes(val *[]AuthorizationType)
	Name() *string
	AddField(options *AddFieldOptions)
	Attribute(options *BaseTypeOptions) GraphqlType
	ToString() *string
}

Union Types are abstract types that are similar to Interface Types, but they cannot to specify any common fields between types.

Note that fields of a union type need to be object types. In other words, you can't create a union type out of interfaces, other unions, or inputs.

TODO: EXAMPLE

Experimental.

func NewUnionType 

func NewUnionType(name *string, options *UnionTypeOptions) UnionType

Experimental.

type UnionTypeOptions 

type UnionTypeOptions struct {
	// the object types for this union type.
	// Experimental.
	Definition *[]IIntermediateType `json:"definition"`
}

Properties for configuring an Union Type.

TODO: EXAMPLE

Experimental.

type UserPoolConfig 

type UserPoolConfig struct {
	// the optional app id regex.
	// Experimental.
	AppIdClientRegex *string `json:"appIdClientRegex"`
	// Default auth action.
	// Experimental.
	DefaultAction UserPoolDefaultAction `json:"defaultAction"`
	// The Cognito user pool to use as identity source.
	// Experimental.
	UserPool awscognito.IUserPool `json:"userPool"`
}

Configuration for Cognito user-pools in AppSync.

TODO: EXAMPLE

Experimental.

type UserPoolDefaultAction 

type UserPoolDefaultAction string

enum with all possible values for Cognito user-pool default actions. Experimental. 

const (
	UserPoolDefaultAction_ALLOW UserPoolDefaultAction = "ALLOW"
	UserPoolDefaultAction_DENY  UserPoolDefaultAction = "DENY"
)

type Values 

type Values interface {
}

Factory class for attribute value assignments.

TODO: EXAMPLE

Experimental.

func NewValues 

func NewValues() Values

Experimental.

Source Files

View all Source files

Directories

Path Synopsis
Package jsii contains the functionaility needed for jsii packages to initialize their dependencies and themselves.
 Package jsii contains the functionaility needed for jsii packages to initialize their dependencies and themselves.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.