CfnWebExperience

class aws_cdk.aws_qbusiness.CfnWebExperience(scope, id, *, application_id, identity_provider_configuration=None, origins=None, role_arn=None, sample_prompts_control_mode=None, subtitle=None, tags=None, title=None, welcome_message=None)

Bases: CfnResource

Creates an Amazon Q Business web experience.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html
CloudformationResource:: AWS::QBusiness::WebExperience
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_qbusiness as qbusiness

cfn_web_experience = qbusiness.CfnWebExperience(self, "MyCfnWebExperience",
    application_id="applicationId",

    # the properties below are optional
    identity_provider_configuration=qbusiness.CfnWebExperience.IdentityProviderConfigurationProperty(
        open_id_connect_configuration=qbusiness.CfnWebExperience.OpenIDConnectProviderConfigurationProperty(
            secrets_arn="secretsArn",
            secrets_role="secretsRole"
        ),
        saml_configuration=qbusiness.CfnWebExperience.SamlProviderConfigurationProperty(
            authentication_url="authenticationUrl"
        )
    ),
    origins=["origins"],
    role_arn="roleArn",
    sample_prompts_control_mode="samplePromptsControlMode",
    subtitle="subtitle",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    title="title",
    welcome_message="welcomeMessage"
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
application_id (str) – The identifier of the Amazon Q Business web experience.
identity_provider_configuration (Union[IResolvable, IdentityProviderConfigurationProperty, Dict[str, Any], None]) – Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
origins (Optional[Sequence[str]]) – 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). .. epigraph:: You must only submit a base URL and not a full path. For example, https://docs.aws.amazon.com .
role_arn (Optional[str]) – The Amazon Resource Name (ARN) of the service role attached to your web experience. .. epigraph:: 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.
sample_prompts_control_mode (Optional[str]) – Determines whether sample prompts are enabled in the web experience for an end user.
subtitle (Optional[str]) – A subtitle to personalize your Amazon Q Business web experience.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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 (Optional[str]) – The title for your Amazon Q Business web experience.
welcome_message (Optional[str]) – A message in an Amazon Q Business web experience.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

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:

target (CfnResource) –

Return type:

None

add_depends_on(target)

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

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

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.

add_override(path, 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:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

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

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

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

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

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

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

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:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

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:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

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

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

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

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

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

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

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

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

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:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::QBusiness::WebExperience'

application_id: The identifier of the Amazon Q Business web experience.

attr_created_at

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

CloudformationAttribute:: CreatedAt

attr_default_endpoint

The endpoint URLs for your Amazon Q Business web experience.

The URLs are unique and fully hosted by AWS .

CloudformationAttribute:: DefaultEndpoint

attr_status

The status of your Amazon Q Business web experience.

CloudformationAttribute:: Status

attr_updated_at

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

CloudformationAttribute:: UpdatedAt

attr_web_experience_arn

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

CloudformationAttribute:: WebExperienceArn

attr_web_experience_id

The identifier of your Amazon Q Business web experience.

CloudformationAttribute:: WebExperienceId

cdk_tag_manager: Tag Manager which manages the tags for this resource.

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

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

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

logical_id

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

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node: The tree node.

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

ref

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

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

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

stack

The stack in which this element is defined.

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

subtitle: A subtitle to personalize your Amazon Q Business web experience.

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

title: The title for your Amazon Q Business web experience.

welcome_message: A message in an Amazon Q Business web experience.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

IdentityProviderConfigurationProperty

class CfnWebExperience.IdentityProviderConfigurationProperty(*, open_id_connect_configuration=None, saml_configuration=None)

Bases: object

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

Parameters:

open_id_connect_configuration (Union[IResolvable, OpenIDConnectProviderConfigurationProperty, Dict[str, Any], None]) –
saml_configuration (Union[IResolvable, SamlProviderConfigurationProperty, Dict[str, Any], None]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-webexperience-identityproviderconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_qbusiness as qbusiness

identity_provider_configuration_property = qbusiness.CfnWebExperience.IdentityProviderConfigurationProperty(
    open_id_connect_configuration=qbusiness.CfnWebExperience.OpenIDConnectProviderConfigurationProperty(
        secrets_arn="secretsArn",
        secrets_role="secretsRole"
    ),
    saml_configuration=qbusiness.CfnWebExperience.SamlProviderConfigurationProperty(
        authentication_url="authenticationUrl"
    )
)

Attributes

open_id_connect_configuration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-webexperience-identityproviderconfiguration.html#cfn-qbusiness-webexperience-identityproviderconfiguration-openidconnectconfiguration

Type:: see

saml_configuration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-webexperience-identityproviderconfiguration.html#cfn-qbusiness-webexperience-identityproviderconfiguration-samlconfiguration

Type:: see

OpenIDConnectProviderConfigurationProperty

class CfnWebExperience.OpenIDConnectProviderConfigurationProperty(*, secrets_arn, secrets_role)

Bases: object

Information about the OIDC-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

Parameters:

secrets_arn (str) – The Amazon Resource Name (ARN) of a Secrets Manager secret containing the OIDC client secret.
secrets_role (str) – An IAM role with permissions to access AWS KMS to decrypt the Secrets Manager secret containing your OIDC client secret.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-webexperience-openidconnectproviderconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_qbusiness as qbusiness

open_iDConnect_provider_configuration_property = qbusiness.CfnWebExperience.OpenIDConnectProviderConfigurationProperty(
    secrets_arn="secretsArn",
    secrets_role="secretsRole"
)

Attributes

secrets_arn

The Amazon Resource Name (ARN) of a Secrets Manager secret containing the OIDC client secret.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-webexperience-openidconnectproviderconfiguration.html#cfn-qbusiness-webexperience-openidconnectproviderconfiguration-secretsarn

secrets_role

An IAM role with permissions to access AWS KMS to decrypt the Secrets Manager secret containing your OIDC client secret.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-webexperience-openidconnectproviderconfiguration.html#cfn-qbusiness-webexperience-openidconnectproviderconfiguration-secretsrole

SamlProviderConfigurationProperty

class CfnWebExperience.SamlProviderConfigurationProperty(*, authentication_url)

Bases: object

Information about the SAML 2.0-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

Parameters:: authentication_url (str) – The URL where Amazon Q Business end users will be redirected for authentication.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-webexperience-samlproviderconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_qbusiness as qbusiness

saml_provider_configuration_property = qbusiness.CfnWebExperience.SamlProviderConfigurationProperty(
    authentication_url="authenticationUrl"
)

Attributes

authentication_url

The URL where Amazon Q Business end users will be redirected for authentication.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-webexperience-samlproviderconfiguration.html#cfn-qbusiness-webexperience-samlproviderconfiguration-authenticationurl