@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-05-19T23:09:25.223Z") @Stability(value=Stable) public class CfnSlackChannelConfiguration extends CfnResource implements IInspectable
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 steps 1-4 in Setting Up AWS Chatbot with Slack 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")) .userRoleRequired(false) .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnSlackChannelConfiguration.Builder
A fluent builder for
CfnSlackChannelConfiguration . |
software.amazon.jsii.JsiiObject.InitializationMode
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnSlackChannelConfiguration(Construct scope,
String id,
CfnSlackChannelConfigurationProps props)
Create a new `AWS::Chatbot::SlackChannelConfiguration`.
|
protected |
CfnSlackChannelConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnSlackChannelConfiguration(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
String |
getAttrArn() |
protected Map<String,Object> |
getCfnProperties() |
String |
getConfigurationName()
The name of the configuration.
|
List<String> |
getGuardrailPolicies()
The list of IAM policy ARNs that are applied as channel guardrails.
|
String |
getIamRoleArn()
The ARN of the IAM role that defines the permissions for AWS Chatbot .
|
String |
getLoggingLevel()
Specifies the logging level for this configuration.
|
String |
getSlackChannelId()
The ID of the Slack channel.
|
String |
getSlackWorkspaceId()
The ID of the Slack workspace authorized with AWS Chatbot .
|
List<String> |
getSnsTopicArns()
The ARNs of the SNS topics that deliver notifications to AWS Chatbot .
|
Object |
getUserRoleRequired()
Enables use of a user role requirement in your chat configuration.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected Map<String,Object> |
renderProperties(Map<String,Object> props) |
void |
setConfigurationName(String value)
The name of the configuration.
|
void |
setGuardrailPolicies(List<String> value)
The list of IAM policy ARNs that are applied as channel guardrails.
|
void |
setIamRoleArn(String value)
The ARN of the IAM role that defines the permissions for AWS Chatbot .
|
void |
setLoggingLevel(String value)
Specifies the logging level for this configuration.
|
void |
setSlackChannelId(String value)
The ID of the Slack channel.
|
void |
setSlackWorkspaceId(String value)
The ID of the Slack workspace authorized with AWS Chatbot .
|
void |
setSnsTopicArns(List<String> value)
The ARNs of the SNS topics that deliver notifications to AWS Chatbot .
|
void |
setUserRoleRequired(Boolean value)
Enables use of a user role requirement in your chat configuration.
|
void |
setUserRoleRequired(IResolvable value)
Enables use of a user role requirement in your chat configuration.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
@Stability(value=Stable) public static final String CFN_RESOURCE_TYPE_NAME
protected CfnSlackChannelConfiguration(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnSlackChannelConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
@Stability(value=Stable) public CfnSlackChannelConfiguration(@NotNull Construct scope, @NotNull String id, @NotNull CfnSlackChannelConfigurationProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.@Stability(value=Stable) public void inspect(@NotNull TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.@Stability(value=Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.@Stability(value=Stable) @NotNull public String getAttrArn()
@Stability(value=Stable) @NotNull protected Map<String,Object> getCfnProperties()
getCfnProperties
in class CfnResource
@Stability(value=Stable) @NotNull public String getConfigurationName()
@Stability(value=Stable) public void setConfigurationName(@NotNull String value)
@Stability(value=Stable) @NotNull public String getIamRoleArn()
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 .
@Stability(value=Stable) public void setIamRoleArn(@NotNull String value)
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 .
@Stability(value=Stable) @NotNull public String getSlackChannelId()
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 9-character string at the end of the URL. For example, ABCBBLZZZ
.
@Stability(value=Stable) public void setSlackChannelId(@NotNull String value)
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 9-character string at the end of the URL. For example, ABCBBLZZZ
.
@Stability(value=Stable) @NotNull public String getSlackWorkspaceId()
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-4 in Setting Up AWS Chatbot with Slack in the AWS Chatbot User Guide .
@Stability(value=Stable) public void setSlackWorkspaceId(@NotNull String value)
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-4 in Setting Up AWS Chatbot with Slack in the AWS Chatbot User Guide .
@Stability(value=Stable) @Nullable public List<String> getGuardrailPolicies()
The AWS managed 'AdministratorAccess' policy is applied as a default if this is not set.
@Stability(value=Stable) public void setGuardrailPolicies(@Nullable List<String> value)
The AWS managed 'AdministratorAccess' policy is applied as a default if this is not set.
@Stability(value=Stable) @Nullable public String getLoggingLevel()
Logging levels include ERROR
, INFO
, or NONE
.
@Stability(value=Stable) public void setLoggingLevel(@Nullable String value)
Logging levels include ERROR
, INFO
, or NONE
.
@Stability(value=Stable) @Nullable public List<String> getSnsTopicArns()
@Stability(value=Stable) public void setSnsTopicArns(@Nullable List<String> value)
@Stability(value=Stable) @Nullable public Object getUserRoleRequired()
@Stability(value=Stable) public void setUserRoleRequired(@Nullable Boolean value)
@Stability(value=Stable) public void setUserRoleRequired(@Nullable IResolvable value)
Copyright © 2023. All rights reserved.