Class: AWSCDK::QBusiness::CfnWebExperienceProps

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

Overview

Properties for defining a CfnWebExperience.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(application_id:, browser_extension_configuration: nil, customization_configuration: nil, identity_provider_configuration: nil, origins: nil, role_arn: nil, sample_prompts_control_mode: nil, subtitle: nil, tags: nil, title: nil, welcome_message: nil) ⇒ CfnWebExperienceProps

Returns a new instance of CfnWebExperienceProps.

Parameters:

  • application_id (String) —

    The identifier of the Amazon Q Business web experience.

  • browser_extension_configuration (AWSCDK::IResolvable, AWSCDK::QBusiness::CfnWebExperience::BrowserExtensionConfigurationProperty, nil) (defaults to: nil) —

    The container for browser extension configuration for an Amazon Q Business web experience.

  • customization_configuration (AWSCDK::IResolvable, AWSCDK::QBusiness::CfnWebExperience::CustomizationConfigurationProperty, nil) (defaults to: nil) —

    Contains the configuration information to customize the logo, font, and color of an Amazon Q Business web experience with individual files for each property or a CSS file for them all.

  • identity_provider_configuration (AWSCDK::IResolvable, AWSCDK::QBusiness::CfnWebExperience::IdentityProviderConfigurationProperty, nil) (defaults to: nil) —

    Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

  • origins (Array<String>, nil) (defaults to: nil) —

    Sets the website domain origins that are allowed to embed the Amazon Q Business web experience.

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

    The Amazon Resource Name (ARN) of the service role attached to your web experience.

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

    Determines whether sample prompts are enabled in the web experience for an end user.

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

    A subtitle to personalize your Amazon Q Business web experience.

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

    A list of key-value pairs that identify or categorize your Amazon Q Business web experience.

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

    The title for your Amazon Q Business web experience.

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

    A message in an Amazon Q Business web experience.



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'q_business/cfn_web_experience_props.rb', line 20

def initialize(application_id:, browser_extension_configuration: nil, customization_configuration: nil, identity_provider_configuration: nil, origins: nil, role_arn: nil, sample_prompts_control_mode: nil, subtitle: nil, tags: nil, title: nil, welcome_message: nil)
  @application_id = application_id
  Jsii::Type.check_type(@application_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationId")
  @browser_extension_configuration = browser_extension_configuration.is_a?(Hash) ? ::AWSCDK::QBusiness::CfnWebExperience::BrowserExtensionConfigurationProperty.new(**browser_extension_configuration.transform_keys(&:to_sym)) : browser_extension_configuration
  Jsii::Type.check_type(@browser_extension_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xYnVzaW5lc3MuQ2ZuV2ViRXhwZXJpZW5jZS5Ccm93c2VyRXh0ZW5zaW9uQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "browserExtensionConfiguration") unless @browser_extension_configuration.nil?
  @customization_configuration = customization_configuration.is_a?(Hash) ? ::AWSCDK::QBusiness::CfnWebExperience::CustomizationConfigurationProperty.new(**customization_configuration.transform_keys(&:to_sym)) : customization_configuration
  Jsii::Type.check_type(@customization_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xYnVzaW5lc3MuQ2ZuV2ViRXhwZXJpZW5jZS5DdXN0b21pemF0aW9uQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "customizationConfiguration") unless @customization_configuration.nil?
  @identity_provider_configuration = identity_provider_configuration.is_a?(Hash) ? ::AWSCDK::QBusiness::CfnWebExperience::IdentityProviderConfigurationProperty.new(**identity_provider_configuration.transform_keys(&:to_sym)) : identity_provider_configuration
  Jsii::Type.check_type(@identity_provider_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xYnVzaW5lc3MuQ2ZuV2ViRXhwZXJpZW5jZS5JZGVudGl0eVByb3ZpZGVyQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "identityProviderConfiguration") unless @identity_provider_configuration.nil?
  @origins = origins
  Jsii::Type.check_type(@origins, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "origins") unless @origins.nil?
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn") unless @role_arn.nil?
  @sample_prompts_control_mode = sample_prompts_control_mode
  Jsii::Type.check_type(@sample_prompts_control_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "samplePromptsControlMode") unless @sample_prompts_control_mode.nil?
  @subtitle = subtitle
  Jsii::Type.check_type(@subtitle, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "subtitle") unless @subtitle.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?
  @title = title
  Jsii::Type.check_type(@title, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "title") unless @title.nil?
  @welcome_message = welcome_message
  Jsii::Type.check_type(@welcome_message, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "welcomeMessage") unless @welcome_message.nil?
end

Instance Attribute Details

#application_id ⇒ String (readonly)

The identifier of the Amazon Q Business web experience.

Returns:

  • (String)

See Also:



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

def application_id
  @application_id
end

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

The container for browser extension configuration for an Amazon Q Business web experience.

Returns:

See Also:



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

def browser_extension_configuration
  @browser_extension_configuration
end

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

Contains the configuration information to customize the logo, font, and color of an Amazon Q Business web experience with individual files for each property or a CSS file for them all.

Returns:

See Also:



59
60
61
 
# File 'q_business/cfn_web_experience_props.rb', line 59

def customization_configuration
  @customization_configuration
end

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

Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

Returns:

See Also:



64
65
66
 
# File 'q_business/cfn_web_experience_props.rb', line 64

def identity_provider_configuration
  @identity_provider_configuration
end

#origins ⇒ Array<String>? (readonly)

Sets the website domain origins that are allowed to embed the Amazon Q Business web experience.

The domain origin refers to the base URL for accessing a website including the protocol ( http/https ), the domain name, and the port number (if specified).

You must only submit a base URL and not a full path. For example, https://docs.aws.amazon.com .

Returns:

  • (Array<String>, nil)

See Also:



73
74
75
 
# File 'q_business/cfn_web_experience_props.rb', line 73

def origins
  @origins
end

#role_arn ⇒ String? (readonly)

The Amazon Resource Name (ARN) of the service role attached to your web experience.

The role_arn parameter is required when your Amazon Q Business application is created with IAM Identity Center. It is not required for SAML-based applications.

Returns:

  • (String, nil)

See Also:



80
81
82
 
# File 'q_business/cfn_web_experience_props.rb', line 80

def role_arn
  @role_arn
end

#sample_prompts_control_mode ⇒ String? (readonly)

Determines whether sample prompts are enabled in the web experience for an end user.

Returns:

  • (String, nil)

See Also:



85
86
87
 
# File 'q_business/cfn_web_experience_props.rb', line 85

def sample_prompts_control_mode
  @sample_prompts_control_mode
end

#subtitle ⇒ String? (readonly)

A subtitle to personalize your Amazon Q Business web experience.

Returns:

  • (String, nil)

See Also:



90
91
92
 
# File 'q_business/cfn_web_experience_props.rb', line 90

def subtitle
  @subtitle
end

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

A list of key-value pairs that identify or categorize your Amazon Q Business web experience.

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

Returns:

See Also:



97
98
99
 
# File 'q_business/cfn_web_experience_props.rb', line 97

def tags
  @tags
end

#title ⇒ String? (readonly)

The title for your Amazon Q Business web experience.

Returns:

  • (String, nil)

See Also:



102
103
104
 
# File 'q_business/cfn_web_experience_props.rb', line 102

def title
  @title
end

#welcome_message ⇒ String? (readonly)

A message in an Amazon Q Business web experience.

Returns:

  • (String, nil)

See Also:



107
108
109
 
# File 'q_business/cfn_web_experience_props.rb', line 107

def welcome_message
  @welcome_message
end

Class Method Details

.jsii_properties ⇒ Object 



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'q_business/cfn_web_experience_props.rb', line 109

def self.jsii_properties
  {
    :application_id => "applicationId",
    :browser_extension_configuration => "browserExtensionConfiguration",
    :customization_configuration => "customizationConfiguration",
    :identity_provider_configuration => "identityProviderConfiguration",
    :origins => "origins",
    :role_arn => "roleArn",
    :sample_prompts_control_mode => "samplePromptsControlMode",
    :subtitle => "subtitle",
    :tags => "tags",
    :title => "title",
    :welcome_message => "welcomeMessage",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'q_business/cfn_web_experience_props.rb', line 125

def to_jsii
  result = {}
  result.merge!({
    "applicationId" => @application_id,
    "browserExtensionConfiguration" => @browser_extension_configuration,
    "customizationConfiguration" => @customization_configuration,
    "identityProviderConfiguration" => @identity_provider_configuration,
    "origins" => @origins,
    "roleArn" => @role_arn,
    "samplePromptsControlMode" => @sample_prompts_control_mode,
    "subtitle" => @subtitle,
    "tags" => @tags,
    "title" => @title,
    "welcomeMessage" => @welcome_message,
  })
  result.compact
end