Class: AWSCDK::Chatbot::SlackChannelConfiguration

Inherits:
Resource
  • Object
show all
Includes:
ISlackChannelConfiguration
Defined in:
chatbot/slack_channel_configuration.rb

Overview

A new Slack channel configuration.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ SlackChannelConfiguration

Returns a new instance of SlackChannelConfiguration.

Parameters:



12
13
14
15
16
17
18
 
# File 'chatbot/slack_channel_configuration.rb', line 12

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Chatbot::SlackChannelConfigurationProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2hhdGJvdC5TbGFja0NoYW5uZWxDb25maWd1cmF0aW9uUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.from_slack_channel_configuration_arn(scope, id, slack_channel_configuration_arn) ⇒ AWSCDK::Chatbot::ISlackChannelConfiguration

Import an existing Slack channel configuration provided an ARN.

Parameters:

  • scope (Constructs::Construct) —

    The parent creating construct.

  • id (String) —

    The construct's name.

  • slack_channel_configuration_arn (String) —

    configuration ARN (i.e. arn:aws:chatbot::1234567890:chat-configuration/slack-channel/my-slack).

Returns:



51
52
53
54
55
56
 
# File 'chatbot/slack_channel_configuration.rb', line 51

def self.from_slack_channel_configuration_arn(scope, id, slack_channel_configuration_arn)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(slack_channel_configuration_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "slackChannelConfigurationArn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_chatbot.SlackChannelConfiguration", "fromSlackChannelConfigurationArn", [scope, id, slack_channel_configuration_arn])
end

.jsii_overridable_methods ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'chatbot/slack_channel_configuration.rb', line 20

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :grant_principal => { kind: :property, name: "grantPrincipal", is_optional: false },
    :slack_channel_configuration_arn => { kind: :property, name: "slackChannelConfigurationArn", is_optional: false },
    :slack_channel_configuration_name => { kind: :property, name: "slackChannelConfigurationName", is_optional: false },
    :slack_channel_configuration_ref => { kind: :property, name: "slackChannelConfigurationRef", is_optional: false },
    :role => { kind: :property, name: "role", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
    :add_notification_topic => { kind: :method, name: "addNotificationTopic", is_optional: false },
    :add_to_role_policy => { kind: :method, name: "addToRolePolicy", is_optional: false },
    :bind_as_notification_rule_target => { kind: :method, name: "bindAsNotificationRuleTarget", is_optional: false },
    :metric => { kind: :method, name: "metric", is_optional: false },
  }
end

.metric_all(metric_name, props = nil) ⇒ AWSCDK::CloudWatch::Metric

Return the given named metric for All SlackChannelConfigurations.

Parameters:

Returns:



63
64
65
66
67
68
 
# File 'chatbot/slack_channel_configuration.rb', line 63

def self.metric_all(metric_name, props = nil)
  Jsii::Type.check_type(metric_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "metricName")
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_chatbot.SlackChannelConfiguration", "metricAll", [metric_name, props])
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


116
117
118
 
# File 'chatbot/slack_channel_configuration.rb', line 116

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_chatbot.SlackChannelConfiguration", "PROPERTY_INJECTION_ID")
end

Instance Method Details

#add_notification_topic(notification_topic) ⇒ void

This method returns an undefined value.

Adds a SNS topic that deliver notifications to AWS Chatbot.

Parameters:



249
250
251
252
 
# File 'chatbot/slack_channel_configuration.rb', line 249

def add_notification_topic(notification_topic)
  Jsii::Type.check_type(notification_topic, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc25zLklUb3BpYyJ9")), "notificationTopic")
  jsii_call_method("addNotificationTopic", [notification_topic])
end

#add_to_role_policy(statement) ⇒ void

This method returns an undefined value.

Adds extra permission to iam-role of Slack channel configuration.

Parameters:



258
259
260
261
 
# File 'chatbot/slack_channel_configuration.rb', line 258

def add_to_role_policy(statement)
  Jsii::Type.check_type(statement, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLlBvbGljeVN0YXRlbWVudCJ9")), "statement")
  jsii_call_method("addToRolePolicy", [statement])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



188
189
190
191
 
# File 'chatbot/slack_channel_configuration.rb', line 188

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:



205
206
207
208
 
# File 'chatbot/slack_channel_configuration.rb', line 205

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#bind_as_notification_rule_target(_scope) ⇒ AWSCDK::CodeStarNotifications::NotificationRuleTargetConfig

Returns a target configuration for notification rule.

Parameters:

  • _scope (Constructs::Construct)

Returns:



267
268
269
270
 
# File 'chatbot/slack_channel_configuration.rb', line 267

def bind_as_notification_rule_target(_scope)
  Jsii::Type.check_type(_scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "_scope")
  jsii_call_method("bindAsNotificationRuleTarget", [_scope])
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



88
89
90
 
# File 'chatbot/slack_channel_configuration.rb', line 88

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


211
212
213
 
# File 'chatbot/slack_channel_configuration.rb', line 211

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


225
226
227
228
229
230
 
# File 'chatbot/slack_channel_configuration.rb', line 225

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


240
241
242
243
 
# File 'chatbot/slack_channel_configuration.rb', line 240

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#grant_principal ⇒ AWSCDK::IAM::IPrincipal

The principal to grant permissions to.

Returns:



123
124
125
 
# File 'chatbot/slack_channel_configuration.rb', line 123

def grant_principal()
  jsii_get_property("grantPrincipal")
end

#metric(metric_name, props = nil) ⇒ AWSCDK::CloudWatch::Metric

Return the given named metric for this SlackChannelConfiguration.

Parameters:

Returns:



277
278
279
280
281
282
 
# File 'chatbot/slack_channel_configuration.rb', line 277

def metric(metric_name, props = nil)
  Jsii::Type.check_type(metric_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "metricName")
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metric", [metric_name, props])
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


73
74
75
 
# File 'chatbot/slack_channel_configuration.rb', line 73

def node()
  jsii_get_property("node")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


102
103
104
 
# File 'chatbot/slack_channel_configuration.rb', line 102

def physical_name()
  jsii_get_property("physicalName")
end

#role ⇒ AWSCDK::IAM::IRole?

The permission role of Slack channel configuration.

Returns:



151
152
153
 
# File 'chatbot/slack_channel_configuration.rb', line 151

def role()
  jsii_get_property("role")
end

#slack_channel_configuration_arn ⇒ String

The ARN of the Slack channel configuration In the form of arn:aws:chatbot:region:account:chat-configuration/slack-channel/slackChannelName.

Returns:

  • (String) 


130
131
132
 
# File 'chatbot/slack_channel_configuration.rb', line 130

def slack_channel_configuration_arn()
  jsii_get_property("slackChannelConfigurationArn")
end

#slack_channel_configuration_name ⇒ String

The name of Slack channel configuration.

Returns:

  • (String) 


137
138
139
 
# File 'chatbot/slack_channel_configuration.rb', line 137

def slack_channel_configuration_name()
  jsii_get_property("slackChannelConfigurationName")
end

#slack_channel_configuration_ref ⇒ AWSCDK::Interfaces::AWSChatbot::SlackChannelConfigurationReference

A reference to a SlackChannelConfiguration resource.

Returns:



144
145
146
 
# File 'chatbot/slack_channel_configuration.rb', line 144

def slack_channel_configuration_ref()
  jsii_get_property("slackChannelConfigurationRef")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



109
110
111
 
# File 'chatbot/slack_channel_configuration.rb', line 109

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


158
159
160
 
# File 'chatbot/slack_channel_configuration.rb', line 158

def to_string()
  jsii_call_method("toString", [])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


171
172
173
174
175
176
 
# File 'chatbot/slack_channel_configuration.rb', line 171

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end