class GraphqlApi (construct) 🔹

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

Implements IConstruct, IConstruct, IDependable, IResource, IGraphqlApi

An AppSync GraphQL API.

Example

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

Initializer

new GraphqlApi(scope: Construct, id: string, props: GraphqlApiProps)

Parameters

• scope Construct
• id string
• props GraphqlApiProps

Construct Props

Name	Type	Description
name🔹	string	the name of the GraphQL API.
authorizationConfig?🔹	AuthorizationConfig	Optional authorization configuration.
domainName?🔹	DomainOptions	The domain name configuration for the GraphQL API.
logConfig?🔹	LogConfig	Logging configuration for this api.
schema?🔹	Schema	GraphQL schema definition. Specify how you want to define your schema.
xrayEnabled?🔹	boolean	A flag indicating whether or not X-Ray tracing is enabled for the GraphQL API.

---

name🔹

Type: string

the name of the GraphQL API.

---

authorizationConfig?🔹

Type: AuthorizationConfig (optional, default: API Key authorization)

Optional authorization configuration.

---

domainName?🔹

Type: DomainOptions (optional, default: no domain name)

The domain name configuration for the GraphQL API.

The Route 53 hosted zone and CName DNS record must be configured in addition to this setting to enable custom domain URL

---

logConfig?🔹

Type: LogConfig (optional, default: None)

Logging configuration for this api.

---

schema?🔹

Type: Schema (optional, default: schema will be generated code-first (i.e. addType, addObjectType, etc.))

GraphQL schema definition. Specify how you want to define your schema.

Schema.fromFile(filePath: string) allows schema definition through schema.graphql file

---

xrayEnabled?🔹

Type: boolean (optional, default: false)

A flag indicating whether or not X-Ray tracing is enabled for the GraphQL API.

Properties

Name	Type	Description
apiId🔹	string	an unique AWS AppSync GraphQL API identifier i.e. 'lxz775lwdrgcndgz3nurvac7oa'.
arn🔹	string	the ARN of the API.
env🔹	ResourceEnvironment	The environment this resource belongs to.
graphqlUrl🔹	string	the URL of the endpoint created by AppSync.
modes🔹	AuthorizationType[]	The Authorization Types for this GraphQL Api.
name🔹	string	the name of the API.
node🔹	ConstructNode	The construct tree node associated with this construct.
schema🔹	Schema	the schema attached to this api.
stack🔹	Stack	The stack in which this resource is defined.
apiKey?🔹	string	the configured API key, if present.

---

apiId🔹

Type: string

an unique AWS AppSync GraphQL API identifier i.e. 'lxz775lwdrgcndgz3nurvac7oa'.

---

arn🔹

Type: string

the ARN of the API.

---

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

graphqlUrl🔹

Type: string

the URL of the endpoint created by AppSync.

---

modes🔹

Type: AuthorizationType[]

The Authorization Types for this GraphQL Api.

---

name🔹

Type: string

the name of the API.

---

node🔹

Type: ConstructNode

The construct tree node associated with this construct.

---

schema🔹

Type: Schema

the schema attached to this api.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

---

apiKey?🔹

Type: string (optional, default: no api key)

the configured API key, if present.

Methods

Name	Description
addDynamoDbDataSource(id, table, options?)🔹	add a new DynamoDB data source to this API.
addElasticsearchDataSource(id, domain, options?)⚠️	add a new elasticsearch data source to this API.
addHttpDataSource(id, endpoint, options?)🔹	add a new http data source to this API.
addLambdaDataSource(id, lambdaFunction, options?)🔹	add a new Lambda data source to this API.
addMutation(fieldName, field)🔹	Add a mutation field to the schema's Mutation. CDK will create an Object Type called 'Mutation'. For example,.
addNoneDataSource(id, options?)🔹	add a new dummy data source to this API.
addOpenSearchDataSource(id, domain, options?)🔹	add a new OpenSearch data source to this API.
addQuery(fieldName, field)🔹	Add a query field to the schema's Query. CDK will create an Object Type called 'Query'. For example,.
addRdsDataSource(id, serverlessCluster, secretStore, databaseName?, options?)🔹	add a new Rds data source to this API.
addSchemaDependency(construct)🔹	Add schema dependency to a given construct.
addSubscription(fieldName, field)🔹	Add a subscription field to the schema's Subscription. CDK will create an Object Type called 'Subscription'. For example,.
addToSchema(addition, delimiter?)🔹	Escape hatch to append to Schema as desired.
addType(type)🔹	Add type to the schema.
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
createResolver(props)🔹	creates a new resolver for this datasource and API using the given properties.
grant(grantee, resources, ...actions)🔹	Adds an IAM policy statement associated with this GraphQLApi to an IAM principal's policy.
grantMutation(grantee, ...fields)🔹	Adds an IAM policy statement for Mutation access to this GraphQLApi to an IAM principal's policy.
grantQuery(grantee, ...fields)🔹	Adds an IAM policy statement for Query access to this GraphQLApi to an IAM principal's policy.
grantSubscription(grantee, ...fields)🔹	Adds an IAM policy statement for Subscription access to this GraphQLApi to an IAM principal's policy.
toString()🔹	Returns a string representation of this construct.
static fromGraphqlApiAttributes(scope, id, attrs)🔹	Import a GraphQL API through this function.

---

addDynamoDbDataSource(id, table, options?)🔹

public addDynamoDbDataSource(id: string, table: ITable, options?: DataSourceOptions): DynamoDbDataSource

Parameters

• id string — The data source's id.
• table ITable — The DynamoDB table backing this data source.
• options DataSourceOptions — The optional configuration for this data source.

Returns

• DynamoDbDataSource

add a new DynamoDB data source to this API.

---

addElasticsearchDataSource(id, domain, options?)⚠️

public addElasticsearchDataSource(id: string, domain: IDomain, options?: DataSourceOptions): ElasticsearchDataSource

⚠️ Deprecated: - use addOpenSearchDataSource

Parameters

• id string — The data source's id.
• domain IDomain — The elasticsearch domain for this data source.
• options DataSourceOptions — The optional configuration for this data source.

Returns

• ElasticsearchDataSource

add a new elasticsearch data source to this API.

---

addHttpDataSource(id, endpoint, options?)🔹

public addHttpDataSource(id: string, endpoint: string, options?: HttpDataSourceOptions): HttpDataSource

Parameters

• id string — The data source's id.
• endpoint string — The http endpoint.
• options HttpDataSourceOptions — The optional configuration for this data source.

Returns

• HttpDataSource

add a new http data source to this API.

---

addLambdaDataSource(id, lambdaFunction, options?)🔹

public addLambdaDataSource(id: string, lambdaFunction: IFunction, options?: DataSourceOptions): LambdaDataSource

Parameters

• id string — The data source's id.
• lambdaFunction IFunction — The Lambda function to call to interact with this data source.
• options DataSourceOptions — The optional configuration for this data source.

Returns

• LambdaDataSource

add a new Lambda data source to this API.

---

addMutation(fieldName, field)🔹

public addMutation(fieldName: string, field: ResolvableField): ObjectType

Parameters

• fieldName string — the name of the Mutation.
• field ResolvableField — the resolvable field to for this Mutation.

Returns

• ObjectType

Add a mutation field to the schema's Mutation. CDK will create an Object Type called 'Mutation'. For example,.

type Mutation { fieldName: Field.returnType }

---

addNoneDataSource(id, options?)🔹

public addNoneDataSource(id: string, options?: DataSourceOptions): NoneDataSource

Parameters

• id string — The data source's id.
• options DataSourceOptions — The optional configuration for this data source.

Returns

• NoneDataSource

add a new dummy data source to this API.

Useful for pipeline resolvers and for backend changes that don't require a data source.

---

addOpenSearchDataSource(id, domain, options?)🔹

public addOpenSearchDataSource(id: string, domain: IDomain, options?: DataSourceOptions): OpenSearchDataSource

Parameters

• id string — The data source's id.
• domain IDomain — The OpenSearch domain for this data source.
• options DataSourceOptions — The optional configuration for this data source.

Returns

• OpenSearchDataSource

add a new OpenSearch data source to this API.

---

addQuery(fieldName, field)🔹

public addQuery(fieldName: string, field: ResolvableField): ObjectType

Parameters

• fieldName string — the name of the query.
• field ResolvableField — the resolvable field to for this query.

Returns

• ObjectType

Add a query field to the schema's Query. CDK will create an Object Type called 'Query'. For example,.

type Query { fieldName: Field.returnType }

---

addRdsDataSource(id, serverlessCluster, secretStore, databaseName?, options?)🔹

public addRdsDataSource(id: string, serverlessCluster: IServerlessCluster, secretStore: ISecret, databaseName?: string, options?: DataSourceOptions): RdsDataSource

Parameters

• id string — The data source's id.
• serverlessCluster IServerlessCluster — The serverless cluster to interact with this data source.
• secretStore ISecret — The secret store that contains the username and password for the serverless cluster.
• databaseName string — The optional name of the database to use within the cluster.
• options DataSourceOptions — The optional configuration for this data source.

Returns

• RdsDataSource

add a new Rds data source to this API.

---

addSchemaDependency(construct)🔹

public addSchemaDependency(construct: CfnResource): boolean

Parameters

• construct CfnResource — the dependee.

Returns

• boolean

Add schema dependency to a given construct.

---

addSubscription(fieldName, field)🔹

public addSubscription(fieldName: string, field: ResolvableField): ObjectType

Parameters

• fieldName string — the name of the Subscription.
• field ResolvableField — the resolvable field to for this Subscription.

Returns

• ObjectType

Add a subscription field to the schema's Subscription. CDK will create an Object Type called 'Subscription'. For example,.

type Subscription { fieldName: Field.returnType }

---

addToSchema(addition, delimiter?)🔹

public addToSchema(addition: string, delimiter?: string): void

Parameters

• addition string — the addition to add to schema.
• delimiter string — the delimiter between schema and addition.

Escape hatch to append to Schema as desired.

Will always result in a newline.

---

addType(type)🔹

public addType(type: IIntermediateType): IIntermediateType

Parameters

• type IIntermediateType — the intermediate type to add to the schema.

Returns

• IIntermediateType

Add type to the schema.

---

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

createResolver(props)🔹

public createResolver(props: ExtendedResolverProps): Resolver

Parameters

• props ExtendedResolverProps

Returns

• Resolver

creates a new resolver for this datasource and API using the given properties.

---

grant(grantee, resources, ...actions)🔹

public grant(grantee: IGrantable, resources: IamResource, ...actions: string[]): Grant

Parameters

• grantee IGrantable — The principal.
• resources IamResource — The set of resources to allow (i.e. ...:[region]:[accountId]:apis/GraphQLId/...).
• actions string — The actions that should be granted to the principal (i.e. appsync:graphql ).

Returns

• Grant

Adds an IAM policy statement associated with this GraphQLApi to an IAM principal's policy.

---

grantMutation(grantee, ...fields)🔹

public grantMutation(grantee: IGrantable, ...fields: string[]): Grant

Parameters

• grantee IGrantable — The principal.
• fields string — The fields to grant access to that are Mutations (leave blank for all).

Returns

• Grant

Adds an IAM policy statement for Mutation access to this GraphQLApi to an IAM principal's policy.

---

grantQuery(grantee, ...fields)🔹

public grantQuery(grantee: IGrantable, ...fields: string[]): Grant

Parameters

• grantee IGrantable — The principal.
• fields string — The fields to grant access to that are Queries (leave blank for all).

Returns

• Grant

Adds an IAM policy statement for Query access to this GraphQLApi to an IAM principal's policy.

---

grantSubscription(grantee, ...fields)🔹

public grantSubscription(grantee: IGrantable, ...fields: string[]): Grant

Parameters

• grantee IGrantable — The principal.
• fields string — The fields to grant access to that are Subscriptions (leave blank for all).

Returns

• Grant

Adds an IAM policy statement for Subscription access to this GraphQLApi to an IAM principal's policy.

---

toString()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

static fromGraphqlApiAttributes(scope, id, attrs)🔹

public static fromGraphqlApiAttributes(scope: Construct, id: string, attrs: GraphqlApiAttributes): IGraphqlApi

Parameters

• scope Construct — scope.
• id string — id.
• attrs GraphqlApiAttributes — GraphQL API Attributes of an API.

Returns

• IGraphqlApi

Import a GraphQL API through this function.