software.amazon.awscdk.services.appsync

Interface IGraphqlApi.Jsii$Default

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, IDependable, IDependable.Jsii$Default, IGraphqlApi, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IGraphqlApi.Jsii$Proxy

Enclosing interface:

IGraphqlApi

@Internal
public static interface IGraphqlApi.Jsii$Default
extends IGraphqlApi, IResource.Jsii$Default

Internal default implementation for IGraphqlApi.

Nested Class Summary

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

IGraphqlApi.Jsii$Default, IGraphqlApi.Jsii$Proxy

Method Summary

Modifier and Type	Method and Description
default DynamoDbDataSource	addDynamoDbDataSource(String id, ITable table, DataSourceOptions options) (experimental) add a new DynamoDB data source to this API.
default HttpDataSource	addHttpDataSource(String id, String endpoint, HttpDataSourceOptions options) (experimental) add a new http data source to this API.
default LambdaDataSource	addLambdaDataSource(String id, IFunction lambdaFunction, DataSourceOptions options) (experimental) add a new Lambda data source to this API.
default NoneDataSource	addNoneDataSource(String id, DataSourceOptions options) (experimental) add a new dummy data source to this API.
default RdsDataSource	addRdsDataSource(String id, IServerlessCluster serverlessCluster, ISecret secretStore, String databaseName, DataSourceOptions options) (experimental) add a new Rds data source to this API.
default Boolean	addSchemaDependency(CfnResource construct) (experimental) Add schema dependency if not imported.
default Resolver	createResolver(ExtendedResolverProps props) (experimental) creates a new resolver for this datasource and API using the given properties.
default String	getApiId() (experimental) an unique AWS AppSync GraphQL API identifier i.e.
default String	getArn() (experimental) the ARN of the API.
default ResourceEnvironment	getEnv() (experimental) The environment this resource belongs to.
default ConstructNode	getNode() (experimental) The construct tree node for this construct.
default Stack	getStack() (experimental) The stack in which this resource is defined.

Methods inherited from interface software.amazon.awscdk.services.appsync.IGraphqlApi

addDynamoDbDataSource, addHttpDataSource, addLambdaDataSource, addNoneDataSource, addRdsDataSource, addRdsDataSource

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getNode

@Stability(value=Experimental)
 @NotNull
default ConstructNode getNode()

(experimental) The construct tree node for this construct.

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(value=Experimental)
 @NotNull
default ResourceEnvironment getEnv()

(experimental) 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.

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

@Stability(value=Experimental)
 @NotNull
default Stack getStack()

(experimental) The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getApiId

@Stability(value=Experimental)
 @NotNull
default String getApiId()

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

Specified by:

getApiId in interface IGraphqlApi

getArn

@Stability(value=Experimental)
 @NotNull
default String getArn()

(experimental) the ARN of the API.

Specified by:

getArn in interface IGraphqlApi

addDynamoDbDataSource

@Stability(value=Experimental)
 @NotNull
default DynamoDbDataSource addDynamoDbDataSource(@NotNull
                                                                                          String id,
                                                                                          @NotNull
                                                                                          ITable table,
                                                                                          @Nullable
                                                                                          DataSourceOptions options)

(experimental) add a new DynamoDB data source to this API.

Specified by:

addDynamoDbDataSource in interface IGraphqlApi

Parameters:

id - The data source's id. This parameter is required.

table - The DynamoDB table backing this data source. This parameter is required.

options - The optional configuration for this data source.

addHttpDataSource

@Stability(value=Experimental)
 @NotNull
default HttpDataSource addHttpDataSource(@NotNull
                                                                                  String id,
                                                                                  @NotNull
                                                                                  String endpoint,
                                                                                  @Nullable
                                                                                  HttpDataSourceOptions options)

(experimental) add a new http data source to this API.

Specified by:

addHttpDataSource in interface IGraphqlApi

Parameters:

id - The data source's id. This parameter is required.

endpoint - The http endpoint. This parameter is required.

options - The optional configuration for this data source.

addLambdaDataSource

@Stability(value=Experimental)
 @NotNull
default LambdaDataSource addLambdaDataSource(@NotNull
                                                                                      String id,
                                                                                      @NotNull
                                                                                      IFunction lambdaFunction,
                                                                                      @Nullable
                                                                                      DataSourceOptions options)

(experimental) add a new Lambda data source to this API.

Specified by:

addLambdaDataSource in interface IGraphqlApi

Parameters:

id - The data source's id. This parameter is required.

lambdaFunction - The Lambda function to call to interact with this data source. This parameter is required.

options - The optional configuration for this data source.

addNoneDataSource

@Stability(value=Experimental)
 @NotNull
default NoneDataSource addNoneDataSource(@NotNull
                                                                                  String id,
                                                                                  @Nullable
                                                                                  DataSourceOptions options)

(experimental) add a new dummy data source to this API.

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

Specified by:

addNoneDataSource in interface IGraphqlApi

Parameters:

id - The data source's id. This parameter is required.

options - The optional configuration for this data source.

addRdsDataSource

@Stability(value=Experimental)
 @NotNull
default RdsDataSource addRdsDataSource(@NotNull
                                                                                String id,
                                                                                @NotNull
                                                                                IServerlessCluster serverlessCluster,
                                                                                @NotNull
                                                                                ISecret secretStore,
                                                                                @Nullable
                                                                                String databaseName,
                                                                                @Nullable
                                                                                DataSourceOptions options)

(experimental) add a new Rds data source to this API.

Specified by:

addRdsDataSource in interface IGraphqlApi

Parameters:

id - The data source's id. This parameter is required.

serverlessCluster - The serverless cluster to interact with this data source. This parameter is required.

secretStore - The secret store that contains the username and password for the serverless cluster. This parameter is required.

databaseName - The optional name of the database to use within the cluster.

options - The optional configuration for this data source.

addSchemaDependency

@Stability(value=Experimental)
 @NotNull
default Boolean addSchemaDependency(@NotNull
                                                                             CfnResource construct)

(experimental) Add schema dependency if not imported.

Specified by:

addSchemaDependency in interface IGraphqlApi

Parameters:

construct - the dependee. This parameter is required.

createResolver

@Stability(value=Experimental)
 @NotNull
default Resolver createResolver(@NotNull
                                                                         ExtendedResolverProps props)

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

Specified by:

createResolver in interface IGraphqlApi

Parameters:

props - This parameter is required.