Package software.amazon.awscdk.services.chime

Class CfnChannel

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.chime.CfnChannel
All Implemented Interfaces:
IInspectable, IChannelRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)", date="2026-09-30T11:04:46.934Z") @Stability(Stable) public class CfnChannel extends CfnResource implements IInspectable, IChannelRef, ITaggableV2
Creates a channel in an Amazon Chime SDK Messaging AppInstance.

Members of a channel exchange messages within it. Every channel operation is performed on behalf of an AppInstanceUser or AppInstanceBot, whose ARN is supplied as ChimeBearer and forms part of the channel's CloudFormation identifier.

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.*;
 CfnChannel cfnChannel = CfnChannel.Builder.create(this, "MyCfnChannel")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnChannel

      protected CfnChannel(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnChannel

      protected CfnChannel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnChannel

      @Stability(Stable) public CfnChannel(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnChannelProps props)
      Create a new AWS::Chime::Channel.

      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.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForChannel

      @Stability(Stable) @NotNull public static String arnForChannel(@NotNull IChannelRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnChannel

      @Stability(Stable) @NotNull public static Boolean isCfnChannel(@NotNull Object x)
      Checks whether the given object is a CfnChannel.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The ARN of the channel.

    • getAttrChannelFlowArn

      @Stability(Stable) @NotNull public String getAttrChannelFlowArn()
      The ARN of the channel flow.

    • getAttrCreatedBy

      @Stability(Stable) @NotNull public IResolvable getAttrCreatedBy()
      The AppInstanceUser or AppInstanceBot that created the channel.

    • getAttrCreatedTimestamp

      @Stability(Stable) @NotNull public String getAttrCreatedTimestamp()
      The time at which the channel was created.

    • getAttrLastMessageTimestamp

      @Stability(Stable) @NotNull public String getAttrLastMessageTimestamp()
      The time at which a member sent the last message in the channel.

    • getAttrLastUpdatedTimestamp

      @Stability(Stable) @NotNull public String getAttrLastUpdatedTimestamp()
      The time at which the channel was last updated.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getChannelRef

      @Stability(Stable) @NotNull public ChannelReference getChannelRef()
      A reference to a Channel resource.
      Specified by:
      getChannelRef in interface IChannelRef

    • getAppInstanceArn

      @Stability(Stable) @NotNull public String getAppInstanceArn()
      The ARN of the AppInstance that contains the channel.

    • setAppInstanceArn

      @Stability(Stable) public void setAppInstanceArn(@NotNull String value)
      The ARN of the AppInstance that contains the channel.

    • getChimeBearer

      @Stability(Stable) @NotNull public String getChimeBearer()
      The ARN of the AppInstanceUser or AppInstanceBot that performs every operation on this channel.

    • setChimeBearer

      @Stability(Stable) public void setChimeBearer(@NotNull String value)
      The ARN of the AppInstanceUser or AppInstanceBot that performs every operation on this channel.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the channel.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the channel.

    • getChannelId

      @Stability(Stable) @Nullable public String getChannelId()
      The ID of the channel.

    • setChannelId

      @Stability(Stable) public void setChannelId(@Nullable String value)
      The ID of the channel.

    • getElasticChannelConfiguration

      @Stability(Stable) @Nullable public Object getElasticChannelConfiguration()
      The attributes required to configure and create an elastic channel.

      Returns union: either IResolvable or CfnChannel.ElasticChannelConfigurationProperty

    • setElasticChannelConfiguration

      @Stability(Stable) public void setElasticChannelConfiguration(@Nullable IResolvable value)
      The attributes required to configure and create an elastic channel.

    • setElasticChannelConfiguration

      @Stability(Stable) public void setElasticChannelConfiguration(@Nullable CfnChannel.ElasticChannelConfigurationProperty value)
      The attributes required to configure and create an elastic channel.

    • getExpirationSettings

      @Stability(Stable) @Nullable public Object getExpirationSettings()
      Settings that control the interval after which the channel is automatically deleted.

      Returns union: either IResolvable or CfnChannel.ExpirationSettingsProperty

    • setExpirationSettings

      @Stability(Stable) public void setExpirationSettings(@Nullable IResolvable value)
      Settings that control the interval after which the channel is automatically deleted.

    • setExpirationSettings

      @Stability(Stable) public void setExpirationSettings(@Nullable CfnChannel.ExpirationSettingsProperty value)
      Settings that control the interval after which the channel is automatically deleted.

    • getMemberArns

      @Stability(Stable) @Nullable public List<String> getMemberArns()
      The ARNs of the AppInstanceUsers to add to the channel as members when it is created.

    • setMemberArns

      @Stability(Stable) public void setMemberArns(@Nullable List<String> value)
      The ARNs of the AppInstanceUsers to add to the channel as members when it is created.

    • getMetadata

      @Stability(Stable) @Nullable public String getMetadata()
      The metadata of the channel.

    • setMetadata

      @Stability(Stable) public void setMetadata(@Nullable String value)
      The metadata of the channel.

    • getMode

      @Stability(Stable) @Nullable public String getMode()
      The channel mode.

    • setMode

      @Stability(Stable) public void setMode(@Nullable String value)
      The channel mode.

    • getModeratorArns

      @Stability(Stable) @Nullable public List<String> getModeratorArns()
      The ARNs of the AppInstanceUsers to add to the channel as moderators when it is created.

    • setModeratorArns

      @Stability(Stable) public void setModeratorArns(@Nullable List<String> value)
      The ARNs of the AppInstanceUsers to add to the channel as moderators when it is created.

    • getPrivacy

      @Stability(Stable) @Nullable public String getPrivacy()
      The channel's privacy level.

    • setPrivacy

      @Stability(Stable) public void setPrivacy(@Nullable String value)
      The channel's privacy level.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags for the channel.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags for the channel.