software.amazon.awscdk.services.supportapp

Class CfnSlackChannelConfiguration

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.supportapp.CfnSlackChannelConfiguration

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:40.218Z")
public class CfnSlackChannelConfiguration
extends CfnResource
implements IInspectable

A CloudFormation `AWS::SupportApp::SlackChannelConfiguration`.

You can use the AWS::SupportApp::SlackChannelConfiguration resource to specify your AWS account when you configure the AWS Support App . This resource includes the following information:

• The Slack channel name and ID
• The team ID in Slack
• The Amazon Resource Name (ARN) of the AWS Identity and Access Management ( IAM ) role
• Whether you want the AWS Support App to notify you when your support cases are created, updated, resolved, or reopened
• The case severity that you want to get notified for

For more information, see the following topics in the AWS Support User Guide :

• AWS Support App in Slack
• Creating AWS Support App in Slack resources with AWS CloudFormation

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.supportapp.*;
 CfnSlackChannelConfiguration cfnSlackChannelConfiguration = CfnSlackChannelConfiguration.Builder.create(this, "MyCfnSlackChannelConfiguration")
         .channelId("channelId")
         .channelRoleArn("channelRoleArn")
         .notifyOnCaseSeverity("notifyOnCaseSeverity")
         .teamId("teamId")
         // the properties below are optional
         .channelName("channelName")
         .notifyOnAddCorrespondenceToCase(false)
         .notifyOnCreateOrReopenCase(false)
         .notifyOnResolveCase(false)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnSlackChannelConfiguration.Builder A fluent builder for CfnSlackChannelConfiguration.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnSlackChannelConfiguration(Construct scope, java.lang.String id, CfnSlackChannelConfigurationProps props) Create a new `AWS::SupportApp::SlackChannelConfiguration`.
protected	CfnSlackChannelConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSlackChannelConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getChannelId() The channel ID in Slack.
java.lang.String	getChannelName() The channel name in Slack.
java.lang.String	getChannelRoleArn() The Amazon Resource Name (ARN) of the IAM role for this Slack channel configuration.
java.lang.Object	getNotifyOnAddCorrespondenceToCase() Whether to get notified when a correspondence is added to your support cases.
java.lang.String	getNotifyOnCaseSeverity() The case severity for your support cases that you want to receive notifications.
java.lang.Object	getNotifyOnCreateOrReopenCase() Whether to get notified when your support cases are created or reopened.
java.lang.Object	getNotifyOnResolveCase() Whether to get notified when your support cases are resolved.
java.lang.String	getTeamId() The team ID in Slack.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setChannelId(java.lang.String value) The channel ID in Slack.
void	setChannelName(java.lang.String value) The channel name in Slack.
void	setChannelRoleArn(java.lang.String value) The Amazon Resource Name (ARN) of the IAM role for this Slack channel configuration.
void	setNotifyOnAddCorrespondenceToCase(java.lang.Boolean value) Whether to get notified when a correspondence is added to your support cases.
void	setNotifyOnAddCorrespondenceToCase(IResolvable value) Whether to get notified when a correspondence is added to your support cases.
void	setNotifyOnCaseSeverity(java.lang.String value) The case severity for your support cases that you want to receive notifications.
void	setNotifyOnCreateOrReopenCase(java.lang.Boolean value) Whether to get notified when your support cases are created or reopened.
void	setNotifyOnCreateOrReopenCase(IResolvable value) Whether to get notified when your support cases are created or reopened.
void	setNotifyOnResolveCase(java.lang.Boolean value) Whether to get notified when your support cases are resolved.
void	setNotifyOnResolveCase(IResolvable value) Whether to get notified when your support cases are resolved.
void	setTeamId(java.lang.String value) The team ID in Slack.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnSlackChannelConfiguration

protected CfnSlackChannelConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

CfnSlackChannelConfiguration

protected CfnSlackChannelConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnSlackChannelConfiguration

public CfnSlackChannelConfiguration(Construct scope,
                                    java.lang.String id,
                                    CfnSlackChannelConfigurationProps props)

Create a new `AWS::SupportApp::SlackChannelConfiguration`.

Parameters:

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.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getChannelId

public java.lang.String getChannelId()

The channel ID in Slack.

This ID identifies a channel within a Slack workspace.

setChannelId

public void setChannelId(java.lang.String value)

The channel ID in Slack.

This ID identifies a channel within a Slack workspace.

getChannelRoleArn

public java.lang.String getChannelRoleArn()

The Amazon Resource Name (ARN) of the IAM role for this Slack channel configuration.

The AWS Support App uses this role to perform AWS Support and Service Quotas actions on your behalf.

setChannelRoleArn

public void setChannelRoleArn(java.lang.String value)

The Amazon Resource Name (ARN) of the IAM role for this Slack channel configuration.

The AWS Support App uses this role to perform AWS Support and Service Quotas actions on your behalf.

getNotifyOnCaseSeverity

public java.lang.String getNotifyOnCaseSeverity()

The case severity for your support cases that you want to receive notifications.

You can specify none , all , or high .

setNotifyOnCaseSeverity

public void setNotifyOnCaseSeverity(java.lang.String value)

The case severity for your support cases that you want to receive notifications.

You can specify none , all , or high .

getTeamId

public java.lang.String getTeamId()

The team ID in Slack.

This ID uniquely identifies a Slack workspace.

setTeamId

public void setTeamId(java.lang.String value)

The team ID in Slack.

This ID uniquely identifies a Slack workspace.

getChannelName

public java.lang.String getChannelName()

The channel name in Slack.

This is the channel where you invite the AWS Support App .

setChannelName

public void setChannelName(java.lang.String value)

The channel name in Slack.

This is the channel where you invite the AWS Support App .

getNotifyOnAddCorrespondenceToCase

public java.lang.Object getNotifyOnAddCorrespondenceToCase()

Whether to get notified when a correspondence is added to your support cases.

setNotifyOnAddCorrespondenceToCase

public void setNotifyOnAddCorrespondenceToCase(java.lang.Boolean value)

Whether to get notified when a correspondence is added to your support cases.

setNotifyOnAddCorrespondenceToCase

public void setNotifyOnAddCorrespondenceToCase(IResolvable value)

Whether to get notified when a correspondence is added to your support cases.

getNotifyOnCreateOrReopenCase

public java.lang.Object getNotifyOnCreateOrReopenCase()

Whether to get notified when your support cases are created or reopened.

setNotifyOnCreateOrReopenCase

public void setNotifyOnCreateOrReopenCase(java.lang.Boolean value)

Whether to get notified when your support cases are created or reopened.

setNotifyOnCreateOrReopenCase

public void setNotifyOnCreateOrReopenCase(IResolvable value)

Whether to get notified when your support cases are created or reopened.

getNotifyOnResolveCase

public java.lang.Object getNotifyOnResolveCase()

Whether to get notified when your support cases are resolved.

setNotifyOnResolveCase

public void setNotifyOnResolveCase(java.lang.Boolean value)

Whether to get notified when your support cases are resolved.

setNotifyOnResolveCase

public void setNotifyOnResolveCase(IResolvable value)

Whether to get notified when your support cases are resolved.