software.amazon.awscdk.services.appsync

Class GraphqlApi

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.appsync.GraphqlApiBase

software.amazon.awscdk.services.appsync.GraphqlApi

All Implemented Interfaces:

IConstruct, IDependable, IResource, IGraphqlApi

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-17T17:31:22.743Z")
public class GraphqlApi
extends GraphqlApiBase

(experimental) An AppSync GraphQL API.

Example:

 GraphqlApi api = GraphqlApi.Builder.create(this, "Api")
         .name("demo")
         .build();
 ObjectType demo = ObjectType.Builder.create("Demo")
         .definition(Map.of(
                 "id", GraphqlType.string(BaseTypeOptions.builder().isRequired(true).build()),
                 "version", GraphqlType.string(BaseTypeOptions.builder().isRequired(true).build())))
         .build();
 api.addType(demo);
 

Nested Class Summary

Nested Classes

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

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

IGraphqlApi.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GraphqlApi(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	GraphqlApi(software.amazon.jsii.JsiiObjectRef objRef)
	GraphqlApi(software.constructs.Construct scope, java.lang.String id, GraphqlApiProps props)

Method Summary

Modifier and Type	Method and Description
ObjectType	addMutation(java.lang.String fieldName, ResolvableField field) (experimental) Add a mutation field to the schema's Mutation.
ObjectType	addQuery(java.lang.String fieldName, ResolvableField field) (experimental) Add a query field to the schema's Query.
java.lang.Boolean	addSchemaDependency(CfnResource construct) (experimental) Add schema dependency to a given construct.
ObjectType	addSubscription(java.lang.String fieldName, ResolvableField field) (experimental) Add a subscription field to the schema's Subscription.
void	addToSchema(java.lang.String addition) (experimental) Escape hatch to append to Schema as desired.
void	addToSchema(java.lang.String addition, java.lang.String delimiter) (experimental) Escape hatch to append to Schema as desired.
IIntermediateType	addType(IIntermediateType type) (experimental) Add type to the schema.
static IGraphqlApi	fromGraphqlApiAttributes(software.constructs.Construct scope, java.lang.String id, GraphqlApiAttributes attrs) (experimental) Import a GraphQL API through this function.
java.lang.String	getApiId() (experimental) an unique AWS AppSync GraphQL API identifier i.e.
java.lang.String	getApiKey() (experimental) the configured API key, if present.
java.lang.String	getArn() (experimental) the ARN of the API.
java.lang.String	getGraphqlUrl() (experimental) the URL of the endpoint created by AppSync.
java.util.List<AuthorizationType>	getModes() (experimental) The Authorization Types for this GraphQL Api.
java.lang.String	getName() (experimental) the name of the API.
Schema	getSchema() (experimental) the schema attached to this api.
Grant	grant(IGrantable grantee, IamResource resources, java.lang.String... actions) (experimental) Adds an IAM policy statement associated with this GraphQLApi to an IAM principal's policy.
Grant	grantMutation(IGrantable grantee, java.lang.String... fields) (experimental) Adds an IAM policy statement for Mutation access to this GraphQLApi to an IAM principal's policy.
Grant	grantQuery(IGrantable grantee, java.lang.String... fields) (experimental) Adds an IAM policy statement for Query access to this GraphQLApi to an IAM principal's policy.
Grant	grantSubscription(IGrantable grantee, java.lang.String... fields) (experimental) Adds an IAM policy statement for Subscription access to this GraphQLApi to an IAM principal's policy.

Methods inherited from class software.amazon.awscdk.services.appsync.GraphqlApiBase

addDynamoDbDataSource, addDynamoDbDataSource, addElasticsearchDataSource, addElasticsearchDataSource, addHttpDataSource, addHttpDataSource, addLambdaDataSource, addLambdaDataSource, addNoneDataSource, addNoneDataSource, addOpenSearchDataSource, addOpenSearchDataSource, addRdsDataSource, addRdsDataSource, addRdsDataSource, createResolver

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

GraphqlApi

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

GraphqlApi

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

GraphqlApi

public GraphqlApi(software.constructs.Construct scope,
                  java.lang.String id,
                  GraphqlApiProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromGraphqlApiAttributes

public static IGraphqlApi fromGraphqlApiAttributes(software.constructs.Construct scope,
                                                   java.lang.String id,
                                                   GraphqlApiAttributes attrs)

(experimental) Import a GraphQL API through this function.

Parameters:

scope - scope. This parameter is required.

id - id. This parameter is required.

attrs - GraphQL API Attributes of an API. This parameter is required.

addMutation

public ObjectType addMutation(java.lang.String fieldName,
                              ResolvableField field)

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

type Mutation { fieldName: Field.returnType }

Parameters:

fieldName - the name of the Mutation. This parameter is required.

field - the resolvable field to for this Mutation. This parameter is required.

addQuery

public ObjectType addQuery(java.lang.String fieldName,
                           ResolvableField field)

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

type Query { fieldName: Field.returnType }

Parameters:

fieldName - the name of the query. This parameter is required.

field - the resolvable field to for this query. This parameter is required.

addSchemaDependency

public java.lang.Boolean addSchemaDependency(CfnResource construct)

(experimental) Add schema dependency to a given construct.

Specified by:

addSchemaDependency in interface IGraphqlApi

Overrides:

addSchemaDependency in class GraphqlApiBase

Parameters:

construct - the dependee. This parameter is required.

addSubscription

public ObjectType addSubscription(java.lang.String fieldName,
                                  ResolvableField field)

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

type Subscription { fieldName: Field.returnType }

Parameters:

fieldName - the name of the Subscription. This parameter is required.

field - the resolvable field to for this Subscription. This parameter is required.

addToSchema

public void addToSchema(java.lang.String addition,
                        java.lang.String delimiter)

(experimental) Escape hatch to append to Schema as desired.

Will always result in a newline.

Default: - ''

Parameters:

addition - the addition to add to schema. This parameter is required.

delimiter - the delimiter between schema and addition.

addToSchema

public void addToSchema(java.lang.String addition)

(experimental) Escape hatch to append to Schema as desired.

Will always result in a newline.

Default: - ''

Parameters:

addition - the addition to add to schema. This parameter is required.

addType

public IIntermediateType addType(IIntermediateType type)

(experimental) Add type to the schema.

Parameters:

type - the intermediate type to add to the schema. This parameter is required.

grant

public Grant grant(IGrantable grantee,
                   IamResource resources,
                   java.lang.String... actions)

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

Parameters:

grantee - The principal. This parameter is required.

resources - The set of resources to allow (i.e. ...:[region]:[accountId]:apis/GraphQLId/...). This parameter is required.

actions - The actions that should be granted to the principal (i.e. appsync:graphql ). This parameter is required.

grantMutation

public Grant grantMutation(IGrantable grantee,
                           java.lang.String... fields)

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

Parameters:

grantee - The principal. This parameter is required.

fields - The fields to grant access to that are Mutations (leave blank for all). This parameter is required.

grantQuery

public Grant grantQuery(IGrantable grantee,
                        java.lang.String... fields)

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

Parameters:

grantee - The principal. This parameter is required.

fields - The fields to grant access to that are Queries (leave blank for all). This parameter is required.

grantSubscription

public Grant grantSubscription(IGrantable grantee,
                               java.lang.String... fields)

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

Parameters:

grantee - The principal. This parameter is required.

fields - The fields to grant access to that are Subscriptions (leave blank for all). This parameter is required.

getApiId

public java.lang.String getApiId()

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

Specified by:

getApiId in interface IGraphqlApi

Specified by:

getApiId in class GraphqlApiBase

getArn

public java.lang.String getArn()

(experimental) the ARN of the API.

Specified by:

getArn in interface IGraphqlApi

Specified by:

getArn in class GraphqlApiBase

getGraphqlUrl

public java.lang.String getGraphqlUrl()

(experimental) the URL of the endpoint created by AppSync.

getModes

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

(experimental) The Authorization Types for this GraphQL Api.

getName

public java.lang.String getName()

(experimental) the name of the API.

getSchema

public Schema getSchema()

(experimental) the schema attached to this api.

getApiKey

public java.lang.String getApiKey()

(experimental) the configured API key, if present.

Default: - no api key