Interface IGraphqlApi
(experimental) Interface for GraphQL.
Inherited Members
Namespace: Amazon.CDK.AWS.AppSync
Assembly: Amazon.CDK.AWS.AppSync.dll
Syntax (csharp)
public interface IGraphqlApi : IResource, IConstruct, IDependable
Syntax (vb)
Public Interface IGraphqlApi
Inherits IResource, IConstruct, IConstruct, IDependable
Remarks
Stability: Experimental
Synopsis
Properties
ApiId | (experimental) an unique AWS AppSync GraphQL API identifier i.e. 'lxz775lwdrgcndgz3nurvac7oa'. |
Arn | (experimental) the ARN of the API. |
Methods
AddDynamoDbDataSource(String, ITable, IDataSourceOptions) | (experimental) add a new DynamoDB data source to this API. |
AddElasticsearchDataSource(String, IDomain, IDataSourceOptions) | (deprecated) add a new elasticsearch data source to this API. |
AddHttpDataSource(String, String, IHttpDataSourceOptions) | (experimental) add a new http data source to this API. |
AddLambdaDataSource(String, IFunction, IDataSourceOptions) | (experimental) add a new Lambda data source to this API. |
AddNoneDataSource(String, IDataSourceOptions) | (experimental) add a new dummy data source to this API. |
AddOpenSearchDataSource(String, IDomain, IDataSourceOptions) | (experimental) Add a new OpenSearch data source to this API. |
AddRdsDataSource(String, IServerlessCluster, ISecret, String, IDataSourceOptions) | (experimental) add a new Rds data source to this API. |
AddSchemaDependency(CfnResource) | (experimental) Add schema dependency if not imported. |
CreateResolver(IExtendedResolverProps) | (experimental) creates a new resolver for this datasource and API using the given properties. |
Properties
ApiId
(experimental) an unique AWS AppSync GraphQL API identifier i.e. 'lxz775lwdrgcndgz3nurvac7oa'.
string ApiId { get; }
Property Value
System.String
Remarks
Stability: Experimental
Attribute: true
Arn
(experimental) the ARN of the API.
string Arn { get; }
Property Value
System.String
Remarks
Stability: Experimental
Attribute: true
Methods
AddDynamoDbDataSource(String, ITable, IDataSourceOptions)
(experimental) add a new DynamoDB data source to this API.
DynamoDbDataSource AddDynamoDbDataSource(string id, ITable table, IDataSourceOptions options = null)
Parameters
- id System.String
The data source's id.
- table ITable
The DynamoDB table backing this data source.
- options IDataSourceOptions
The optional configuration for this data source.
Returns
Remarks
Stability: Experimental
AddElasticsearchDataSource(String, IDomain, IDataSourceOptions)
(deprecated) add a new elasticsearch data source to this API.
ElasticsearchDataSource AddElasticsearchDataSource(string id, IDomain domain, IDataSourceOptions options = null)
Parameters
- id System.String
The data source's id.
- domain IDomain
The elasticsearch domain for this data source.
- options IDataSourceOptions
The optional configuration for this data source.
Returns
Remarks
Stability: Deprecated
AddHttpDataSource(String, String, IHttpDataSourceOptions)
(experimental) add a new http data source to this API.
HttpDataSource AddHttpDataSource(string id, string endpoint, IHttpDataSourceOptions options = null)
Parameters
- id System.String
The data source's id.
- endpoint System.String
The http endpoint.
- options IHttpDataSourceOptions
The optional configuration for this data source.
Returns
Remarks
Stability: Experimental
AddLambdaDataSource(String, IFunction, IDataSourceOptions)
(experimental) add a new Lambda data source to this API.
LambdaDataSource AddLambdaDataSource(string id, IFunction lambdaFunction, IDataSourceOptions options = null)
Parameters
- id System.String
The data source's id.
- lambdaFunction IFunction
The Lambda function to call to interact with this data source.
- options IDataSourceOptions
The optional configuration for this data source.
Returns
Remarks
Stability: Experimental
AddNoneDataSource(String, IDataSourceOptions)
(experimental) add a new dummy data source to this API.
NoneDataSource AddNoneDataSource(string id, IDataSourceOptions options = null)
Parameters
- id System.String
The data source's id.
- options IDataSourceOptions
The optional configuration for this data source.
Returns
Remarks
Useful for pipeline resolvers and for backend changes that don't require a data source.
Stability: Experimental
AddOpenSearchDataSource(String, IDomain, IDataSourceOptions)
(experimental) Add a new OpenSearch data source to this API.
OpenSearchDataSource AddOpenSearchDataSource(string id, IDomain domain, IDataSourceOptions options = null)
Parameters
- id System.String
The data source's id.
- domain IDomain
The OpenSearch domain for this data source.
- options IDataSourceOptions
The optional configuration for this data source.
Returns
Remarks
Stability: Experimental
AddRdsDataSource(String, IServerlessCluster, ISecret, String, IDataSourceOptions)
(experimental) add a new Rds data source to this API.
RdsDataSource AddRdsDataSource(string id, IServerlessCluster serverlessCluster, ISecret secretStore, string databaseName = null, IDataSourceOptions options = null)
Parameters
- id System.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 System.String
The optional name of the database to use within the cluster.
- options IDataSourceOptions
The optional configuration for this data source.
Returns
Remarks
Stability: Experimental
AddSchemaDependency(CfnResource)
(experimental) Add schema dependency if not imported.
bool AddSchemaDependency(CfnResource construct)
Parameters
- construct CfnResource
the dependee.
Returns
System.Boolean
Remarks
Stability: Experimental
CreateResolver(IExtendedResolverProps)
(experimental) creates a new resolver for this datasource and API using the given properties.
Resolver CreateResolver(IExtendedResolverProps props)
Parameters
- props IExtendedResolverProps
Returns
Remarks
Stability: Experimental