aws-cdk-lib 2.144.0__py3-none-any.whl → 2.146.0__py3-none-any.whl

aws_cdk/aws_chatbot/__init__.py

@@ -47,6 +47,24 @@ correct log retention period (never expire, by default).
 
 By default slack channel will use `AdministratorAccess` managed policy as guardrail policy.
 The `guardrailPolicies` property can be used to set a different set of managed policies.
+
+## User Role Requirement
+
+Administrators can [require user roles](https://docs.aws.amazon.com/chatbot/latest/adminguide/understanding-permissions.html#user-role-requirement) for all current channel members and channels and all channels created in the future by enabling a user role requirement.
+
+You can configure this feature by setting the `userRoleRequired` property.
+
+```python
+import aws_cdk.aws_chatbot as chatbot
+
+
+slack_channel = chatbot.SlackChannelConfiguration(self, "MySlackChannel",
+    slack_channel_configuration_name="YOUR_CHANNEL_NAME",
+    slack_workspace_id="YOUR_SLACK_WORKSPACE_ID",
+    slack_channel_id="YOUR_SLACK_CHANNEL_ID",
+    user_role_required=True
+)
+```
 '''
 from pkgutil import extend_path
 __path__ = extend_path(__path__, __name__)
@@ -1301,6 +1319,7 @@ class SlackChannelConfiguration(
         log_retention_role: typing.Optional[_IRole_235f5d8e] = None,
         notification_topics: typing.Optional[typing.Sequence[_ITopic_9eca4852]] = None,
         role: typing.Optional[_IRole_235f5d8e] = None,
+        user_role_required: typing.Optional[builtins.bool] = None,
     ) -> None:
         '''
         :param scope: -
@@ -1315,6 +1334,7 @@ class SlackChannelConfiguration(
         :param log_retention_role: The IAM role for the Lambda function associated with the custom resource that sets the retention policy. Default: - A new role is created.
         :param notification_topics: The SNS topics that deliver notifications to AWS Chatbot. Default: None
         :param role: The permission role of Slack channel configuration. Default: - A role will be created.
+        :param user_role_required: Enables use of a user role requirement in your chat configuration. Default: false
         '''
         if __debug__:
             type_hints = typing.get_type_hints(_typecheckingstub__efdd5da37140f8254b4a44f567a060e15106ce03d4f75880500b5d15d8076be9)
@@ -1331,6 +1351,7 @@ class SlackChannelConfiguration(
             log_retention_role=log_retention_role,
             notification_topics=notification_topics,
             role=role,
+            user_role_required=user_role_required,
         )
 
         jsii.create(self.__class__, self, [scope, id, props])
@@ -1518,6 +1539,7 @@ class SlackChannelConfiguration(
         "log_retention_role": "logRetentionRole",
         "notification_topics": "notificationTopics",
         "role": "role",
+        "user_role_required": "userRoleRequired",
     },
 )
 class SlackChannelConfigurationProps:
@@ -1534,6 +1556,7 @@ class SlackChannelConfigurationProps:
         log_retention_role: typing.Optional[_IRole_235f5d8e] = None,
         notification_topics: typing.Optional[typing.Sequence[_ITopic_9eca4852]] = None,
         role: typing.Optional[_IRole_235f5d8e] = None,
+        user_role_required: typing.Optional[builtins.bool] = None,
     ) -> None:
         '''Properties for a new Slack channel configuration.
 
@@ -1547,6 +1570,7 @@ class SlackChannelConfigurationProps:
         :param log_retention_role: The IAM role for the Lambda function associated with the custom resource that sets the retention policy. Default: - A new role is created.
         :param notification_topics: The SNS topics that deliver notifications to AWS Chatbot. Default: None
         :param role: The permission role of Slack channel configuration. Default: - A role will be created.
+        :param user_role_required: Enables use of a user role requirement in your chat configuration. Default: false
 
         :exampleMetadata: infused
 
@@ -1579,6 +1603,7 @@ class SlackChannelConfigurationProps:
             check_type(argname="argument log_retention_role", value=log_retention_role, expected_type=type_hints["log_retention_role"])
             check_type(argname="argument notification_topics", value=notification_topics, expected_type=type_hints["notification_topics"])
             check_type(argname="argument role", value=role, expected_type=type_hints["role"])
+            check_type(argname="argument user_role_required", value=user_role_required, expected_type=type_hints["user_role_required"])
         self._values: typing.Dict[builtins.str, typing.Any] = {
             "slack_channel_configuration_name": slack_channel_configuration_name,
             "slack_channel_id": slack_channel_id,
@@ -1598,6 +1623,8 @@ class SlackChannelConfigurationProps:
             self._values["notification_topics"] = notification_topics
         if role is not None:
             self._values["role"] = role
+        if user_role_required is not None:
+            self._values["user_role_required"] = user_role_required
 
     @builtins.property
     def slack_channel_configuration_name(self) -> builtins.str:
@@ -1706,6 +1733,15 @@ class SlackChannelConfigurationProps:
         result = self._values.get("role")
         return typing.cast(typing.Optional[_IRole_235f5d8e], result)
 
+    @builtins.property
+    def user_role_required(self) -> typing.Optional[builtins.bool]:
+        '''Enables use of a user role requirement in your chat configuration.
+
+        :default: false
+        '''
+        result = self._values.get("user_role_required")
+        return typing.cast(typing.Optional[builtins.bool], result)
+
     def __eq__(self, rhs: typing.Any) -> builtins.bool:
         return isinstance(rhs, self.__class__) and rhs._values == self._values
 
@@ -1970,6 +2006,7 @@ def _typecheckingstub__efdd5da37140f8254b4a44f567a060e15106ce03d4f75880500b5d15d
     log_retention_role: typing.Optional[_IRole_235f5d8e] = None,
     notification_topics: typing.Optional[typing.Sequence[_ITopic_9eca4852]] = None,
     role: typing.Optional[_IRole_235f5d8e] = None,
+    user_role_required: typing.Optional[builtins.bool] = None,
 ) -> None:
     """Type checking stubs"""
     pass
@@ -2042,6 +2079,7 @@ def _typecheckingstub__0ac26e048cc95c25fe58a4f6af5e010a7fb045d511f758ebcd363a166
     log_retention_role: typing.Optional[_IRole_235f5d8e] = None,
     notification_topics: typing.Optional[typing.Sequence[_ITopic_9eca4852]] = None,
     role: typing.Optional[_IRole_235f5d8e] = None,
+    user_role_required: typing.Optional[builtins.bool] = None,
 ) -> None:
     """Type checking stubs"""
     pass