class CfnWebExperience (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.aws_qbusiness.CfnWebExperience |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsqbusiness#CfnWebExperience |
![]() | software.amazon.awscdk.services.qbusiness.CfnWebExperience |
![]() | aws_cdk.aws_qbusiness.CfnWebExperience |
![]() | aws-cdk-lib » aws_qbusiness » CfnWebExperience |
Implements
IConstruct
, IDependable
, IInspectable
, ITaggable
Creates an Amazon Q Business web experience.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_qbusiness as qbusiness } from 'aws-cdk-lib';
const cfnWebExperience = new qbusiness.CfnWebExperience(this, 'MyCfnWebExperience', {
applicationId: 'applicationId',
// the properties below are optional
browserExtensionConfiguration: {
enabledBrowserExtensions: ['enabledBrowserExtensions'],
},
customizationConfiguration: {
customCssUrl: 'customCssUrl',
faviconUrl: 'faviconUrl',
fontUrl: 'fontUrl',
logoUrl: 'logoUrl',
},
identityProviderConfiguration: {
openIdConnectConfiguration: {
secretsArn: 'secretsArn',
secretsRole: 'secretsRole',
},
samlConfiguration: {
authenticationUrl: 'authenticationUrl',
},
},
origins: ['origins'],
roleArn: 'roleArn',
samplePromptsControlMode: 'samplePromptsControlMode',
subtitle: 'subtitle',
tags: [{
key: 'key',
value: 'value',
}],
title: 'title',
welcomeMessage: 'welcomeMessage',
});
Initializer
new CfnWebExperience(scope: Construct, id: string, props: CfnWebExperienceProps)
Parameters
- scope
Construct
— Scope in which this resource is defined. - id
string
— Construct identifier for this resource (unique in its scope). - props
Cfn
— Resource properties.Web Experience Props
Construct Props
Name | Type | Description |
---|---|---|
application | string | The identifier of the Amazon Q Business web experience. |
browser | IResolvable | Browser | The container for browser extension configuration for an Amazon Q Business web experience. |
customization | IResolvable | Customization | 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 | IResolvable | Identity | Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience. |
origins? | string[] | Sets the website domain origins that are allowed to embed the Amazon Q Business web experience. |
role | string | The Amazon Resource Name (ARN) of the service role attached to your web experience. |
sample | string | Determines whether sample prompts are enabled in the web experience for an end user. |
subtitle? | string | A subtitle to personalize your Amazon Q Business web experience. |
tags? | Cfn [] | A list of key-value pairs that identify or categorize your Amazon Q Business web experience. |
title? | string | The title for your Amazon Q Business web experience. |
welcome | string | A message in an Amazon Q Business web experience. |
applicationId
Type:
string
The identifier of the Amazon Q Business web experience.
browserExtensionConfiguration?
Type:
IResolvable
|
Browser
(optional)
The container for browser extension configuration for an Amazon Q Business web experience.
customizationConfiguration?
Type:
IResolvable
|
Customization
(optional)
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.
identityProviderConfiguration?
Type:
IResolvable
|
Identity
(optional)
Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
origins?
Type:
string[]
(optional)
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
.
roleArn?
Type:
string
(optional)
The Amazon Resource Name (ARN) of the service role attached to your web experience.
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.
samplePromptsControlMode?
Type:
string
(optional)
Determines whether sample prompts are enabled in the web experience for an end user.
subtitle?
Type:
string
(optional)
A subtitle to personalize your Amazon Q Business web experience.
tags?
Type:
Cfn
[]
(optional)
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: _ . : / = + -
title?
Type:
string
(optional)
The title for your Amazon Q Business web experience.
welcomeMessage?
Type:
string
(optional)
A message in an Amazon Q Business web experience.
Properties
Name | Type | Description |
---|---|---|
application | string | The identifier of the Amazon Q Business web experience. |
attr | string | The Unix timestamp when the Amazon Q Business application was last updated. |
attr | string | The endpoint URLs for your Amazon Q Business web experience. |
attr | string | The status of your Amazon Q Business web experience. |
attr | string | The Unix timestamp when your Amazon Q Business web experience was updated. |
attr | string | The Amazon Resource Name (ARN) of an Amazon Q Business web experience. |
attr | string | The identifier of your Amazon Q Business web experience. |
cdk | Tag | Tag Manager which manages the tags for this resource. |
cfn | ICfn | Options for this resource, such as condition, update policy etc. |
cfn | { [string]: any } | |
cfn | string | AWS resource type. |
creation | string[] | |
logical | string | The logical ID for this CloudFormation stack element. |
node | Node | The tree node. |
ref | string | Return a string that will be resolved to a CloudFormation { Ref } for this element. |
stack | Stack | The stack in which this element is defined. |
browser | IResolvable | Browser | The container for browser extension configuration for an Amazon Q Business web experience. |
customization | IResolvable | Customization | 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 | IResolvable | Identity | Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience. |
origins? | string[] | Sets the website domain origins that are allowed to embed the Amazon Q Business web experience. |
role | string | The Amazon Resource Name (ARN) of the service role attached to your web experience. |
sample | string | Determines whether sample prompts are enabled in the web experience for an end user. |
subtitle? | string | A subtitle to personalize your Amazon Q Business web experience. |
tags? | Cfn [] | A list of key-value pairs that identify or categorize your Amazon Q Business web experience. |
title? | string | The title for your Amazon Q Business web experience. |
welcome | string | A message in an Amazon Q Business web experience. |
static CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. |
applicationId
Type:
string
The identifier of the Amazon Q Business web experience.
attrCreatedAt
Type:
string
The Unix timestamp when the Amazon Q Business application was last updated.
attrDefaultEndpoint
Type:
string
The endpoint URLs for your Amazon Q Business web experience.
The URLs are unique and fully hosted by AWS .
attrStatus
Type:
string
The status of your Amazon Q Business web experience.
attrUpdatedAt
Type:
string
The Unix timestamp when your Amazon Q Business web experience was updated.
attrWebExperienceArn
Type:
string
The Amazon Resource Name (ARN) of an Amazon Q Business web experience.
attrWebExperienceId
Type:
string
The identifier of your Amazon Q Business web experience.
cdkTagManager
Type:
Tag
Tag Manager which manages the tags for this resource.
cfnOptions
Type:
ICfn
Options for this resource, such as condition, update policy etc.
cfnProperties
Type:
{ [string]: any }
cfnResourceType
Type:
string
AWS resource type.
creationStack
Type:
string[]
logicalId
Type:
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 overrideLogicalId(newLogicalId)
.
node
Type:
Node
The tree node.
ref
Type:
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 })
.
stack
Type:
Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
browserExtensionConfiguration?
Type:
IResolvable
|
Browser
(optional)
The container for browser extension configuration for an Amazon Q Business web experience.
customizationConfiguration?
Type:
IResolvable
|
Customization
(optional)
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.
identityProviderConfiguration?
Type:
IResolvable
|
Identity
(optional)
Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
origins?
Type:
string[]
(optional)
Sets the website domain origins that are allowed to embed the Amazon Q Business web experience.
roleArn?
Type:
string
(optional)
The Amazon Resource Name (ARN) of the service role attached to your web experience.
samplePromptsControlMode?
Type:
string
(optional)
Determines whether sample prompts are enabled in the web experience for an end user.
subtitle?
Type:
string
(optional)
A subtitle to personalize your Amazon Q Business web experience.
tags?
Type:
Cfn
[]
(optional)
A list of key-value pairs that identify or categorize your Amazon Q Business web experience.
title?
Type:
string
(optional)
The title for your Amazon Q Business web experience.
welcomeMessage?
Type:
string
(optional)
A message in an Amazon Q Business web experience.
static CFN_RESOURCE_TYPE_NAME
Type:
string
The CloudFormation resource type name for this resource class.
Methods
Name | Description |
---|---|
add | Syntactic sugar for addOverride(path, undefined) . |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Add a value to the CloudFormation Resource Metadata. |
add | Adds an override to the synthesized CloudFormation resource. |
add | Adds an override that deletes the value of a property from the resource definition. |
add | Adds an override to a resource property. |
apply | Sets the deletion policy of the resource based on the removal policy specified. |
get | Returns a token for an runtime attribute of this resource. |
get | Retrieve a value value from the CloudFormation Resource Metadata. |
inspect(inspector) | Examines the CloudFormation resource and discloses attributes. |
obtain | Retrieves an array of resources this resource depends on. |
obtain | Get a shallow copy of dependencies between this resource and other resources in the same stack. |
override | Overrides the auto-generated logical ID with a specific ID. |
remove | Indicates that this resource no longer depends on another resource. |
replace | Replaces one dependency with another. |
to | Returns a string representation of this construct. |
protected render |
addDeletionOverride(path)
public addDeletionOverride(path: string): void
Parameters
- path
string
— The path of the value to delete.
Syntactic sugar for addOverride(path, undefined)
.
addDependency(target)
public addDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
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.
addDependsOn(target)
public addDependsOn(target: CfnResource): void
⚠️ Deprecated: use addDependency
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)
public addMetadata(key: string, value: any): void
Parameters
- key
string
- value
any
Add a value to the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
addOverride(path, value)
public addOverride(path: string, value: any): void
Parameters
- path
string
— - The path of the property, you can use dot notation to override values in complex types. - value
any
— - The value.
Adds an override to the synthesized CloudFormation resource.
To add a
property override, either use addPropertyOverride
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,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value
argument to addOverride
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.
addPropertyDeletionOverride(propertyPath)
public addPropertyDeletionOverride(propertyPath: string): void
Parameters
- propertyPath
string
— The path to the property.
Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)
public addPropertyOverride(propertyPath: string, value: any): void
Parameters
- propertyPath
string
— The path of the property. - value
any
— The value.
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value)
.
applyRemovalPolicy(policy?, options?)
public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void
Parameters
- policy
Removal
Policy - options
Removal
Policy Options
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:
getAtt(attributeName, typeHint?)
public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference
Parameters
- attributeName
string
— The name of the attribute. - typeHint
Resolution
Type Hint
Returns
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.
getMetadata(key)
public getMetadata(key: string): any
Parameters
- key
string
Returns
any
Retrieve a value value from the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
inspect(inspector)
public inspect(inspector: TreeInspector): void
Parameters
- inspector
Tree
— tree inspector to collect and process attributes.Inspector
Examines the CloudFormation resource and discloses attributes.
obtainDependencies()
public obtainDependencies(): Stack | CfnResource[]
Returns
Stack
|
Cfn
Resource []
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
obtainResourceDependencies()
public obtainResourceDependencies(): CfnResource[]
Returns
Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)
public overrideLogicalId(newLogicalId: string): void
Parameters
- newLogicalId
string
— The new logical ID to use for this stack element.
Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)
public removeDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
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.
replaceDependency(target, newTarget)
public replaceDependency(target: CfnResource, newTarget: CfnResource): void
Parameters
- target
Cfn
— The dependency to replace.Resource - newTarget
Cfn
— The new dependency to add.Resource
Replaces one dependency with another.
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
protected renderProperties(props)
protected renderProperties(props: { [string]: any }): { [string]: any }
Parameters
- props
{ [string]: any }
Returns
{ [string]: any }