EventApiBase

class aws_cdk.aws_appsync.EventApiBase(scope, id, *, account=None, environment_from_arn=None, physical_name=None, region=None)

Bases: ApiBase

Base Class for Event API.

Parameters:

scope (Construct)
id (str)
account (Optional[str]) – The AWS account ID this resource belongs to. Default: - the resource is in the same account as the stack it belongs to
environment_from_arn (Optional[str]) – ARN to deduce region and account from. The ARN is parsed and the account and region are taken from the ARN. This should be used for imported resources. Cannot be supplied together with either account or region. Default: - take environment from account, region parameters, or use Stack environment.
physical_name (Optional[str]) – The value passed in by users to the physical name prop of the resource. - undefined implies that a physical name will be allocated by CloudFormation during deployment. - a concrete value implies a specific physical name - PhysicalName.GENERATE_IF_NEEDED is a marker that indicates that a physical will only be generated by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation. Default: - The physical name will be allocated by CloudFormation at deployment time
region (Optional[str]) – The AWS region this resource belongs to. Default: - the resource is in the same region as the stack it belongs to

Methods

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

add a new Channel Namespace to this API.

Parameters:

id (str)
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
publish_handler_config (Union[HandlerConfig, Dict[str, Any], None]) – onPublish handler config. Default: - no handler config
subscribe_handler_config (Union[HandlerConfig, Dict[str, Any], None]) – onSubscribe handler config. Default: - no handler config

Return type:

ChannelNamespace

add_dynamo_db_data_source(id, table, *, description=None, name=None)

add a new DynamoDB data source to this API.

Parameters:

id (str) – The data source’s id.
table (ITable) – The DynamoDB table backing this data source.
description (Optional[str]) – The description of the data source. Default: - No description
name (Optional[str]) – The name of the data source, overrides the id given by CDK. Default: - generated by CDK given the id

Return type:

AppSyncDynamoDbDataSource

add_event_bridge_data_source(id, event_bus, *, description=None, name=None)

Add an EventBridge data source to this api.

Parameters:

id (str) – The data source’s id.
event_bus (IEventBus) – The EventBridge EventBus on which to put events.
description (Optional[str]) – The description of the data source. Default: - No description
name (Optional[str]) – The name of the data source, overrides the id given by CDK. Default: - generated by CDK given the id

Return type:

AppSyncEventBridgeDataSource

add_http_data_source(id, endpoint, *, authorization_config=None, description=None, name=None)

add a new http data source to this API.

Parameters:

id (str) – The data source’s id.
endpoint (str) – The http endpoint.
authorization_config (Union[AppSyncAwsIamConfig, Dict[str, Any], None]) – The authorization config in case the HTTP endpoint requires authorization. Default: - none
description (Optional[str]) – The description of the data source. Default: - No description
name (Optional[str]) – The name of the data source, overrides the id given by CDK. Default: - generated by CDK given the id

Return type:

AppSyncHttpDataSource

add_lambda_data_source(id, lambda_function, *, description=None, name=None)

add a new Lambda data source to this API.

Parameters:

id (str) – The data source’s id.
lambda_function (IFunction) – The Lambda function to call to interact with this data source.
description (Optional[str]) – The description of the data source. Default: - No description
name (Optional[str]) – The name of the data source, overrides the id given by CDK. Default: - generated by CDK given the id

Return type:

AppSyncLambdaDataSource

add_open_search_data_source(id, domain, *, description=None, name=None)

add a new OpenSearch data source to this API.

Parameters:

id (str) – The data source’s id.
domain (IDomain) – The OpenSearch domain for this data source.
description (Optional[str]) – The description of the data source. Default: - No description
name (Optional[str]) – The name of the data source, overrides the id given by CDK. Default: - generated by CDK given the id

Return type:

AppSyncOpenSearchDataSource

add_rds_data_source(id, serverless_cluster, secret_store, database_name=None, *, description=None, name=None)

add a new Rds data source to this API.

Parameters:

id (str) – The data source’s id.
serverless_cluster (Union[IDatabaseCluster, IServerlessCluster]) – The database cluster to interact with this data source.
secret_store (ISecret) – The secret store that contains the username and password for the database cluster.
database_name (Optional[str]) – The optional name of the database to use within the cluster.
description (Optional[str]) – The description of the data source. Default: - No description
name (Optional[str]) – The name of the data source, overrides the id given by CDK. Default: - generated by CDK given the id

Return type:

AppSyncRdsDataSource

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.

This grants publish permission for all channels within the API.

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.

This grants publish & subscribe permission for all channels within the API.

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.

This grants subscribe permission for all channels within the API.

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

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

api_arn: The ARN of the AWS AppSync Api.

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

auth_provider_types: The Authorization Types for this Event Api.

env

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

http_dns: The domain name of the Api’s HTTP endpoint.

node: The tree node.

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

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

Static Methods

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:: construct (IConstruct)
Return type:: bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:: construct (IConstruct)
Return type:: bool