AWS CDK Reference

Appearance

v2.273.0

AppSyncEventResource Class ​

A class used to generate resource arns for AppSync Event APIs.

Source
aws-appsync/lib/appsync-common.ts
Type last changed
v2.178.0 · 6 Feb 2025

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appsync as appsync } from 'aws-cdk-lib';
const appSyncEventResource = appsync.AppSyncEventResource.all();

Methods ​

all(): AppSyncEventResource // chainable@staticmethod def all() -> AppSyncEventResourcepublic static AppSyncEventResource all()public static AppSyncEventResource All()func All() AppSyncEventResourcestatic#
Generate the resource names that accepts all types: `*`.
allChannelNamespaces(): AppSyncEventResource // chainable@staticmethod def all_channel_namespaces() -> AppSyncEventResourcepublic static AppSyncEventResource allChannelNamespaces()public static AppSyncEventResource AllChannelNamespaces()func AllChannelNamespaces() AppSyncEventResourcestatic#
Generate the resource names that accepts all channel namespaces: `*`.
forAPI(): AppSyncEventResource // chainable@staticmethod def for_api() -> AppSyncEventResourcepublic static AppSyncEventResource forAPI()public static AppSyncEventResource ForAPI()func ForAPI() AppSyncEventResourcestatic#
Generate a resource for the calling API.
ofChannelNamespace(channelNamespace: string): AppSyncEventResource // chainable@staticmethod def of_channel_namespace(channel_namespace: str) -> AppSyncEventResourcepublic static AppSyncEventResource ofChannelNamespace(String channelNamespace)public static AppSyncEventResource OfChannelNamespace(string channelNamespace)func OfChannelNamespace(ChannelNamespace *string) AppSyncEventResourcestatic#
Generate the resource names given a channel namespace.
1 parameter

Parameters

  • channelNamespacechannel_namespacechannelNamespacechannelNamespaceChannelNamespace — The channel namespace that needs to be allowed.
resourceArns(api: EventApiBase): string[]def resource_arns(self, api: EventApiBase) -> typing.List[str]public List<String> resourceArns(EventApiBase api)public string[] ResourceArns(EventApiBase api)func ResourceArns(Api EventApiBase) *[]*string#
Return the Resource ARN.
1 parameter

Parameters

  • apiapiapiapiApi — The AppSync API to give permissions.