Package software.amazon.awscdk.services.chime

Class CfnChannelFlow

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.CfnChannelFlow
All Implemented Interfaces:
IInspectable, IChannelFlowRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-02T11:03:05.194Z") @Stability(Stable) public class CfnChannelFlow extends CfnResource implements IInspectable, IChannelFlowRef, ITaggableV2
Creates a channel flow in the Amazon Chime SDK Messaging service.

A channel flow is a container for processors (Lambda functions) that perform actions on chat messages.

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.*;
 CfnChannelFlow cfnChannelFlow = CfnChannelFlow.Builder.create(this, "MyCfnChannelFlow")
         .appInstanceArn("appInstanceArn")
         .name("name")
         .processors(List.of(ProcessorProperty.builder()
                 .configuration(ProcessorConfigurationProperty.builder()
                         .lambda(LambdaConfigurationProperty.builder()
                                 .invocationType("invocationType")
                                 .resourceArn("resourceArn")
                                 .build())
                         .build())
                 .executionOrder(123)
                 .fallbackAction("fallbackAction")
                 .name("name")
                 .build()))
         // the properties below are optional
         .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

    • CfnChannelFlow

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

    • CfnChannelFlow

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

    • CfnChannelFlow

      @Stability(Stable) public CfnChannelFlow(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnChannelFlowProps props)
      Create a new AWS::Chime::ChannelFlow.

      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

    • arnForChannelFlow

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

    • isCfnChannelFlow

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

      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.

    • getAttrAppInstanceId

      @Stability(Stable) @NotNull public String getAttrAppInstanceId()
      The ID of the app instance, extracted from the channel flow ARN.

    • getAttrArn

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

    • getAttrChannelFlowId

      @Stability(Stable) @NotNull public String getAttrChannelFlowId()
      The ID of the channel flow, extracted from the channel flow ARN.

    • getAttrCreatedTimestamp

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

    • getAttrLastUpdatedTimestamp

      @Stability(Stable) @NotNull public String getAttrLastUpdatedTimestamp()
      The time at which the channel flow 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

    • getChannelFlowRef

      @Stability(Stable) @NotNull public ChannelFlowReference getChannelFlowRef()
      A reference to a ChannelFlow resource.
      Specified by:
      getChannelFlowRef in interface IChannelFlowRef

    • getAppInstanceArn

      @Stability(Stable) @NotNull public String getAppInstanceArn()
      The ARN of the app instance.

    • setAppInstanceArn

      @Stability(Stable) public void setAppInstanceArn(@NotNull String value)
      The ARN of the app instance.

    • getName

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

    • setName

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

    • getProcessors

      @Stability(Stable) @NotNull public Object getProcessors()
      Information about the processor Lambda functions.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnChannelFlow.ProcessorProperty>

    • setProcessors

      @Stability(Stable) public void setProcessors(@NotNull IResolvable value)
      Information about the processor Lambda functions.

    • setProcessors

      @Stability(Stable) public void setProcessors(@NotNull List<Object> value)
      Information about the processor Lambda functions.

    • getTags

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

    • setTags

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