Interface ICfnChannelNamespaceProps

Properties for defining a CfnChannelNamespace.

Namespace: Amazon.CDK.AWS.AppSync
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnChannelNamespaceProps
Syntax (vb)
Public Interface ICfnChannelNamespaceProps
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-channelnamespace.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppSync;

var cfnChannelNamespaceProps = new CfnChannelNamespaceProps {
    ApiId = "apiId",
    Name = "name",

    // the properties below are optional
    CodeHandlers = "codeHandlers",
    CodeS3Location = "codeS3Location",
    PublishAuthModes = new [] { new AuthModeProperty {
        AuthType = "authType"
    } },
    SubscribeAuthModes = new [] { new AuthModeProperty {
        AuthType = "authType"
    } },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};

Synopsis

Properties

ApiId

The Api ID.
CodeHandlers

The event handler functions that run custom business logic to process published events and subscribe requests.
CodeS3Location

The Amazon S3 endpoint where the code is located.
Name

The name of the channel namespace.
PublishAuthModes

The authorization mode to use for publishing messages on the channel namespace.
SubscribeAuthModes

The authorization mode to use for subscribing to messages on the channel namespace.
Tags

A set of tags (key-value pairs) for this channel namespace.

Properties

ApiId

The Api ID.

string ApiId { get; }
Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-channelnamespace.html#cfn-appsync-channelnamespace-apiid

CodeHandlers

The event handler functions that run custom business logic to process published events and subscribe requests.

virtual string CodeHandlers { get; }
Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-channelnamespace.html#cfn-appsync-channelnamespace-codehandlers

CodeS3Location

The Amazon S3 endpoint where the code is located.

virtual string CodeS3Location { get; }
Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-channelnamespace.html#cfn-appsync-channelnamespace-codes3location

Name

The name of the channel namespace.

string Name { get; }
Property Value

System.String

Remarks

This name must be unique within the Api .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-channelnamespace.html#cfn-appsync-channelnamespace-name

PublishAuthModes

The authorization mode to use for publishing messages on the channel namespace.

virtual object PublishAuthModes { get; }
Property Value

System.Object

Remarks

This configuration overrides the default Api authorization configuration.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-channelnamespace.html#cfn-appsync-channelnamespace-publishauthmodes

SubscribeAuthModes

The authorization mode to use for subscribing to messages on the channel namespace.

virtual object SubscribeAuthModes { get; }
Property Value

System.Object

Remarks

This configuration overrides the default Api authorization configuration.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-channelnamespace.html#cfn-appsync-channelnamespace-subscribeauthmodes

Tags

A set of tags (key-value pairs) for this channel namespace.

virtual ICfnTag[] Tags { get; }
Property Value

ICfnTag[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-channelnamespace.html#cfn-appsync-channelnamespace-tags