Class: AWSCDK::QBusiness::CfnWebExperience

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSQbusiness::IWebExperienceRef
Defined in:
q_business/cfn_web_experience.rb

Overview

Creates an Amazon Q Business web experience.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnWebExperience

Create a new AWS::QBusiness::WebExperience.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::QBusiness::CfnWebExperienceProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'q_business/cfn_web_experience.rb', line 18

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::QBusiness::CfnWebExperienceProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcWJ1c2luZXNzLkNmbldlYkV4cGVyaWVuY2VQcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_web_experience(resource) ⇒ String

Parameters:

Returns:

  • (String) 


87
88
89
90
 
# File 'q_business/cfn_web_experience.rb', line 87

def self.arn_for_web_experience(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19xYnVzaW5lc3MuSVdlYkV4cGVyaWVuY2VSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_qbusiness.CfnWebExperience", "arnForWebExperience", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


194
195
196
 
# File 'q_business/cfn_web_experience.rb', line 194

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_qbusiness.CfnWebExperience", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_web_experience(x) ⇒ Boolean

Checks whether the given object is a CfnWebExperience.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


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

def self.is_cfn_web_experience(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_qbusiness.CfnWebExperience", "isCfnWebExperience", [x])
end

.jsii_overridable_methods ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'q_business/cfn_web_experience.rb', line 26

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_default_endpoint => { kind: :property, name: "attrDefaultEndpoint", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :attr_updated_at => { kind: :property, name: "attrUpdatedAt", is_optional: false },
    :attr_web_experience_arn => { kind: :property, name: "attrWebExperienceArn", is_optional: false },
    :attr_web_experience_id => { kind: :property, name: "attrWebExperienceId", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :web_experience_ref => { kind: :property, name: "webExperienceRef", is_optional: false },
    :application_id => { kind: :property, name: "applicationId", is_optional: false },
    :browser_extension_configuration => { kind: :property, name: "browserExtensionConfiguration", is_optional: true },
    :customization_configuration => { kind: :property, name: "customizationConfiguration", is_optional: true },
    :identity_provider_configuration => { kind: :property, name: "identityProviderConfiguration", is_optional: true },
    :origins => { kind: :property, name: "origins", is_optional: true },
    :role_arn => { kind: :property, name: "roleArn", is_optional: true },
    :sample_prompts_control_mode => { kind: :property, name: "samplePromptsControlMode", is_optional: true },
    :subtitle => { kind: :property, name: "subtitle", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :title => { kind: :property, name: "title", is_optional: true },
    :welcome_message => { kind: :property, name: "welcomeMessage", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



428
429
430
431
 
# File 'q_business/cfn_web_experience.rb', line 428

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



440
441
442
443
 
# File 'q_business/cfn_web_experience.rb', line 440

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



450
451
452
453
 
# File 'q_business/cfn_web_experience.rb', line 450

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



461
462
463
464
465
 
# File 'q_business/cfn_web_experience.rb', line 461

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


518
519
520
521
522
 
# File 'q_business/cfn_web_experience.rb', line 518

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



528
529
530
531
 
# File 'q_business/cfn_web_experience.rb', line 528

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



540
541
542
543
544
 
# File 'q_business/cfn_web_experience.rb', line 540

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#application_id ⇒ String

The identifier of the Amazon Q Business web experience.

Returns:

  • (String) 


259
260
261
 
# File 'q_business/cfn_web_experience.rb', line 259

def application_id()
  jsii_get_property("applicationId")
end

#application_id=(value) ⇒ Object 



263
264
265
266
 
# File 'q_business/cfn_web_experience.rb', line 263

def application_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationId")
  jsii_set_property("applicationId", value)
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



553
554
555
556
 
# File 'q_business/cfn_web_experience.rb', line 553

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



575
576
577
578
579
580
 
# File 'q_business/cfn_web_experience.rb', line 575

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_created_at ⇒ String

The Unix timestamp when the Amazon Q Business application was last updated.

Returns:

  • (String) 


201
202
203
 
# File 'q_business/cfn_web_experience.rb', line 201

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_default_endpoint ⇒ String

The endpoint URLs for your Amazon Q Business web experience.

The URLs are unique and fully hosted by AWS .

Returns:

  • (String) 


210
211
212
 
# File 'q_business/cfn_web_experience.rb', line 210

def attr_default_endpoint()
  jsii_get_property("attrDefaultEndpoint")
end

#attr_status ⇒ String

The status of your Amazon Q Business web experience.

Returns:

  • (String) 


217
218
219
 
# File 'q_business/cfn_web_experience.rb', line 217

def attr_status()
  jsii_get_property("attrStatus")
end

#attr_updated_at ⇒ String

The Unix timestamp when your Amazon Q Business web experience was updated.

Returns:

  • (String) 


224
225
226
 
# File 'q_business/cfn_web_experience.rb', line 224

def attr_updated_at()
  jsii_get_property("attrUpdatedAt")
end

#attr_web_experience_arn ⇒ String

The Amazon Resource Name (ARN) of an Amazon Q Business web experience.

Returns:

  • (String) 


231
232
233
 
# File 'q_business/cfn_web_experience.rb', line 231

def attr_web_experience_arn()
  jsii_get_property("attrWebExperienceArn")
end

#attr_web_experience_id ⇒ String

The identifier of your Amazon Q Business web experience.

Returns:

  • (String) 


238
239
240
 
# File 'q_business/cfn_web_experience.rb', line 238

def attr_web_experience_id()
  jsii_get_property("attrWebExperienceId")
end

#browser_extension_configuration ⇒ AWSCDK::IResolvable, ...

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

Returns:



271
272
273
 
# File 'q_business/cfn_web_experience.rb', line 271

def browser_extension_configuration()
  jsii_get_property("browserExtensionConfiguration")
end

#browser_extension_configuration=(value) ⇒ Object 



275
276
277
278
279
 
# File 'q_business/cfn_web_experience.rb', line 275

def browser_extension_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::QBusiness::CfnWebExperience::BrowserExtensionConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xYnVzaW5lc3MuQ2ZuV2ViRXhwZXJpZW5jZS5Ccm93c2VyRXh0ZW5zaW9uQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "browserExtensionConfiguration") unless value.nil?
  jsii_set_property("browserExtensionConfiguration", value)
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



245
246
247
 
# File 'q_business/cfn_web_experience.rb', line 245

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



147
148
149
 
# File 'q_business/cfn_web_experience.rb', line 147

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


152
153
154
 
# File 'q_business/cfn_web_experience.rb', line 152

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


584
585
586
587
 
# File 'q_business/cfn_web_experience.rb', line 584

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


157
158
159
 
# File 'q_business/cfn_web_experience.rb', line 157

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


164
165
166
 
# File 'q_business/cfn_web_experience.rb', line 164

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


109
110
111
 
# File 'q_business/cfn_web_experience.rb', line 109

def creation_stack()
  jsii_get_property("creationStack")
end

#customization_configuration ⇒ AWSCDK::IResolvable, ...

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:



284
285
286
 
# File 'q_business/cfn_web_experience.rb', line 284

def customization_configuration()
  jsii_get_property("customizationConfiguration")
end

#customization_configuration=(value) ⇒ Object 



288
289
290
291
292
 
# File 'q_business/cfn_web_experience.rb', line 288

def customization_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::QBusiness::CfnWebExperience::CustomizationConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xYnVzaW5lc3MuQ2ZuV2ViRXhwZXJpZW5jZS5DdXN0b21pemF0aW9uQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "customizationConfiguration") unless value.nil?
  jsii_set_property("customizationConfiguration", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



169
170
171
 
# File 'q_business/cfn_web_experience.rb', line 169

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



597
598
599
600
601
 
# File 'q_business/cfn_web_experience.rb', line 597

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



608
609
610
611
 
# File 'q_business/cfn_web_experience.rb', line 608

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#identity_provider_configuration ⇒ AWSCDK::IResolvable, ...

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

Returns:



297
298
299
 
# File 'q_business/cfn_web_experience.rb', line 297

def identity_provider_configuration()
  jsii_get_property("identityProviderConfiguration")
end

#identity_provider_configuration=(value) ⇒ Object 



301
302
303
304
305
 
# File 'q_business/cfn_web_experience.rb', line 301

def identity_provider_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::QBusiness::CfnWebExperience::IdentityProviderConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xYnVzaW5lc3MuQ2ZuV2ViRXhwZXJpZW5jZS5JZGVudGl0eVByb3ZpZGVyQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "identityProviderConfiguration") unless value.nil?
  jsii_set_property("identityProviderConfiguration", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



678
679
680
681
 
# File 'q_business/cfn_web_experience.rb', line 678

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


121
122
123
 
# File 'q_business/cfn_web_experience.rb', line 121

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


104
105
106
 
# File 'q_business/cfn_web_experience.rb', line 104

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



619
620
621
 
# File 'q_business/cfn_web_experience.rb', line 619

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



626
627
628
 
# File 'q_business/cfn_web_experience.rb', line 626

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#origins ⇒ Array<String>?

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

Returns:

  • (Array<String>, nil) 


310
311
312
 
# File 'q_business/cfn_web_experience.rb', line 310

def origins()
  jsii_get_property("origins")
end

#origins=(value) ⇒ Object 



314
315
316
317
 
# File 'q_business/cfn_web_experience.rb', line 314

def origins=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "origins") unless value.nil?
  jsii_set_property("origins", value)
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



419
420
421
422
 
# File 'q_business/cfn_web_experience.rb', line 419

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


140
141
142
 
# File 'q_business/cfn_web_experience.rb', line 140

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



637
638
639
640
 
# File 'q_business/cfn_web_experience.rb', line 637

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


644
645
646
647
 
# File 'q_business/cfn_web_experience.rb', line 644

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



654
655
656
657
658
 
# File 'q_business/cfn_web_experience.rb', line 654

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#role_arn ⇒ String?

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

Returns:

  • (String, nil) 


322
323
324
 
# File 'q_business/cfn_web_experience.rb', line 322

def role_arn()
  jsii_get_property("roleArn")
end

#role_arn=(value) ⇒ Object 



326
327
328
329
 
# File 'q_business/cfn_web_experience.rb', line 326

def role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn") unless value.nil?
  jsii_set_property("roleArn", value)
end

#sample_prompts_control_mode ⇒ String?

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

Returns:

  • (String, nil) 


334
335
336
 
# File 'q_business/cfn_web_experience.rb', line 334

def sample_prompts_control_mode()
  jsii_get_property("samplePromptsControlMode")
end

#sample_prompts_control_mode=(value) ⇒ Object 



338
339
340
341
 
# File 'q_business/cfn_web_experience.rb', line 338

def sample_prompts_control_mode=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "samplePromptsControlMode") unless value.nil?
  jsii_set_property("samplePromptsControlMode", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



663
664
665
 
# File 'q_business/cfn_web_experience.rb', line 663

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



130
131
132
 
# File 'q_business/cfn_web_experience.rb', line 130

def stack()
  jsii_get_property("stack")
end

#subtitle ⇒ String?

A subtitle to personalize your Amazon Q Business web experience.

Returns:

  • (String, nil) 


346
347
348
 
# File 'q_business/cfn_web_experience.rb', line 346

def subtitle()
  jsii_get_property("subtitle")
end

#subtitle=(value) ⇒ Object 



350
351
352
353
 
# File 'q_business/cfn_web_experience.rb', line 350

def subtitle=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "subtitle") unless value.nil?
  jsii_set_property("subtitle", value)
end

#tags ⇒ Array<AWSCDK::CfnTag>?

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

Returns:



358
359
360
 
# File 'q_business/cfn_web_experience.rb', line 358

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



362
363
364
365
366
 
# File 'q_business/cfn_web_experience.rb', line 362

def tags=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#title ⇒ String?

The title for your Amazon Q Business web experience.

Returns:

  • (String, nil) 


371
372
373
 
# File 'q_business/cfn_web_experience.rb', line 371

def title()
  jsii_get_property("title")
end

#title=(value) ⇒ Object 



375
376
377
378
 
# File 'q_business/cfn_web_experience.rb', line 375

def title=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "title") unless value.nil?
  jsii_set_property("title", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



395
396
397
 
# File 'q_business/cfn_web_experience.rb', line 395

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


177
178
179
 
# File 'q_business/cfn_web_experience.rb', line 177

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


187
188
189
 
# File 'q_business/cfn_web_experience.rb', line 187

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


669
670
671
672
 
# File 'q_business/cfn_web_experience.rb', line 669

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#web_experience_ref ⇒ AWSCDK::Interfaces::AWSQbusiness::WebExperienceReference

A reference to a WebExperience resource.

Returns:



252
253
254
 
# File 'q_business/cfn_web_experience.rb', line 252

def web_experience_ref()
  jsii_get_property("webExperienceRef")
end

#welcome_message ⇒ String?

A message in an Amazon Q Business web experience.

Returns:

  • (String, nil) 


383
384
385
 
# File 'q_business/cfn_web_experience.rb', line 383

def welcome_message()
  jsii_get_property("welcomeMessage")
end

#welcome_message=(value) ⇒ Object 



387
388
389
390
 
# File 'q_business/cfn_web_experience.rb', line 387

def welcome_message=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "welcomeMessage") unless value.nil?
  jsii_set_property("welcomeMessage", value)
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


408
409
410
411
412
413
 
# File 'q_business/cfn_web_experience.rb', line 408

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end