Class: AWSCDK::QBusiness::CfnRetrieverProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
q_business/cfn_retriever_props.rb

Overview

Properties for defining a CfnRetriever.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(application_id:, configuration:, display_name:, type:, role_arn: nil, tags: nil) ⇒ CfnRetrieverProps

Returns a new instance of CfnRetrieverProps.

Parameters:

  • application_id (String) —

    The identifier of the Amazon Q Business application using the retriever.

  • configuration (AWSCDK::IResolvable, AWSCDK::QBusiness::CfnRetriever::RetrieverConfigurationProperty) —

    Provides information on how the retriever used for your Amazon Q Business application is configured.

  • display_name (String) —

    The name of your retriever.

  • type (String) —

    The type of your retriever.

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

    The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.

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

    A list of key-value pairs that identify or categorize the retriever.



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

def initialize(application_id:, configuration:, display_name:, type:, role_arn: nil, tags: nil)
  @application_id = application_id
  Jsii::Type.check_type(@application_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationId")
  @configuration = configuration.is_a?(Hash) ? ::AWSCDK::QBusiness::CfnRetriever::RetrieverConfigurationProperty.new(**configuration.transform_keys(&:to_sym)) : configuration
  Jsii::Type.check_type(@configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xYnVzaW5lc3MuQ2ZuUmV0cmlldmVyLlJldHJpZXZlckNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "configuration")
  @display_name = display_name
  Jsii::Type.check_type(@display_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "displayName")
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn") unless @role_arn.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

#application_id ⇒ String (readonly)

The identifier of the Amazon Q Business application using the retriever.

Returns:

  • (String)

See Also:



34
35
36
 
# File 'q_business/cfn_retriever_props.rb', line 34

def application_id
  @application_id
end

#configuration ⇒ AWSCDK::IResolvable, AWSCDK::QBusiness::CfnRetriever::RetrieverConfigurationProperty (readonly)

Provides information on how the retriever used for your Amazon Q Business application is configured.

Returns:

See Also:



39
40
41
 
# File 'q_business/cfn_retriever_props.rb', line 39

def configuration
  @configuration
end

#display_name ⇒ String (readonly)

The name of your retriever.

Returns:

  • (String)

See Also:



44
45
46
 
# File 'q_business/cfn_retriever_props.rb', line 44

def display_name
  @display_name
end

#role_arn ⇒ String? (readonly)

The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.

Returns:

  • (String, nil)

See Also:



54
55
56
 
# File 'q_business/cfn_retriever_props.rb', line 54

def role_arn
  @role_arn
end

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

A list of key-value pairs that identify or categorize the retriever.

You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + -

Returns:

See Also:



61
62
63
 
# File 'q_business/cfn_retriever_props.rb', line 61

def tags
  @tags
end

#type ⇒ String (readonly)

The type of your retriever.

Returns:

  • (String)

See Also:



49
50
51
 
# File 'q_business/cfn_retriever_props.rb', line 49

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object 



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

def self.jsii_properties
  {
    :application_id => "applicationId",
    :configuration => "configuration",
    :display_name => "displayName",
    :type => "type",
    :role_arn => "roleArn",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



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

def to_jsii
  result = {}
  result.merge!({
    "applicationId" => @application_id,
    "configuration" => @configuration,
    "displayName" => @display_name,
    "type" => @type,
    "roleArn" => @role_arn,
    "tags" => @tags,
  })
  result.compact
end