Class: AWSCDK::Wisdom::CfnAIAgentProps

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

Overview

Properties for defining a CfnAIAgent.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(assistant_id:, configuration:, type:, description: nil, name: nil, tags: nil) ⇒ CfnAIAgentProps

Returns a new instance of CfnAIAgentProps.

Parameters:

  • assistant_id (String) —

    The identifier of the Amazon Q in Connect assistant.

  • configuration (AWSCDK::IResolvable, AWSCDK::Wisdom::CfnAIAgent::AIAgentConfigurationProperty) —

    Configuration for the AI Agent.

  • type (String) —

    The type of the AI Agent.

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

    The description of the AI Agent.

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

    The name of the AI Agent.

  • tags (Hash{String => String}, nil) (defaults to: nil) —

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



15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'wisdom/cfn_ai_agent_props.rb', line 15

def initialize(assistant_id:, configuration:, type:, description: nil, name: nil, tags: nil)
  @assistant_id = assistant_id
  Jsii::Type.check_type(@assistant_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "assistantId")
  @configuration = configuration.is_a?(Hash) ? ::AWSCDK::Wisdom::CfnAIAgent::AIAgentConfigurationProperty.new(**configuration.transform_keys(&:to_sym)) : configuration
  Jsii::Type.check_type(@configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c193aXNkb20uQ2ZuQUlBZ2VudC5BSUFnZW50Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "configuration")
  @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?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @tags = tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "tags") unless @tags.nil?
end

Instance Attribute Details

#assistant_id ⇒ String (readonly)

The identifier of the Amazon Q in Connect assistant.

Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

  • (String)

See Also:



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

def assistant_id
  @assistant_id
end

#configuration ⇒ AWSCDK::IResolvable, AWSCDK::Wisdom::CfnAIAgent::AIAgentConfigurationProperty (readonly)

Configuration for the AI Agent.

Returns:

See Also:



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

def configuration
  @configuration
end

#description ⇒ String? (readonly)

The description of the AI Agent.

Returns:

  • (String, nil)

See Also:



51
52
53
 
# File 'wisdom/cfn_ai_agent_props.rb', line 51

def description
  @description
end

#name ⇒ String? (readonly)

The name of the AI Agent.

Returns:

  • (String, nil)

See Also:



56
57
58
 
# File 'wisdom/cfn_ai_agent_props.rb', line 56

def name
  @name
end

#tags ⇒ Hash{String => String}? (readonly)

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

Returns:

  • (Hash{String => String}, nil)

See Also:



61
62
63
 
# File 'wisdom/cfn_ai_agent_props.rb', line 61

def tags
  @tags
end

#type ⇒ String (readonly)

The type of the AI Agent.

Returns:

  • (String)

See Also:



46
47
48
 
# File 'wisdom/cfn_ai_agent_props.rb', line 46

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object 



63
64
65
66
67
68
69
70
71
72
 
# File 'wisdom/cfn_ai_agent_props.rb', line 63

def self.jsii_properties
  {
    :assistant_id => "assistantId",
    :configuration => "configuration",
    :type => "type",
    :description => "description",
    :name => "name",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'wisdom/cfn_ai_agent_props.rb', line 74

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