Class CfnWebExperience
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.qbusiness.CfnWebExperience
- All Implemented Interfaces:
IInspectable
,ITaggableV2
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.106.0 (build e852934)",
date="2025-02-06T22:15:58.412Z")
@Stability(Stable)
public class CfnWebExperience
extends CfnResource
implements IInspectable, ITaggableV2
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 software.amazon.awscdk.services.qbusiness.*; CfnWebExperience cfnWebExperience = CfnWebExperience.Builder.create(this, "MyCfnWebExperience") .applicationId("applicationId") // the properties below are optional .browserExtensionConfiguration(BrowserExtensionConfigurationProperty.builder() .enabledBrowserExtensions(List.of("enabledBrowserExtensions")) .build()) .customizationConfiguration(CustomizationConfigurationProperty.builder() .customCssUrl("customCssUrl") .faviconUrl("faviconUrl") .fontUrl("fontUrl") .logoUrl("logoUrl") .build()) .identityProviderConfiguration(IdentityProviderConfigurationProperty.builder() .openIdConnectConfiguration(OpenIDConnectProviderConfigurationProperty.builder() .secretsArn("secretsArn") .secretsRole("secretsRole") .build()) .samlConfiguration(SamlProviderConfigurationProperty.builder() .authenticationUrl("authenticationUrl") .build()) .build()) .origins(List.of("origins")) .roleArn("roleArn") .samplePromptsControlMode("samplePromptsControlMode") .subtitle("subtitle") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .title("title") .welcomeMessage("welcomeMessage") .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interface
The container for browser extension configuration for an Amazon Q Business web experience.static final class
A fluent builder forCfnWebExperience
.static interface
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.static interface
Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.static interface
Information about the OIDC-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.static interface
Information about the SAML 2.0-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2
ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
CfnWebExperience
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnWebExperience
(software.amazon.jsii.JsiiObjectRef objRef) CfnWebExperience
(software.constructs.Construct scope, String id, CfnWebExperienceProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe identifier of the Amazon Q Business web experience.The Unix timestamp when the Amazon Q Business application was last updated.The endpoint URLs for your Amazon Q Business web experience.The status of your Amazon Q Business web experience.The Unix timestamp when your Amazon Q Business web experience was updated.The Amazon Resource Name (ARN) of an Amazon Q Business web experience.The identifier of your Amazon Q Business web experience.The container for browser extension configuration for an Amazon Q Business web experience.Tag Manager which manages the tags for this resource.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.Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.Sets the website domain origins that are allowed to embed the Amazon Q Business web experience.The Amazon Resource Name (ARN) of the service role attached to your web experience.Determines whether sample prompts are enabled in the web experience for an end user.A subtitle to personalize your Amazon Q Business web experience.getTags()
A list of key-value pairs that identify or categorize your Amazon Q Business web experience.getTitle()
The title for your Amazon Q Business web experience.A message in an Amazon Q Business web experience.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setApplicationId
(String value) The identifier of the Amazon Q Business web experience.void
The container for browser extension configuration for an Amazon Q Business web experience.void
The container for browser extension configuration for an Amazon Q Business web experience.void
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.void
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.void
Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.void
Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.void
setOrigins
(List<String> value) Sets the website domain origins that are allowed to embed the Amazon Q Business web experience.void
setRoleArn
(String value) The Amazon Resource Name (ARN) of the service role attached to your web experience.void
Determines whether sample prompts are enabled in the web experience for an end user.void
setSubtitle
(String value) A subtitle to personalize your Amazon Q Business web experience.void
A list of key-value pairs that identify or categorize your Amazon Q Business web experience.void
The title for your Amazon Q Business web experience.void
setWelcomeMessage
(String value) A message in an Amazon Q Business web experience.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnWebExperience
protected CfnWebExperience(software.amazon.jsii.JsiiObjectRef objRef) -
CfnWebExperience
protected CfnWebExperience(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnWebExperience
@Stability(Stable) public CfnWebExperience(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnWebExperienceProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrCreatedAt
The Unix timestamp when the Amazon Q Business application was last updated. -
getAttrDefaultEndpoint
The endpoint URLs for your Amazon Q Business web experience.The URLs are unique and fully hosted by AWS .
-
getAttrStatus
The status of your Amazon Q Business web experience. -
getAttrUpdatedAt
The Unix timestamp when your Amazon Q Business web experience was updated. -
getAttrWebExperienceArn
The Amazon Resource Name (ARN) of an Amazon Q Business web experience. -
getAttrWebExperienceId
The identifier of your Amazon Q Business web experience. -
getCdkTagManager
Tag Manager which manages the tags for this resource.- Specified by:
getCdkTagManager
in interfaceITaggableV2
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getApplicationId
The identifier of the Amazon Q Business web experience. -
setApplicationId
The identifier of the Amazon Q Business web experience. -
getBrowserExtensionConfiguration
The container for browser extension configuration for an Amazon Q Business web experience. -
setBrowserExtensionConfiguration
The container for browser extension configuration for an Amazon Q Business web experience. -
setBrowserExtensionConfiguration
@Stability(Stable) public void setBrowserExtensionConfiguration(@Nullable CfnWebExperience.BrowserExtensionConfigurationProperty value) The container for browser extension configuration for an Amazon Q Business web experience. -
getCustomizationConfiguration
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. -
setCustomizationConfiguration
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. -
setCustomizationConfiguration
@Stability(Stable) public void setCustomizationConfiguration(@Nullable CfnWebExperience.CustomizationConfigurationProperty value) 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. -
getIdentityProviderConfiguration
Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience. -
setIdentityProviderConfiguration
Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience. -
setIdentityProviderConfiguration
@Stability(Stable) public void setIdentityProviderConfiguration(@Nullable CfnWebExperience.IdentityProviderConfigurationProperty value) Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience. -
getOrigins
Sets the website domain origins that are allowed to embed the Amazon Q Business web experience. -
setOrigins
Sets the website domain origins that are allowed to embed the Amazon Q Business web experience. -
getRoleArn
The Amazon Resource Name (ARN) of the service role attached to your web experience. -
setRoleArn
The Amazon Resource Name (ARN) of the service role attached to your web experience. -
getSamplePromptsControlMode
Determines whether sample prompts are enabled in the web experience for an end user. -
setSamplePromptsControlMode
Determines whether sample prompts are enabled in the web experience for an end user. -
getSubtitle
A subtitle to personalize your Amazon Q Business web experience. -
setSubtitle
A subtitle to personalize your Amazon Q Business web experience. -
getTags
A list of key-value pairs that identify or categorize your Amazon Q Business web experience. -
setTags
A list of key-value pairs that identify or categorize your Amazon Q Business web experience. -
getTitle
The title for your Amazon Q Business web experience. -
setTitle
The title for your Amazon Q Business web experience. -
getWelcomeMessage
A message in an Amazon Q Business web experience. -
setWelcomeMessage
A message in an Amazon Q Business web experience.
-