Class IGraphqlApi.Jsii$Proxy
- All Implemented Interfaces:
IResource
,IResource.Jsii$Default
,IGraphqlApi
,IGraphqlApi.Jsii$Default
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IConstruct.Jsii$Default
,software.constructs.IDependable
,software.constructs.IDependable.Jsii$Default
- Enclosing interface:
IGraphqlApi
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy
Nested classes/interfaces inherited from interface software.constructs.IDependable
software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.appsync.IGraphqlApi
IGraphqlApi.Jsii$Default, IGraphqlApi.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource
IResource.Jsii$Default, IResource.Jsii$Proxy
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal DynamoDbDataSource
addDynamoDbDataSource
(String id, ITable table) add a new DynamoDB data source to this API.final DynamoDbDataSource
addDynamoDbDataSource
(String id, ITable table, DataSourceOptions options) add a new DynamoDB data source to this API.final ElasticsearchDataSource
addElasticsearchDataSource
(String id, IDomain domain) Deprecated.final ElasticsearchDataSource
addElasticsearchDataSource
(String id, IDomain domain, DataSourceOptions options) Deprecated.useaddOpenSearchDataSource
final EventBridgeDataSource
addEventBridgeDataSource
(String id, IEventBus eventBus) Add an EventBridge data source to this api.final EventBridgeDataSource
addEventBridgeDataSource
(String id, IEventBus eventBus, DataSourceOptions options) Add an EventBridge data source to this api.final HttpDataSource
addHttpDataSource
(String id, String endpoint) add a new http data source to this API.final HttpDataSource
addHttpDataSource
(String id, String endpoint, HttpDataSourceOptions options) add a new http data source to this API.final LambdaDataSource
addLambdaDataSource
(String id, IFunction lambdaFunction) add a new Lambda data source to this API.final LambdaDataSource
addLambdaDataSource
(String id, IFunction lambdaFunction, DataSourceOptions options) add a new Lambda data source to this API.final NoneDataSource
add a new dummy data source to this API.final NoneDataSource
addNoneDataSource
(String id, DataSourceOptions options) add a new dummy data source to this API.final OpenSearchDataSource
addOpenSearchDataSource
(String id, IDomain domain) Add a new OpenSearch data source to this API.final OpenSearchDataSource
addOpenSearchDataSource
(String id, IDomain domain, DataSourceOptions options) Add a new OpenSearch data source to this API.final RdsDataSource
addRdsDataSource
(String id, IServerlessCluster serverlessCluster, ISecret secretStore) add a new Rds data source to this API.final RdsDataSource
addRdsDataSource
(String id, IServerlessCluster serverlessCluster, ISecret secretStore, String databaseName) add a new Rds data source to this API.final RdsDataSource
addRdsDataSource
(String id, IServerlessCluster serverlessCluster, ISecret secretStore, String databaseName, DataSourceOptions options) add a new Rds data source to this API.final RdsDataSource
addRdsDataSourceV2
(String id, IDatabaseCluster serverlessCluster, ISecret secretStore) add a new Rds Serverless V2 data source to this API.final RdsDataSource
addRdsDataSourceV2
(String id, IDatabaseCluster serverlessCluster, ISecret secretStore, String databaseName) add a new Rds Serverless V2 data source to this API.final RdsDataSource
addRdsDataSourceV2
(String id, IDatabaseCluster serverlessCluster, ISecret secretStore, String databaseName, DataSourceOptions options) add a new Rds Serverless V2 data source to this API.final Boolean
addSchemaDependency
(CfnResource construct) Add schema dependency if not imported.final void
applyRemovalPolicy
(RemovalPolicy policy) Apply the given removal policy to this resource.final Resolver
createResolver
(String id, ExtendedResolverProps props) creates a new resolver for this datasource and API using the given properties.final String
getApiId()
an unique AWS AppSync GraphQL API identifier i.e.final String
getArn()
the ARN of the API.final ResourceEnvironment
getEnv()
The environment this resource belongs to.final String
The GraphQL endpoint ARN.final List<AuthorizationType>
getModes()
The Authorization Types for this GraphQL Api.final software.constructs.Node
getNode()
The tree node.final Stack
getStack()
The stack in which this resource is defined.final Visibility
the visibility of the API.final Grant
grant
(IGrantable grantee, IamResource resources, @NotNull String... actions) Adds an IAM policy statement associated with this GraphQLApi to an IAM principal's policy.final Grant
grantMutation
(IGrantable grantee, @NotNull String... fields) Adds an IAM policy statement for Mutation access to this GraphQLApi to an IAM principal's policy.final Grant
grantQuery
(IGrantable grantee, @NotNull String... fields) Adds an IAM policy statement for Query access to this GraphQLApi to an IAM principal's policy.final Grant
grantSubscription
(IGrantable grantee, @NotNull String... fields) Adds an IAM policy statement for Subscription access to this GraphQLApi to an IAM principal's policy.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, toString, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
-
-
Method Details
-
getNode
@Stability(Stable) @NotNull public final software.constructs.Node getNode()The tree node.- Specified by:
getNode
in interfacesoftware.constructs.IConstruct
- Specified by:
getNode
in interfacesoftware.constructs.IConstruct.Jsii$Default
- Specified by:
getNode
in interfaceIGraphqlApi.Jsii$Default
- Specified by:
getNode
in interfaceIResource.Jsii$Default
-
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 interfaceIGraphqlApi.Jsii$Default
- Specified by:
getEnv
in interfaceIResource
- Specified by:
getEnv
in interfaceIResource.Jsii$Default
-
getStack
The stack in which this resource is defined.- Specified by:
getStack
in interfaceIGraphqlApi.Jsii$Default
- Specified by:
getStack
in interfaceIResource
- Specified by:
getStack
in interfaceIResource.Jsii$Default
-
getApiId
an unique AWS AppSync GraphQL API identifier i.e. 'lxz775lwdrgcndgz3nurvac7oa'.- Specified by:
getApiId
in interfaceIGraphqlApi
- Specified by:
getApiId
in interfaceIGraphqlApi.Jsii$Default
-
getArn
the ARN of the API.- Specified by:
getArn
in interfaceIGraphqlApi
- Specified by:
getArn
in interfaceIGraphqlApi.Jsii$Default
-
getGraphQLEndpointArn
The GraphQL endpoint ARN.- Specified by:
getGraphQLEndpointArn
in interfaceIGraphqlApi
- Specified by:
getGraphQLEndpointArn
in interfaceIGraphqlApi.Jsii$Default
-
getModes
The Authorization Types for this GraphQL Api.- Specified by:
getModes
in interfaceIGraphqlApi
- Specified by:
getModes
in interfaceIGraphqlApi.Jsii$Default
-
getVisibility
the visibility of the API.- Specified by:
getVisibility
in interfaceIGraphqlApi
- Specified by:
getVisibility
in interfaceIGraphqlApi.Jsii$Default
-
applyRemovalPolicy
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 interfaceIGraphqlApi.Jsii$Default
- Specified by:
applyRemovalPolicy
in interfaceIResource
- Specified by:
applyRemovalPolicy
in interfaceIResource.Jsii$Default
- Parameters:
policy
- This parameter is required.
-
addDynamoDbDataSource
@Stability(Stable) @NotNull public final DynamoDbDataSource addDynamoDbDataSource(@NotNull String id, @NotNull ITable table, @Nullable DataSourceOptions options) add a new DynamoDB data source to this API.- Specified by:
addDynamoDbDataSource
in interfaceIGraphqlApi
- Specified by:
addDynamoDbDataSource
in interfaceIGraphqlApi.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
@Stability(Stable) @NotNull public final DynamoDbDataSource addDynamoDbDataSource(@NotNull String id, @NotNull ITable table) add a new DynamoDB data source to this API.- Specified by:
addDynamoDbDataSource
in interfaceIGraphqlApi
- 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 final 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 interfaceIGraphqlApi
- Specified by:
addElasticsearchDataSource
in interfaceIGraphqlApi.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.
- use
-
addElasticsearchDataSource
@Stability(Deprecated) @Deprecated @NotNull public final 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 interfaceIGraphqlApi
- Parameters:
id
- The data source's id. This parameter is required.domain
- The elasticsearch domain for this data source. This parameter is required.
- use
-
addEventBridgeDataSource
@Stability(Stable) @NotNull public final EventBridgeDataSource addEventBridgeDataSource(@NotNull String id, @NotNull IEventBus eventBus, @Nullable DataSourceOptions options) Add an EventBridge data source to this api.- Specified by:
addEventBridgeDataSource
in interfaceIGraphqlApi
- Specified by:
addEventBridgeDataSource
in interfaceIGraphqlApi.Jsii$Default
- Parameters:
id
- The data source's id. This parameter is required.eventBus
- The EventBridge EventBus on which to put events. This parameter is required.options
- The optional configuration for this data source.
-
addEventBridgeDataSource
@Stability(Stable) @NotNull public final EventBridgeDataSource addEventBridgeDataSource(@NotNull String id, @NotNull IEventBus eventBus) Add an EventBridge data source to this api.- Specified by:
addEventBridgeDataSource
in interfaceIGraphqlApi
- Parameters:
id
- The data source's id. This parameter is required.eventBus
- The EventBridge EventBus on which to put events. This parameter is required.
-
addHttpDataSource
@Stability(Stable) @NotNull public final HttpDataSource addHttpDataSource(@NotNull String id, @NotNull String endpoint, @Nullable HttpDataSourceOptions options) add a new http data source to this API.- Specified by:
addHttpDataSource
in interfaceIGraphqlApi
- Specified by:
addHttpDataSource
in interfaceIGraphqlApi.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
@Stability(Stable) @NotNull public final HttpDataSource addHttpDataSource(@NotNull String id, @NotNull String endpoint) add a new http data source to this API.- Specified by:
addHttpDataSource
in interfaceIGraphqlApi
- Parameters:
id
- The data source's id. This parameter is required.endpoint
- The http endpoint. This parameter is required.
-
addLambdaDataSource
@Stability(Stable) @NotNull public final LambdaDataSource addLambdaDataSource(@NotNull String id, @NotNull IFunction lambdaFunction, @Nullable DataSourceOptions options) add a new Lambda data source to this API.- Specified by:
addLambdaDataSource
in interfaceIGraphqlApi
- Specified by:
addLambdaDataSource
in interfaceIGraphqlApi.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
@Stability(Stable) @NotNull public final LambdaDataSource addLambdaDataSource(@NotNull String id, @NotNull IFunction lambdaFunction) add a new Lambda data source to this API.- Specified by:
addLambdaDataSource
in interfaceIGraphqlApi
- 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(Stable) @NotNull public final NoneDataSource addNoneDataSource(@NotNull String id, @Nullable DataSourceOptions options) 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 interfaceIGraphqlApi
- Specified by:
addNoneDataSource
in interfaceIGraphqlApi.Jsii$Default
- Parameters:
id
- The data source's id. This parameter is required.options
- The optional configuration for this data source.
-
addNoneDataSource
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 interfaceIGraphqlApi
- Parameters:
id
- The data source's id. This parameter is required.
-
addOpenSearchDataSource
@Stability(Stable) @NotNull public final OpenSearchDataSource addOpenSearchDataSource(@NotNull String id, @NotNull IDomain domain, @Nullable DataSourceOptions options) Add a new OpenSearch data source to this API.- Specified by:
addOpenSearchDataSource
in interfaceIGraphqlApi
- Specified by:
addOpenSearchDataSource
in interfaceIGraphqlApi.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
@Stability(Stable) @NotNull public final OpenSearchDataSource addOpenSearchDataSource(@NotNull String id, @NotNull IDomain domain) Add a new OpenSearch data source to this API.- Specified by:
addOpenSearchDataSource
in interfaceIGraphqlApi
- 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(Stable) @NotNull public final RdsDataSource addRdsDataSource(@NotNull String id, @NotNull IServerlessCluster serverlessCluster, @NotNull ISecret secretStore, @Nullable String databaseName, @Nullable DataSourceOptions options) add a new Rds data source to this API.- Specified by:
addRdsDataSource
in interfaceIGraphqlApi
- Specified by:
addRdsDataSource
in interfaceIGraphqlApi.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
@Stability(Stable) @NotNull public final RdsDataSource addRdsDataSource(@NotNull String id, @NotNull IServerlessCluster serverlessCluster, @NotNull ISecret secretStore, @Nullable String databaseName) add a new Rds data source to this API.- Specified by:
addRdsDataSource
in interfaceIGraphqlApi
- 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(Stable) @NotNull public final RdsDataSource addRdsDataSource(@NotNull String id, @NotNull IServerlessCluster serverlessCluster, @NotNull ISecret secretStore) add a new Rds data source to this API.- Specified by:
addRdsDataSource
in interfaceIGraphqlApi
- 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.
-
addRdsDataSourceV2
@Stability(Stable) @NotNull public final RdsDataSource addRdsDataSourceV2(@NotNull String id, @NotNull IDatabaseCluster serverlessCluster, @NotNull ISecret secretStore, @Nullable String databaseName, @Nullable DataSourceOptions options) add a new Rds Serverless V2 data source to this API.- Specified by:
addRdsDataSourceV2
in interfaceIGraphqlApi
- Specified by:
addRdsDataSourceV2
in interfaceIGraphqlApi.Jsii$Default
- Parameters:
id
- The data source's id. This parameter is required.serverlessCluster
- The serverless V2 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.
-
addRdsDataSourceV2
@Stability(Stable) @NotNull public final RdsDataSource addRdsDataSourceV2(@NotNull String id, @NotNull IDatabaseCluster serverlessCluster, @NotNull ISecret secretStore, @Nullable String databaseName) add a new Rds Serverless V2 data source to this API.- Specified by:
addRdsDataSourceV2
in interfaceIGraphqlApi
- Parameters:
id
- The data source's id. This parameter is required.serverlessCluster
- The serverless V2 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.
-
addRdsDataSourceV2
@Stability(Stable) @NotNull public final RdsDataSource addRdsDataSourceV2(@NotNull String id, @NotNull IDatabaseCluster serverlessCluster, @NotNull ISecret secretStore) add a new Rds Serverless V2 data source to this API.- Specified by:
addRdsDataSourceV2
in interfaceIGraphqlApi
- Parameters:
id
- The data source's id. This parameter is required.serverlessCluster
- The serverless V2 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(Stable) @NotNull public final Boolean addSchemaDependency(@NotNull CfnResource construct) Add schema dependency if not imported.- Specified by:
addSchemaDependency
in interfaceIGraphqlApi
- Specified by:
addSchemaDependency
in interfaceIGraphqlApi.Jsii$Default
- Parameters:
construct
- the dependee. This parameter is required.
-
createResolver
@Stability(Stable) @NotNull public final Resolver createResolver(@NotNull String id, @NotNull ExtendedResolverProps props) creates a new resolver for this datasource and API using the given properties.- Specified by:
createResolver
in interfaceIGraphqlApi
- Specified by:
createResolver
in interfaceIGraphqlApi.Jsii$Default
- Parameters:
id
- This parameter is required.props
- This parameter is required.
-
grant
@Stability(Stable) @NotNull public final Grant grant(@NotNull IGrantable grantee, @NotNull IamResource resources, @NotNull @NotNull String... actions) Adds an IAM policy statement associated with this GraphQLApi to an IAM principal's policy.- Specified by:
grant
in interfaceIGraphqlApi
- Specified by:
grant
in interfaceIGraphqlApi.Jsii$Default
- Parameters:
grantee
- The principal. This parameter is required.resources
- The set of resources to allow (i.e. ...:[region]:[accountId]:apis/GraphQLId/...). This parameter is required.actions
- The actions that should be granted to the principal (i.e. appsync:graphql ). This parameter is required.
-
grantMutation
@Stability(Stable) @NotNull public final Grant grantMutation(@NotNull IGrantable grantee, @NotNull @NotNull String... fields) Adds an IAM policy statement for Mutation access to this GraphQLApi to an IAM principal's policy.- Specified by:
grantMutation
in interfaceIGraphqlApi
- Specified by:
grantMutation
in interfaceIGraphqlApi.Jsii$Default
- Parameters:
grantee
- The principal. This parameter is required.fields
- The fields to grant access to that are Mutations (leave blank for all). This parameter is required.
-
grantQuery
@Stability(Stable) @NotNull public final Grant grantQuery(@NotNull IGrantable grantee, @NotNull @NotNull String... fields) Adds an IAM policy statement for Query access to this GraphQLApi to an IAM principal's policy.- Specified by:
grantQuery
in interfaceIGraphqlApi
- Specified by:
grantQuery
in interfaceIGraphqlApi.Jsii$Default
- Parameters:
grantee
- The principal. This parameter is required.fields
- The fields to grant access to that are Queries (leave blank for all). This parameter is required.
-
grantSubscription
@Stability(Stable) @NotNull public final Grant grantSubscription(@NotNull IGrantable grantee, @NotNull @NotNull String... fields) Adds an IAM policy statement for Subscription access to this GraphQLApi to an IAM principal's policy.- Specified by:
grantSubscription
in interfaceIGraphqlApi
- Specified by:
grantSubscription
in interfaceIGraphqlApi.Jsii$Default
- Parameters:
grantee
- The principal. This parameter is required.fields
- The fields to grant access to that are Subscriptions (leave blank for all). This parameter is required.
-
addOpenSearchDataSource