Class CfnSlackChannelConfiguration
The AWS::Chatbot::SlackChannelConfiguration
resource configures a Slack channel to allow users to use AWS Chatbot with AWS CloudFormation templates.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Chatbot
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnSlackChannelConfiguration : CfnResource, IInspectable
Syntax (vb)
Public Class CfnSlackChannelConfiguration
Inherits CfnResource
Implements IInspectable
Remarks
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 .
CloudformationResource: AWS::Chatbot::SlackChannelConfiguration
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Chatbot;
var cfnSlackChannelConfiguration = new CfnSlackChannelConfiguration(this, "MyCfnSlackChannelConfiguration", new CfnSlackChannelConfigurationProps {
ConfigurationName = "configurationName",
IamRoleArn = "iamRoleArn",
SlackChannelId = "slackChannelId",
SlackWorkspaceId = "slackWorkspaceId",
// the properties below are optional
GuardrailPolicies = new [] { "guardrailPolicies" },
LoggingLevel = "loggingLevel",
SnsTopicArns = new [] { "snsTopicArns" },
UserRoleRequired = false
});
Synopsis
Constructors
CfnSlackChannelConfiguration(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnSlackChannelConfiguration(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnSlackChannelConfiguration(Construct, String, ICfnSlackChannelConfigurationProps) |
Properties
AttrArn | Amazon Resource Name (ARN) of the configuration. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ConfigurationName | The name of the configuration. |
GuardrailPolicies | The list of IAM policy ARNs that are applied as channel guardrails. |
IamRoleArn | The ARN of the IAM role that defines the permissions for AWS Chatbot . |
LoggingLevel | Specifies the logging level for this configuration. |
SlackChannelId | The ID of the Slack channel. |
SlackWorkspaceId | The ID of the Slack workspace authorized with AWS Chatbot . |
SnsTopicArns | The ARNs of the SNS topics that deliver notifications to AWS Chatbot . |
UserRoleRequired | Enables use of a user role requirement in your chat configuration. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnSlackChannelConfiguration(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnSlackChannelConfiguration(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnSlackChannelConfiguration(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnSlackChannelConfiguration(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnSlackChannelConfiguration(Construct, String, ICfnSlackChannelConfigurationProps)
public CfnSlackChannelConfiguration(Construct scope, string id, ICfnSlackChannelConfigurationProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnSlackChannelConfigurationProps
Resource properties.
Properties
AttrArn
Amazon Resource Name (ARN) of the configuration.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ConfigurationName
The name of the configuration.
public virtual string ConfigurationName { get; set; }
Property Value
System.String
GuardrailPolicies
The list of IAM policy ARNs that are applied as channel guardrails.
public virtual string[] GuardrailPolicies { get; set; }
Property Value
System.String[]
IamRoleArn
The ARN of the IAM role that defines the permissions for AWS Chatbot .
public virtual string IamRoleArn { get; set; }
Property Value
System.String
LoggingLevel
Specifies the logging level for this configuration.
public virtual string LoggingLevel { get; set; }
Property Value
System.String
Remarks
This property affects the log entries pushed to Amazon CloudWatch Logs.
SlackChannelId
The ID of the Slack channel.
public virtual string SlackChannelId { get; set; }
Property Value
System.String
SlackWorkspaceId
The ID of the Slack workspace authorized with AWS Chatbot .
public virtual string SlackWorkspaceId { get; set; }
Property Value
System.String
SnsTopicArns
The ARNs of the SNS topics that deliver notifications to AWS Chatbot .
public virtual string[] SnsTopicArns { get; set; }
Property Value
System.String[]
UserRoleRequired
Enables use of a user role requirement in your chat configuration.
public virtual object UserRoleRequired { get; set; }
Property Value
System.Object
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>