Class: AWSCDK::Wisdom::CfnAssistantProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
wisdom/cfn_assistant_props.rb

Overview

Properties for defining a CfnAssistant.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, type:, description: nil, server_side_encryption_configuration: nil, tags: nil) ⇒ CfnAssistantProps

Returns a new instance of CfnAssistantProps.

Parameters:

  • name (String) —

    The name of the assistant.

  • type (String) —

    The type of assistant.

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

    The description of the assistant.

  • server_side_encryption_configuration (AWSCDK::IResolvable, AWSCDK::Wisdom::CfnAssistant::ServerSideEncryptionConfigurationProperty, nil) (defaults to: nil) —

    The configuration information for the customer managed key used for encryption.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    The tags used to organize, track, or control access for this resource.



14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'wisdom/cfn_assistant_props.rb', line 14

def initialize(name:, type:, description: nil, server_side_encryption_configuration: nil, tags: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @server_side_encryption_configuration = server_side_encryption_configuration.is_a?(Hash) ? ::AWSCDK::Wisdom::CfnAssistant::ServerSideEncryptionConfigurationProperty.new(**server_side_encryption_configuration.transform_keys(&:to_sym)) : server_side_encryption_configuration
  Jsii::Type.check_type(@server_side_encryption_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c193aXNkb20uQ2ZuQXNzaXN0YW50LlNlcnZlclNpZGVFbmNyeXB0aW9uQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "serverSideEncryptionConfiguration") unless @server_side_encryption_configuration.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#description ⇒ String? (readonly)

The description of the assistant.

Returns:

  • (String, nil)

See Also:



41
42
43
 
# File 'wisdom/cfn_assistant_props.rb', line 41

def description
  @description
end

#name ⇒ String (readonly)

The name of the assistant.

Returns:

  • (String)

See Also:



31
32
33
 
# File 'wisdom/cfn_assistant_props.rb', line 31

def name
  @name
end

#server_side_encryption_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

The configuration information for the customer managed key used for encryption.

The customer managed key must have a policy that allows kms:CreateGrant and kms:DescribeKey permissions to the IAM identity using the key to invoke Wisdom. To use Wisdom with chat, the key policy must also allow kms:Decrypt , kms:GenerateDataKey* , and kms:DescribeKey permissions to the connect.amazonaws.com service principal. For more information about setting up a customer managed key for Wisdom, see Enable Connect Customer Wisdom for your instance .

Returns:

See Also:



48
49
50
 
# File 'wisdom/cfn_assistant_props.rb', line 48

def server_side_encryption_configuration
  @server_side_encryption_configuration
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

The tags used to organize, track, or control access for this resource.

Returns:

See Also:



53
54
55
 
# File 'wisdom/cfn_assistant_props.rb', line 53

def tags
  @tags
end

#type ⇒ String (readonly)

The type of assistant.

Returns:

  • (String)

See Also:



36
37
38
 
# File 'wisdom/cfn_assistant_props.rb', line 36

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object 



55
56
57
58
59
60
61
62
63
 
# File 'wisdom/cfn_assistant_props.rb', line 55

def self.jsii_properties
  {
    :name => "name",
    :type => "type",
    :description => "description",
    :server_side_encryption_configuration => "serverSideEncryptionConfiguration",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



65
66
67
68
69
70
71
72
73
74
75
 
# File 'wisdom/cfn_assistant_props.rb', line 65

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "type" => @type,
    "description" => @description,
    "serverSideEncryptionConfiguration" => @server_side_encryption_configuration,
    "tags" => @tags,
  })
  result.compact
end