class AppSyncEventResource

Language	Type name
.NET	Amazon.CDK.AWS.AppSync.AppSyncEventResource
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsappsync#AppSyncEventResource
Java	software.amazon.awscdk.services.appsync.AppSyncEventResource
Python	aws_cdk.aws_appsync.AppSyncEventResource
TypeScript (source)	aws-cdk-lib » aws_appsync » AppSyncEventResource

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

Example

// 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

Name	Description
resourceArns(api)	Return the Resource ARN.
static all()	Generate the resource names that accepts all types: *.
static allChannelNamespaces()	Generate the resource names that accepts all channel namespaces: *.
static forAPI()	Generate a resource for the calling API.
static ofChannelNamespace(channelNamespace)	Generate the resource names given a channel namespace.

---

resourceArns(api)

public resourceArns(api: EventApiBase): string[]

Parameters

• api EventApiBase — The AppSync API to give permissions.

Returns

• string[]

Return the Resource ARN.

---

static all()

public static all(): AppSyncEventResource

Returns

• AppSyncEventResource

Generate the resource names that accepts all types: *.

---

static allChannelNamespaces()

public static allChannelNamespaces(): AppSyncEventResource

Returns

• AppSyncEventResource

Generate the resource names that accepts all channel namespaces: *.

---

static forAPI()

public static forAPI(): AppSyncEventResource

Returns

• AppSyncEventResource

Generate a resource for the calling API.

---

static ofChannelNamespace(channelNamespace)

public static ofChannelNamespace(channelNamespace: string): AppSyncEventResource

Parameters

• channelNamespace string — The channel namespace that needs to be allowed.

Returns

• AppSyncEventResource

Generate the resource names given a channel namespace.