Package software.amazon.awscdk.services.chime

Interface CfnChannelProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnChannelProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)",
           date="2026-09-30T11:04:46.939Z")
@Stability(Stable)
public interface CfnChannelProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnChannel.

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.chime.*;
 CfnChannelProps cfnChannelProps = CfnChannelProps.builder()
         .appInstanceArn("appInstanceArn")
         .chimeBearer("chimeBearer")
         .name("name")
         // the properties below are optional
         .channelId("channelId")
         .elasticChannelConfiguration(ElasticChannelConfigurationProperty.builder()
                 .maximumSubChannels(123)
                 .minimumMembershipPercentage(123)
                 .targetMembershipsPerSubChannel(123)
                 .build())
         .expirationSettings(ExpirationSettingsProperty.builder()
                 .expirationCriterion("expirationCriterion")
                 .expirationDays(123)
                 .build())
         .memberArns(List.of("memberArns"))
         .metadata("metadata")
         .mode("mode")
         .moderatorArns(List.of("moderatorArns"))
         .privacy("privacy")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chime-channel.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnChannelProps.Builder	builder()
String	getAppInstanceArn()	The ARN of the AppInstance that contains the channel.
default String	getChannelId()	The ID of the channel.
String	getChimeBearer()	The ARN of the AppInstanceUser or AppInstanceBot that performs every operation on this channel.
default Object	getElasticChannelConfiguration()	The attributes required to configure and create an elastic channel.
default Object	getExpirationSettings()	Settings that control the interval after which the channel is automatically deleted.
default List<String>	getMemberArns()	The ARNs of the AppInstanceUsers to add to the channel as members when it is created.
default String	getMetadata()	The metadata of the channel.
default String	getMode()	The channel mode.
default List<String>	getModeratorArns()	The ARNs of the AppInstanceUsers to add to the channel as moderators when it is created.
String	getName()	The name of the channel.
default String	getPrivacy()	The channel's privacy level.
default List<CfnTag>	getTags()	The tags for the channel.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAppInstanceArn

@Stability(Stable)
@NotNull
String getAppInstanceArn()

The ARN of the AppInstance that contains the channel.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chime-channel.html#cfn-chime-channel-appinstancearn

getChimeBearer

@Stability(Stable)
@NotNull
String getChimeBearer()

The ARN of the AppInstanceUser or AppInstanceBot that performs every operation on this channel.

Whichever of the two creates a channel automatically becomes one of its moderators, so the same ARN can subsequently read, update and delete the channel.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chime-channel.html#cfn-chime-channel-chimebearer

getName

@Stability(Stable)
@NotNull
String getName()

The name of the channel.

See Also:

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

getChannelId

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

The ID of the channel.

When omitted, the service generates a UUID.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chime-channel.html#cfn-chime-channel-channelid

getElasticChannelConfiguration

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

The attributes required to configure and create an elastic channel.

An elastic channel must use RESTRICTED mode, cannot be created with MemberArns, and is available only in some regions.

Returns union: either IResolvable or CfnChannel.ElasticChannelConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chime-channel.html#cfn-chime-channel-elasticchannelconfiguration

getExpirationSettings

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

Settings that control the interval after which the channel is automatically deleted.

Returns union: either IResolvable or CfnChannel.ExpirationSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chime-channel.html#cfn-chime-channel-expirationsettings

getMemberArns

@Stability(Stable)
@Nullable
default List<String> getMemberArns()

The ARNs of the AppInstanceUsers to add to the channel as members when it is created.

Cannot be combined with ElasticChannelConfiguration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chime-channel.html#cfn-chime-channel-memberarns

getMetadata

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

The metadata of the channel.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chime-channel.html#cfn-chime-channel-metadata

getMode

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

The channel mode.

In an UNRESTRICTED channel, members can add themselves and other members; in a RESTRICTED channel, only administrators and moderators can add members. An elastic channel must be RESTRICTED.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chime-channel.html#cfn-chime-channel-mode

getModeratorArns

@Stability(Stable)
@Nullable
default List<String> getModeratorArns()

The ARNs of the AppInstanceUsers to add to the channel as moderators when it is created.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chime-channel.html#cfn-chime-channel-moderatorarns

getPrivacy

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

The channel's privacy level.

A PUBLIC channel is discoverable by anyone in the AppInstance; a PRIVATE channel is not. Privacy cannot be changed after creation.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chime-channel.html#cfn-chime-channel-privacy

getTags

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

The tags for the channel.

See Also:

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

builder

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

Returns:

a CfnChannelProps.Builder of CfnChannelProps