Class: AWSCDK::Chatbot::CfnMicrosoftTeamsChannelConfiguration

Inherits:
AWSCDK::CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSChatbot::IMicrosoftTeamsChannelConfigurationRef
Defined in:
chatbot/cfn_microsoft_teams_channel_configuration.rb

Overview

AWS Chatbot is now . Learn more > > Type attribute values remain unchanged.

The AWS::Chatbot::MicrosoftTeamsChannelConfiguration resource configures a Microsoft Teams channel to allow users to use with CloudFormation templates.

This resource requires some setup to be done in the in chat applications console. To provide the required Microsoft Teams team and tenant IDs, you must perform the initial authorization flow with Microsoft Teams in the in chat applications console, then copy and paste the IDs from the console. For more details, see steps 1-3 in Get started with Microsoft Teams in the in chat applications Administrator Guide .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnMicrosoftTeamsChannelConfiguration

Create a new AWS::Chatbot::MicrosoftTeamsChannelConfiguration.

Parameters:



22
23
24
25
26
27
28
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 22

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Chatbot::CfnMicrosoftTeamsChannelConfigurationProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2hhdGJvdC5DZm5NaWNyb3NvZnRUZWFtc0NoYW5uZWxDb25maWd1cmF0aW9uUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_microsoft_teams_channel_configuration(resource) ⇒ String

Parameters:

Returns:

  • (String) 


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

def self.arn_for_microsoft_teams_channel_configuration(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19jaGF0Ym90LklNaWNyb3NvZnRUZWFtc0NoYW5uZWxDb25maWd1cmF0aW9uUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_chatbot.CfnMicrosoftTeamsChannelConfiguration", "arnForMicrosoftTeamsChannelConfiguration", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


194
195
196
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 194

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

.is_cfn_microsoft_teams_channel_configuration(x) ⇒ Boolean

Checks whether the given object is a CfnMicrosoftTeamsChannelConfiguration.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


96
97
98
99
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 96

def self.is_cfn_microsoft_teams_channel_configuration(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_chatbot.CfnMicrosoftTeamsChannelConfiguration", "isCfnMicrosoftTeamsChannelConfiguration", [x])
end

.jsii_overridable_methods ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 30

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :microsoft_teams_channel_configuration_ref => { kind: :property, name: "microsoftTeamsChannelConfigurationRef", is_optional: false },
    :configuration_name => { kind: :property, name: "configurationName", is_optional: false },
    :iam_role_arn => { kind: :property, name: "iamRoleArn", is_optional: false },
    :team_id => { kind: :property, name: "teamId", is_optional: false },
    :teams_channel_id => { kind: :property, name: "teamsChannelId", is_optional: false },
    :teams_tenant_id => { kind: :property, name: "teamsTenantId", is_optional: false },
    :customization_resource_arns => { kind: :property, name: "customizationResourceArns", is_optional: true },
    :guardrail_policies => { kind: :property, name: "guardrailPolicies", is_optional: true },
    :logging_level => { kind: :property, name: "loggingLevel", is_optional: true },
    :sns_topic_arns => { kind: :property, name: "snsTopicArns", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :teams_channel_name => { kind: :property, name: "teamsChannelName", is_optional: true },
    :user_role_required => { kind: :property, name: "userRoleRequired", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", 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 },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



402
403
404
405
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 402

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



414
415
416
417
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 414

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



424
425
426
427
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 424

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



435
436
437
438
439
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 435

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


492
493
494
495
496
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 492

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



502
503
504
505
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 502

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



514
515
516
517
518
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 514

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



527
528
529
530
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 527

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 = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



549
550
551
552
553
554
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 549

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_arn ⇒ String

The ARN of the resource.

Returns:

  • (String) 


201
202
203
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 201

def attr_arn()
  jsii_get_property("attrArn")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



208
209
210
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 208

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



147
148
149
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 147

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


152
153
154
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 152

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


558
559
560
561
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 558

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


157
158
159
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 157

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


164
165
166
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 164

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#configuration_name ⇒ String

The name of the configuration.

Returns:

  • (String) 


222
223
224
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 222

def configuration_name()
  jsii_get_property("configurationName")
end

#configuration_name=(value) ⇒ Object 



226
227
228
229
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 226

def configuration_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "configurationName")
  jsii_set_property("configurationName", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


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

def creation_stack()
  jsii_get_property("creationStack")
end

#customization_resource_arns ⇒ Array<String>?

Links a list of resource ARNs (for example, custom action ARNs) to a Microsoft Teams channel configuration for .

Returns:

  • (Array<String>, nil) 


282
283
284
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 282

def customization_resource_arns()
  jsii_get_property("customizationResourceArns")
end

#customization_resource_arns=(value) ⇒ Object 



286
287
288
289
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 286

def customization_resource_arns=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "customizationResourceArns") unless value.nil?
  jsii_set_property("customizationResourceArns", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



169
170
171
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 169

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



571
572
573
574
575
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 571

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



582
583
584
585
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 582

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#guardrail_policies ⇒ Array<String>?

The list of IAM policy ARNs that are applied as channel guardrails.

Returns:

  • (Array<String>, nil) 


294
295
296
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 294

def guardrail_policies()
  jsii_get_property("guardrailPolicies")
end

#guardrail_policies=(value) ⇒ Object 



298
299
300
301
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 298

def guardrail_policies=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "guardrailPolicies") unless value.nil?
  jsii_set_property("guardrailPolicies", value)
end

#iam_role_arn ⇒ String

The ARN of the IAM role that defines the permissions for .

Returns:

  • (String) 


234
235
236
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 234

def iam_role_arn()
  jsii_get_property("iamRoleArn")
end

#iam_role_arn=(value) ⇒ Object 



238
239
240
241
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 238

def iam_role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "iamRoleArn")
  jsii_set_property("iamRoleArn", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



652
653
654
655
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 652

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#logging_level ⇒ String?

Specifies the logging level for this configuration.

This property affects the log entries pushed to Amazon CloudWatch Logs.

Returns:

  • (String, nil) 


308
309
310
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 308

def logging_level()
  jsii_get_property("loggingLevel")
end

#logging_level=(value) ⇒ Object 



312
313
314
315
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 312

def logging_level=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "loggingLevel") unless value.nil?
  jsii_set_property("loggingLevel", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


121
122
123
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 121

def logical_id()
  jsii_get_property("logicalId")
end

#microsoft_teams_channel_configuration_ref ⇒ AWSCDK::Interfaces::AWSChatbot::MicrosoftTeamsChannelConfigurationReference

A reference to a MicrosoftTeamsChannelConfiguration resource.

Returns:



215
216
217
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 215

def microsoft_teams_channel_configuration_ref()
  jsii_get_property("microsoftTeamsChannelConfigurationRef")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


104
105
106
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 104

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



593
594
595
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 593

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



600
601
602
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 600

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



393
394
395
396
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 393

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


140
141
142
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 140

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



611
612
613
614
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 611

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


618
619
620
621
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 618

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



628
629
630
631
632
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 628

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



637
638
639
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 637

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#sns_topic_arns ⇒ Array<String>?

The ARNs of the SNS topics that deliver notifications to .

Returns:

  • (Array<String>, nil) 


320
321
322
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 320

def sns_topic_arns()
  jsii_get_property("snsTopicArns")
end

#sns_topic_arns=(value) ⇒ Object 



324
325
326
327
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 324

def sns_topic_arns=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "snsTopicArns") unless value.nil?
  jsii_set_property("snsTopicArns", value)
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



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

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

The tags to add to the configuration.

Returns:



332
333
334
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 332

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



336
337
338
339
340
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 336

def tags=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#team_id ⇒ String

The ID of the Microsoft Team authorized with .

Returns:

  • (String) 


246
247
248
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 246

def team_id()
  jsii_get_property("teamId")
end

#team_id=(value) ⇒ Object 



250
251
252
253
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 250

def team_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "teamId")
  jsii_set_property("teamId", value)
end

#teams_channel_id ⇒ String

The ID of the Microsoft Teams channel.

Returns:

  • (String) 


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

def teams_channel_id()
  jsii_get_property("teamsChannelId")
end

#teams_channel_id=(value) ⇒ Object 



262
263
264
265
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 262

def teams_channel_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "teamsChannelId")
  jsii_set_property("teamsChannelId", value)
end

#teams_channel_name ⇒ String?

The name of the Microsoft Teams channel.

Returns:

  • (String, nil) 


345
346
347
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 345

def teams_channel_name()
  jsii_get_property("teamsChannelName")
end

#teams_channel_name=(value) ⇒ Object 



349
350
351
352
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 349

def teams_channel_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "teamsChannelName") unless value.nil?
  jsii_set_property("teamsChannelName", value)
end

#teams_tenant_id ⇒ String

The ID of the Microsoft Teams tenant.

Returns:

  • (String) 


270
271
272
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 270

def teams_tenant_id()
  jsii_get_property("teamsTenantId")
end

#teams_tenant_id=(value) ⇒ Object 



274
275
276
277
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 274

def teams_tenant_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "teamsTenantId")
  jsii_set_property("teamsTenantId", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



369
370
371
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 369

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

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


177
178
179
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 177

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


187
188
189
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 187

def updated_properties()
  jsii_get_property("updatedProperties")
end

#user_role_required ⇒ Boolean, ...

Enables use of a user role requirement in your chat configuration.

Returns:



357
358
359
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 357

def user_role_required()
  jsii_get_property("userRoleRequired")
end

#user_role_required=(value) ⇒ Object 



361
362
363
364
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 361

def user_role_required=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "userRoleRequired") unless value.nil?
  jsii_set_property("userRoleRequired", value)
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


643
644
645
646
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 643

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
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) 


382
383
384
385
386
387
 
# File 'chatbot/cfn_microsoft_teams_channel_configuration.rb', line 382

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