Class CfnSlackChannelConfiguration

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.chatbot.CfnSlackChannelConfiguration
All Implemented Interfaces:
IInspectable, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-12T19:33:58.434Z") @Stability(Stable) public class CfnSlackChannelConfiguration extends CfnResource implements IInspectable, ITaggableV2
The AWS::Chatbot::SlackChannelConfiguration resource configures a Slack channel to allow users to use AWS Chatbot with AWS CloudFormation templates.

This resource requires some setup to be done in the AWS Chatbot console. To provide the required Slack workspace ID, you must perform the initial authorization flow with Slack in the AWS Chatbot console, then copy and paste the workspace ID from the console. For more details, see Configure a Slack client in the AWS Chatbot User Guide .

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.chatbot.*;
 CfnSlackChannelConfiguration cfnSlackChannelConfiguration = CfnSlackChannelConfiguration.Builder.create(this, "MyCfnSlackChannelConfiguration")
         .configurationName("configurationName")
         .iamRoleArn("iamRoleArn")
         .slackChannelId("slackChannelId")
         .slackWorkspaceId("slackWorkspaceId")
         // the properties below are optional
         .guardrailPolicies(List.of("guardrailPolicies"))
         .loggingLevel("loggingLevel")
         .snsTopicArns(List.of("snsTopicArns"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .userRoleRequired(false)
         .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

    • CfnSlackChannelConfiguration

      protected CfnSlackChannelConfiguration(software.amazon.jsii.JsiiObjectRef objRef)
    • CfnSlackChannelConfiguration

      protected CfnSlackChannelConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
    • CfnSlackChannelConfiguration

      @Stability(Stable) public CfnSlackChannelConfiguration(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnSlackChannelConfigurationProps props)
      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

    • 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()
      Amazon Resource Name (ARN) of the configuration.
    • 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
    • getConfigurationName

      @Stability(Stable) @NotNull public String getConfigurationName()
      The name of the configuration.
    • setConfigurationName

      @Stability(Stable) public void setConfigurationName(@NotNull String value)
      The name of the configuration.
    • getIamRoleArn

      @Stability(Stable) @NotNull public String getIamRoleArn()
      The ARN of the IAM role that defines the permissions for AWS Chatbot .
    • setIamRoleArn

      @Stability(Stable) public void setIamRoleArn(@NotNull String value)
      The ARN of the IAM role that defines the permissions for AWS Chatbot .
    • getSlackChannelId

      @Stability(Stable) @NotNull public String getSlackChannelId()
      The ID of the Slack channel.
    • setSlackChannelId

      @Stability(Stable) public void setSlackChannelId(@NotNull String value)
      The ID of the Slack channel.
    • getSlackWorkspaceId

      @Stability(Stable) @NotNull public String getSlackWorkspaceId()
      The ID of the Slack workspace authorized with AWS Chatbot .
    • setSlackWorkspaceId

      @Stability(Stable) public void setSlackWorkspaceId(@NotNull String value)
      The ID of the Slack workspace authorized with AWS Chatbot .
    • getGuardrailPolicies

      @Stability(Stable) @Nullable public List<String> getGuardrailPolicies()
      The list of IAM policy ARNs that are applied as channel guardrails.
    • setGuardrailPolicies

      @Stability(Stable) public void setGuardrailPolicies(@Nullable List<String> value)
      The list of IAM policy ARNs that are applied as channel guardrails.
    • getLoggingLevel

      @Stability(Stable) @Nullable public String getLoggingLevel()
      Specifies the logging level for this configuration.

      This property affects the log entries pushed to Amazon CloudWatch Logs.

    • setLoggingLevel

      @Stability(Stable) public void setLoggingLevel(@Nullable String value)
      Specifies the logging level for this configuration.

      This property affects the log entries pushed to Amazon CloudWatch Logs.

    • getSnsTopicArns

      @Stability(Stable) @Nullable public List<String> getSnsTopicArns()
      The ARNs of the SNS topics that deliver notifications to AWS Chatbot .
    • setSnsTopicArns

      @Stability(Stable) public void setSnsTopicArns(@Nullable List<String> value)
      The ARNs of the SNS topics that deliver notifications to AWS Chatbot .
    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags to add to the configuration.
    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags to add to the configuration.
    • getUserRoleRequired

      @Stability(Stable) @Nullable public Object getUserRoleRequired()
      Enables use of a user role requirement in your chat configuration.
    • setUserRoleRequired

      @Stability(Stable) public void setUserRoleRequired(@Nullable Boolean value)
      Enables use of a user role requirement in your chat configuration.
    • setUserRoleRequired

      @Stability(Stable) public void setUserRoleRequired(@Nullable IResolvable value)
      Enables use of a user role requirement in your chat configuration.