Package software.amazon.awscdk.services.appsync

Interface CfnChannelNamespaceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnChannelNamespaceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-11T23:26:28.847Z")
@Stability(Stable)
public interface CfnChannelNamespaceProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.appsync.*;
 CfnChannelNamespaceProps cfnChannelNamespaceProps = CfnChannelNamespaceProps.builder()
         .apiId("apiId")
         .name("name")
         // the properties below are optional
         .codeHandlers("codeHandlers")
         .codeS3Location("codeS3Location")
         .publishAuthModes(List.of(AuthModeProperty.builder()
                 .authType("authType")
                 .build()))
         .subscribeAuthModes(List.of(AuthModeProperty.builder()
                 .authType("authType")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnChannelNamespaceProps.Builder	A builder for CfnChannelNamespaceProps
static final class	CfnChannelNamespaceProps.Jsii$Proxy	An implementation for CfnChannelNamespaceProps

Method Summary

Modifier and Type	Method	Description
static CfnChannelNamespaceProps.Builder	builder()
String	getApiId()	The Api ID.
default String	getCodeHandlers()	The event handler functions that run custom business logic to process published events and subscribe requests.
default String	getCodeS3Location()	The Amazon S3 endpoint where the code is located.
String	getName()	The name of the channel namespace.
default Object	getPublishAuthModes()	The authorization mode to use for publishing messages on the channel namespace.
default Object	getSubscribeAuthModes()	The authorization mode to use for subscribing to messages on the channel namespace.
default List<CfnTag>	getTags()	A set of tags (key-value pairs) for this channel namespace.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiId

@Stability(Stable)
@NotNull
String getApiId()

The Api ID.

See Also:

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

getName

@Stability(Stable)
@NotNull
String getName()

The name of the channel namespace.

This name must be unique within the Api .

See Also:

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

getCodeHandlers

@Stability(Stable)
@Nullable
default String getCodeHandlers()

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

See Also:

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

getCodeS3Location

@Stability(Stable)
@Nullable
default String getCodeS3Location()

The Amazon S3 endpoint where the code is located.

See Also:

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

getPublishAuthModes

@Stability(Stable)
@Nullable
default Object getPublishAuthModes()

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

This configuration overrides the default Api authorization configuration.

See Also:

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

getSubscribeAuthModes

@Stability(Stable)
@Nullable
default Object getSubscribeAuthModes()

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

This configuration overrides the default Api authorization configuration.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

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

builder

@Stability(Stable)
static CfnChannelNamespaceProps.Builder builder()

Returns:

a CfnChannelNamespaceProps.Builder of CfnChannelNamespaceProps