interface CfnChannelNamespaceProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.AppSync.CfnChannelNamespaceProps |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsappsync#CfnChannelNamespaceProps |
Java | software.amazon.awscdk.services.appsync.CfnChannelNamespaceProps |
Python | aws_cdk.aws_appsync.CfnChannelNamespaceProps |
TypeScript | aws-cdk-lib » aws_appsync » CfnChannelNamespaceProps |
Properties for defining a CfnChannelNamespace
.
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 cfnChannelNamespaceProps: appsync.CfnChannelNamespaceProps = {
apiId: 'apiId',
name: 'name',
// the properties below are optional
codeHandlers: 'codeHandlers',
codeS3Location: 'codeS3Location',
publishAuthModes: [{
authType: 'authType',
}],
subscribeAuthModes: [{
authType: 'authType',
}],
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
Name | Type | Description |
---|---|---|
api | string | The Api ID. |
name | string | The name of the channel namespace. |
code | string | The event handler functions that run custom business logic to process published events and subscribe requests. |
code | string | The Amazon S3 endpoint where the code is located. |
publish | IResolvable | IResolvable | Auth [] | The authorization mode to use for publishing messages on the channel namespace. |
subscribe | IResolvable | IResolvable | Auth [] | The authorization mode to use for subscribing to messages on the channel namespace. |
tags? | Cfn [] | A set of tags (key-value pairs) for this channel namespace. |
apiId
Type:
string
The Api
ID.
name
Type:
string
The name of the channel namespace.
This name must be unique within the Api
.
codeHandlers?
Type:
string
(optional)
The event handler functions that run custom business logic to process published events and subscribe requests.
codeS3Location?
Type:
string
(optional)
The Amazon S3 endpoint where the code is located.
publishAuthModes?
Type:
IResolvable
|
IResolvable
|
Auth
[]
(optional)
The authorization mode to use for publishing messages on the channel namespace.
This configuration overrides the default Api
authorization configuration.
subscribeAuthModes?
Type:
IResolvable
|
IResolvable
|
Auth
[]
(optional)
The authorization mode to use for subscribing to messages on the channel namespace.
This configuration overrides the default Api
authorization configuration.
tags?
Type:
Cfn
[]
(optional)
A set of tags (key-value pairs) for this channel namespace.