io.cloudshiftdev.awscdk.services.chatbot.CfnSlackChannelConfiguration.kt Maven / Gradle / Ivy
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package io.cloudshiftdev.awscdk.services.chatbot
import io.cloudshiftdev.awscdk.CfnResource
import io.cloudshiftdev.awscdk.CfnTag
import io.cloudshiftdev.awscdk.IInspectable
import io.cloudshiftdev.awscdk.IResolvable
import io.cloudshiftdev.awscdk.ITaggableV2
import io.cloudshiftdev.awscdk.TagManager
import io.cloudshiftdev.awscdk.TreeInspector
import io.cloudshiftdev.awscdk.common.CdkDslMarker
import kotlin.Any
import kotlin.Boolean
import kotlin.String
import kotlin.Unit
import kotlin.collections.List
import io.cloudshiftdev.constructs.Construct as CloudshiftdevConstructsConstruct
import software.constructs.Construct as SoftwareConstructsConstruct
/**
* 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](https://docs.aws.amazon.com/chatbot/latest/adminguide/slack-setup.html#slack-client-setup)
* 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 io.cloudshiftdev.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();
* ```
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html)
*/
public open class CfnSlackChannelConfiguration(
cdkObject: software.amazon.awscdk.services.chatbot.CfnSlackChannelConfiguration,
) : CfnResource(cdkObject),
IInspectable,
ITaggableV2 {
public constructor(
scope: CloudshiftdevConstructsConstruct,
id: String,
props: CfnSlackChannelConfigurationProps,
) :
this(software.amazon.awscdk.services.chatbot.CfnSlackChannelConfiguration(scope.let(CloudshiftdevConstructsConstruct.Companion::unwrap),
id, props.let(CfnSlackChannelConfigurationProps.Companion::unwrap))
)
public constructor(
scope: CloudshiftdevConstructsConstruct,
id: String,
props: CfnSlackChannelConfigurationProps.Builder.() -> Unit,
) : this(scope, id, CfnSlackChannelConfigurationProps(props)
)
/**
* Amazon Resource Name (ARN) of the configuration.
*/
public open fun attrArn(): String = unwrap(this).getAttrArn()
/**
* Tag Manager which manages the tags for this resource.
*/
public override fun cdkTagManager(): TagManager =
unwrap(this).getCdkTagManager().let(TagManager::wrap)
/**
* The name of the configuration.
*/
public open fun configurationName(): String = unwrap(this).getConfigurationName()
/**
* The name of the configuration.
*/
public open fun configurationName(`value`: String) {
unwrap(this).setConfigurationName(`value`)
}
/**
* The list of IAM policy ARNs that are applied as channel guardrails.
*/
public open fun guardrailPolicies(): List = unwrap(this).getGuardrailPolicies() ?:
emptyList()
/**
* The list of IAM policy ARNs that are applied as channel guardrails.
*/
public open fun guardrailPolicies(`value`: List) {
unwrap(this).setGuardrailPolicies(`value`)
}
/**
* The list of IAM policy ARNs that are applied as channel guardrails.
*/
public open fun guardrailPolicies(vararg `value`: String): Unit =
guardrailPolicies(`value`.toList())
/**
* The ARN of the IAM role that defines the permissions for AWS Chatbot .
*/
public open fun iamRoleArn(): String = unwrap(this).getIamRoleArn()
/**
* The ARN of the IAM role that defines the permissions for AWS Chatbot .
*/
public open fun iamRoleArn(`value`: String) {
unwrap(this).setIamRoleArn(`value`)
}
/**
* Examines the CloudFormation resource and discloses attributes.
*
* @param inspector tree inspector to collect and process attributes.
*/
public override fun inspect(inspector: TreeInspector) {
unwrap(this).inspect(inspector.let(TreeInspector.Companion::unwrap))
}
/**
* Specifies the logging level for this configuration.
*
* This property affects the log entries pushed to Amazon CloudWatch Logs.
*/
public open fun loggingLevel(): String? = unwrap(this).getLoggingLevel()
/**
* Specifies the logging level for this configuration.
*
* This property affects the log entries pushed to Amazon CloudWatch Logs.
*/
public open fun loggingLevel(`value`: String) {
unwrap(this).setLoggingLevel(`value`)
}
/**
* The ID of the Slack channel.
*/
public open fun slackChannelId(): String = unwrap(this).getSlackChannelId()
/**
* The ID of the Slack channel.
*/
public open fun slackChannelId(`value`: String) {
unwrap(this).setSlackChannelId(`value`)
}
/**
* The ID of the Slack workspace authorized with AWS Chatbot .
*/
public open fun slackWorkspaceId(): String = unwrap(this).getSlackWorkspaceId()
/**
* The ID of the Slack workspace authorized with AWS Chatbot .
*/
public open fun slackWorkspaceId(`value`: String) {
unwrap(this).setSlackWorkspaceId(`value`)
}
/**
* The ARNs of the SNS topics that deliver notifications to AWS Chatbot .
*/
public open fun snsTopicArns(): List = unwrap(this).getSnsTopicArns() ?: emptyList()
/**
* The ARNs of the SNS topics that deliver notifications to AWS Chatbot .
*/
public open fun snsTopicArns(`value`: List) {
unwrap(this).setSnsTopicArns(`value`)
}
/**
* The ARNs of the SNS topics that deliver notifications to AWS Chatbot .
*/
public open fun snsTopicArns(vararg `value`: String): Unit = snsTopicArns(`value`.toList())
/**
* The tags to add to the configuration.
*/
public open fun tags(): List = unwrap(this).getTags()?.map(CfnTag::wrap) ?: emptyList()
/**
* The tags to add to the configuration.
*/
public open fun tags(`value`: List) {
unwrap(this).setTags(`value`.map(CfnTag.Companion::unwrap))
}
/**
* The tags to add to the configuration.
*/
public open fun tags(vararg `value`: CfnTag): Unit = tags(`value`.toList())
/**
* Enables use of a user role requirement in your chat configuration.
*/
public open fun userRoleRequired(): Any? = unwrap(this).getUserRoleRequired()
/**
* Enables use of a user role requirement in your chat configuration.
*/
public open fun userRoleRequired(`value`: Boolean) {
unwrap(this).setUserRoleRequired(`value`)
}
/**
* Enables use of a user role requirement in your chat configuration.
*/
public open fun userRoleRequired(`value`: IResolvable) {
unwrap(this).setUserRoleRequired(`value`.let(IResolvable.Companion::unwrap))
}
/**
* A fluent builder for [io.cloudshiftdev.awscdk.services.chatbot.CfnSlackChannelConfiguration].
*/
@CdkDslMarker
public interface Builder {
/**
* The name of the configuration.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-configurationname)
* @param configurationName The name of the configuration.
*/
public fun configurationName(configurationName: String)
/**
* 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.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-guardrailpolicies)
* @param guardrailPolicies The list of IAM policy ARNs that are applied as channel guardrails.
*/
public fun guardrailPolicies(guardrailPolicies: List)
/**
* 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.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-guardrailpolicies)
* @param guardrailPolicies The list of IAM policy ARNs that are applied as channel guardrails.
*/
public fun guardrailPolicies(vararg guardrailPolicies: String)
/**
* 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](https://docs.aws.amazon.com/chatbot/latest/adminguide/chatbot-iam-policies.html) .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-iamrolearn)
* @param iamRoleArn The ARN of the IAM role that defines the permissions for AWS Chatbot .
*/
public fun iamRoleArn(iamRoleArn: String)
/**
* 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"
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-logginglevel)
* @param loggingLevel Specifies the logging level for this configuration. This property affects
* the log entries pushed to Amazon CloudWatch Logs.
*/
public fun loggingLevel(loggingLevel: String)
/**
* 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` .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-slackchannelid)
* @param slackChannelId The ID of the Slack channel.
*/
public fun slackChannelId(slackChannelId: String)
/**
* 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](https://docs.aws.amazon.com/chatbot/latest/adminguide/slack-setup.html) in the *AWS
* Chatbot User Guide* .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-slackworkspaceid)
* @param slackWorkspaceId The ID of the Slack workspace authorized with AWS Chatbot .
*/
public fun slackWorkspaceId(slackWorkspaceId: String)
/**
* The ARNs of the SNS topics that deliver notifications to AWS Chatbot .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-snstopicarns)
* @param snsTopicArns The ARNs of the SNS topics that deliver notifications to AWS Chatbot .
*/
public fun snsTopicArns(snsTopicArns: List)
/**
* The ARNs of the SNS topics that deliver notifications to AWS Chatbot .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-snstopicarns)
* @param snsTopicArns The ARNs of the SNS topics that deliver notifications to AWS Chatbot .
*/
public fun snsTopicArns(vararg snsTopicArns: String)
/**
* The tags to add to the configuration.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-tags)
* @param tags The tags to add to the configuration.
*/
public fun tags(tags: List)
/**
* The tags to add to the configuration.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-tags)
* @param tags The tags to add to the configuration.
*/
public fun tags(vararg tags: CfnTag)
/**
* Enables use of a user role requirement in your chat configuration.
*
* Default: - false
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-userrolerequired)
* @param userRoleRequired Enables use of a user role requirement in your chat configuration.
*/
public fun userRoleRequired(userRoleRequired: Boolean)
/**
* Enables use of a user role requirement in your chat configuration.
*
* Default: - false
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-userrolerequired)
* @param userRoleRequired Enables use of a user role requirement in your chat configuration.
*/
public fun userRoleRequired(userRoleRequired: IResolvable)
}
private class BuilderImpl(
scope: SoftwareConstructsConstruct,
id: String,
) : Builder {
private val cdkBuilder:
software.amazon.awscdk.services.chatbot.CfnSlackChannelConfiguration.Builder =
software.amazon.awscdk.services.chatbot.CfnSlackChannelConfiguration.Builder.create(scope,
id)
/**
* The name of the configuration.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-configurationname)
* @param configurationName The name of the configuration.
*/
override fun configurationName(configurationName: String) {
cdkBuilder.configurationName(configurationName)
}
/**
* 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.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-guardrailpolicies)
* @param guardrailPolicies The list of IAM policy ARNs that are applied as channel guardrails.
*/
override fun guardrailPolicies(guardrailPolicies: List) {
cdkBuilder.guardrailPolicies(guardrailPolicies)
}
/**
* 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.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-guardrailpolicies)
* @param guardrailPolicies The list of IAM policy ARNs that are applied as channel guardrails.
*/
override fun guardrailPolicies(vararg guardrailPolicies: String): Unit =
guardrailPolicies(guardrailPolicies.toList())
/**
* 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](https://docs.aws.amazon.com/chatbot/latest/adminguide/chatbot-iam-policies.html) .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-iamrolearn)
* @param iamRoleArn The ARN of the IAM role that defines the permissions for AWS Chatbot .
*/
override fun iamRoleArn(iamRoleArn: String) {
cdkBuilder.iamRoleArn(iamRoleArn)
}
/**
* 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"
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-logginglevel)
* @param loggingLevel Specifies the logging level for this configuration. This property affects
* the log entries pushed to Amazon CloudWatch Logs.
*/
override fun loggingLevel(loggingLevel: String) {
cdkBuilder.loggingLevel(loggingLevel)
}
/**
* 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` .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-slackchannelid)
* @param slackChannelId The ID of the Slack channel.
*/
override fun slackChannelId(slackChannelId: String) {
cdkBuilder.slackChannelId(slackChannelId)
}
/**
* 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](https://docs.aws.amazon.com/chatbot/latest/adminguide/slack-setup.html) in the *AWS
* Chatbot User Guide* .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-slackworkspaceid)
* @param slackWorkspaceId The ID of the Slack workspace authorized with AWS Chatbot .
*/
override fun slackWorkspaceId(slackWorkspaceId: String) {
cdkBuilder.slackWorkspaceId(slackWorkspaceId)
}
/**
* The ARNs of the SNS topics that deliver notifications to AWS Chatbot .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-snstopicarns)
* @param snsTopicArns The ARNs of the SNS topics that deliver notifications to AWS Chatbot .
*/
override fun snsTopicArns(snsTopicArns: List) {
cdkBuilder.snsTopicArns(snsTopicArns)
}
/**
* The ARNs of the SNS topics that deliver notifications to AWS Chatbot .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-snstopicarns)
* @param snsTopicArns The ARNs of the SNS topics that deliver notifications to AWS Chatbot .
*/
override fun snsTopicArns(vararg snsTopicArns: String): Unit =
snsTopicArns(snsTopicArns.toList())
/**
* The tags to add to the configuration.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-tags)
* @param tags The tags to add to the configuration.
*/
override fun tags(tags: List) {
cdkBuilder.tags(tags.map(CfnTag.Companion::unwrap))
}
/**
* The tags to add to the configuration.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-tags)
* @param tags The tags to add to the configuration.
*/
override fun tags(vararg tags: CfnTag): Unit = tags(tags.toList())
/**
* Enables use of a user role requirement in your chat configuration.
*
* Default: - false
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-userrolerequired)
* @param userRoleRequired Enables use of a user role requirement in your chat configuration.
*/
override fun userRoleRequired(userRoleRequired: Boolean) {
cdkBuilder.userRoleRequired(userRoleRequired)
}
/**
* Enables use of a user role requirement in your chat configuration.
*
* Default: - false
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-userrolerequired)
* @param userRoleRequired Enables use of a user role requirement in your chat configuration.
*/
override fun userRoleRequired(userRoleRequired: IResolvable) {
cdkBuilder.userRoleRequired(userRoleRequired.let(IResolvable.Companion::unwrap))
}
public fun build(): software.amazon.awscdk.services.chatbot.CfnSlackChannelConfiguration =
cdkBuilder.build()
}
public companion object {
public val CFN_RESOURCE_TYPE_NAME: String =
software.amazon.awscdk.services.chatbot.CfnSlackChannelConfiguration.CFN_RESOURCE_TYPE_NAME
public operator fun invoke(
scope: CloudshiftdevConstructsConstruct,
id: String,
block: Builder.() -> Unit = {},
): CfnSlackChannelConfiguration {
val builderImpl = BuilderImpl(CloudshiftdevConstructsConstruct.unwrap(scope), id)
return CfnSlackChannelConfiguration(builderImpl.apply(block).build())
}
internal
fun wrap(cdkObject: software.amazon.awscdk.services.chatbot.CfnSlackChannelConfiguration):
CfnSlackChannelConfiguration = CfnSlackChannelConfiguration(cdkObject)
internal fun unwrap(wrapped: CfnSlackChannelConfiguration):
software.amazon.awscdk.services.chatbot.CfnSlackChannelConfiguration = wrapped.cdkObject as
software.amazon.awscdk.services.chatbot.CfnSlackChannelConfiguration
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy