AWS::QBusiness::WebExperience - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::QBusiness::WebExperience

Creates an Amazon Q Business web experience.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::QBusiness::WebExperience",
  "Properties" : {
      "ApplicationId" : String,
      "IdentityProviderConfiguration" : IdentityProviderConfiguration,
      "Origins" : [ String, ... ],
      "RoleArn" : String,
      "SamplePromptsControlMode" : String,
      "Subtitle" : String,
      "Tags" : [ Tag, ... ],
      "Title" : String,
      "WelcomeMessage" : String
    }
}

YAML

Type: AWS::QBusiness::WebExperience
Properties:
  ApplicationId: String
  IdentityProviderConfiguration: 
    IdentityProviderConfiguration
  Origins: 
    - String
  RoleArn: String
  SamplePromptsControlMode: String
  Subtitle: String
  Tags: 
    - Tag
  Title: String
  WelcomeMessage: String

Properties

ApplicationId

The identifier of the Amazon Q Business web experience.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$

Minimum: 36

Maximum: 36

Update requires: Replacement

IdentityProviderConfiguration

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

Required: No

Type: IdentityProviderConfiguration

Update requires: No interruption

Origins

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).

Note

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

Required: No

Type: Array of String

Minimum: 0

Maximum: 10

Update requires: No interruption

RoleArn

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

Note

You must provide this value if you're using IAM Identity Center to manage end user access to your application. If you're using legacy identity management to manage user access, you don't need to provide this value.

Required: No

Type: String

Pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$

Minimum: 0

Maximum: 1284

Update requires: No interruption

SamplePromptsControlMode

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

Required: No

Type: String

Allowed values: ENABLED | DISABLED

Update requires: No interruption

Subtitle

A subtitle to personalize your Amazon Q Business web experience.

Required: No

Type: String

Pattern: ^[\s\S]*$

Minimum: 0

Maximum: 500

Update requires: No interruption

Tags

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: _ . : / = + - @.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 200

Update requires: No interruption

Title

The title for your Amazon Q Business web experience.

Required: No

Type: String

Pattern: ^[\s\S]*$

Minimum: 0

Maximum: 500

Update requires: No interruption

WelcomeMessage

A message in an Amazon Q Business web experience.

Required: No

Type: String

Minimum: 0

Maximum: 300

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the application and web experience ID. For example:

{"Ref": "ApplicationId|WebExperienceId"}

For more information about using the Ref function, see Ref.

Fn::GetAtt

CreatedAt

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

DefaultEndpoint

The endpoint URLs for your Amazon Q Business web experience. The URLs are unique and fully hosted by AWS.

Status

The status of your Amazon Q Business web experience.

UpdatedAt

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

WebExperienceArn

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

WebExperienceId

The identifier of your Amazon Q Business web experience.