Package software.amazon.awscdk.services.appsync

Interface IEventApi.Jsii$Default

All Superinterfaces:
IApi, IApi.Jsii$Default, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.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

    • getNode

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

    • getApiArn

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

    • getApiId

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

    • 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

    • 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 IApi.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 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

    • grant

      @Stability(Stable) @NotNull default Grant grant(@NotNull IGrantable grantee, @NotNull AppSyncEventResource resources, @NotNull @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.