Package software.amazon.awscdk.services.appsync

Interface IGraphqlApi.Jsii$Default

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IGraphqlApi, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
IGraphqlApi.Jsii$Proxy
Enclosing interface:
IGraphqlApi
@Internal public static interface IGraphqlApi.Jsii$Default extends IGraphqlApi, IResource.Jsii$Default
Internal default implementation for IGraphqlApi.

  • Method Details

    • getNode

      @Stability(Stable) @NotNull default software.constructs.Node getNode()
      The tree node.
      Specified by:
      getNode in interface software.constructs.IConstruct
      Specified by:
      getNode in interface software.constructs.IConstruct.Jsii$Default
      Specified by:
      getNode in interface IResource.Jsii$Default

    • getEnv

      @Stability(Stable) @NotNull 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

      @Stability(Stable) @NotNull 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

      @Stability(Stable) @NotNull default String getApiId()
      an unique AWS AppSync GraphQL API identifier i.e. 'lxz775lwdrgcndgz3nurvac7oa'.
      Specified by:
      getApiId in interface IGraphqlApi

    • getArn

      @Stability(Stable) @NotNull default String getArn()
      the ARN of the API.
      Specified by:
      getArn in interface IGraphqlApi

    • getGraphQLEndpointArn

      @Stability(Stable) @NotNull default String getGraphQLEndpointArn()
      The GraphQL endpoint ARN.
      Specified by:
      getGraphQLEndpointArn in interface IGraphqlApi

    • getModes

      @Stability(Stable) @NotNull default List<AuthorizationType> getModes()
      The Authorization Types for this GraphQL Api.
      Specified by:
      getModes in interface IGraphqlApi

    • getVisibility

      @Stability(Stable) @NotNull default Visibility getVisibility()
      the visibility of the API.
      Specified by:
      getVisibility in interface IGraphqlApi

    • applyRemovalPolicy

      @Stability(Stable) default void applyRemovalPolicy(@NotNull 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

      @Stability(Stable) @NotNull default DynamoDbDataSource addDynamoDbDataSource(@NotNull String id, @NotNull ITable table, @Nullable DataSourceOptions options)
      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

      @Stability(Deprecated) @Deprecated @NotNull default 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 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.

    • addEventBridgeDataSource

      @Stability(Stable) @NotNull default EventBridgeDataSource addEventBridgeDataSource(@NotNull String id, @NotNull IEventBus eventBus, @Nullable DataSourceOptions options)
      Add an EventBridge data source to this api.

      Specified by:
      addEventBridgeDataSource in interface IGraphqlApi
      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.

    • addHttpDataSource

      @Stability(Stable) @NotNull default HttpDataSource addHttpDataSource(@NotNull String id, @NotNull String endpoint, @Nullable HttpDataSourceOptions options)
      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

      @Stability(Stable) @NotNull default LambdaDataSource addLambdaDataSource(@NotNull String id, @NotNull IFunction lambdaFunction, @Nullable DataSourceOptions options)
      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

      @Stability(Stable) @NotNull default 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 interface IGraphqlApi
      Parameters:
      id - The data source's id. This parameter is required.
      options - The optional configuration for this data source.

    • addOpenSearchDataSource

      @Stability(Stable) @NotNull default OpenSearchDataSource addOpenSearchDataSource(@NotNull String id, @NotNull IDomain domain, @Nullable DataSourceOptions options)
      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

      @Stability(Stable) @NotNull default 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 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.

    • addRdsDataSourceV2

      @Stability(Stable) @NotNull default 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 interface IGraphqlApi
      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.

    • addSchemaDependency

      @Stability(Stable) @NotNull default Boolean addSchemaDependency(@NotNull CfnResource construct)
      Add schema dependency if not imported.

      Specified by:
      addSchemaDependency in interface IGraphqlApi
      Parameters:
      construct - the dependee. This parameter is required.

    • createResolver

      @Stability(Stable) @NotNull default 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 interface IGraphqlApi
      Parameters:
      id - This parameter is required.
      props - This parameter is required.

    • grant

      @Stability(Stable) @NotNull default 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 interface IGraphqlApi
      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 default 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 interface IGraphqlApi
      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 default 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 interface IGraphqlApi
      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 default 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 interface IGraphqlApi
      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.