public static interface IGraphqlApi.Jsii$Default extends IGraphqlApi, IResource.Jsii$Default
IGraphqlApi
.IGraphqlApi.Jsii$Default, IGraphqlApi.Jsii$Proxy
Modifier and Type | Method and Description |
---|---|
default DynamoDbDataSource |
addDynamoDbDataSource(java.lang.String id,
ITable table,
DataSourceOptions options)
(experimental) add a new DynamoDB data source to this API.
|
default ElasticsearchDataSource |
addElasticsearchDataSource(java.lang.String id,
IDomain domain,
DataSourceOptions options)
Deprecated.
- use `addOpenSearchDataSource`
|
default HttpDataSource |
addHttpDataSource(java.lang.String id,
java.lang.String endpoint,
HttpDataSourceOptions options)
(experimental) add a new http data source to this API.
|
default LambdaDataSource |
addLambdaDataSource(java.lang.String id,
IFunction lambdaFunction,
DataSourceOptions options)
(experimental) add a new Lambda data source to this API.
|
default NoneDataSource |
addNoneDataSource(java.lang.String id,
DataSourceOptions options)
(experimental) add a new dummy data source to this API.
|
default OpenSearchDataSource |
addOpenSearchDataSource(java.lang.String id,
IDomain domain,
DataSourceOptions options)
(experimental) Add a new OpenSearch data source to this API.
|
default RdsDataSource |
addRdsDataSource(java.lang.String id,
IServerlessCluster serverlessCluster,
ISecret secretStore,
java.lang.String databaseName,
DataSourceOptions options)
(experimental) add a new Rds data source to this API.
|
default java.lang.Boolean |
addSchemaDependency(CfnResource construct)
(experimental) Add schema dependency if not imported.
|
default void |
applyRemovalPolicy(RemovalPolicy policy)
Apply the given removal policy to this resource.
|
default Resolver |
createResolver(ExtendedResolverProps props)
(experimental) creates a new resolver for this datasource and API using the given properties.
|
default java.lang.String |
getApiId()
(experimental) an unique AWS AppSync GraphQL API identifier i.e.
|
default java.lang.String |
getArn()
(experimental) the ARN of the API.
|
default ResourceEnvironment |
getEnv()
The environment this resource belongs to.
|
default ConstructNode |
getNode()
The construct tree node for this construct.
|
default Stack |
getStack()
The stack in which this resource is defined.
|
addDynamoDbDataSource, addElasticsearchDataSource, addHttpDataSource, addLambdaDataSource, addNoneDataSource, addOpenSearchDataSource, addRdsDataSource, addRdsDataSource
default ConstructNode getNode()
getNode
in interface IConstruct
getNode
in interface IConstruct.Jsii$Default
getNode
in interface IResource.Jsii$Default
default ResourceEnvironment getEnv()
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.
getEnv
in interface IResource
getEnv
in interface IResource.Jsii$Default
default Stack getStack()
getStack
in interface IResource
getStack
in interface IResource.Jsii$Default
default java.lang.String getApiId()
getApiId
in interface IGraphqlApi
default java.lang.String getArn()
getArn
in interface IGraphqlApi
default void applyRemovalPolicy(RemovalPolicy policy)
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY
), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN
).
applyRemovalPolicy
in interface IResource
applyRemovalPolicy
in interface IResource.Jsii$Default
policy
- This parameter is required.default DynamoDbDataSource addDynamoDbDataSource(java.lang.String id, ITable table, DataSourceOptions options)
addDynamoDbDataSource
in interface IGraphqlApi
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.@Deprecated default ElasticsearchDataSource addElasticsearchDataSource(java.lang.String id, IDomain domain, DataSourceOptions options)
addElasticsearchDataSource
in interface IGraphqlApi
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.default HttpDataSource addHttpDataSource(java.lang.String id, java.lang.String endpoint, HttpDataSourceOptions options)
addHttpDataSource
in interface IGraphqlApi
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.default LambdaDataSource addLambdaDataSource(java.lang.String id, IFunction lambdaFunction, DataSourceOptions options)
addLambdaDataSource
in interface IGraphqlApi
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.default NoneDataSource addNoneDataSource(java.lang.String id, DataSourceOptions options)
Useful for pipeline resolvers and for backend changes that don't require a data source.
addNoneDataSource
in interface IGraphqlApi
id
- The data source's id. This parameter is required.options
- The optional configuration for this data source.default OpenSearchDataSource addOpenSearchDataSource(java.lang.String id, IDomain domain, DataSourceOptions options)
addOpenSearchDataSource
in interface IGraphqlApi
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.default RdsDataSource addRdsDataSource(java.lang.String id, IServerlessCluster serverlessCluster, ISecret secretStore, java.lang.String databaseName, DataSourceOptions options)
addRdsDataSource
in interface IGraphqlApi
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.default java.lang.Boolean addSchemaDependency(CfnResource construct)
addSchemaDependency
in interface IGraphqlApi
construct
- the dependee. This parameter is required.default Resolver createResolver(ExtendedResolverProps props)
createResolver
in interface IGraphqlApi
props
- This parameter is required.