Package software.amazon.awscdk.services.appsync

Class GraphqlApiBase

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.appsync.GraphqlApiBase

All Implemented Interfaces:

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

Direct Known Subclasses:

GraphqlApi

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:49.504Z")
@Stability(Experimental)
public abstract class GraphqlApiBase
extends Resource
implements IGraphqlApi

(experimental) Base Class for GraphQL API.

Nested Class Summary

Nested classes/interfaces inherited from class software.constructs.Construct

software.constructs.Construct.Builder

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

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

IGraphqlApi.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GraphqlApiBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	GraphqlApiBase(software.amazon.jsii.JsiiObjectRef objRef)
protected	GraphqlApiBase(software.constructs.Construct scope, String id)
protected	GraphqlApiBase(software.constructs.Construct scope, String id, ResourceProps props)

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.
abstract String	getApiId()	(experimental) an unique AWS AppSync GraphQL API identifier i.e.
abstract String	getArn()	(experimental) the ARN of the API.

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 software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

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

Constructor Details

GraphqlApiBase

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

GraphqlApiBase

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

GraphqlApiBase

@Stability(Stable)
protected GraphqlApiBase(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 ResourceProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

GraphqlApiBase

@Stability(Stable)
protected GraphqlApiBase(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Details

addDynamoDbDataSource

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

addDynamoDbDataSource

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

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

addElasticsearchDataSource

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

Deprecated.

• use addOpenSearchDataSource

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

Specified by:

addElasticsearchDataSource in interface IGraphqlApi

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
public ElasticsearchDataSource addElasticsearchDataSource(@NotNull
 String id,
 @NotNull
 IDomain domain)

Deprecated.

• use addOpenSearchDataSource

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

Specified by:

addElasticsearchDataSource in interface IGraphqlApi

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

addHttpDataSource

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

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

addLambdaDataSource

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

addLambdaDataSource

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

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

addNoneDataSource

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

addNoneDataSource

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

Specified by:

addNoneDataSource in interface IGraphqlApi

Parameters:

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

addOpenSearchDataSource

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

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

Specified by:

addOpenSearchDataSource in interface IGraphqlApi

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
public OpenSearchDataSource addOpenSearchDataSource(@NotNull
 String id,
 @NotNull
 IDomain domain)

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

Specified by:

addOpenSearchDataSource in interface IGraphqlApi

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

addRdsDataSource

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

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

addRdsDataSource

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

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

addSchemaDependency

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

getApiId

@Stability(Experimental)
@NotNull
public abstract String getApiId()

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

Specified by:

getApiId in interface IGraphqlApi

getArn

@Stability(Experimental)
@NotNull
public abstract String getArn()

(experimental) the ARN of the API.

Specified by:

getArn in interface IGraphqlApi