Package software.amazon.awscdk.services.appsync

Class IEventApi.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.appsync.IEventApi.Jsii$Proxy
All Implemented Interfaces:
IResource, IResource.Jsii$Default, IApi, IApi.Jsii$Default, IEventApi, IEventApi.Jsii$Default, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default
Enclosing interface:
IEventApi
@Internal public static final class IEventApi.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements IEventApi.Jsii$Default
A proxy class which represents a concrete javascript instance of this type.

  • 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 interface IApi.Jsii$Default
      Specified by:
      getNode in interface software.constructs.IConstruct
      Specified by:
      getNode in interface software.constructs.IConstruct.Jsii$Default
      Specified by:
      getNode in interface IEventApi.Jsii$Default
      Specified by:
      getNode in interface IResource.Jsii$Default

    • getEnv

      @Stability(Stable) @NotNull 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 IApi.Jsii$Default
      Specified by:
      getEnv in interface IEventApi.Jsii$Default
      Specified by:
      getEnv in interface IResource
      Specified by:
      getEnv in interface IResource.Jsii$Default

    • getStack

      @Stability(Stable) @NotNull public final Stack getStack()
      The stack in which this resource is defined.
      Specified by:
      getStack in interface IApi.Jsii$Default
      Specified by:
      getStack in interface IEventApi.Jsii$Default
      Specified by:
      getStack in interface IResource
      Specified by:
      getStack in interface IResource.Jsii$Default

    • getApiArn

      @Stability(Stable) @NotNull public final String getApiArn()
      The ARN of the AWS AppSync Api.
      Specified by:
      getApiArn in interface IApi
      Specified by:
      getApiArn in interface IApi.Jsii$Default
      Specified by:
      getApiArn in interface IEventApi.Jsii$Default

    • getApiId

      @Stability(Stable) @NotNull public final String getApiId()
      The unique identifier for the AWS AppSync Api generated by the service.
      Specified by:
      getApiId in interface IApi
      Specified by:
      getApiId in interface IApi.Jsii$Default
      Specified by:
      getApiId in interface IEventApi.Jsii$Default

    • getAuthProviderTypes

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

    • getHttpDns

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

    • getRealtimeDns

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

    • applyRemovalPolicy

      @Stability(Stable) public final 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 IApi.Jsii$Default
      Specified by:
      applyRemovalPolicy in interface IEventApi.Jsii$Default
      Specified by:
      applyRemovalPolicy in interface IResource
      Specified by:
      applyRemovalPolicy in interface IResource.Jsii$Default
      Parameters:
      policy - This parameter is required.

    • addChannelNamespace

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

      Specified by:
      addChannelNamespace in interface IEventApi
      Specified by:
      addChannelNamespace in interface IEventApi.Jsii$Default
      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 public final 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 public final 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
      Specified by:
      addDynamoDbDataSource in interface IEventApi.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 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 public final 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
      Specified by:
      addEventBridgeDataSource in interface IEventApi.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 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 public final 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
      Specified by:
      addHttpDataSource in interface IEventApi.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 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 public final 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
      Specified by:
      addLambdaDataSource in interface IEventApi.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 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 public final 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
      Specified by:
      addOpenSearchDataSource in interface IEventApi.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 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 public final 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
      Specified by:
      addRdsDataSource in interface IEventApi.Jsii$Default
      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 public final 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 public final 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 public final 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
      Specified by:
      grant in interface IEventApi.Jsii$Default
      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 public final 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
      Specified by:
      grantConnect in interface IEventApi.Jsii$Default
      Parameters:
      grantee - The principal. This parameter is required.

    • grantPublish

      @Stability(Stable) @NotNull public final 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
      Specified by:
      grantPublish in interface IEventApi.Jsii$Default
      Parameters:
      grantee - The principal. This parameter is required.

    • grantPublishAndSubscribe

      @Stability(Stable) @NotNull public final 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
      Specified by:
      grantPublishAndSubscribe in interface IEventApi.Jsii$Default
      Parameters:
      grantee - The principal. This parameter is required.

    • grantSubscribe

      @Stability(Stable) @NotNull public final 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
      Specified by:
      grantSubscribe in interface IEventApi.Jsii$Default
      Parameters:
      grantee - The principal. This parameter is required.