Class: AWSCDK::QBusiness::CfnDataAccessorProps

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

Overview

Properties for defining a CfnDataAccessor.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(action_configurations:, application_id:, display_name:, principal:, authentication_detail: nil, tags: nil) ⇒ CfnDataAccessorProps

Returns a new instance of CfnDataAccessorProps.

Parameters:



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

def initialize(action_configurations:, application_id:, display_name:, principal:, authentication_detail: nil, tags: nil)
  @action_configurations = action_configurations
  Jsii::Type.check_type(@action_configurations, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcWJ1c2luZXNzLkNmbkRhdGFBY2Nlc3Nvci5BY3Rpb25Db25maWd1cmF0aW9uUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "actionConfigurations")
  @application_id = application_id
  Jsii::Type.check_type(@application_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationId")
  @display_name = display_name
  Jsii::Type.check_type(@display_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "displayName")
  @principal = principal
  Jsii::Type.check_type(@principal, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "principal")
  @authentication_detail = authentication_detail.is_a?(Hash) ? ::AWSCDK::QBusiness::CfnDataAccessor::DataAccessorAuthenticationDetailProperty.new(**authentication_detail.transform_keys(&:to_sym)) : authentication_detail
  Jsii::Type.check_type(@authentication_detail, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xYnVzaW5lc3MuQ2ZuRGF0YUFjY2Vzc29yLkRhdGFBY2Nlc3NvckF1dGhlbnRpY2F0aW9uRGV0YWlsUHJvcGVydHkifV19fQ==")), "authenticationDetail") unless @authentication_detail.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

#action_configurations ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::QBusiness::CfnDataAccessor::ActionConfigurationProperty> (readonly)

A list of action configurations specifying the allowed actions and any associated filters.

Returns:

See Also:



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

def action_configurations
  @action_configurations
end

#application_id ⇒ String (readonly)

The unique identifier of the Amazon Q Business application.

Returns:

  • (String)

See Also:



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

def application_id
  @application_id
end

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

The authentication configuration details for the data accessor.

This specifies how the ISV authenticates when accessing data through this data accessor.

Returns:

See Also:



56
57
58
 
# File 'q_business/cfn_data_accessor_props.rb', line 56

def authentication_detail
  @authentication_detail
end

#display_name ⇒ String (readonly)

The friendly name of the data accessor.

Returns:

  • (String)

See Also:



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

def display_name
  @display_name
end

#principal ⇒ String (readonly)

The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.

Returns:

  • (String)

See Also:



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

def principal
  @principal
end

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

The tags to associate with the data accessor.

Returns:

See Also:



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

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



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

def self.jsii_properties
  {
    :action_configurations => "actionConfigurations",
    :application_id => "applicationId",
    :display_name => "displayName",
    :principal => "principal",
    :authentication_detail => "authenticationDetail",
    :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_data_accessor_props.rb', line 74

def to_jsii
  result = {}
  result.merge!({
    "actionConfigurations" => @action_configurations,
    "applicationId" => @application_id,
    "displayName" => @display_name,
    "principal" => @principal,
    "authenticationDetail" => @authentication_detail,
    "tags" => @tags,
  })
  result.compact
end