web_experiences

Creates, updates, deletes or gets a web_experience resource or lists web_experiences in a region

Overview

Name	web_experiences
Type	Resource
Description	Definition of AWS::QBusiness::WebExperience Resource Type
Id	awscc.qbusiness.web_experiences

Fields

get (all properties)

Name	Datatype	Description
application_id	string
created_at	string
default_endpoint	string
identity_provider_configuration	object
role_arn	string
sample_prompts_control_mode	string
status	string
subtitle	string
▶tags	array
title	string
updated_at	string
web_experience_arn	string
web_experience_id	string
welcome_message	string
origins	array
▶customization_configuration	object
▶browser_extension_configuration	object
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
application_id	string
web_experience_id	string
region	string	AWS region.

For more information, see AWS::QBusiness::WebExperience.

Methods

Name	Resource	Accessible by	Required Params
create_resource	web_experiences	INSERT	ApplicationId, region
delete_resource	web_experiences	DELETE	Identifier, region
update_resource	web_experiences	UPDATE	Identifier, PatchDocument, region
list_resources	web_experiences_list_only	SELECT	region
get_resource	web_experiences	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual web_experience.

SELECT
  region,
  application_id,
  created_at,
  default_endpoint,
  identity_provider_configuration,
  role_arn,
  sample_prompts_control_mode,
  status,
  subtitle,
  tags,
  title,
  updated_at,
  web_experience_arn,
  web_experience_id,
  welcome_message,
  origins,
  customization_configuration,
  browser_extension_configuration
FROM awscc.qbusiness.web_experiences
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ application_id }}|{{ web_experience_id }}';

list (identifiers only)

Lists all web_experiences in a region.

SELECT
  region,
  application_id,
  web_experience_id
FROM awscc.qbusiness.web_experiences_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new web_experience resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.qbusiness.web_experiences (
  ApplicationId,
  region
)
SELECT
  '{{ application_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.qbusiness.web_experiences (
  ApplicationId,
  IdentityProviderConfiguration,
  RoleArn,
  SamplePromptsControlMode,
  Subtitle,
  Tags,
  Title,
  WelcomeMessage,
  Origins,
  CustomizationConfiguration,
  BrowserExtensionConfiguration,
  region
)
SELECT
  '{{ application_id }}',
  '{{ identity_provider_configuration }}',
  '{{ role_arn }}',
  '{{ sample_prompts_control_mode }}',
  '{{ subtitle }}',
  '{{ tags }}',
  '{{ title }}',
  '{{ welcome_message }}',
  '{{ origins }}',
  '{{ customization_configuration }}',
  '{{ browser_extension_configuration }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: web_experience
  props:
    - name: application_id
      value: '{{ application_id }}'
    - name: identity_provider_configuration
      value: null
    - name: role_arn
      value: '{{ role_arn }}'
    - name: sample_prompts_control_mode
      value: '{{ sample_prompts_control_mode }}'
    - name: subtitle
      value: '{{ subtitle }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'
    - name: title
      value: '{{ title }}'
    - name: welcome_message
      value: '{{ welcome_message }}'
    - name: origins
      value:
        - '{{ origins[0] }}'
    - name: customization_configuration
      value:
        custom_cs_surl: '{{ custom_cs_surl }}'
        logo_url: '{{ logo_url }}'
        font_url: '{{ font_url }}'
        favicon_url: '{{ favicon_url }}'
    - name: browser_extension_configuration
      value:
        enabled_browser_extensions:
          - '{{ enabled_browser_extensions[0] }}'

UPDATE example

Use the following StackQL query and manifest file to update a web_experience resource, using stack-deploy.

/*+ update */
UPDATE awscc.qbusiness.web_experiences
SET PatchDocument = string('{{ {
    "IdentityProviderConfiguration": identity_provider_configuration,
    "RoleArn": role_arn,
    "SamplePromptsControlMode": sample_prompts_control_mode,
    "Subtitle": subtitle,
    "Tags": tags,
    "Title": title,
    "WelcomeMessage": welcome_message,
    "Origins": origins,
    "CustomizationConfiguration": customization_configuration,
    "BrowserExtensionConfiguration": browser_extension_configuration
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ application_id }}|{{ web_experience_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.qbusiness.web_experiences
WHERE
  Identifier = '{{ application_id }}|{{ web_experience_id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the web_experiences resource, the following permissions are required:

Create

iam:PassRole,
qbusiness:CreateWebExperience,
qbusiness:GetWebExperience,
qbusiness:ListTagsForResource,
qbusiness:TagResource,
sso:PutApplicationGrant,
sso:UpdateApplication

Read

qbusiness:GetWebExperience,
qbusiness:ListTagsForResource

Update

iam:PassRole,
qbusiness:GetWebExperience,
qbusiness:ListTagsForResource,
qbusiness:TagResource,
qbusiness:UntagResource,
qbusiness:UpdateWebExperience,
sso:PutApplicationGrant,
sso:UpdateApplication

Delete

qbusiness:DeleteWebExperience,
qbusiness:GetWebExperience

List

qbusiness:ListWebExperiences