Package software.amazon.awscdk.services.appsync

Class CfnChannelNamespace.Builder

java.lang.Object

software.amazon.awscdk.services.appsync.CfnChannelNamespace.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnChannelNamespace>

Enclosing class:

CfnChannelNamespace

@Stability(Stable)
public static final class CfnChannelNamespace.Builder
extends Object
implements software.amazon.jsii.Builder<CfnChannelNamespace>

A fluent builder for CfnChannelNamespace.

Method Summary

Modifier and Type	Method	Description
CfnChannelNamespace.Builder	apiId(String apiId)	The Api ID.
CfnChannelNamespace	build()
CfnChannelNamespace.Builder	codeHandlers(String codeHandlers)	The event handler functions that run custom business logic to process published events and subscribe requests.
CfnChannelNamespace.Builder	codeS3Location(String codeS3Location)	The Amazon S3 endpoint where the code is located.
static CfnChannelNamespace.Builder	create(software.constructs.Construct scope, String id)
CfnChannelNamespace.Builder	name(String name)	The name of the channel namespace.
CfnChannelNamespace.Builder	publishAuthModes(List<? extends Object> publishAuthModes)	The authorization mode to use for publishing messages on the channel namespace.
CfnChannelNamespace.Builder	publishAuthModes(IResolvable publishAuthModes)	The authorization mode to use for publishing messages on the channel namespace.
CfnChannelNamespace.Builder	subscribeAuthModes(List<? extends Object> subscribeAuthModes)	The authorization mode to use for subscribing to messages on the channel namespace.
CfnChannelNamespace.Builder	subscribeAuthModes(IResolvable subscribeAuthModes)	The authorization mode to use for subscribing to messages on the channel namespace.
CfnChannelNamespace.Builder	tags(List<? extends CfnTag> tags)	A set of tags (key-value pairs) for this channel namespace.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnChannelNamespace.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnChannelNamespace.Builder.

apiId

@Stability(Stable)
public CfnChannelNamespace.Builder apiId(String apiId)

The Api ID.

Parameters:

apiId - The Api ID. This parameter is required.

Returns:

this

See Also:

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

name

@Stability(Stable)
public CfnChannelNamespace.Builder name(String name)

The name of the channel namespace.

This name must be unique within the Api .

Parameters:

name - The name of the channel namespace. This parameter is required.

Returns:

this

See Also:

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

codeHandlers

@Stability(Stable)
public CfnChannelNamespace.Builder codeHandlers(String codeHandlers)

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

Parameters:

codeHandlers - The event handler functions that run custom business logic to process published events and subscribe requests. This parameter is required.

Returns:

this

See Also:

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

codeS3Location

@Stability(Stable)
public CfnChannelNamespace.Builder codeS3Location(String codeS3Location)

The Amazon S3 endpoint where the code is located.

Parameters:

codeS3Location - The Amazon S3 endpoint where the code is located. This parameter is required.

Returns:

this

See Also:

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

publishAuthModes

@Stability(Stable)
public CfnChannelNamespace.Builder publishAuthModes(IResolvable publishAuthModes)

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

This configuration overrides the default Api authorization configuration.

Parameters:

publishAuthModes - The authorization mode to use for publishing messages on the channel namespace. This parameter is required.

Returns:

this

See Also:

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

publishAuthModes

@Stability(Stable)
public CfnChannelNamespace.Builder publishAuthModes(List<? extends Object> publishAuthModes)

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

This configuration overrides the default Api authorization configuration.

Parameters:

publishAuthModes - The authorization mode to use for publishing messages on the channel namespace. This parameter is required.

Returns:

this

See Also:

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

subscribeAuthModes

@Stability(Stable)
public CfnChannelNamespace.Builder subscribeAuthModes(IResolvable subscribeAuthModes)

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

This configuration overrides the default Api authorization configuration.

Parameters:

subscribeAuthModes - The authorization mode to use for subscribing to messages on the channel namespace. This parameter is required.

Returns:

this

See Also:

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

subscribeAuthModes

@Stability(Stable)
public CfnChannelNamespace.Builder subscribeAuthModes(List<? extends Object> subscribeAuthModes)

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

This configuration overrides the default Api authorization configuration.

Parameters:

subscribeAuthModes - The authorization mode to use for subscribing to messages on the channel namespace. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnChannelNamespace.Builder tags(List<? extends CfnTag> tags)

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

Parameters:

tags - A set of tags (key-value pairs) for this channel namespace. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnChannelNamespace build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnChannelNamespace>

Returns:

a newly built instance of CfnChannelNamespace.