Class CfnChannelNamespace

The AWS::AppSync::ChannelNamespace resource creates a channel namespace associated with an Api .

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnChannelNamespace

Implements

IInspectable

IChannelNamespaceRef

IConstruct

IDependable

IEnvironmentAware

ITaggableV2

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.AppSync

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnChannelNamespace : CfnResource, IInspectable, IChannelNamespaceRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Syntax (vb)

Public Class CfnChannelNamespace Inherits CfnResource Implements IInspectable, IChannelNamespaceRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Remarks

The ChannelNamespace contains the definitions for code handlers for the Api .

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

CloudformationResource: AWS::AppSync::ChannelNamespace

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 cfnChannelNamespace = new CfnChannelNamespace(this, "MyCfnChannelNamespace", new CfnChannelNamespaceProps {
                 ApiId = "apiId",
                 Name = "name",

                 // the properties below are optional
                 CodeHandlers = "codeHandlers",
                 CodeS3Location = "codeS3Location",
                 HandlerConfigs = new HandlerConfigsProperty {
                     OnPublish = new HandlerConfigProperty {
                         Behavior = "behavior",
                         Integration = new IntegrationProperty {
                             DataSourceName = "dataSourceName",

                             // the properties below are optional
                             LambdaConfig = new LambdaConfigProperty {
                                 InvokeType = "invokeType"
                             }
                         }
                     },
                     OnSubscribe = new HandlerConfigProperty {
                         Behavior = "behavior",
                         Integration = new IntegrationProperty {
                             DataSourceName = "dataSourceName",

                             // the properties below are optional
                             LambdaConfig = new LambdaConfigProperty {
                                 InvokeType = "invokeType"
                             }
                         }
                     }
                 },
                 PublishAuthModes = new [] { new AuthModeProperty {
                     AuthType = "authType"
                 } },
                 SubscribeAuthModes = new [] { new AuthModeProperty {
                     AuthType = "authType"
                 } },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnChannelNamespace(Construct, string, ICfnChannelNamespaceProps)

Create a new AWS::AppSync::ChannelNamespace.

Properties

ApiId	The Api ID.
AttrChannelNamespaceArn	The Amazon Resource Name (ARN) of the channel namespace.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CdkTagManager	Tag Manager which manages the tags for this resource.
CfnProperties	The AWS::AppSync::ChannelNamespace resource creates a channel namespace associated with an Api .
ChannelNamespaceRef	A reference to a ChannelNamespace resource.
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.
HandlerConfigs	The configuration for the OnPublish and OnSubscribe handlers.
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.

Methods

ArnForChannelNamespace(IChannelNamespaceRef)	The AWS::AppSync::ChannelNamespace resource creates a channel namespace associated with an Api .
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnChannelNamespace(object)	Checks whether the given object is a CfnChannelNamespace.
RenderProperties(IDictionary<string, object>)	The AWS::AppSync::ChannelNamespace resource creates a channel namespace associated with an Api .

Constructors

CfnChannelNamespace(Construct, string, ICfnChannelNamespaceProps)

Create a new AWS::AppSync::ChannelNamespace.

public CfnChannelNamespace(Construct scope, string id, ICfnChannelNamespaceProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnChannelNamespaceProps

Resource properties.

Remarks

The ChannelNamespace contains the definitions for code handlers for the Api .

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

CloudformationResource: AWS::AppSync::ChannelNamespace

ExampleMetadata: fixture=_generated

Properties

ApiId

The Api ID.

public virtual string ApiId { get; set; }

Property Value

string

Remarks

The ChannelNamespace contains the definitions for code handlers for the Api .

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

CloudformationResource: AWS::AppSync::ChannelNamespace

ExampleMetadata: fixture=_generated

AttrChannelNamespaceArn

The Amazon Resource Name (ARN) of the channel namespace.

public virtual string AttrChannelNamespaceArn { get; }

Property Value

string

Remarks

CloudformationAttribute: ChannelNamespaceArn

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

The ChannelNamespace contains the definitions for code handlers for the Api .

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

CloudformationResource: AWS::AppSync::ChannelNamespace

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }

Property Value

TagManager

Remarks

The ChannelNamespace contains the definitions for code handlers for the Api .

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

CloudformationResource: AWS::AppSync::ChannelNamespace

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::AppSync::ChannelNamespace resource creates a channel namespace associated with an Api .

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

The ChannelNamespace contains the definitions for code handlers for the Api .

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

CloudformationResource: AWS::AppSync::ChannelNamespace

ExampleMetadata: fixture=_generated

ChannelNamespaceRef

A reference to a ChannelNamespace resource.

public virtual IChannelNamespaceReference ChannelNamespaceRef { get; }

Property Value

IChannelNamespaceReference

Remarks

The ChannelNamespace contains the definitions for code handlers for the Api .

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

CloudformationResource: AWS::AppSync::ChannelNamespace

ExampleMetadata: fixture=_generated

CodeHandlers

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

public virtual string? CodeHandlers { get; set; }

Property Value

string

Remarks

The ChannelNamespace contains the definitions for code handlers for the Api .

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

CloudformationResource: AWS::AppSync::ChannelNamespace

ExampleMetadata: fixture=_generated

CodeS3Location

The Amazon S3 endpoint where the code is located.

public virtual string? CodeS3Location { get; set; }

Property Value

string

Remarks

The ChannelNamespace contains the definitions for code handlers for the Api .

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

CloudformationResource: AWS::AppSync::ChannelNamespace

ExampleMetadata: fixture=_generated

HandlerConfigs

The configuration for the OnPublish and OnSubscribe handlers.

public virtual object? HandlerConfigs { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnChannelNamespace.IHandlerConfigsProperty

Name

The name of the channel namespace.

public virtual string Name { get; set; }

Property Value

string

Remarks

The ChannelNamespace contains the definitions for code handlers for the Api .

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

CloudformationResource: AWS::AppSync::ChannelNamespace

ExampleMetadata: fixture=_generated

PublishAuthModes

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

public virtual object? PublishAuthModes { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnChannelNamespace.IAuthModeProperty)[]

SubscribeAuthModes

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

public virtual object? SubscribeAuthModes { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnChannelNamespace.IAuthModeProperty)[]

Tags

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

public virtual ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

The ChannelNamespace contains the definitions for code handlers for the Api .

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

CloudformationResource: AWS::AppSync::ChannelNamespace

ExampleMetadata: fixture=_generated

Methods

ArnForChannelNamespace(IChannelNamespaceRef)

The AWS::AppSync::ChannelNamespace resource creates a channel namespace associated with an Api .

public static string ArnForChannelNamespace(IChannelNamespaceRef resource)

Parameters

resource IChannelNamespaceRef

Returns

string

Remarks

The ChannelNamespace contains the definitions for code handlers for the Api .

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

CloudformationResource: AWS::AppSync::ChannelNamespace

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 cfnChannelNamespace = new CfnChannelNamespace(this, "MyCfnChannelNamespace", new CfnChannelNamespaceProps {
                 ApiId = "apiId",
                 Name = "name",

                 // the properties below are optional
                 CodeHandlers = "codeHandlers",
                 CodeS3Location = "codeS3Location",
                 HandlerConfigs = new HandlerConfigsProperty {
                     OnPublish = new HandlerConfigProperty {
                         Behavior = "behavior",
                         Integration = new IntegrationProperty {
                             DataSourceName = "dataSourceName",

                             // the properties below are optional
                             LambdaConfig = new LambdaConfigProperty {
                                 InvokeType = "invokeType"
                             }
                         }
                     },
                     OnSubscribe = new HandlerConfigProperty {
                         Behavior = "behavior",
                         Integration = new IntegrationProperty {
                             DataSourceName = "dataSourceName",

                             // the properties below are optional
                             LambdaConfig = new LambdaConfigProperty {
                                 InvokeType = "invokeType"
                             }
                         }
                     }
                 },
                 PublishAuthModes = new [] { new AuthModeProperty {
                     AuthType = "authType"
                 } },
                 SubscribeAuthModes = new [] { new AuthModeProperty {
                     AuthType = "authType"
                 } },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

The ChannelNamespace contains the definitions for code handlers for the Api .

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

CloudformationResource: AWS::AppSync::ChannelNamespace

ExampleMetadata: fixture=_generated

IsCfnChannelNamespace(object)

Checks whether the given object is a CfnChannelNamespace.

public static bool IsCfnChannelNamespace(object x)

Parameters

x object

Returns

bool

Remarks

The ChannelNamespace contains the definitions for code handlers for the Api .

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

CloudformationResource: AWS::AppSync::ChannelNamespace

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::AppSync::ChannelNamespace resource creates a channel namespace associated with an Api .

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

The ChannelNamespace contains the definitions for code handlers for the Api .

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

CloudformationResource: AWS::AppSync::ChannelNamespace

ExampleMetadata: fixture=_generated

Implements

IInspectable

IChannelNamespaceRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggableV2