Package software.amazon.awscdk.services.appsync

Interface IEventApi.Jsii$Default

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

  • Method Details

    • getAuthProviderTypes

      @Stability(Stable) @NotNull default List<AppSyncAuthorizationType> getAuthProviderTypes()
      The Authorization Types for this Event Api.
      Specified by:
      getAuthProviderTypes in interface IEventApi

    • getHttpDns

      @Stability(Stable) @NotNull default String getHttpDns()
      The domain name of the Api's HTTP endpoint.
      Specified by:
      getHttpDns in interface IEventApi

    • getRealtimeDns

      @Stability(Stable) @NotNull default String getRealtimeDns()
      The domain name of the Api's real-time endpoint.
      Specified by:
      getRealtimeDns in interface IEventApi

    • addChannelNamespace

      @Stability(Stable) @NotNull default ChannelNamespace addChannelNamespace(@NotNull String id, @Nullable ChannelNamespaceOptions options)
      add a new channel namespace.

      Specified by:
      addChannelNamespace in interface IEventApi
      Parameters:
      id - the id of the channel namespace. This parameter is required.
      options - the options for the channel namespace.
      Returns:
      the channel namespace

    • addChannelNamespace

      @Stability(Stable) @NotNull default ChannelNamespace addChannelNamespace(@NotNull String id)
      add a new channel namespace.

      Specified by:
      addChannelNamespace in interface IEventApi
      Parameters:
      id - the id of the channel namespace. This parameter is required.
      Returns:
      the channel namespace

    • addDynamoDbDataSource

      @Stability(Stable) @NotNull default AppSyncDynamoDbDataSource addDynamoDbDataSource(@NotNull String id, @NotNull ITable table, @Nullable AppSyncDataSourceOptions options)
      Add a new DynamoDB data source to this API.

      Specified by:
      addDynamoDbDataSource in interface IEventApi
      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 default AppSyncDynamoDbDataSource addDynamoDbDataSource(@NotNull String id, @NotNull ITable table)
      Add a new DynamoDB data source to this API.

      Specified by:
      addDynamoDbDataSource in interface IEventApi
      Parameters:
      id - The data source's id. This parameter is required.
      table - The DynamoDB table backing this data source. This parameter is required.

    • addEventBridgeDataSource

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

      Specified by:
      addEventBridgeDataSource in interface IEventApi
      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 default AppSyncEventBridgeDataSource addEventBridgeDataSource(@NotNull String id, @NotNull IEventBus eventBus)
      Add an EventBridge data source to this api.

      Specified by:
      addEventBridgeDataSource in interface IEventApi
      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 default AppSyncHttpDataSource addHttpDataSource(@NotNull String id, @NotNull String endpoint, @Nullable AppSyncHttpDataSourceOptions options)
      add a new http data source to this API.

      Specified by:
      addHttpDataSource in interface IEventApi
      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 default AppSyncHttpDataSource addHttpDataSource(@NotNull String id, @NotNull String endpoint)
      add a new http data source to this API.

      Specified by:
      addHttpDataSource in interface IEventApi
      Parameters:
      id - The data source's id. This parameter is required.
      endpoint - The http endpoint. This parameter is required.

    • addLambdaDataSource

      @Stability(Stable) @NotNull default AppSyncLambdaDataSource addLambdaDataSource(@NotNull String id, @NotNull IFunction lambdaFunction, @Nullable AppSyncDataSourceOptions options)
      add a new Lambda data source to this API.

      Specified by:
      addLambdaDataSource in interface IEventApi
      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 default AppSyncLambdaDataSource addLambdaDataSource(@NotNull String id, @NotNull IFunction lambdaFunction)
      add a new Lambda data source to this API.

      Specified by:
      addLambdaDataSource in interface IEventApi
      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.

    • addOpenSearchDataSource

      @Stability(Stable) @NotNull default AppSyncOpenSearchDataSource addOpenSearchDataSource(@NotNull String id, @NotNull IDomain domain, @Nullable AppSyncDataSourceOptions options)
      Add a new OpenSearch data source to this API.

      Specified by:
      addOpenSearchDataSource in interface IEventApi
      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 default AppSyncOpenSearchDataSource addOpenSearchDataSource(@NotNull String id, @NotNull IDomain domain)
      Add a new OpenSearch data source to this API.

      Specified by:
      addOpenSearchDataSource in interface IEventApi
      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 default AppSyncRdsDataSource addRdsDataSource(@NotNull String id, @NotNull Object serverlessCluster, @NotNull ISecret secretStore, @Nullable String databaseName, @Nullable AppSyncDataSourceOptions options)
      add a new Rds data source to this API.

      Specified by:
      addRdsDataSource in interface IEventApi
      Parameters:
      id - The data source's id. This parameter is required.
      serverlessCluster - The database cluster to interact with this data source. Takes union: either IDatabaseCluster or IServerlessCluster. This parameter is required.
      secretStore - The secret store that contains the username and password for the database 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 default AppSyncRdsDataSource addRdsDataSource(@NotNull String id, @NotNull Object serverlessCluster, @NotNull ISecret secretStore, @Nullable String databaseName)
      add a new Rds data source to this API.

      Specified by:
      addRdsDataSource in interface IEventApi
      Parameters:
      id - The data source's id. This parameter is required.
      serverlessCluster - The database cluster to interact with this data source. Takes union: either IDatabaseCluster or IServerlessCluster. This parameter is required.
      secretStore - The secret store that contains the username and password for the database cluster. This parameter is required.
      databaseName - The optional name of the database to use within the cluster.

    • addRdsDataSource

      @Stability(Stable) @NotNull default AppSyncRdsDataSource addRdsDataSource(@NotNull String id, @NotNull Object serverlessCluster, @NotNull ISecret secretStore)
      add a new Rds data source to this API.

      Specified by:
      addRdsDataSource in interface IEventApi
      Parameters:
      id - The data source's id. This parameter is required.
      serverlessCluster - The database cluster to interact with this data source. Takes union: either IDatabaseCluster or IServerlessCluster. This parameter is required.
      secretStore - The secret store that contains the username and password for the database cluster. This parameter is required.

    • grant

      @Stability(Stable) @NotNull default Grant grant(@NotNull IGrantable grantee, @NotNull AppSyncEventResource resources, @NotNull String... actions)
      Adds an IAM policy statement associated with this Event API to an IAM principal's policy.

      Specified by:
      grant in interface IEventApi
      Parameters:
      grantee - The principal. This parameter is required.
      resources - The set of resources to allow (i.e. ...:[region]:[accountId]:apis/EventApiId/...). This parameter is required.
      actions - The actions that should be granted to the principal (i.e. appsync:EventPublish ). This parameter is required.

    • grantConnect

      @Stability(Stable) @NotNull default Grant grantConnect(@NotNull IGrantable grantee)
      Adds an IAM policy statement for EventConnect access to this EventApi to an IAM principal's policy.

      Specified by:
      grantConnect in interface IEventApi
      Parameters:
      grantee - The principal. This parameter is required.

    • grantPublish

      @Stability(Stable) @NotNull default Grant grantPublish(@NotNull IGrantable grantee)
      Adds an IAM policy statement for EventPublish access to this EventApi to an IAM principal's policy.

      Specified by:
      grantPublish in interface IEventApi
      Parameters:
      grantee - The principal. This parameter is required.

    • grantPublishAndSubscribe

      @Stability(Stable) @NotNull default Grant grantPublishAndSubscribe(@NotNull IGrantable grantee)
      Adds an IAM policy statement to publish and subscribe to this API for an IAM principal's policy.

      Specified by:
      grantPublishAndSubscribe in interface IEventApi
      Parameters:
      grantee - The principal. This parameter is required.

    • grantSubscribe

      @Stability(Stable) @NotNull default Grant grantSubscribe(@NotNull IGrantable grantee)
      Adds an IAM policy statement for EventSubscribe access to this EventApi to an IAM principal's policy.

      Specified by:
      grantSubscribe in interface IEventApi
      Parameters:
      grantee - The principal. This parameter is required.