IEventApi

class aws_cdk.aws_appsync.IEventApi(*args, **kwargs)

Bases: IApi, Protocol

Interface for Event API.

Methods

add_channel_namespace(id, *, authorization_config=None, channel_namespace_name=None, code=None)

add a new channel namespace.

Parameters:

id (str) – the id of the channel namespace.
authorization_config (Union[NamespaceAuthConfig, Dict[str, Any], None]) – Authorization config for channel namespace. Default: - defaults to Event API default auth config
channel_namespace_name (Optional[str]) – The Channel Namespace name. Default: - the construct’s id will be used
code (Optional[Code]) – The Event Handler code. Default: - no code is used

Return type:

ChannelNamespace

Returns:

the channel namespace

apply_removal_policy(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).

Parameters:

policy (RemovalPolicy) –

Return type:

None

grant(grantee, resources, *actions)

Adds an IAM policy statement associated with this Event API to an IAM principal’s policy.

Parameters:

grantee (IGrantable) – The principal.
resources (AppSyncEventResource) – The set of resources to allow (i.e. …:[region]:[accountId]:apis/EventApiId/…).
actions (str) – The actions that should be granted to the principal (i.e. appsync:EventPublish ).

Return type:

Grant

grant_connect(grantee)

Adds an IAM policy statement for EventConnect access to this EventApi to an IAM principal’s policy.

Parameters:: grantee (IGrantable) – The principal.
Return type:: Grant

grant_publish(grantee)

Adds an IAM policy statement for EventPublish access to this EventApi to an IAM principal’s policy.

Parameters:: grantee (IGrantable) – The principal.
Return type:: Grant

grant_publish_and_subscribe(grantee)

Adds an IAM policy statement to publish and subscribe to this API for an IAM principal’s policy.

Parameters:: grantee (IGrantable) – The principal.
Return type:: Grant

grant_subscribe(grantee)

Adds an IAM policy statement for EventSubscribe access to this EventApi to an IAM principal’s policy.

Parameters:: grantee (IGrantable) – The principal.
Return type:: Grant

Attributes

api_arn

The ARN of the AWS AppSync Api.

Attribute:: true

api_id

The unique identifier for the AWS AppSync Api generated by the service.

Attribute:: true

auth_provider_types: The Authorization Types for this Event Api.

env

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.

http_dns

The domain name of the Api’s HTTP endpoint.

Attribute:: true

node: The tree node.

realtime_dns

The domain name of the Api’s real-time endpoint.

Attribute:: true

stack: The stack in which this resource is defined.