CfnSlackChannelConfigurationProps

class aws_cdk.aws_chatbot.CfnSlackChannelConfigurationProps(*, configuration_name, iam_role_arn, slack_channel_id, slack_workspace_id, guardrail_policies=None, logging_level=None, sns_topic_arns=None, tags=None, user_role_required=None)

Bases: object

Properties for defining a CfnSlackChannelConfiguration.

Parameters:

configuration_name (str) – The name of the configuration.
iam_role_arn (str) – The ARN of the IAM role that defines the permissions for AWS Chatbot . This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot .
slack_channel_id (str) – The ID of the Slack channel. To get the ID, open Slack, right click on the channel name in the left pane, then choose Copy Link. The channel ID is the character string at the end of the URL. For example, ABCBBLZZZ .
slack_workspace_id (str) – The ID of the Slack workspace authorized with AWS Chatbot . To get the workspace ID, you must perform the initial authorization flow with Slack in the AWS Chatbot console. Then you can copy and paste the workspace ID from the console. For more details, see steps 1-3 in Tutorial: Get started with Slack in the AWS Chatbot User Guide .
guardrail_policies (Optional[Sequence[str]]) – The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed ‘AdministratorAccess’ policy is applied as a default if this is not set.
logging_level (Optional[str]) – Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon CloudWatch Logs. Logging levels include ERROR , INFO , or NONE . Default: - “NONE”
sns_topic_arns (Optional[Sequence[str]]) – The ARNs of the SNS topics that deliver notifications to AWS Chatbot .
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags to add to the configuration.
user_role_required (Union[bool, IResolvable, None]) – Enables use of a user role requirement in your chat configuration. Default: - false

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_chatbot as chatbot

cfn_slack_channel_configuration_props = chatbot.CfnSlackChannelConfigurationProps(
    configuration_name="configurationName",
    iam_role_arn="iamRoleArn",
    slack_channel_id="slackChannelId",
    slack_workspace_id="slackWorkspaceId",

    # the properties below are optional
    guardrail_policies=["guardrailPolicies"],
    logging_level="loggingLevel",
    sns_topic_arns=["snsTopicArns"],
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    user_role_required=False
)

Attributes

configuration_name

The name of the configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-configurationname

guardrail_policies

The list of IAM policy ARNs that are applied as channel guardrails.

The AWS managed ‘AdministratorAccess’ policy is applied as a default if this is not set.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-guardrailpolicies

iam_role_arn

The ARN of the IAM role that defines the permissions for AWS Chatbot .

This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-iamrolearn

logging_level

Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon CloudWatch Logs.

Logging levels include ERROR , INFO , or NONE .

Default:

“NONE”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-logginglevel

slack_channel_id

The ID of the Slack channel.

To get the ID, open Slack, right click on the channel name in the left pane, then choose Copy Link. The channel ID is the character string at the end of the URL. For example, ABCBBLZZZ .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-slackchannelid

slack_workspace_id

The ID of the Slack workspace authorized with AWS Chatbot .

To get the workspace ID, you must perform the initial authorization flow with Slack in the AWS Chatbot console. Then you can copy and paste the workspace ID from the console. For more details, see steps 1-3 in Tutorial: Get started with Slack in the AWS Chatbot User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-slackworkspaceid

sns_topic_arns

The ARNs of the SNS topics that deliver notifications to AWS Chatbot .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-snstopicarns

tags

The tags to add to the configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-tags

user_role_required

Enables use of a user role requirement in your chat configuration.

Default:

false

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-userrolerequired