software.amazon.awscdk.services.appsync

Class IGraphqlApi.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.appsync.IGraphqlApi.Jsii$Proxy

All Implemented Interfaces:

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

Enclosing interface:

IGraphqlApi

public static final class IGraphqlApi.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements IGraphqlApi.Jsii$Default

A proxy class which represents a concrete javascript instance of this type.

Nested Class Summary

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

IGraphqlApi.Jsii$Default, IGraphqlApi.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
DynamoDbDataSource	addDynamoDbDataSource(java.lang.String id, ITable table) (experimental) add a new DynamoDB data source to this API.
DynamoDbDataSource	addDynamoDbDataSource(java.lang.String id, ITable table, DataSourceOptions options) (experimental) add a new DynamoDB data source to this API.
ElasticsearchDataSource	addElasticsearchDataSource(java.lang.String id, IDomain domain) Deprecated. - use `addOpenSearchDataSource`
ElasticsearchDataSource	addElasticsearchDataSource(java.lang.String id, IDomain domain, DataSourceOptions options) Deprecated. - use `addOpenSearchDataSource`
HttpDataSource	addHttpDataSource(java.lang.String id, java.lang.String endpoint) (experimental) add a new http data source to this API.
HttpDataSource	addHttpDataSource(java.lang.String id, java.lang.String endpoint, HttpDataSourceOptions options) (experimental) add a new http data source to this API.
LambdaDataSource	addLambdaDataSource(java.lang.String id, IFunction lambdaFunction) (experimental) add a new Lambda data source to this API.
LambdaDataSource	addLambdaDataSource(java.lang.String id, IFunction lambdaFunction, DataSourceOptions options) (experimental) add a new Lambda data source to this API.
NoneDataSource	addNoneDataSource(java.lang.String id) (experimental) add a new dummy data source to this API.
NoneDataSource	addNoneDataSource(java.lang.String id, DataSourceOptions options) (experimental) add a new dummy data source to this API.
OpenSearchDataSource	addOpenSearchDataSource(java.lang.String id, IDomain domain) (experimental) Add a new OpenSearch data source to this API.
OpenSearchDataSource	addOpenSearchDataSource(java.lang.String id, IDomain domain, DataSourceOptions options) (experimental) Add a new OpenSearch data source to this API.
RdsDataSource	addRdsDataSource(java.lang.String id, IServerlessCluster serverlessCluster, ISecret secretStore) (experimental) add a new Rds data source to this API.
RdsDataSource	addRdsDataSource(java.lang.String id, IServerlessCluster serverlessCluster, ISecret secretStore, java.lang.String databaseName) (experimental) add a new Rds data source to this API.
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.
java.lang.Boolean	addSchemaDependency(CfnResource construct) (experimental) Add schema dependency if not imported.
void	applyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.
Resolver	createResolver(ExtendedResolverProps props) (experimental) creates a new resolver for this datasource and API using the given properties.
java.lang.String	getApiId() (experimental) an unique AWS AppSync GraphQL API identifier i.e.
java.lang.String	getArn() (experimental) the ARN of the API.
ResourceEnvironment	getEnv() The environment this resource belongs to.
ConstructNode	getNode() The construct tree node for this construct.
Stack	getStack() The stack in which this resource is defined.

Methods inherited from class java.lang.Object

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

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Detail

getNode

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

Specified by:

getNode in interface IGraphqlApi.Jsii$Default

getEnv

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

Specified by:

getEnv in interface IGraphqlApi.Jsii$Default

getStack

public final Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

Specified by:

getStack in interface IGraphqlApi.Jsii$Default

getApiId

public final java.lang.String getApiId()

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

Specified by:

getApiId in interface IGraphqlApi

Specified by:

getApiId in interface IGraphqlApi.Jsii$Default

getArn

public final java.lang.String getArn()

(experimental) the ARN of the API.

Specified by:

getArn in interface IGraphqlApi

Specified by:

getArn in interface IGraphqlApi.Jsii$Default

applyRemovalPolicy

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

Specified by:

applyRemovalPolicy in interface IGraphqlApi.Jsii$Default

Parameters:

policy - This parameter is required.

addDynamoDbDataSource

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

Specified by:

addDynamoDbDataSource in interface IGraphqlApi.Jsii$Default

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

public final DynamoDbDataSource addDynamoDbDataSource(java.lang.String id,
                                                      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

@Deprecated
public final 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

Specified by:

addElasticsearchDataSource in interface IGraphqlApi.Jsii$Default

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

@Deprecated
public final ElasticsearchDataSource addElasticsearchDataSource(java.lang.String id,
                                                                            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

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

Specified by:

addHttpDataSource in interface IGraphqlApi.Jsii$Default

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

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

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

Specified by:

addLambdaDataSource in interface IGraphqlApi.Jsii$Default

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

public final LambdaDataSource addLambdaDataSource(java.lang.String id,
                                                  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

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

Specified by:

addNoneDataSource in interface IGraphqlApi.Jsii$Default

Parameters:

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

options - The optional configuration for this data source.

addNoneDataSource

public final NoneDataSource addNoneDataSource(java.lang.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

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

Specified by:

addOpenSearchDataSource in interface IGraphqlApi.Jsii$Default

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

public final OpenSearchDataSource addOpenSearchDataSource(java.lang.String id,
                                                          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

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

Specified by:

addRdsDataSource in interface IGraphqlApi.Jsii$Default

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

public final RdsDataSource addRdsDataSource(java.lang.String id,
                                            IServerlessCluster serverlessCluster,
                                            ISecret secretStore,
                                            java.lang.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

public final RdsDataSource addRdsDataSource(java.lang.String id,
                                            IServerlessCluster serverlessCluster,
                                            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

public final java.lang.Boolean addSchemaDependency(CfnResource construct)

(experimental) Add schema dependency if not imported.

Specified by:

addSchemaDependency in interface IGraphqlApi

Specified by:

addSchemaDependency in interface IGraphqlApi.Jsii$Default

Parameters:

construct - the dependee. This parameter is required.

createResolver

public final Resolver createResolver(ExtendedResolverProps props)

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

Specified by:

createResolver in interface IGraphqlApi

Specified by:

createResolver in interface IGraphqlApi.Jsii$Default

Parameters:

props - This parameter is required.