This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html). # Amazon Q Business **Resource types** + [AWS::QBusiness::Application](aws-resource-qbusiness-application.md) + [AWS::QBusiness::DataAccessor](aws-resource-qbusiness-dataaccessor.md) + [AWS::QBusiness::DataSource](aws-resource-qbusiness-datasource.md) + [AWS::QBusiness::Index](aws-resource-qbusiness-index.md) + [AWS::QBusiness::Permission](aws-resource-qbusiness-permission.md) + [AWS::QBusiness::Plugin](aws-resource-qbusiness-plugin.md) + [AWS::QBusiness::Retriever](aws-resource-qbusiness-retriever.md) + [AWS::QBusiness::WebExperience](aws-resource-qbusiness-webexperience.md) # AWS::QBusiness::Application Creates an Amazon Q Business application. **Note** There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are also available in Amazon Q Business Lite. For information on what's included in Amazon Q Business Lite and what's included in Amazon Q Business Pro, see [Amazon Q Business tiers](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tiers.html#user-sub-tiers). You must use the Amazon Q Business console to assign subscription tiers to users. An Amazon Q Apps service linked role will be created if it's absent in the AWS account when `QAppsConfiguration` is enabled in the request. For more information, see [ Using service-linked roles for Q Apps](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/using-service-linked-roles-qapps.html). When you create an application, Amazon Q Business may securely transmit data for processing from your selected AWS region, but within your geography. For more information, see [Cross region inference in Amazon Q Business](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/cross-region-inference.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::QBusiness::Application", "Properties" : { "[AttachmentsConfiguration](#cfn-qbusiness-application-attachmentsconfiguration)" : AttachmentsConfiguration, "[AutoSubscriptionConfiguration](#cfn-qbusiness-application-autosubscriptionconfiguration)" : AutoSubscriptionConfiguration, "[ClientIdsForOIDC](#cfn-qbusiness-application-clientidsforoidc)" : [ String, ... ], "[Description](#cfn-qbusiness-application-description)" : String, "[DisplayName](#cfn-qbusiness-application-displayname)" : String, "[EncryptionConfiguration](#cfn-qbusiness-application-encryptionconfiguration)" : EncryptionConfiguration, "[IamIdentityProviderArn](#cfn-qbusiness-application-iamidentityproviderarn)" : String, "[IdentityCenterInstanceArn](#cfn-qbusiness-application-identitycenterinstancearn)" : String, "[IdentityType](#cfn-qbusiness-application-identitytype)" : String, "[PersonalizationConfiguration](#cfn-qbusiness-application-personalizationconfiguration)" : PersonalizationConfiguration, "[QAppsConfiguration](#cfn-qbusiness-application-qappsconfiguration)" : QAppsConfiguration, "[QuickSightConfiguration](#cfn-qbusiness-application-quicksightconfiguration)" : QuickSightConfiguration, "[RoleArn](#cfn-qbusiness-application-rolearn)" : String, "[Tags](#cfn-qbusiness-application-tags)" : [ Tag, ... ] } } ``` ### YAML ``` Type: AWS::QBusiness::Application Properties: [AttachmentsConfiguration](#cfn-qbusiness-application-attachmentsconfiguration): AttachmentsConfiguration [AutoSubscriptionConfiguration](#cfn-qbusiness-application-autosubscriptionconfiguration): AutoSubscriptionConfiguration [ClientIdsForOIDC](#cfn-qbusiness-application-clientidsforoidc): - String [Description](#cfn-qbusiness-application-description): String [DisplayName](#cfn-qbusiness-application-displayname): String [EncryptionConfiguration](#cfn-qbusiness-application-encryptionconfiguration): EncryptionConfiguration [IamIdentityProviderArn](#cfn-qbusiness-application-iamidentityproviderarn): String [IdentityCenterInstanceArn](#cfn-qbusiness-application-identitycenterinstancearn): String [IdentityType](#cfn-qbusiness-application-identitytype): String [PersonalizationConfiguration](#cfn-qbusiness-application-personalizationconfiguration): PersonalizationConfiguration [QAppsConfiguration](#cfn-qbusiness-application-qappsconfiguration): QAppsConfiguration [QuickSightConfiguration](#cfn-qbusiness-application-quicksightconfiguration): QuickSightConfiguration [RoleArn](#cfn-qbusiness-application-rolearn): String [Tags](#cfn-qbusiness-application-tags): - Tag ``` ## Properties `AttachmentsConfiguration` Configuration information for the file upload during chat feature. *Required*: No *Type*: [AttachmentsConfiguration](aws-properties-qbusiness-application-attachmentsconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AutoSubscriptionConfiguration` Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management. *Required*: No *Type*: [AutoSubscriptionConfiguration](aws-properties-qbusiness-application-autosubscriptionconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ClientIdsForOIDC` The OIDC client ID for a Amazon Q Business application. *Required*: No *Type*: Array of String *Minimum*: `1` *Maximum*: `255` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Description` A description for the Amazon Q Business application. *Required*: No *Type*: String *Pattern*: `^[\s\S]*$` *Minimum*: `0` *Maximum*: `1000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DisplayName` The name of the Amazon Q Business application. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9_-]*$` *Minimum*: `1` *Maximum*: `1000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `EncryptionConfiguration` Provides the identifier of the AWS KMS key used to encrypt data indexed by Amazon Q Business. Amazon Q Business doesn't support asymmetric keys. *Required*: No *Type*: [EncryptionConfiguration](aws-properties-qbusiness-application-encryptionconfiguration.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `IamIdentityProviderArn` The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application. *Required*: No *Type*: String *Pattern*: `^arn:aws:iam::\d{12}:(oidc-provider|saml-provider)/[a-zA-Z0-9_\.\/@\-]+$` *Minimum*: `20` *Maximum*: `2048` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `IdentityCenterInstanceArn` The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application. *Required*: `Yes` *Required*: Conditional *Type*: String *Pattern*: `^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$` *Minimum*: `10` *Maximum*: `1224` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IdentityType` The authentication type being used by a Amazon Q Business application. *Required*: No *Type*: String *Allowed values*: `AWS_IAM_IDP_SAML | AWS_IAM_IDP_OIDC | AWS_IAM_IDC | AWS_QUICKSIGHT_IDP | ANONYMOUS` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `PersonalizationConfiguration` Configuration information about chat response personalization. For more information, see [Personalizing chat responses](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html). *Required*: No *Type*: [PersonalizationConfiguration](aws-properties-qbusiness-application-personalizationconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `QAppsConfiguration` Configuration information about Amazon Q Apps. *Required*: No *Type*: [QAppsConfiguration](aws-properties-qbusiness-application-qappsconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `QuickSightConfiguration` The Amazon Quick configuration for an Amazon Q Business application that uses Quick as the identity provider. *Required*: No *Type*: [QuickSightConfiguration](aws-properties-qbusiness-application-quicksightconfiguration.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `RoleArn` The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics. If this property is not specified, Amazon Q Business will create a [service linked role (SLR)](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/using-service-linked-roles.html#slr-permissions) and use it as the application's role. *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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` A list of key-value pairs that identify or categorize your Amazon Q Business application. You can also use tags to help control access to the application. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: \$1 . : / = \$1 - @. *Required*: No *Type*: Array of [Tag](aws-properties-qbusiness-application-tag.md) *Minimum*: `0` *Maximum*: `200` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the application ID. For example: `{"Ref": "ApplicationId"}` For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `ApplicationArn` The Amazon Resource Name (ARN) of the Amazon Q Business application. `ApplicationId` The identifier for the Amazon Q Business application. `CreatedAt` The Unix timestamp when the Amazon Q Business application was created. `IdentityCenterApplicationArn` The Amazon Resource Name (ARN) of the AWSIAM Identity Center instance attached to your Amazon Q Business application. `Status` The status of the Amazon Q Business application. The application is ready to use when the status is `ACTIVE`. `UpdatedAt` The Unix timestamp when the Amazon Q Business application was last updated. # AWS::QBusiness::Application AttachmentsConfiguration Configuration information for the file upload during chat feature. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AttachmentsControlMode](#cfn-qbusiness-application-attachmentsconfiguration-attachmentscontrolmode)" : String } ``` ### YAML ``` [AttachmentsControlMode](#cfn-qbusiness-application-attachmentsconfiguration-attachmentscontrolmode): String ``` ## Properties `AttachmentsControlMode` Status information about whether file upload functionality is activated or deactivated for your end user. *Required*: Yes *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::Application AutoSubscriptionConfiguration Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AutoSubscribe](#cfn-qbusiness-application-autosubscriptionconfiguration-autosubscribe)" : String, "[DefaultSubscriptionType](#cfn-qbusiness-application-autosubscriptionconfiguration-defaultsubscriptiontype)" : String } ``` ### YAML ``` [AutoSubscribe](#cfn-qbusiness-application-autosubscriptionconfiguration-autosubscribe): String [DefaultSubscriptionType](#cfn-qbusiness-application-autosubscriptionconfiguration-defaultsubscriptiontype): String ``` ## Properties `AutoSubscribe` Describes whether automatic subscriptions are enabled for an Amazon Q Business application using IAM identity federation for user management. *Required*: Yes *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DefaultSubscriptionType` Describes the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management. If the value for `autoSubscribe` is set to `ENABLED` you must select a value for this field. *Required*: No *Type*: String *Allowed values*: `Q_LITE | Q_BUSINESS` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::Application EncryptionConfiguration Provides the identifier of the AWS KMS key used to encrypt data indexed by Amazon Q Business. Amazon Q Business doesn't support asymmetric keys. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[KmsKeyId](#cfn-qbusiness-application-encryptionconfiguration-kmskeyid)" : String } ``` ### YAML ``` [KmsKeyId](#cfn-qbusiness-application-encryptionconfiguration-kmskeyid): String ``` ## Properties `KmsKeyId` The identifier of the AWS KMS key. Amazon Q Business doesn't support asymmetric keys. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `2048` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::QBusiness::Application PersonalizationConfiguration Configuration information about chat response personalization. For more information, see [Personalizing chat responses](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[PersonalizationControlMode](#cfn-qbusiness-application-personalizationconfiguration-personalizationcontrolmode)" : String } ``` ### YAML ``` [PersonalizationControlMode](#cfn-qbusiness-application-personalizationconfiguration-personalizationcontrolmode): String ``` ## Properties `PersonalizationControlMode` An option to allow Amazon Q Business to customize chat responses using user specific metadata—specifically, location and job information—in your IAM Identity Center instance. *Required*: Yes *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::Application QAppsConfiguration Configuration information about Amazon Q Apps. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[QAppsControlMode](#cfn-qbusiness-application-qappsconfiguration-qappscontrolmode)" : String } ``` ### YAML ``` [QAppsControlMode](#cfn-qbusiness-application-qappsconfiguration-qappscontrolmode): String ``` ## Properties `QAppsControlMode` Status information about whether end users can create and use Amazon Q Apps in the web experience. *Required*: Yes *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::Application QuickSightConfiguration The Amazon Quick configuration for an Amazon Q Business application that uses Quick as the identity provider. For more information, see [Creating an Amazon Quick integrated application](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/create-quicksight-integrated-application.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ClientNamespace](#cfn-qbusiness-application-quicksightconfiguration-clientnamespace)" : String } ``` ### YAML ``` [ClientNamespace](#cfn-qbusiness-application-quicksightconfiguration-clientnamespace): String ``` ## Properties `ClientNamespace` The Amazon Quick namespace that is used as the identity provider. For more information about Quick namespaces, see [Namespace operations](https://docs.aws.amazon.com/quicksight/latest/developerguide/namespace-operations.html). *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9._-]*$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::QBusiness::Application Tag A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: \$1 . : / = \$1 - @. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-qbusiness-application-tag-key)" : String, "[Value](#cfn-qbusiness-application-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-qbusiness-application-tag-key): String [Value](#cfn-qbusiness-application-tag-value): String ``` ## Properties `Key` The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value associated with the tag. The value may be an empty string but it can't be null. *Required*: Yes *Type*: String *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::DataAccessor Creates a new data accessor for an ISV to access data from a Amazon Q Business application. The data accessor is an entity that represents the ISV's access to the Amazon Q Business application's data. It includes the IAM role ARN for the ISV, a friendly name, and a set of action configurations that define the specific actions the ISV is allowed to perform and any associated data filters. When the data accessor is created, an IAM Identity Center application is also created to manage the ISV's identity and authentication for accessing the Amazon Q Business application. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::QBusiness::DataAccessor", "Properties" : { "[ActionConfigurations](#cfn-qbusiness-dataaccessor-actionconfigurations)" : [ ActionConfiguration, ... ], "[ApplicationId](#cfn-qbusiness-dataaccessor-applicationid)" : String, "[AuthenticationDetail](#cfn-qbusiness-dataaccessor-authenticationdetail)" : DataAccessorAuthenticationDetail, "[DisplayName](#cfn-qbusiness-dataaccessor-displayname)" : String, "[Principal](#cfn-qbusiness-dataaccessor-principal)" : String, "[Tags](#cfn-qbusiness-dataaccessor-tags)" : [ Tag, ... ] } } ``` ### YAML ``` Type: AWS::QBusiness::DataAccessor Properties: [ActionConfigurations](#cfn-qbusiness-dataaccessor-actionconfigurations): - ActionConfiguration [ApplicationId](#cfn-qbusiness-dataaccessor-applicationid): String [AuthenticationDetail](#cfn-qbusiness-dataaccessor-authenticationdetail): DataAccessorAuthenticationDetail [DisplayName](#cfn-qbusiness-dataaccessor-displayname): String [Principal](#cfn-qbusiness-dataaccessor-principal): String [Tags](#cfn-qbusiness-dataaccessor-tags): - Tag ``` ## Properties `ActionConfigurations` A list of action configurations specifying the allowed actions and any associated filters. *Required*: Yes *Type*: Array of [ActionConfiguration](aws-properties-qbusiness-dataaccessor-actionconfiguration.md) *Minimum*: `1` *Maximum*: `10` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ApplicationId` The unique identifier of the Amazon Q Business application. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9-]{35}$` *Minimum*: `36` *Maximum*: `36` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `AuthenticationDetail` The authentication configuration details for the data accessor. This specifies how the ISV authenticates when accessing data through this data accessor. *Required*: No *Type*: [DataAccessorAuthenticationDetail](aws-properties-qbusiness-dataaccessor-dataaccessorauthenticationdetail.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DisplayName` The friendly name of the data accessor. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9_-]*$` *Minimum*: `1` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Principal` The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor. *Required*: Yes *Type*: String *Pattern*: `^arn:aws:iam::[0-9]{12}:role/[a-zA-Z0-9_/+=,.@-]+$` *Minimum*: `1` *Maximum*: `1284` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Tags` The tags to associate with the data accessor. *Required*: No *Type*: Array of [Tag](aws-properties-qbusiness-dataaccessor-tag.md) *Minimum*: `0` *Maximum*: `200` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the application and data accessor ID. For example: `{"Ref": "ApplicationId|DataAccessorId"}` For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `CreatedAt` The timestamp when the data accessor was created. `DataAccessorArn` The Amazon Resource Name (ARN) of the data accessor. `DataAccessorId` The unique identifier of the data accessor. `IdcApplicationArn` The Amazon Resource Name (ARN) of the associated IAM Identity Center application. `UpdatedAt` The timestamp when the data accessor was last updated. # AWS::QBusiness::DataAccessor ActionConfiguration Specifies an allowed action and its associated filter configuration. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Action](#cfn-qbusiness-dataaccessor-actionconfiguration-action)" : String, "[FilterConfiguration](#cfn-qbusiness-dataaccessor-actionconfiguration-filterconfiguration)" : ActionFilterConfiguration } ``` ### YAML ``` [Action](#cfn-qbusiness-dataaccessor-actionconfiguration-action): String [FilterConfiguration](#cfn-qbusiness-dataaccessor-actionconfiguration-filterconfiguration): ActionFilterConfiguration ``` ## Properties `Action` The Amazon Q Business action that is allowed. *Required*: Yes *Type*: String *Pattern*: `^qbusiness:[a-zA-Z]+$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FilterConfiguration` The filter configuration for the action, if any. *Required*: No *Type*: [ActionFilterConfiguration](aws-properties-qbusiness-dataaccessor-actionfilterconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::DataAccessor ActionFilterConfiguration Specifies filters to apply to an allowed action. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DocumentAttributeFilter](#cfn-qbusiness-dataaccessor-actionfilterconfiguration-documentattributefilter)" : AttributeFilter } ``` ### YAML ``` [DocumentAttributeFilter](#cfn-qbusiness-dataaccessor-actionfilterconfiguration-documentattributefilter): AttributeFilter ``` ## Properties `DocumentAttributeFilter` Enables filtering of responses based on document attributes or metadata fields. *Required*: Yes *Type*: [AttributeFilter](aws-properties-qbusiness-dataaccessor-attributefilter.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::DataAccessor AttributeFilter Enables filtering of responses based on document attributes or metadata fields. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AndAllFilters](#cfn-qbusiness-dataaccessor-attributefilter-andallfilters)" : [ AttributeFilter, ... ], "[ContainsAll](#cfn-qbusiness-dataaccessor-attributefilter-containsall)" : DocumentAttribute, "[ContainsAny](#cfn-qbusiness-dataaccessor-attributefilter-containsany)" : DocumentAttribute, "[EqualsTo](#cfn-qbusiness-dataaccessor-attributefilter-equalsto)" : DocumentAttribute, "[GreaterThan](#cfn-qbusiness-dataaccessor-attributefilter-greaterthan)" : DocumentAttribute, "[GreaterThanOrEquals](#cfn-qbusiness-dataaccessor-attributefilter-greaterthanorequals)" : DocumentAttribute, "[LessThan](#cfn-qbusiness-dataaccessor-attributefilter-lessthan)" : DocumentAttribute, "[LessThanOrEquals](#cfn-qbusiness-dataaccessor-attributefilter-lessthanorequals)" : DocumentAttribute, "[NotFilter](#cfn-qbusiness-dataaccessor-attributefilter-notfilter)" : AttributeFilter, "[OrAllFilters](#cfn-qbusiness-dataaccessor-attributefilter-orallfilters)" : [ AttributeFilter, ... ] } ``` ### YAML ``` [AndAllFilters](#cfn-qbusiness-dataaccessor-attributefilter-andallfilters): - AttributeFilter [ContainsAll](#cfn-qbusiness-dataaccessor-attributefilter-containsall): DocumentAttribute [ContainsAny](#cfn-qbusiness-dataaccessor-attributefilter-containsany): DocumentAttribute [EqualsTo](#cfn-qbusiness-dataaccessor-attributefilter-equalsto): DocumentAttribute [GreaterThan](#cfn-qbusiness-dataaccessor-attributefilter-greaterthan): DocumentAttribute [GreaterThanOrEquals](#cfn-qbusiness-dataaccessor-attributefilter-greaterthanorequals): DocumentAttribute [LessThan](#cfn-qbusiness-dataaccessor-attributefilter-lessthan): DocumentAttribute [LessThanOrEquals](#cfn-qbusiness-dataaccessor-attributefilter-lessthanorequals): DocumentAttribute [NotFilter](#cfn-qbusiness-dataaccessor-attributefilter-notfilter): AttributeFilter [OrAllFilters](#cfn-qbusiness-dataaccessor-attributefilter-orallfilters): - AttributeFilter ``` ## Properties `AndAllFilters` Performs a logical `AND` operation on all supplied filters. *Required*: No *Type*: Array of [AttributeFilter](#aws-properties-qbusiness-dataaccessor-attributefilter) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ContainsAll` Returns `true` when a document contains all the specified document attributes or metadata fields. Supported for the following [document attribute value types](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html): `stringListValue`. *Required*: No *Type*: [DocumentAttribute](aws-properties-qbusiness-dataaccessor-documentattribute.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ContainsAny` Returns `true` when a document contains any of the specified document attributes or metadata fields. Supported for the following [document attribute value types](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html): `stringListValue`. *Required*: No *Type*: [DocumentAttribute](aws-properties-qbusiness-dataaccessor-documentattribute.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `EqualsTo` Performs an equals operation on two document attributes or metadata fields. Supported for the following [document attribute value types](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html): `dateValue`, `longValue`, `stringListValue` and `stringValue`. *Required*: No *Type*: [DocumentAttribute](aws-properties-qbusiness-dataaccessor-documentattribute.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `GreaterThan` Performs a greater than operation on two document attributes or metadata fields. Supported for the following [document attribute value types](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html): `dateValue` and `longValue`. *Required*: No *Type*: [DocumentAttribute](aws-properties-qbusiness-dataaccessor-documentattribute.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `GreaterThanOrEquals` Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following [document attribute value types](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html): `dateValue` and `longValue`. *Required*: No *Type*: [DocumentAttribute](aws-properties-qbusiness-dataaccessor-documentattribute.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LessThan` Performs a less than operation on two document attributes or metadata fields. Supported for the following [document attribute value types](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html): `dateValue` and `longValue`. *Required*: No *Type*: [DocumentAttribute](aws-properties-qbusiness-dataaccessor-documentattribute.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LessThanOrEquals` Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following [document attribute value type](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html): `dateValue` and `longValue`. *Required*: No *Type*: [DocumentAttribute](aws-properties-qbusiness-dataaccessor-documentattribute.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `NotFilter` Performs a logical `NOT` operation on all supplied filters. *Required*: No *Type*: [AttributeFilter](#aws-properties-qbusiness-dataaccessor-attributefilter) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OrAllFilters` Performs a logical `OR` operation on all supplied filters. *Required*: No *Type*: Array of [AttributeFilter](#aws-properties-qbusiness-dataaccessor-attributefilter) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::DataAccessor DataAccessorAuthenticationConfiguration A union type that contains the specific authentication configuration based on the authentication type selected. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[IdcTrustedTokenIssuerConfiguration](#cfn-qbusiness-dataaccessor-dataaccessorauthenticationconfiguration-idctrustedtokenissuerconfiguration)" : DataAccessorIdcTrustedTokenIssuerConfiguration } ``` ### YAML ``` [IdcTrustedTokenIssuerConfiguration](#cfn-qbusiness-dataaccessor-dataaccessorauthenticationconfiguration-idctrustedtokenissuerconfiguration): DataAccessorIdcTrustedTokenIssuerConfiguration ``` ## Properties `IdcTrustedTokenIssuerConfiguration` Configuration for IAM Identity Center Trusted Token Issuer (TTI) authentication used when the authentication type is `AWS_IAM_IDC_TTI`. *Required*: Yes *Type*: [DataAccessorIdcTrustedTokenIssuerConfiguration](aws-properties-qbusiness-dataaccessor-dataaccessoridctrustedtokenissuerconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::DataAccessor DataAccessorAuthenticationDetail Contains the authentication configuration details for a data accessor. This structure defines how the ISV authenticates when accessing data through the data accessor. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AuthenticationConfiguration](#cfn-qbusiness-dataaccessor-dataaccessorauthenticationdetail-authenticationconfiguration)" : DataAccessorAuthenticationConfiguration, "[AuthenticationType](#cfn-qbusiness-dataaccessor-dataaccessorauthenticationdetail-authenticationtype)" : String, "[ExternalIds](#cfn-qbusiness-dataaccessor-dataaccessorauthenticationdetail-externalids)" : [ String, ... ] } ``` ### YAML ``` [AuthenticationConfiguration](#cfn-qbusiness-dataaccessor-dataaccessorauthenticationdetail-authenticationconfiguration): DataAccessorAuthenticationConfiguration [AuthenticationType](#cfn-qbusiness-dataaccessor-dataaccessorauthenticationdetail-authenticationtype): String [ExternalIds](#cfn-qbusiness-dataaccessor-dataaccessorauthenticationdetail-externalids): - String ``` ## Properties `AuthenticationConfiguration` The specific authentication configuration based on the authentication type. *Required*: No *Type*: [DataAccessorAuthenticationConfiguration](aws-properties-qbusiness-dataaccessor-dataaccessorauthenticationconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AuthenticationType` The type of authentication to use for the data accessor. This determines how the ISV authenticates when accessing data. You can use one of two authentication types: + `AWS_IAM_IDC_TTI` - Authentication using IAM Identity Center Trusted Token Issuer (TTI). This authentication type allows the ISV to use a trusted token issuer to generate tokens for accessing the data. + `AWS_IAM_IDC_AUTH_CODE` - Authentication using IAM Identity Center authorization code flow. This authentication type uses the standard OAuth 2.0 authorization code flow for authentication. *Required*: Yes *Type*: String *Allowed values*: `AWS_IAM_IDC_TTI | AWS_IAM_IDC_AUTH_CODE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ExternalIds` A list of external identifiers associated with this authentication configuration. These are used to correlate the data accessor with external systems. *Required*: No *Type*: Array of String *Minimum*: `1 | 1` *Maximum*: `1000 | 1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::DataAccessor DataAccessorIdcTrustedTokenIssuerConfiguration Configuration details for IAM Identity Center Trusted Token Issuer (TTI) authentication. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[IdcTrustedTokenIssuerArn](#cfn-qbusiness-dataaccessor-dataaccessoridctrustedtokenissuerconfiguration-idctrustedtokenissuerarn)" : String } ``` ### YAML ``` [IdcTrustedTokenIssuerArn](#cfn-qbusiness-dataaccessor-dataaccessoridctrustedtokenissuerconfiguration-idctrustedtokenissuerarn): String ``` ## Properties `IdcTrustedTokenIssuerArn` The Amazon Resource Name (ARN) of the IAM Identity Center Trusted Token Issuer that will be used for authentication. *Required*: Yes *Type*: String *Pattern*: `^arn:aws:sso::[0-9]{12}:trustedTokenIssuer/(sso)?ins-[a-zA-Z0-9-.]{16}/tti-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` *Minimum*: `0` *Maximum*: `1284` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::DataAccessor DocumentAttribute A document attribute or metadata field. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Name](#cfn-qbusiness-dataaccessor-documentattribute-name)" : String, "[Value](#cfn-qbusiness-dataaccessor-documentattribute-value)" : DocumentAttributeValue } ``` ### YAML ``` [Name](#cfn-qbusiness-dataaccessor-documentattribute-name): String [Value](#cfn-qbusiness-dataaccessor-documentattribute-value): DocumentAttributeValue ``` ## Properties `Name` The identifier for the attribute. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9_][a-zA-Z0-9_-]*$` *Minimum*: `1` *Maximum*: `200` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value of the attribute. *Required*: Yes *Type*: [DocumentAttributeValue](aws-properties-qbusiness-dataaccessor-documentattributevalue.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::DataAccessor DocumentAttributeValue The value of a document attribute. You can only provide one value for a document attribute. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DateValue](#cfn-qbusiness-dataaccessor-documentattributevalue-datevalue)" : String, "[LongValue](#cfn-qbusiness-dataaccessor-documentattributevalue-longvalue)" : Number, "[StringListValue](#cfn-qbusiness-dataaccessor-documentattributevalue-stringlistvalue)" : [ String, ... ], "[StringValue](#cfn-qbusiness-dataaccessor-documentattributevalue-stringvalue)" : String } ``` ### YAML ``` [DateValue](#cfn-qbusiness-dataaccessor-documentattributevalue-datevalue): String [LongValue](#cfn-qbusiness-dataaccessor-documentattributevalue-longvalue): Number [StringListValue](#cfn-qbusiness-dataaccessor-documentattributevalue-stringlistvalue): - String [StringValue](#cfn-qbusiness-dataaccessor-documentattributevalue-stringvalue): String ``` ## Properties `DateValue` A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10\$101:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LongValue` A long integer value. *Required*: No *Type*: Number *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `StringListValue` A list of strings. *Required*: No *Type*: Array of String *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `StringValue` A string. *Required*: No *Type*: String *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::DataAccessor Tag A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: \$1 . : / = \$1 - @. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-qbusiness-dataaccessor-tag-key)" : String, "[Value](#cfn-qbusiness-dataaccessor-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-qbusiness-dataaccessor-tag-key): String [Value](#cfn-qbusiness-dataaccessor-tag-value): String ``` ## Properties `Key` The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value associated with the tag. The value may be an empty string but it can't be null. *Required*: Yes *Type*: String *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::DataSource Creates a data source connector for an Amazon Q Business application. `CreateDataSource` is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::QBusiness::DataSource", "Properties" : { "[ApplicationId](#cfn-qbusiness-datasource-applicationid)" : String, "[Configuration](#cfn-qbusiness-datasource-configuration)" : , "[Description](#cfn-qbusiness-datasource-description)" : String, "[DisplayName](#cfn-qbusiness-datasource-displayname)" : String, "[DocumentEnrichmentConfiguration](#cfn-qbusiness-datasource-documentenrichmentconfiguration)" : DocumentEnrichmentConfiguration, "[IndexId](#cfn-qbusiness-datasource-indexid)" : String, "[MediaExtractionConfiguration](#cfn-qbusiness-datasource-mediaextractionconfiguration)" : MediaExtractionConfiguration, "[RoleArn](#cfn-qbusiness-datasource-rolearn)" : String, "[SyncSchedule](#cfn-qbusiness-datasource-syncschedule)" : String, "[Tags](#cfn-qbusiness-datasource-tags)" : [ Tag, ... ], "[VpcConfiguration](#cfn-qbusiness-datasource-vpcconfiguration)" : DataSourceVpcConfiguration } } ``` ### YAML ``` Type: AWS::QBusiness::DataSource Properties: [ApplicationId](#cfn-qbusiness-datasource-applicationid): String [Configuration](#cfn-qbusiness-datasource-configuration): [Description](#cfn-qbusiness-datasource-description): String [DisplayName](#cfn-qbusiness-datasource-displayname): String [DocumentEnrichmentConfiguration](#cfn-qbusiness-datasource-documentenrichmentconfiguration): DocumentEnrichmentConfiguration [IndexId](#cfn-qbusiness-datasource-indexid): String [MediaExtractionConfiguration](#cfn-qbusiness-datasource-mediaextractionconfiguration): MediaExtractionConfiguration [RoleArn](#cfn-qbusiness-datasource-rolearn): String [SyncSchedule](#cfn-qbusiness-datasource-syncschedule): String [Tags](#cfn-qbusiness-datasource-tags): - Tag [VpcConfiguration](#cfn-qbusiness-datasource-vpcconfiguration): DataSourceVpcConfiguration ``` ## Properties `ApplicationId` The identifier of the Amazon Q Business application the data source will be attached to. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9-]{35}$` *Minimum*: `36` *Maximum*: `36` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Configuration` Use this property to specify a JSON or YAML schema with configuration properties specific to your data source connector to connect your data source repository to Amazon Q Business. You must use the JSON or YAML schema provided by Amazon Q. The following links have the configuration properties and schemas for AWS CloudFormation for the following connectors: + [Amazon Simple Storage Service](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/s3-cfn.html) + [Amazon Q Web Crawler](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/web-crawler-cfn.html) Similarly, you can find configuration templates and properties for your specific data source using the following steps: 1. Navigate to the [Supported connectors](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connectors-list.html) page in the Amazon Q Business User Guide, and select the data source connector of your choice. 1. Then, from that specific data source connector's page, choose the topic containing **Using CloudFormation** to find the schemas for your data source connector, including configuration parameter descriptions and examples. *Required*: Yes *Type*: *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Description` A description for the data source connector. *Required*: No *Type*: String *Pattern*: `^[\s\S]*$` *Minimum*: `0` *Maximum*: `1000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DisplayName` The name of the Amazon Q Business data source. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9_-]*$` *Minimum*: `1` *Maximum*: `1000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DocumentEnrichmentConfiguration` Provides the configuration information for altering document metadata and content during the document ingestion process. For more information, see [Custom document enrichment](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html). *Required*: No *Type*: [DocumentEnrichmentConfiguration](aws-properties-qbusiness-datasource-documentenrichmentconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IndexId` The identifier of the index the data source is attached to. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9-]{35}$` *Minimum*: `36` *Maximum*: `36` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `MediaExtractionConfiguration` The configuration for extracting information from media in documents. *Required*: No *Type*: [MediaExtractionConfiguration](aws-properties-qbusiness-datasource-mediaextractionconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RoleArn` The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources. This field is required for all connector types except custom connectors, where it is optional. *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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SyncSchedule` Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index. If you don't set a schedule, Amazon Q Business won't periodically update the index. Specify a `cron-` format schedule string or an empty string to indicate that the index is updated on demand. You can't specify the `Schedule` parameter when the `Type` parameter is set to `CUSTOM`. If you do, you receive a `ValidationException` exception. *Required*: No *Type*: String *Pattern*: `^[\s\S]*$` *Maximum*: `998` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: \$1 . : / = \$1 - @. *Required*: No *Type*: Array of [Tag](aws-properties-qbusiness-datasource-tag.md) *Minimum*: `0` *Maximum*: `200` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `VpcConfiguration` Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. For more information, see [Using Amazon VPC with Amazon Q Business connectors](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connector-vpc.html). *Required*: No *Type*: [DataSourceVpcConfiguration](aws-properties-qbusiness-datasource-datasourcevpcconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the application ID, data source ID, and index ID. For example: `{"Ref": "ApplicationId|DataSourceId|IndexId"}` For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `CreatedAt` The Unix timestamp when the Amazon Q Business data source was created. `DataSourceArn` The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application. `DataSourceId` The identifier of the Amazon Q Business data source. `Status` The status of the Amazon Q Business data source. `Type` The type of the Amazon Q Business data source. `UpdatedAt` The Unix timestamp when the Amazon Q Business data source was last updated. # AWS::QBusiness::DataSource AudioExtractionConfiguration Configuration settings for audio content extraction and processing. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AudioExtractionStatus](#cfn-qbusiness-datasource-audioextractionconfiguration-audioextractionstatus)" : String } ``` ### YAML ``` [AudioExtractionStatus](#cfn-qbusiness-datasource-audioextractionconfiguration-audioextractionstatus): String ``` ## Properties `AudioExtractionStatus` The status of audio extraction (ENABLED or DISABLED) for processing audio content from files. *Required*: Yes *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::DataSource DataSourceVpcConfiguration Provides configuration information needed to connect to an Amazon VPC (Virtual Private Cloud). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[SecurityGroupIds](#cfn-qbusiness-datasource-datasourcevpcconfiguration-securitygroupids)" : [ String, ... ], "[SubnetIds](#cfn-qbusiness-datasource-datasourcevpcconfiguration-subnetids)" : [ String, ... ] } ``` ### YAML ``` [SecurityGroupIds](#cfn-qbusiness-datasource-datasourcevpcconfiguration-securitygroupids): - String [SubnetIds](#cfn-qbusiness-datasource-datasourcevpcconfiguration-subnetids): - String ``` ## Properties `SecurityGroupIds` A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Q Business to connect to the data source. *Required*: Yes *Type*: Array of String *Minimum*: `1 | 1` *Maximum*: `200 | 10` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SubnetIds` A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device. *Required*: Yes *Type*: Array of String *Minimum*: `1` *Maximum*: `200` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::DataSource DocumentAttributeCondition The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business. You use this with [https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html) to apply the condition. For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source\$1URI' field. Set the condition that if the 'Source\$1URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document. Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using `DocumentAttributeTarget`. Amazon Q Business then will map your newly created metadata field to your index field. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-qbusiness-datasource-documentattributecondition-key)" : String, "[Operator](#cfn-qbusiness-datasource-documentattributecondition-operator)" : String, "[Value](#cfn-qbusiness-datasource-documentattributecondition-value)" : DocumentAttributeValue } ``` ### YAML ``` [Key](#cfn-qbusiness-datasource-documentattributecondition-key): String [Operator](#cfn-qbusiness-datasource-documentattributecondition-operator): String [Value](#cfn-qbusiness-datasource-documentattributecondition-value): DocumentAttributeValue ``` ## Properties `Key` The identifier of the document attribute used for the condition. For example, 'Source\$1URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon Q Business currently doesn't support `_document_body` as an attribute key used for the condition. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9_][a-zA-Z0-9_-]*$` *Minimum*: `1` *Maximum*: `200` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Operator` The identifier of the document attribute used for the condition. For example, 'Source\$1URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon Q Business currently does not support `_document_body` as an attribute key used for the condition. *Required*: Yes *Type*: String *Allowed values*: `GREATER_THAN | GREATER_THAN_OR_EQUALS | LESS_THAN | LESS_THAN_OR_EQUALS | EQUALS | NOT_EQUALS | CONTAINS | NOT_CONTAINS | EXISTS | NOT_EXISTS | BEGINS_WITH` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value of a document attribute. You can only provide one value for a document attribute. *Required*: No *Type*: [DocumentAttributeValue](aws-properties-qbusiness-datasource-documentattributevalue.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::DataSource DocumentAttributeTarget The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business. For example, you can delete all customer identification numbers associated with the documents, stored in the document metadata field called 'Customer\$1ID' by setting the target key as 'Customer\$1ID' and the deletion flag to `TRUE`. This removes all customer ID values in the field 'Customer\$1ID'. This would scrub personally identifiable information from each document's metadata. Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using [https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html). Amazon Q Business will then map your newly created document attribute to your index field. You can also use this with [https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeCondition.html](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeCondition.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AttributeValueOperator](#cfn-qbusiness-datasource-documentattributetarget-attributevalueoperator)" : String, "[Key](#cfn-qbusiness-datasource-documentattributetarget-key)" : String, "[Value](#cfn-qbusiness-datasource-documentattributetarget-value)" : DocumentAttributeValue } ``` ### YAML ``` [AttributeValueOperator](#cfn-qbusiness-datasource-documentattributetarget-attributevalueoperator): String [Key](#cfn-qbusiness-datasource-documentattributetarget-key): String [Value](#cfn-qbusiness-datasource-documentattributetarget-value): DocumentAttributeValue ``` ## Properties `AttributeValueOperator` `TRUE` to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to `TRUE`. *Required*: No *Type*: String *Allowed values*: `DELETE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Key` The identifier of the target document attribute or metadata field. For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9_][a-zA-Z0-9_-]*$` *Minimum*: `1` *Maximum*: `200` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value of a document attribute. You can only provide one value for a document attribute. *Required*: No *Type*: [DocumentAttributeValue](aws-properties-qbusiness-datasource-documentattributevalue.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::DataSource DocumentAttributeValue The value of a document attribute. You can only provide one value for a document attribute. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DateValue](#cfn-qbusiness-datasource-documentattributevalue-datevalue)" : String, "[LongValue](#cfn-qbusiness-datasource-documentattributevalue-longvalue)" : Number, "[StringListValue](#cfn-qbusiness-datasource-documentattributevalue-stringlistvalue)" : [ String, ... ], "[StringValue](#cfn-qbusiness-datasource-documentattributevalue-stringvalue)" : String } ``` ### YAML ``` [DateValue](#cfn-qbusiness-datasource-documentattributevalue-datevalue): String [LongValue](#cfn-qbusiness-datasource-documentattributevalue-longvalue): Number [StringListValue](#cfn-qbusiness-datasource-documentattributevalue-stringlistvalue): - String [StringValue](#cfn-qbusiness-datasource-documentattributevalue-stringvalue): String ``` ## Properties `DateValue` A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10\$101:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LongValue` A long integer value. *Required*: No *Type*: Number *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `StringListValue` A list of strings. *Required*: No *Type*: Array of String *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `StringValue` A string. *Required*: No *Type*: String *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::DataSource DocumentEnrichmentConfiguration Provides the configuration information for altering document metadata and content during the document ingestion process. For more information, see [Custom document enrichment](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[InlineConfigurations](#cfn-qbusiness-datasource-documentenrichmentconfiguration-inlineconfigurations)" : [ InlineDocumentEnrichmentConfiguration, ... ], "[PostExtractionHookConfiguration](#cfn-qbusiness-datasource-documentenrichmentconfiguration-postextractionhookconfiguration)" : HookConfiguration, "[PreExtractionHookConfiguration](#cfn-qbusiness-datasource-documentenrichmentconfiguration-preextractionhookconfiguration)" : HookConfiguration } ``` ### YAML ``` [InlineConfigurations](#cfn-qbusiness-datasource-documentenrichmentconfiguration-inlineconfigurations): - InlineDocumentEnrichmentConfiguration [PostExtractionHookConfiguration](#cfn-qbusiness-datasource-documentenrichmentconfiguration-postextractionhookconfiguration): HookConfiguration [PreExtractionHookConfiguration](#cfn-qbusiness-datasource-documentenrichmentconfiguration-preextractionhookconfiguration): HookConfiguration ``` ## Properties `InlineConfigurations` Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business. *Required*: No *Type*: Array of [InlineDocumentEnrichmentConfiguration](aws-properties-qbusiness-datasource-inlinedocumentenrichmentconfiguration.md) *Minimum*: `1` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PostExtractionHookConfiguration` Configuration information for invoking a Lambda function in AWS Lambda on the structured documents with their metadata and text extracted. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see [Using Lambda functions](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/cde-lambda-operations.html). *Required*: No *Type*: [HookConfiguration](aws-properties-qbusiness-datasource-hookconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PreExtractionHookConfiguration` Configuration information for invoking a Lambda function in AWS Lambda on the original or raw documents before extracting their metadata and text. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see [Using Lambda functions](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/cde-lambda-operations.html). *Required*: No *Type*: [HookConfiguration](aws-properties-qbusiness-datasource-hookconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::DataSource HookConfiguration Provides the configuration information for invoking a Lambda function in AWS Lambda to alter document metadata and content when ingesting documents into Amazon Q Business. You can configure your Lambda function using the `PreExtractionHookConfiguration` parameter if you want to apply advanced alterations on the original or raw documents. If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using `PostExtractionHookConfiguration`. You can only invoke one Lambda function. However, this function can invoke other functions it requires. For more information, see [Custom document enrichment](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[InvocationCondition](#cfn-qbusiness-datasource-hookconfiguration-invocationcondition)" : DocumentAttributeCondition, "[LambdaArn](#cfn-qbusiness-datasource-hookconfiguration-lambdaarn)" : String, "[RoleArn](#cfn-qbusiness-datasource-hookconfiguration-rolearn)" : String, "[S3BucketName](#cfn-qbusiness-datasource-hookconfiguration-s3bucketname)" : String } ``` ### YAML ``` [InvocationCondition](#cfn-qbusiness-datasource-hookconfiguration-invocationcondition): DocumentAttributeCondition [LambdaArn](#cfn-qbusiness-datasource-hookconfiguration-lambdaarn): String [RoleArn](#cfn-qbusiness-datasource-hookconfiguration-rolearn): String [S3BucketName](#cfn-qbusiness-datasource-hookconfiguration-s3bucketname): String ``` ## Properties `InvocationCondition` The condition used for when a Lambda function should be invoked. For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time. *Required*: No *Type*: [DocumentAttributeCondition](aws-properties-qbusiness-datasource-documentattributecondition.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LambdaArn` The Amazon Resource Name (ARN) of the Lambda function during ingestion. For more information, see [Using Lambda functions for Amazon Q Business document enrichment](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/cde-lambda-operations.html). *Required*: No *Type*: String *Pattern*: `^arn:aws[a-zA-Z-]*:lambda:[a-z-]*-[0-9]:[0-9]{12}:function:[a-zA-Z0-9-_]+(/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?(:[a-zA-Z0-9-_]+)?$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RoleArn` The Amazon Resource Name (ARN) of a role with permission to run `PreExtractionHookConfiguration` and `PostExtractionHookConfiguration` for altering document metadata and content during the document ingestion process. *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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `S3BucketName` Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see [Data contracts for Lambda functions](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/cde-lambda-operations.html#cde-lambda-operations-data-contracts). *Required*: No *Type*: String *Pattern*: `^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$` *Minimum*: `1` *Maximum*: `63` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::DataSource ImageExtractionConfiguration The configuration for extracting semantic meaning from images in documents. For more information, see [Extracting semantic meaning from images and visuals](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/extracting-meaning-from-images.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ImageExtractionStatus](#cfn-qbusiness-datasource-imageextractionconfiguration-imageextractionstatus)" : String } ``` ### YAML ``` [ImageExtractionStatus](#cfn-qbusiness-datasource-imageextractionconfiguration-imageextractionstatus): String ``` ## Properties `ImageExtractionStatus` Specify whether to extract semantic meaning from images and visuals from documents. *Required*: Yes *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::DataSource InlineDocumentEnrichmentConfiguration Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Q Business. To apply advanced logic, to go beyond what you can do with basic logic, see [https://docs.aws.amazon.com/amazonq/latest/api-reference/API_HookConfiguration.html](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_HookConfiguration.html). For more information, see [Custom document enrichment](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Condition](#cfn-qbusiness-datasource-inlinedocumentenrichmentconfiguration-condition)" : DocumentAttributeCondition, "[DocumentContentOperator](#cfn-qbusiness-datasource-inlinedocumentenrichmentconfiguration-documentcontentoperator)" : String, "[Target](#cfn-qbusiness-datasource-inlinedocumentenrichmentconfiguration-target)" : DocumentAttributeTarget } ``` ### YAML ``` [Condition](#cfn-qbusiness-datasource-inlinedocumentenrichmentconfiguration-condition): DocumentAttributeCondition [DocumentContentOperator](#cfn-qbusiness-datasource-inlinedocumentenrichmentconfiguration-documentcontentoperator): String [Target](#cfn-qbusiness-datasource-inlinedocumentenrichmentconfiguration-target): DocumentAttributeTarget ``` ## Properties `Condition` Configuration of the condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business. *Required*: No *Type*: [DocumentAttributeCondition](aws-properties-qbusiness-datasource-documentattributecondition.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DocumentContentOperator` `TRUE` to delete content if the condition used for the target attribute is met. *Required*: No *Type*: String *Allowed values*: `DELETE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Target` Configuration of the target document attribute or metadata field when ingesting documents into Amazon Q Business. You can also include a value. *Required*: No *Type*: [DocumentAttributeTarget](aws-properties-qbusiness-datasource-documentattributetarget.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::DataSource MediaExtractionConfiguration The configuration for extracting information from media in documents. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AudioExtractionConfiguration](#cfn-qbusiness-datasource-mediaextractionconfiguration-audioextractionconfiguration)" : AudioExtractionConfiguration, "[ImageExtractionConfiguration](#cfn-qbusiness-datasource-mediaextractionconfiguration-imageextractionconfiguration)" : ImageExtractionConfiguration, "[VideoExtractionConfiguration](#cfn-qbusiness-datasource-mediaextractionconfiguration-videoextractionconfiguration)" : VideoExtractionConfiguration } ``` ### YAML ``` [AudioExtractionConfiguration](#cfn-qbusiness-datasource-mediaextractionconfiguration-audioextractionconfiguration): AudioExtractionConfiguration [ImageExtractionConfiguration](#cfn-qbusiness-datasource-mediaextractionconfiguration-imageextractionconfiguration): ImageExtractionConfiguration [VideoExtractionConfiguration](#cfn-qbusiness-datasource-mediaextractionconfiguration-videoextractionconfiguration): VideoExtractionConfiguration ``` ## Properties `AudioExtractionConfiguration` Configuration settings for extracting and processing audio content from media files. *Required*: No *Type*: [AudioExtractionConfiguration](aws-properties-qbusiness-datasource-audioextractionconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ImageExtractionConfiguration` The configuration for extracting semantic meaning from images in documents. For more information, see [Extracting semantic meaning from images and visuals](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/extracting-meaning-from-images.html). *Required*: No *Type*: [ImageExtractionConfiguration](aws-properties-qbusiness-datasource-imageextractionconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `VideoExtractionConfiguration` Configuration settings for extracting and processing video content from media files. *Required*: No *Type*: [VideoExtractionConfiguration](aws-properties-qbusiness-datasource-videoextractionconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::DataSource Tag A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: \$1 . : / = \$1 - @. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-qbusiness-datasource-tag-key)" : String, "[Value](#cfn-qbusiness-datasource-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-qbusiness-datasource-tag-key): String [Value](#cfn-qbusiness-datasource-tag-value): String ``` ## Properties `Key` The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value associated with the tag. The value may be an empty string but it can't be null. *Required*: Yes *Type*: String *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::DataSource VideoExtractionConfiguration Configuration settings for video content extraction and processing. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[VideoExtractionStatus](#cfn-qbusiness-datasource-videoextractionconfiguration-videoextractionstatus)" : String } ``` ### YAML ``` [VideoExtractionStatus](#cfn-qbusiness-datasource-videoextractionconfiguration-videoextractionstatus): String ``` ## Properties `VideoExtractionStatus` The status of video extraction (ENABLED or DISABLED) for processing video content from files. *Required*: Yes *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::Index Creates an Amazon Q Business index. To determine if index creation has completed, check the `Status` field returned from a call to `DescribeIndex`. The `Status` field is set to `ACTIVE` when the index is ready to use. Once the index is active, you can index your documents using the [https://docs.aws.amazon.com/amazonq/latest/api-reference/API_BatchPutDocument.html](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_BatchPutDocument.html) API or the [https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreateDataSource.html](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreateDataSource.html) API. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::QBusiness::Index", "Properties" : { "[ApplicationId](#cfn-qbusiness-index-applicationid)" : String, "[CapacityConfiguration](#cfn-qbusiness-index-capacityconfiguration)" : IndexCapacityConfiguration, "[Description](#cfn-qbusiness-index-description)" : String, "[DisplayName](#cfn-qbusiness-index-displayname)" : String, "[DocumentAttributeConfigurations](#cfn-qbusiness-index-documentattributeconfigurations)" : [ DocumentAttributeConfiguration, ... ], "[Tags](#cfn-qbusiness-index-tags)" : [ Tag, ... ], "[Type](#cfn-qbusiness-index-type)" : String } } ``` ### YAML ``` Type: AWS::QBusiness::Index Properties: [ApplicationId](#cfn-qbusiness-index-applicationid): String [CapacityConfiguration](#cfn-qbusiness-index-capacityconfiguration): IndexCapacityConfiguration [Description](#cfn-qbusiness-index-description): String [DisplayName](#cfn-qbusiness-index-displayname): String [DocumentAttributeConfigurations](#cfn-qbusiness-index-documentattributeconfigurations): - DocumentAttributeConfiguration [Tags](#cfn-qbusiness-index-tags): - Tag [Type](#cfn-qbusiness-index-type): String ``` ## Properties `ApplicationId` The identifier of the Amazon Q Business application using the index. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9-]{35}$` *Minimum*: `36` *Maximum*: `36` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `CapacityConfiguration` The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs. *Required*: No *Type*: [IndexCapacityConfiguration](aws-properties-qbusiness-index-indexcapacityconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Description` A description for the Amazon Q Business index. *Required*: No *Type*: String *Pattern*: `^[\s\S]*$` *Minimum*: `0` *Maximum*: `1000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DisplayName` The name of the index. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9_-]*$` *Minimum*: `1` *Maximum*: `1000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DocumentAttributeConfigurations` Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document. For more information, see [Understanding document attributes](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes.html). *Required*: No *Type*: Array of [DocumentAttributeConfiguration](aws-properties-qbusiness-index-documentattributeconfiguration.md) *Minimum*: `1` *Maximum*: `500` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: \$1 . : / = \$1 - @. *Required*: No *Type*: Array of [Tag](aws-properties-qbusiness-index-tag.md) *Minimum*: `0` *Maximum*: `200` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` The index type that's suitable for your needs. For more information on what's included in each type of index, see [Amazon Q Business tiers](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tiers.html#index-tiers). *Required*: No *Type*: String *Allowed values*: `ENTERPRISE | STARTER` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the application ID and index ID. For example: `{"Ref": "ApplicationId|IndexId"}` For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `CreatedAt` The Unix timestamp when the index was created. `IndexArn` The Amazon Resource Name (ARN) of an Amazon Q Business index. `IndexId` The identifier for the index. `Status` The current status of the index. When the status is `ACTIVE`, the index is ready. `UpdatedAt` The Unix timestamp when the index was last updated. # AWS::QBusiness::Index DocumentAttributeConfiguration Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document. For more information, see [Understanding document attributes](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Name](#cfn-qbusiness-index-documentattributeconfiguration-name)" : String, "[Search](#cfn-qbusiness-index-documentattributeconfiguration-search)" : String, "[Type](#cfn-qbusiness-index-documentattributeconfiguration-type)" : String } ``` ### YAML ``` [Name](#cfn-qbusiness-index-documentattributeconfiguration-name): String [Search](#cfn-qbusiness-index-documentattributeconfiguration-search): String [Type](#cfn-qbusiness-index-documentattributeconfiguration-type): String ``` ## Properties `Name` The name of the document attribute. *Required*: No *Type*: String *Pattern*: `^[a-zA-Z0-9_][a-zA-Z0-9_-]*$` *Minimum*: `1` *Maximum*: `30` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Search` Information about whether the document attribute can be used by an end user to search for information on their web experience. *Required*: No *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` The type of document attribute. *Required*: No *Type*: String *Allowed values*: `STRING | STRING_LIST | NUMBER | DATE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::Index IndexCapacityConfiguration Provides information about index capacity configuration. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Units](#cfn-qbusiness-index-indexcapacityconfiguration-units)" : Number } ``` ### YAML ``` [Units](#cfn-qbusiness-index-indexcapacityconfiguration-units): Number ``` ## Properties `Units` The number of storage units configured for an Amazon Q Business index. *Required*: No *Type*: Number *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::Index IndexStatistics Provides information about the number of documents in an index. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[TextDocumentStatistics](#cfn-qbusiness-index-indexstatistics-textdocumentstatistics)" : TextDocumentStatistics } ``` ### YAML ``` [TextDocumentStatistics](#cfn-qbusiness-index-indexstatistics-textdocumentstatistics): TextDocumentStatistics ``` ## Properties `TextDocumentStatistics` The number of documents indexed. *Required*: No *Type*: [TextDocumentStatistics](aws-properties-qbusiness-index-textdocumentstatistics.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::Index Tag A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: \$1 . : / = \$1 - @. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-qbusiness-index-tag-key)" : String, "[Value](#cfn-qbusiness-index-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-qbusiness-index-tag-key): String [Value](#cfn-qbusiness-index-tag-value): String ``` ## Properties `Key` The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value associated with the tag. The value may be an empty string but it can't be null. *Required*: Yes *Type*: String *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::Index TextDocumentStatistics Provides information about text documents in an index. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[IndexedTextBytes](#cfn-qbusiness-index-textdocumentstatistics-indexedtextbytes)" : Number, "[IndexedTextDocumentCount](#cfn-qbusiness-index-textdocumentstatistics-indexedtextdocumentcount)" : Number } ``` ### YAML ``` [IndexedTextBytes](#cfn-qbusiness-index-textdocumentstatistics-indexedtextbytes): Number [IndexedTextDocumentCount](#cfn-qbusiness-index-textdocumentstatistics-indexedtextdocumentcount): Number ``` ## Properties `IndexedTextBytes` The total size, in bytes, of the indexed documents. *Required*: No *Type*: Number *Minimum*: `0` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IndexedTextDocumentCount` The number of text documents indexed. *Required*: No *Type*: Number *Minimum*: `0` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::Permission Adds or updates a permission policy for a Amazon Q Business application, allowing cross-account access for an ISV. This operation creates a new policy statement for the specified Amazon Q Business application. The policy statement defines the IAM actions that the ISV is allowed to perform on the Amazon Q Business application's resources. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::QBusiness::Permission", "Properties" : { "[Actions](#cfn-qbusiness-permission-actions)" : [ String, ... ], "[ApplicationId](#cfn-qbusiness-permission-applicationid)" : String, "[Conditions](#cfn-qbusiness-permission-conditions)" : [ Condition, ... ], "[Principal](#cfn-qbusiness-permission-principal)" : String, "[StatementId](#cfn-qbusiness-permission-statementid)" : String } } ``` ### YAML ``` Type: AWS::QBusiness::Permission Properties: [Actions](#cfn-qbusiness-permission-actions): - String [ApplicationId](#cfn-qbusiness-permission-applicationid): String [Conditions](#cfn-qbusiness-permission-conditions): - Condition [Principal](#cfn-qbusiness-permission-principal): String [StatementId](#cfn-qbusiness-permission-statementid): String ``` ## Properties `Actions` The list of Amazon Q Business actions that the ISV is allowed to perform. *Required*: Yes *Type*: Array of String *Minimum*: `1` *Maximum*: `10` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `ApplicationId` The unique identifier of the Amazon Q Business application. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9-]{35}$` *Minimum*: `36` *Maximum*: `36` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Conditions` Property description not available. *Required*: No *Type*: Array of [Condition](aws-properties-qbusiness-permission-condition.md) *Minimum*: `1` *Maximum*: `10` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Principal` Provides user and group information used for filtering documents to use for generating Amazon Q Business conversation responses. *Required*: Yes *Type*: String *Pattern*: `^arn:aws:iam::[0-9]{12}:role/[a-zA-Z0-9_/+=,.@-]+$` *Minimum*: `1` *Maximum*: `1284` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `StatementId` A unique identifier for the policy statement. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9_-]+$` *Minimum*: `1` *Maximum*: `100` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the application and statement ID. For example: `{"Ref": "ApplicationId|StatementId"}` For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). # AWS::QBusiness::Permission Condition The `Condition` property type specifies Property description not available. for an [AWS::QBusiness::Permission](aws-resource-qbusiness-permission.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ConditionKey](#cfn-qbusiness-permission-condition-conditionkey)" : String, "[ConditionOperator](#cfn-qbusiness-permission-condition-conditionoperator)" : String, "[ConditionValues](#cfn-qbusiness-permission-condition-conditionvalues)" : [ String, ... ] } ``` ### YAML ``` [ConditionKey](#cfn-qbusiness-permission-condition-conditionkey): String [ConditionOperator](#cfn-qbusiness-permission-condition-conditionoperator): String [ConditionValues](#cfn-qbusiness-permission-condition-conditionvalues): - String ``` ## Properties `ConditionKey` Property description not available. *Required*: Yes *Type*: String *Pattern*: `^aws:PrincipalTag/qbusiness-dataaccessor:[a-zA-Z]+` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `ConditionOperator` Property description not available. *Required*: Yes *Type*: String *Allowed values*: `StringEquals` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `ConditionValues` Property description not available. *Required*: Yes *Type*: Array of String *Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9_-]*$` *Minimum*: `1` *Maximum*: `1` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::QBusiness::Plugin Information about an Amazon Q Business plugin and its configuration. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::QBusiness::Plugin", "Properties" : { "[ApplicationId](#cfn-qbusiness-plugin-applicationid)" : String, "[AuthConfiguration](#cfn-qbusiness-plugin-authconfiguration)" : PluginAuthConfiguration, "[CustomPluginConfiguration](#cfn-qbusiness-plugin-custompluginconfiguration)" : CustomPluginConfiguration, "[DisplayName](#cfn-qbusiness-plugin-displayname)" : String, "[ServerUrl](#cfn-qbusiness-plugin-serverurl)" : String, "[State](#cfn-qbusiness-plugin-state)" : String, "[Tags](#cfn-qbusiness-plugin-tags)" : [ Tag, ... ], "[Type](#cfn-qbusiness-plugin-type)" : String } } ``` ### YAML ``` Type: AWS::QBusiness::Plugin Properties: [ApplicationId](#cfn-qbusiness-plugin-applicationid): String [AuthConfiguration](#cfn-qbusiness-plugin-authconfiguration): PluginAuthConfiguration [CustomPluginConfiguration](#cfn-qbusiness-plugin-custompluginconfiguration): CustomPluginConfiguration [DisplayName](#cfn-qbusiness-plugin-displayname): String [ServerUrl](#cfn-qbusiness-plugin-serverurl): String [State](#cfn-qbusiness-plugin-state): String [Tags](#cfn-qbusiness-plugin-tags): - Tag [Type](#cfn-qbusiness-plugin-type): String ``` ## Properties `ApplicationId` The identifier of the application that will contain the plugin. *Required*: No *Type*: String *Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9-]{35}$` *Minimum*: `36` *Maximum*: `36` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `AuthConfiguration` Authentication configuration information for an Amazon Q Business plugin. *Required*: Yes *Type*: [PluginAuthConfiguration](aws-properties-qbusiness-plugin-pluginauthconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CustomPluginConfiguration` Configuration information required to create a custom plugin. *Required*: No *Type*: [CustomPluginConfiguration](aws-properties-qbusiness-plugin-custompluginconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DisplayName` The name of the plugin. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9_-]*$` *Minimum*: `1` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ServerUrl` The plugin server URL used for configuration. *Required*: No *Type*: String *Pattern*: `^(https?|ftp|file)://([^\s]*)$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `State` The current status of the plugin. *Required*: No *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: \$1 . : / = \$1 - @. *Required*: No *Type*: Array of [Tag](aws-properties-qbusiness-plugin-tag.md) *Minimum*: `0` *Maximum*: `200` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` The type of the plugin. *Required*: Yes *Type*: String *Allowed values*: `SERVICE_NOW | SALESFORCE | JIRA | ZENDESK | CUSTOM | QUICKSIGHT | SERVICENOW_NOW_PLATFORM | JIRA_CLOUD | SALESFORCE_CRM | ZENDESK_SUITE | ATLASSIAN_CONFLUENCE | GOOGLE_CALENDAR | MICROSOFT_TEAMS | MICROSOFT_EXCHANGE | PAGERDUTY_ADVANCE | SMARTSHEET | ASANA` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the application ID and plugin ID. For example: `{"Ref": "ApplicationId|PluginId"}` For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `BuildStatus` The current status of a plugin. A plugin is modified asynchronously. `CreatedAt` The timestamp for when the plugin was created. `PluginArn` The Amazon Resource Name (ARN) of a plugin. `PluginId` The identifier of the plugin. `UpdatedAt` The timestamp for when the plugin was last updated. # AWS::QBusiness::Plugin APISchema Contains details about the OpenAPI schema for a custom plugin. For more information, see [custom plugin OpenAPI schemas](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/custom-plugin.html#plugins-api-schema). You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the `s3` field. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Payload](#cfn-qbusiness-plugin-apischema-payload)" : String, "[S3](#cfn-qbusiness-plugin-apischema-s3)" : S3 } ``` ### YAML ``` [Payload](#cfn-qbusiness-plugin-apischema-payload): String [S3](#cfn-qbusiness-plugin-apischema-s3): S3 ``` ## Properties `Payload` The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `S3` Contains details about the S3 object containing the OpenAPI schema for a custom plugin. The schema could be in either JSON or YAML format. *Required*: No *Type*: [S3](aws-properties-qbusiness-plugin-s3.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::Plugin BasicAuthConfiguration Information about the basic authentication credentials used to configure a plugin. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[RoleArn](#cfn-qbusiness-plugin-basicauthconfiguration-rolearn)" : String, "[SecretArn](#cfn-qbusiness-plugin-basicauthconfiguration-secretarn)" : String } ``` ### YAML ``` [RoleArn](#cfn-qbusiness-plugin-basicauthconfiguration-rolearn): String [SecretArn](#cfn-qbusiness-plugin-basicauthconfiguration-secretarn): String ``` ## Properties `RoleArn` The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret. *Required*: Yes *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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SecretArn` The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration.. *Required*: Yes *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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::Plugin CustomPluginConfiguration Configuration information required to create a custom plugin. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ApiSchema](#cfn-qbusiness-plugin-custompluginconfiguration-apischema)" : APISchema, "[ApiSchemaType](#cfn-qbusiness-plugin-custompluginconfiguration-apischematype)" : String, "[Description](#cfn-qbusiness-plugin-custompluginconfiguration-description)" : String } ``` ### YAML ``` [ApiSchema](#cfn-qbusiness-plugin-custompluginconfiguration-apischema): APISchema [ApiSchemaType](#cfn-qbusiness-plugin-custompluginconfiguration-apischematype): String [Description](#cfn-qbusiness-plugin-custompluginconfiguration-description): String ``` ## Properties `ApiSchema` Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. *Required*: Yes *Type*: [APISchema](aws-properties-qbusiness-plugin-apischema.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ApiSchemaType` The type of OpenAPI schema to use. *Required*: Yes *Type*: String *Allowed values*: `OPEN_API_V3` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Description` A description for your custom plugin configuration. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `200` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::Plugin OAuth2ClientCredentialConfiguration Information about the OAuth 2.0 authentication credential/token used to configure a plugin. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AuthorizationUrl](#cfn-qbusiness-plugin-oauth2clientcredentialconfiguration-authorizationurl)" : String, "[RoleArn](#cfn-qbusiness-plugin-oauth2clientcredentialconfiguration-rolearn)" : String, "[SecretArn](#cfn-qbusiness-plugin-oauth2clientcredentialconfiguration-secretarn)" : String, "[TokenUrl](#cfn-qbusiness-plugin-oauth2clientcredentialconfiguration-tokenurl)" : String } ``` ### YAML ``` [AuthorizationUrl](#cfn-qbusiness-plugin-oauth2clientcredentialconfiguration-authorizationurl): String [RoleArn](#cfn-qbusiness-plugin-oauth2clientcredentialconfiguration-rolearn): String [SecretArn](#cfn-qbusiness-plugin-oauth2clientcredentialconfiguration-secretarn): String [TokenUrl](#cfn-qbusiness-plugin-oauth2clientcredentialconfiguration-tokenurl): String ``` ## Properties `AuthorizationUrl` The redirect URL required by the OAuth 2.0 protocol for Amazon Q Business to authenticate a plugin user through a third party authentication server. *Required*: No *Type*: String *Pattern*: `^(https?|ftp|file)://([^\s]*)$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RoleArn` The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret. *Required*: Yes *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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SecretArn` The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration. *Required*: Yes *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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TokenUrl` The URL required by the OAuth 2.0 protocol to exchange an end user authorization code for an access token. *Required*: No *Type*: String *Pattern*: `^(https?|ftp|file)://([^\s]*)$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::Plugin PluginAuthConfiguration Authentication configuration information for an Amazon Q Business plugin. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BasicAuthConfiguration](#cfn-qbusiness-plugin-pluginauthconfiguration-basicauthconfiguration)" : BasicAuthConfiguration, "[NoAuthConfiguration](#cfn-qbusiness-plugin-pluginauthconfiguration-noauthconfiguration)" : Json, "[OAuth2ClientCredentialConfiguration](#cfn-qbusiness-plugin-pluginauthconfiguration-oauth2clientcredentialconfiguration)" : OAuth2ClientCredentialConfiguration } ``` ### YAML ``` [BasicAuthConfiguration](#cfn-qbusiness-plugin-pluginauthconfiguration-basicauthconfiguration): BasicAuthConfiguration [NoAuthConfiguration](#cfn-qbusiness-plugin-pluginauthconfiguration-noauthconfiguration): Json [OAuth2ClientCredentialConfiguration](#cfn-qbusiness-plugin-pluginauthconfiguration-oauth2clientcredentialconfiguration): OAuth2ClientCredentialConfiguration ``` ## Properties `BasicAuthConfiguration` Information about the basic authentication credentials used to configure a plugin. *Required*: No *Type*: [BasicAuthConfiguration](aws-properties-qbusiness-plugin-basicauthconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `NoAuthConfiguration` Information about invoking a custom plugin without any authentication. *Required*: No *Type*: Json *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OAuth2ClientCredentialConfiguration` Information about the OAuth 2.0 authentication credential/token used to configure a plugin. *Required*: No *Type*: [OAuth2ClientCredentialConfiguration](aws-properties-qbusiness-plugin-oauth2clientcredentialconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::Plugin S3 Information required for Amazon Q Business to find a specific file in an Amazon S3 bucket. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Bucket](#cfn-qbusiness-plugin-s3-bucket)" : String, "[Key](#cfn-qbusiness-plugin-s3-key)" : String } ``` ### YAML ``` [Bucket](#cfn-qbusiness-plugin-s3-bucket): String [Key](#cfn-qbusiness-plugin-s3-key): String ``` ## Properties `Bucket` The name of the S3 bucket that contains the file. *Required*: Yes *Type*: String *Pattern*: `^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$` *Minimum*: `1` *Maximum*: `63` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Key` The name of the file. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `1024` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::Plugin Tag A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: \$1 . : / = \$1 - @. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-qbusiness-plugin-tag-key)" : String, "[Value](#cfn-qbusiness-plugin-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-qbusiness-plugin-tag-key): String [Value](#cfn-qbusiness-plugin-tag-value): String ``` ## Properties `Key` The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value associated with the tag. The value may be an empty string but it can't be null. *Required*: Yes *Type*: String *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::Retriever Adds a retriever to your Amazon Q Business application. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::QBusiness::Retriever", "Properties" : { "[ApplicationId](#cfn-qbusiness-retriever-applicationid)" : String, "[Configuration](#cfn-qbusiness-retriever-configuration)" : RetrieverConfiguration, "[DisplayName](#cfn-qbusiness-retriever-displayname)" : String, "[RoleArn](#cfn-qbusiness-retriever-rolearn)" : String, "[Tags](#cfn-qbusiness-retriever-tags)" : [ Tag, ... ], "[Type](#cfn-qbusiness-retriever-type)" : String } } ``` ### YAML ``` Type: AWS::QBusiness::Retriever Properties: [ApplicationId](#cfn-qbusiness-retriever-applicationid): String [Configuration](#cfn-qbusiness-retriever-configuration): RetrieverConfiguration [DisplayName](#cfn-qbusiness-retriever-displayname): String [RoleArn](#cfn-qbusiness-retriever-rolearn): String [Tags](#cfn-qbusiness-retriever-tags): - Tag [Type](#cfn-qbusiness-retriever-type): String ``` ## Properties `ApplicationId` The identifier of the Amazon Q Business application using the retriever. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9-]{35}$` *Minimum*: `36` *Maximum*: `36` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Configuration` Provides information on how the retriever used for your Amazon Q Business application is configured. *Required*: Yes *Type*: [RetrieverConfiguration](aws-properties-qbusiness-retriever-retrieverconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DisplayName` The name of your retriever. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9_-]*$` *Minimum*: `1` *Maximum*: `1000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RoleArn` The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret. *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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` A list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: \$1 . : / = \$1 - @. *Required*: No *Type*: Array of [Tag](aws-properties-qbusiness-retriever-tag.md) *Minimum*: `0` *Maximum*: `200` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` The type of your retriever. *Required*: Yes *Type*: String *Allowed values*: `NATIVE_INDEX | KENDRA_INDEX` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the application ID and retriever ID. For example: `{"Ref": "ApplicationId|RetrieverId"}` For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `CreatedAt` The Unix timestamp when the retriever was created. `RetrieverArn` The Amazon Resource Name (ARN) of the IAM role associated with the retriever. `RetrieverId` The identifier of the retriever used by your Amazon Q Business application. `Status` The status of your retriever. `UpdatedAt` The Unix timestamp when the retriever was last updated. # AWS::QBusiness::Retriever KendraIndexConfiguration Stores an Amazon Kendra index as a retriever. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[IndexId](#cfn-qbusiness-retriever-kendraindexconfiguration-indexid)" : String } ``` ### YAML ``` [IndexId](#cfn-qbusiness-retriever-kendraindexconfiguration-indexid): String ``` ## Properties `IndexId` The identifier of the Amazon Kendra index. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9-]{35}$` *Minimum*: `36` *Maximum*: `36` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::Retriever NativeIndexConfiguration Configuration information for an Amazon Q Business index. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[IndexId](#cfn-qbusiness-retriever-nativeindexconfiguration-indexid)" : String } ``` ### YAML ``` [IndexId](#cfn-qbusiness-retriever-nativeindexconfiguration-indexid): String ``` ## Properties `IndexId` The identifier for the Amazon Q Business index. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9-]{35}$` *Minimum*: `36` *Maximum*: `36` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::Retriever RetrieverConfiguration Provides information on how the retriever used for your Amazon Q Business application is configured. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[KendraIndexConfiguration](#cfn-qbusiness-retriever-retrieverconfiguration-kendraindexconfiguration)" : KendraIndexConfiguration, "[NativeIndexConfiguration](#cfn-qbusiness-retriever-retrieverconfiguration-nativeindexconfiguration)" : NativeIndexConfiguration } ``` ### YAML ``` [KendraIndexConfiguration](#cfn-qbusiness-retriever-retrieverconfiguration-kendraindexconfiguration): KendraIndexConfiguration [NativeIndexConfiguration](#cfn-qbusiness-retriever-retrieverconfiguration-nativeindexconfiguration): NativeIndexConfiguration ``` ## Properties `KendraIndexConfiguration` Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q Business application is configured. *Required*: No *Type*: [KendraIndexConfiguration](aws-properties-qbusiness-retriever-kendraindexconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `NativeIndexConfiguration` Provides information on how a Amazon Q Business index used as a retriever for your Amazon Q Business application is configured. *Required*: No *Type*: [NativeIndexConfiguration](aws-properties-qbusiness-retriever-nativeindexconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::Retriever Tag A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: \$1 . : / = \$1 - @. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-qbusiness-retriever-tag-key)" : String, "[Value](#cfn-qbusiness-retriever-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-qbusiness-retriever-tag-key): String [Value](#cfn-qbusiness-retriever-tag-value): String ``` ## Properties `Key` The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value associated with the tag. The value may be an empty string but it can't be null. *Required*: Yes *Type*: String *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::WebExperience Creates an Amazon Q Business web experience. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::QBusiness::WebExperience", "Properties" : { "[ApplicationId](#cfn-qbusiness-webexperience-applicationid)" : String, "[BrowserExtensionConfiguration](#cfn-qbusiness-webexperience-browserextensionconfiguration)" : BrowserExtensionConfiguration, "[CustomizationConfiguration](#cfn-qbusiness-webexperience-customizationconfiguration)" : CustomizationConfiguration, "[IdentityProviderConfiguration](#cfn-qbusiness-webexperience-identityproviderconfiguration)" : IdentityProviderConfiguration, "[Origins](#cfn-qbusiness-webexperience-origins)" : [ String, ... ], "[RoleArn](#cfn-qbusiness-webexperience-rolearn)" : String, "[SamplePromptsControlMode](#cfn-qbusiness-webexperience-samplepromptscontrolmode)" : String, "[Subtitle](#cfn-qbusiness-webexperience-subtitle)" : String, "[Tags](#cfn-qbusiness-webexperience-tags)" : [ Tag, ... ], "[Title](#cfn-qbusiness-webexperience-title)" : String, "[WelcomeMessage](#cfn-qbusiness-webexperience-welcomemessage)" : String } } ``` ### YAML ``` Type: AWS::QBusiness::WebExperience Properties: [ApplicationId](#cfn-qbusiness-webexperience-applicationid): String [BrowserExtensionConfiguration](#cfn-qbusiness-webexperience-browserextensionconfiguration): BrowserExtensionConfiguration [CustomizationConfiguration](#cfn-qbusiness-webexperience-customizationconfiguration): CustomizationConfiguration [IdentityProviderConfiguration](#cfn-qbusiness-webexperience-identityproviderconfiguration): IdentityProviderConfiguration [Origins](#cfn-qbusiness-webexperience-origins): - String [RoleArn](#cfn-qbusiness-webexperience-rolearn): String [SamplePromptsControlMode](#cfn-qbusiness-webexperience-samplepromptscontrolmode): String [Subtitle](#cfn-qbusiness-webexperience-subtitle): String [Tags](#cfn-qbusiness-webexperience-tags): - Tag [Title](#cfn-qbusiness-webexperience-title): String [WelcomeMessage](#cfn-qbusiness-webexperience-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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `BrowserExtensionConfiguration` The container for browser extension configuration for an Amazon Q Business web experience. *Required*: No *Type*: [BrowserExtensionConfiguration](aws-properties-qbusiness-webexperience-browserextensionconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CustomizationConfiguration` 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. *Required*: No *Type*: [CustomizationConfiguration](aws-properties-qbusiness-webexperience-customizationconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IdentityProviderConfiguration` Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience. *Required*: No *Type*: [IdentityProviderConfiguration](aws-properties-qbusiness-webexperience-identityproviderconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `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). 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RoleArn` The Amazon Resource Name (ARN) of the service role attached to your web experience. The `roleArn` parameter is required when your Amazon Q Business application is created with IAM Identity Center. It is not required for SAML-based applications. *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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `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: \$1 . : / = \$1 - @. *Required*: No *Type*: Array of [Tag](aws-properties-qbusiness-webexperience-tag.md) *Minimum*: `0` *Maximum*: `200` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `WelcomeMessage` A message in an Amazon Q Business web experience. *Required*: No *Type*: String *Minimum*: `0` *Maximum*: `300` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## 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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### 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. # AWS::QBusiness::WebExperience BrowserExtensionConfiguration The container for browser extension configuration for an Amazon Q Business web experience. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[EnabledBrowserExtensions](#cfn-qbusiness-webexperience-browserextensionconfiguration-enabledbrowserextensions)" : [ String, ... ] } ``` ### YAML ``` [EnabledBrowserExtensions](#cfn-qbusiness-webexperience-browserextensionconfiguration-enabledbrowserextensions): - String ``` ## Properties `EnabledBrowserExtensions` Specify the browser extensions allowed for your Amazon Q web experience. + `CHROME` — Enables the extension for Chromium-based browsers (Google Chrome, Microsoft Edge, Opera, etc.). + `FIREFOX` — Enables the extension for Mozilla Firefox. + `CHROME` and `FIREFOX` — Enable the extension for Chromium-based browsers and Mozilla Firefox. *Required*: Yes *Type*: Array of String *Minimum*: `0` *Maximum*: `2` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::WebExperience CustomizationConfiguration 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. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CustomCSSUrl](#cfn-qbusiness-webexperience-customizationconfiguration-customcssurl)" : String, "[FaviconUrl](#cfn-qbusiness-webexperience-customizationconfiguration-faviconurl)" : String, "[FontUrl](#cfn-qbusiness-webexperience-customizationconfiguration-fonturl)" : String, "[LogoUrl](#cfn-qbusiness-webexperience-customizationconfiguration-logourl)" : String } ``` ### YAML ``` [CustomCSSUrl](#cfn-qbusiness-webexperience-customizationconfiguration-customcssurl): String [FaviconUrl](#cfn-qbusiness-webexperience-customizationconfiguration-faviconurl): String [FontUrl](#cfn-qbusiness-webexperience-customizationconfiguration-fonturl): String [LogoUrl](#cfn-qbusiness-webexperience-customizationconfiguration-logourl): String ``` ## Properties `CustomCSSUrl` Provides the URL where the custom CSS file is hosted for an Amazon Q web experience. *Required*: No *Type*: String *Pattern*: `^(https?://[a-zA-Z0-9-_.+%/]+\.css)?$` *Minimum*: `0` *Maximum*: `1284` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FaviconUrl` Provides the URL where the custom favicon file is hosted for an Amazon Q web experience. *Required*: No *Type*: String *Pattern*: `^(https?://[a-zA-Z0-9-_.+%/]+\.(svg|ico))?$` *Minimum*: `0` *Maximum*: `1284` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FontUrl` Provides the URL where the custom font file is hosted for an Amazon Q web experience. *Required*: No *Type*: String *Pattern*: `^(https?://[a-zA-Z0-9-_.+%/]+\.(ttf|woff|woff2|otf))?$` *Minimum*: `0` *Maximum*: `1284` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LogoUrl` Provides the URL where the custom logo file is hosted for an Amazon Q web experience. *Required*: No *Type*: String *Pattern*: `^(https?://[a-zA-Z0-9-_.+%/]+\.(svg|png))?$` *Minimum*: `0` *Maximum*: `1284` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::WebExperience IdentityProviderConfiguration Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[OpenIDConnectConfiguration](#cfn-qbusiness-webexperience-identityproviderconfiguration-openidconnectconfiguration)" : OpenIDConnectProviderConfiguration, "[SamlConfiguration](#cfn-qbusiness-webexperience-identityproviderconfiguration-samlconfiguration)" : SamlProviderConfiguration } ``` ### YAML ``` [OpenIDConnectConfiguration](#cfn-qbusiness-webexperience-identityproviderconfiguration-openidconnectconfiguration): OpenIDConnectProviderConfiguration [SamlConfiguration](#cfn-qbusiness-webexperience-identityproviderconfiguration-samlconfiguration): SamlProviderConfiguration ``` ## Properties `OpenIDConnectConfiguration` The OIDC-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience. *Required*: No *Type*: [OpenIDConnectProviderConfiguration](aws-properties-qbusiness-webexperience-openidconnectproviderconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SamlConfiguration` The SAML 2.0-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience. *Required*: No *Type*: [SamlProviderConfiguration](aws-properties-qbusiness-webexperience-samlproviderconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::WebExperience OpenIDConnectProviderConfiguration Information about the OIDC-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[SecretsArn](#cfn-qbusiness-webexperience-openidconnectproviderconfiguration-secretsarn)" : String, "[SecretsRole](#cfn-qbusiness-webexperience-openidconnectproviderconfiguration-secretsrole)" : String } ``` ### YAML ``` [SecretsArn](#cfn-qbusiness-webexperience-openidconnectproviderconfiguration-secretsarn): String [SecretsRole](#cfn-qbusiness-webexperience-openidconnectproviderconfiguration-secretsrole): String ``` ## Properties `SecretsArn` The Amazon Resource Name (ARN) of a Secrets Manager secret containing the OIDC client secret. *Required*: Yes *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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SecretsRole` An IAM role with permissions to access AWS KMS to decrypt the Secrets Manager secret containing your OIDC client secret. *Required*: Yes *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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::WebExperience SamlProviderConfiguration Information about the SAML 2.0-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AuthenticationUrl](#cfn-qbusiness-webexperience-samlproviderconfiguration-authenticationurl)" : String } ``` ### YAML ``` [AuthenticationUrl](#cfn-qbusiness-webexperience-samlproviderconfiguration-authenticationurl): String ``` ## Properties `AuthenticationUrl` The URL where Amazon Q Business end users will be redirected for authentication. *Required*: Yes *Type*: String *Pattern*: `^https://.*$` *Minimum*: `1` *Maximum*: `1284` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QBusiness::WebExperience Tag A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: \$1 . : / = \$1 - @. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-qbusiness-webexperience-tag-key)" : String, "[Value](#cfn-qbusiness-webexperience-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-qbusiness-webexperience-tag-key): String [Value](#cfn-qbusiness-webexperience-tag-value): String ``` ## Properties `Key` The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value associated with the tag. The value may be an empty string but it can't be null. *Required*: Yes *Type*: String *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)