EventApiBase L2 construct
Base Class for Event API.
Initializer
ts
new EventApiBase(scope: Construct, id: string, props?: ResourceProps)
python
EventApiBase(scope: Construct, id: str, props: typing.Optional[ResourceProps] = None)
java
new EventApiBase(Construct scope, String id, ResourceProps props)
csharp
new EventApiBase(Construct scope, string id, ResourceProps? props = null)
go
NewEventApiBase(Scope Construct, Id *string, Props ResourceProps)
Construct Props
The AWS account ID this resource belongs to.
default
Default: the resource is in the same account as the stack it belongs to
environmentFromArnstringenvironment_from_arnstrenvironmentFromArnStringEnvironmentFromArnstringEnvironmentFromArn*string= take environment from `account`,…#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
Default: take environment from account, region parameters, or use Stack environment.
physicalNamestringphysical_namestrphysicalNameStringPhysicalNamestringPhysicalName*string= The physical name will be alloca…#The value passed in by users to the physical name prop of the resource.
notes · default
undefinedimplies that a physical name will be allocated by CloudFormation during deployment.- a concrete value implies a specific physical name
PhysicalName.GENERATE_IF_NEEDEDis 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
The AWS region this resource belongs to.
default
Default: the resource is in the same region as the stack it belongs to
Properties
The ARN of the AWS AppSync Api.
The unique identifier for the AWS AppSync Api generated by the service.
apiRefApiReferenceapi_refApiReferenceapiRefApiReferenceApiRefApiReferenceApiRefApiReferencerequired#A reference to a Api resource.
authProviderTypesAppSyncAuthorizationType[]auth_provider_typestyping.List[AppSyncAuthorizationType]authProviderTypesList<AppSyncAuthorizationType>AuthProviderTypesAppSyncAuthorizationType[]AuthProviderTypes*[]AppSyncAuthorizationTyperequired#The Authorization Types for this Event Api.
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#The environment this resource belongs to.
notes
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.
The domain name of the Api's HTTP endpoint.
The domain name of the Api's real-time endpoint.
Methods
addChannelNamespace(id: string, options?: ChannelNamespaceOptions): ChannelNamespacedef add_channel_namespace(self, id: str, options: typing.Optional[ChannelNamespaceOptions] = None) -> ChannelNamespacepublic ChannelNamespace addChannelNamespace(String id, ChannelNamespaceOptions options)public ChannelNamespace AddChannelNamespace(string id, ChannelNamespaceOptions? options = null)func AddChannelNamespace(Id *string, Options ChannelNamespaceOptions) ChannelNamespace#add a new Channel Namespace to this API.
addDynamoDbDataSource(id: string, table: ITable, options?: AppSyncDataSourceOptions): AppSyncDynamoDbDataSourcedef add_dynamo_db_data_source(self, id: str, table: ITable, options: typing.Optional[AppSyncDataSourceOptions] = None) -> AppSyncDynamoDbDataSourcepublic AppSyncDynamoDbDataSource addDynamoDbDataSource(String id, ITable table, AppSyncDataSourceOptions options)public AppSyncDynamoDbDataSource AddDynamoDbDataSource(string id, ITable table, AppSyncDataSourceOptions? options = null)func AddDynamoDbDataSource(Id *string, Table ITable, Options AppSyncDataSourceOptions) AppSyncDynamoDbDataSource#add a new DynamoDB data source to this API.
3 parameters
Parameters
ididididId— The data source's id.tabletabletabletableTable— The DynamoDB table backing this data source.optionsoptionsoptionsoptionsOptions— The optional configuration for this data source.
addEventBridgeDataSource(id: string, eventBus: IEventBus, options?: AppSyncDataSourceOptions): AppSyncEventBridgeDataSourcedef add_event_bridge_data_source(self, id: str, event_bus: IEventBus, options: typing.Optional[AppSyncDataSourceOptions] = None) -> AppSyncEventBridgeDataSourcepublic AppSyncEventBridgeDataSource addEventBridgeDataSource(String id, IEventBus eventBus, AppSyncDataSourceOptions options)public AppSyncEventBridgeDataSource AddEventBridgeDataSource(string id, IEventBus eventBus, AppSyncDataSourceOptions? options = null)func AddEventBridgeDataSource(Id *string, EventBus IEventBus, Options AppSyncDataSourceOptions) AppSyncEventBridgeDataSource#Add an EventBridge data source to this api.
3 parameters
Parameters
ididididId— The data source's id.eventBusevent_buseventBuseventBusEventBus— The EventBridge EventBus on which to put events.optionsoptionsoptionsoptionsOptions— The optional configuration for this data source.
addHttpDataSource(id: string, endpoint: string, options?: AppSyncHttpDataSourceOptions): AppSyncHttpDataSourcedef add_http_data_source(self, id: str, endpoint: str, options: typing.Optional[AppSyncHttpDataSourceOptions] = None) -> AppSyncHttpDataSourcepublic AppSyncHttpDataSource addHttpDataSource(String id, String endpoint, AppSyncHttpDataSourceOptions options)public AppSyncHttpDataSource AddHttpDataSource(string id, string endpoint, AppSyncHttpDataSourceOptions? options = null)func AddHttpDataSource(Id *string, Endpoint *string, Options AppSyncHttpDataSourceOptions) AppSyncHttpDataSource#add a new http data source to this API.
3 parameters
Parameters
ididididId— The data source's id.endpointendpointendpointendpointEndpoint— The http endpoint.optionsoptionsoptionsoptionsOptions— The optional configuration for this data source.
addLambdaDataSource(id: string, lambdaFunction: IFunction, options?: AppSyncDataSourceOptions): AppSyncLambdaDataSourcedef add_lambda_data_source(self, id: str, lambda_function: IFunction, options: typing.Optional[AppSyncDataSourceOptions] = None) -> AppSyncLambdaDataSourcepublic AppSyncLambdaDataSource addLambdaDataSource(String id, IFunction lambdaFunction, AppSyncDataSourceOptions options)public AppSyncLambdaDataSource AddLambdaDataSource(string id, IFunction lambdaFunction, AppSyncDataSourceOptions? options = null)func AddLambdaDataSource(Id *string, LambdaFunction IFunction, Options AppSyncDataSourceOptions) AppSyncLambdaDataSource#add a new Lambda data source to this API.
3 parameters
Parameters
ididididId— The data source's id.lambdaFunctionlambda_functionlambdaFunctionlambdaFunctionLambdaFunction— The Lambda function to call to interact with this data source.optionsoptionsoptionsoptionsOptions— The optional configuration for this data source.
addOpenSearchDataSource(id: string, domain: IDomain, options?: AppSyncDataSourceOptions): AppSyncOpenSearchDataSourcedef add_open_search_data_source(self, id: str, domain: IDomain, options: typing.Optional[AppSyncDataSourceOptions] = None) -> AppSyncOpenSearchDataSourcepublic AppSyncOpenSearchDataSource addOpenSearchDataSource(String id, IDomain domain, AppSyncDataSourceOptions options)public AppSyncOpenSearchDataSource AddOpenSearchDataSource(string id, IDomain domain, AppSyncDataSourceOptions? options = null)func AddOpenSearchDataSource(Id *string, Domain IDomain, Options AppSyncDataSourceOptions) AppSyncOpenSearchDataSource#add a new OpenSearch data source to this API.
3 parameters
Parameters
ididididId— The data source's id.domaindomaindomaindomainDomain— The OpenSearch domain for this data source.optionsoptionsoptionsoptionsOptions— The optional configuration for this data source.
addRdsDataSource(id: string, serverlessCluster: IDatabaseCluster | IServerlessCluster, secretStore: ISecret, databaseName?: string, options?: AppSyncDataSourceOptions): AppSyncRdsDataSourcedef add_rds_data_source(self, id: str, serverless_cluster: typing.Union[IDatabaseCluster, IServerlessCluster], secret_store: ISecret, database_name: typing.Optional[str] = None, options: typing.Optional[AppSyncDataSourceOptions] = None) -> AppSyncRdsDataSourcepublic AppSyncRdsDataSource addRdsDataSource(String id, IDatabaseCluster serverlessCluster, ISecret secretStore, String databaseName, AppSyncDataSourceOptions options)public AppSyncRdsDataSource AddRdsDataSource(string id, IDatabaseCluster serverlessCluster, ISecret secretStore, string? databaseName = null, AppSyncDataSourceOptions? options = null)func AddRdsDataSource(Id *string, ServerlessCluster interface{}, SecretStore ISecret, DatabaseName *string, Options AppSyncDataSourceOptions) AppSyncRdsDataSource#add a new Rds data source to this API.
5 parameters
Parameters
ididididId— The data source's id.serverlessClusterserverless_clusterserverlessClusterserverlessClusterServerlessCluster— The database cluster to interact with this data source.secretStoresecret_storesecretStoresecretStoreSecretStore— The secret store that contains the username and password for the database cluster.databaseNamedatabase_namedatabaseNamedatabaseNameDatabaseName— The optional name of the database to use within the cluster.optionsoptionsoptionsoptionsOptions— The optional configuration for this data source.
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#Override the cross-stack reference strength for this resource.
notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#Apply the given removal policy to this resource.
notes
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).
grant(grantee: IGrantable, resources: AppSyncEventResource, ...actions: string[]): Grantdef grant(self, grantee: IGrantable, resources: AppSyncEventResource, actions: str) -> Grantpublic Grant grant(IGrantable grantee, AppSyncEventResource resources, String actions)public Grant Grant(IGrantable grantee, AppSyncEventResource resources, string actions)func Grant(Grantee IGrantable, Resources AppSyncEventResource, Actions *string) Grant#Adds an IAM policy statement associated with this Event API to an IAM principal's policy.
[disable-awslint:no-grants]
3 parameters
Parameters
granteegranteegranteegranteeGrantee— The principal.resourcesresourcesresourcesresourcesResources— The set of resources to allow (i.e. ...:[region]:[accountId]:apis/EventApiId/...).actionsactionsactionsactionsActions— The actions that should be granted to the principal (i.e. appsync:EventPublish ).
grantConnect(grantee: IGrantable): Grantdef grant_connect(self, grantee: IGrantable) -> Grantpublic Grant grantConnect(IGrantable grantee)public Grant GrantConnect(IGrantable grantee)func GrantConnect(Grantee IGrantable) Grant#Adds an IAM policy statement for EventConnect access to this EventApi to an IAM principal's policy.
[disable-awslint:no-grants]
1 parameter
Parameters
granteegranteegranteegranteeGrantee— The principal.
grantPublish(grantee: IGrantable): Grantdef grant_publish(self, grantee: IGrantable) -> Grantpublic Grant grantPublish(IGrantable grantee)public Grant GrantPublish(IGrantable grantee)func GrantPublish(Grantee IGrantable) Grant#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. [disable-awslint:no-grants]
1 parameter
Parameters
granteegranteegranteegranteeGrantee— The principal.
grantPublishAndSubscribe(grantee: IGrantable): Grantdef grant_publish_and_subscribe(self, grantee: IGrantable) -> Grantpublic Grant grantPublishAndSubscribe(IGrantable grantee)public Grant GrantPublishAndSubscribe(IGrantable grantee)func GrantPublishAndSubscribe(Grantee IGrantable) Grant#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. [disable-awslint:no-grants]
1 parameter
Parameters
granteegranteegranteegranteeGrantee— The principal.
grantSubscribe(grantee: IGrantable): Grantdef grant_subscribe(self, grantee: IGrantable) -> Grantpublic Grant grantSubscribe(IGrantable grantee)public Grant GrantSubscribe(IGrantable grantee)func GrantSubscribe(Grantee IGrantable) Grant#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. [disable-awslint:no-grants]
1 parameter
Parameters
granteegranteegranteegranteeGrantee— The principal.
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#Checks if `x` is a construct.
notes · 1 parameter · returns
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
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#Returns true if the construct was created by CDK, and false otherwise.
isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#Check whether the given construct is a Resource.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#Returns a string representation of this construct.
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.