Package software.amazon.awscdk.services.appsync

Interface IGraphqlApi

All Superinterfaces:

IConstruct, software.constructs.IConstruct, IDependable, IResource, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IGraphqlApi.Jsii$Default

All Known Implementing Classes:

GraphqlApi, GraphqlApiBase, IGraphqlApi.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:49.515Z")
@Stability(Experimental)
public interface IGraphqlApi
extends software.amazon.jsii.JsiiSerializable, IResource

(experimental) Interface for GraphQL.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IGraphqlApi.Jsii$Default	Internal default implementation for IGraphqlApi.
static final class	IGraphqlApi.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
DynamoDbDataSource	addDynamoDbDataSource(String id, ITable table)	(experimental) add a new DynamoDB data source to this API.
DynamoDbDataSource	addDynamoDbDataSource(String id, ITable table, DataSourceOptions options)	(experimental) add a new DynamoDB data source to this API.
ElasticsearchDataSource	addElasticsearchDataSource(String id, IDomain domain)	Deprecated. use addOpenSearchDataSource
ElasticsearchDataSource	addElasticsearchDataSource(String id, IDomain domain, DataSourceOptions options)	Deprecated. use addOpenSearchDataSource
HttpDataSource	addHttpDataSource(String id, String endpoint)	(experimental) add a new http data source to this API.
HttpDataSource	addHttpDataSource(String id, String endpoint, HttpDataSourceOptions options)	(experimental) add a new http data source to this API.
LambdaDataSource	addLambdaDataSource(String id, IFunction lambdaFunction)	(experimental) add a new Lambda data source to this API.
LambdaDataSource	addLambdaDataSource(String id, IFunction lambdaFunction, DataSourceOptions options)	(experimental) add a new Lambda data source to this API.
NoneDataSource	addNoneDataSource(String id)	(experimental) add a new dummy data source to this API.
NoneDataSource	addNoneDataSource(String id, DataSourceOptions options)	(experimental) add a new dummy data source to this API.
OpenSearchDataSource	addOpenSearchDataSource(String id, IDomain domain)	(experimental) Add a new OpenSearch data source to this API.
OpenSearchDataSource	addOpenSearchDataSource(String id, IDomain domain, DataSourceOptions options)	(experimental) Add a new OpenSearch data source to this API.
RdsDataSource	addRdsDataSource(String id, IServerlessCluster serverlessCluster, ISecret secretStore)	(experimental) add a new Rds data source to this API.
RdsDataSource	addRdsDataSource(String id, IServerlessCluster serverlessCluster, ISecret secretStore, String databaseName)	(experimental) add a new Rds data source to this API.
RdsDataSource	addRdsDataSource(String id, IServerlessCluster serverlessCluster, ISecret secretStore, String databaseName, DataSourceOptions options)	(experimental) add a new Rds data source to this API.
Boolean	addSchemaDependency(CfnResource construct)	(experimental) Add schema dependency if not imported.
Resolver	createResolver(ExtendedResolverProps props)	(experimental) creates a new resolver for this datasource and API using the given properties.
String	getApiId()	(experimental) an unique AWS AppSync GraphQL API identifier i.e.
String	getArn()	(experimental) the ARN of the API.

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

getNode

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

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiId

@Stability(Experimental)
@NotNull
String getApiId()

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

getArn

@Stability(Experimental)
@NotNull
String getArn()

(experimental) the ARN of the API.

addDynamoDbDataSource

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

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

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.

addDynamoDbDataSource

@Stability(Experimental)
@NotNull
DynamoDbDataSource addDynamoDbDataSource(@NotNull
 String id,
 @NotNull
 ITable table)

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

Parameters:

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

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

addElasticsearchDataSource

@Stability(Deprecated)
@Deprecated
@NotNull
ElasticsearchDataSource addElasticsearchDataSource(@NotNull
 String id,
 @NotNull
 IDomain domain,
 @Nullable
 DataSourceOptions options)

Deprecated.

• use addOpenSearchDataSource

(deprecated) add a new elasticsearch data source to this API.

Parameters:

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

domain - The elasticsearch domain for this data source. This parameter is required.

options - The optional configuration for this data source.

addElasticsearchDataSource

@Stability(Deprecated)
@Deprecated
@NotNull
ElasticsearchDataSource addElasticsearchDataSource(@NotNull
 String id,
 @NotNull
 IDomain domain)

Deprecated.

• use addOpenSearchDataSource

(deprecated) add a new elasticsearch data source to this API.

Parameters:

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

domain - The elasticsearch domain for this data source. This parameter is required.

addHttpDataSource

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

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

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.

addHttpDataSource

@Stability(Experimental)
@NotNull
HttpDataSource addHttpDataSource(@NotNull
 String id,
 @NotNull
 String endpoint)

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

Parameters:

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

endpoint - The http endpoint. This parameter is required.

addLambdaDataSource

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

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

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.

addLambdaDataSource

@Stability(Experimental)
@NotNull
LambdaDataSource addLambdaDataSource(@NotNull
 String id,
 @NotNull
 IFunction lambdaFunction)

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

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.

addNoneDataSource

@Stability(Experimental)
@NotNull
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.

Parameters:

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

options - The optional configuration for this data source.

addNoneDataSource

@Stability(Experimental)
@NotNull
NoneDataSource addNoneDataSource(@NotNull
 String id)

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

Parameters:

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

addOpenSearchDataSource

@Stability(Experimental)
@NotNull
OpenSearchDataSource addOpenSearchDataSource(@NotNull
 String id,
 @NotNull
 IDomain domain,
 @Nullable
 DataSourceOptions options)

(experimental) Add a new OpenSearch data source to this API.

Parameters:

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

domain - The OpenSearch domain for this data source. This parameter is required.

options - The optional configuration for this data source.

addOpenSearchDataSource

@Stability(Experimental)
@NotNull
OpenSearchDataSource addOpenSearchDataSource(@NotNull
 String id,
 @NotNull
 IDomain domain)

(experimental) Add a new OpenSearch data source to this API.

Parameters:

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

domain - The OpenSearch domain for this data source. This parameter is required.

addRdsDataSource

@Stability(Experimental)
@NotNull
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.

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.

addRdsDataSource

@Stability(Experimental)
@NotNull
RdsDataSource addRdsDataSource(@NotNull
 String id,
 @NotNull
 IServerlessCluster serverlessCluster,
 @NotNull
 ISecret secretStore,
 @Nullable
 String databaseName)

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

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.

addRdsDataSource

@Stability(Experimental)
@NotNull
RdsDataSource addRdsDataSource(@NotNull
 String id,
 @NotNull
 IServerlessCluster serverlessCluster,
 @NotNull
 ISecret secretStore)

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

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.

addSchemaDependency

@Stability(Experimental)
@NotNull
Boolean addSchemaDependency(@NotNull
 CfnResource construct)

(experimental) Add schema dependency if not imported.

Parameters:

construct - the dependee. This parameter is required.

createResolver

@Stability(Experimental)
@NotNull
Resolver createResolver(@NotNull
 ExtendedResolverProps props)

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

Parameters:

props - This parameter is required.