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-11-06T23:25:04.390Z")
@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()	AppSync Api Id that this Channel Namespace belongs to.
default String	getCodeHandlers()	String of APPSYNC_JS code to be used by the handlers.
default String	getCodeS3Location()	The Amazon S3 endpoint where the code is located.
String	getName()	Namespace indentifier.
default Object	getPublishAuthModes()
default Object	getSubscribeAuthModes()
default List<CfnTag>	getTags()	An arbitrary set of tags (key-value pairs) for this AppSync API.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiId

@Stability(Stable)
@NotNull
String getApiId()

AppSync Api Id that this Channel Namespace belongs to.

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()

Namespace indentifier.

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()

String of APPSYNC_JS code to be used by the handlers.

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()

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()

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()

An arbitrary set of tags (key-value pairs) for this AppSync API.

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