Class: AWSCDK::SupportApp::CfnSlackChannelConfigurationProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
support_app/cfn_slack_channel_configuration_props.rb

Overview

Properties for defining a CfnSlackChannelConfiguration.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(channel_id:, channel_role_arn:, notify_on_case_severity:, team_id:, channel_name: nil, notify_on_add_correspondence_to_case: nil, notify_on_create_or_reopen_case: nil, notify_on_resolve_case: nil) ⇒ CfnSlackChannelConfigurationProps

Returns a new instance of CfnSlackChannelConfigurationProps.

Parameters:

  • channel_id (String) —

    The channel ID in Slack.

  • channel_role_arn (String, AWSCDK::Interfaces::AWSIAM::IRoleRef) —

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

  • notify_on_case_severity (String) —

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

  • team_id (String) —

    The team ID in Slack.

  • channel_name (String, nil) (defaults to: nil) —

    The channel name in Slack.

  • notify_on_add_correspondence_to_case (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

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

  • notify_on_create_or_reopen_case (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

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

  • notify_on_resolve_case (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Whether to get notified when your support cases are resolved.



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'support_app/cfn_slack_channel_configuration_props.rb', line 17

def initialize(channel_id:, channel_role_arn:, notify_on_case_severity:, team_id:, channel_name: nil, notify_on_add_correspondence_to_case: nil, notify_on_create_or_reopen_case: nil, notify_on_resolve_case: nil)
  @channel_id = channel_id
  Jsii::Type.check_type(@channel_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "channelId")
  @channel_role_arn = channel_role_arn
  Jsii::Type.check_type(@channel_role_arn, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19pYW0uSVJvbGVSZWYifV19fQ==")), "channelRoleArn")
  @notify_on_case_severity = notify_on_case_severity
  Jsii::Type.check_type(@notify_on_case_severity, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "notifyOnCaseSeverity")
  @team_id = team_id
  Jsii::Type.check_type(@team_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "teamId")
  @channel_name = channel_name
  Jsii::Type.check_type(@channel_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "channelName") unless @channel_name.nil?
  @notify_on_add_correspondence_to_case = notify_on_add_correspondence_to_case
  Jsii::Type.check_type(@notify_on_add_correspondence_to_case, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "notifyOnAddCorrespondenceToCase") unless @notify_on_add_correspondence_to_case.nil?
  @notify_on_create_or_reopen_case = notify_on_create_or_reopen_case
  Jsii::Type.check_type(@notify_on_create_or_reopen_case, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "notifyOnCreateOrReopenCase") unless @notify_on_create_or_reopen_case.nil?
  @notify_on_resolve_case = notify_on_resolve_case
  Jsii::Type.check_type(@notify_on_resolve_case, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "notifyOnResolveCase") unless @notify_on_resolve_case.nil?
end

Instance Attribute Details

#channel_id ⇒ String (readonly)

The channel ID in Slack.

This ID identifies a channel within a Slack workspace.

Returns:

  • (String)

See Also:



42
43
44
 
# File 'support_app/cfn_slack_channel_configuration_props.rb', line 42

def channel_id
  @channel_id
end

#channel_name ⇒ String? (readonly)

The channel name in Slack.

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

Returns:

  • (String, nil)

See Also:



70
71
72
 
# File 'support_app/cfn_slack_channel_configuration_props.rb', line 70

def channel_name
  @channel_name
end

#channel_role_arn ⇒ String, AWSCDK::Interfaces::AWSIAM::IRoleRef (readonly)

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

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

Returns:

See Also:



49
50
51
 
# File 'support_app/cfn_slack_channel_configuration_props.rb', line 49

def channel_role_arn
  @channel_role_arn
end

#notify_on_add_correspondence_to_case ⇒ Boolean, ... (readonly)

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

Returns:

See Also:



75
76
77
 
# File 'support_app/cfn_slack_channel_configuration_props.rb', line 75

def notify_on_add_correspondence_to_case
  @notify_on_add_correspondence_to_case
end

#notify_on_case_severity ⇒ String (readonly)

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

You can specify none , all , or high .

Returns:

  • (String)

See Also:



56
57
58
 
# File 'support_app/cfn_slack_channel_configuration_props.rb', line 56

def notify_on_case_severity
  @notify_on_case_severity
end

#notify_on_create_or_reopen_case ⇒ Boolean, ... (readonly)

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

Returns:

See Also:



80
81
82
 
# File 'support_app/cfn_slack_channel_configuration_props.rb', line 80

def notify_on_create_or_reopen_case
  @notify_on_create_or_reopen_case
end

#notify_on_resolve_case ⇒ Boolean, ... (readonly)

Whether to get notified when your support cases are resolved.

Returns:

See Also:



85
86
87
 
# File 'support_app/cfn_slack_channel_configuration_props.rb', line 85

def notify_on_resolve_case
  @notify_on_resolve_case
end

#team_id ⇒ String (readonly)

The team ID in Slack.

This ID uniquely identifies a Slack workspace.

Returns:

  • (String)

See Also:



63
64
65
 
# File 'support_app/cfn_slack_channel_configuration_props.rb', line 63

def team_id
  @team_id
end

Class Method Details

.jsii_properties ⇒ Object 



87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'support_app/cfn_slack_channel_configuration_props.rb', line 87

def self.jsii_properties
  {
    :channel_id => "channelId",
    :channel_role_arn => "channelRoleArn",
    :notify_on_case_severity => "notifyOnCaseSeverity",
    :team_id => "teamId",
    :channel_name => "channelName",
    :notify_on_add_correspondence_to_case => "notifyOnAddCorrespondenceToCase",
    :notify_on_create_or_reopen_case => "notifyOnCreateOrReopenCase",
    :notify_on_resolve_case => "notifyOnResolveCase",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'support_app/cfn_slack_channel_configuration_props.rb', line 100

def to_jsii
  result = {}
  result.merge!({
    "channelId" => @channel_id,
    "channelRoleArn" => @channel_role_arn,
    "notifyOnCaseSeverity" => @notify_on_case_severity,
    "teamId" => @team_id,
    "channelName" => @channel_name,
    "notifyOnAddCorrespondenceToCase" => @notify_on_add_correspondence_to_case,
    "notifyOnCreateOrReopenCase" => @notify_on_create_or_reopen_case,
    "notifyOnResolveCase" => @notify_on_resolve_case,
  })
  result.compact
end