software.amazon.awscdk.services.appsync

Interface IGraphqlApi.Jsii$Default

All Superinterfaces:

IConstruct, IConstruct.Jsii$Default, IDependable, IDependable.Jsii$Default, IGraphqlApi, IResource, IResource.Jsii$Default

All Known Implementing Classes:

IGraphqlApi.Jsii$Proxy

Enclosing interface:

IGraphqlApi

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

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

addDynamoDbDataSource, addElasticsearchDataSource, addHttpDataSource, addLambdaDataSource, addNoneDataSource, addOpenSearchDataSource, addRdsDataSource, addRdsDataSource

Method Detail

getNode

default ConstructNode getNode()

The construct tree node for this construct.

Specified by:

getNode in interface IConstruct

Specified by:

getNode in interface IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

default ResourceEnvironment getEnv()

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

default Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getApiId

default java.lang.String getApiId()

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

Specified by:

getApiId in interface IGraphqlApi

getArn

default java.lang.String getArn()

(experimental) the ARN of the API.

Specified by:

getArn in interface IGraphqlApi

applyRemovalPolicy

default void applyRemovalPolicy(RemovalPolicy policy)

Apply the given removal policy to this resource.

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

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Parameters:

policy - This parameter is required.

addDynamoDbDataSource

default DynamoDbDataSource addDynamoDbDataSource(java.lang.String id,
                                                 ITable table,
                                                 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.

addElasticsearchDataSource

@Deprecated
default ElasticsearchDataSource addElasticsearchDataSource(java.lang.String id,
                                                                       IDomain domain,
                                                                       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.

addHttpDataSource

default HttpDataSource addHttpDataSource(java.lang.String id,
                                         java.lang.String endpoint,
                                         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

default LambdaDataSource addLambdaDataSource(java.lang.String id,
                                             IFunction lambdaFunction,
                                             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

default NoneDataSource addNoneDataSource(java.lang.String id,
                                         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.

addOpenSearchDataSource

default OpenSearchDataSource addOpenSearchDataSource(java.lang.String id,
                                                     IDomain domain,
                                                     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.

addRdsDataSource

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.

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

default java.lang.Boolean addSchemaDependency(CfnResource construct)

(experimental) Add schema dependency if not imported.

Specified by:

addSchemaDependency in interface IGraphqlApi

Parameters:

construct - the dependee. This parameter is required.

createResolver

default Resolver createResolver(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.