View a markdown version of this page

AWS::QBusiness::Permission - AWS CloudFormation
SyntaxPropertiesReturn values

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.

AWS::QBusiness::Permission

Note

Amazon Q Business will no longer be open to new customers starting on July 31, 2026. If you would like to use the service, please sign up prior to July 30. For capabilities similar to Q Business, explore Amazon Quick. Learn more.

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" : [ String, ... ],
      "ApplicationId" : String,
      "Conditions" : [ Condition, ... ],
      "Principal" : String,
      "StatementId" : String
    }
}

YAML

Type: AWS::QBusiness::Permission
Properties:
  Actions: 
    - String
  ApplicationId: String
  Conditions: 
    - Condition
  Principal: String
  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

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

Conditions

Property description not available.

Required: No

Type: Array of Condition

Minimum: 1

Maximum: 10

Update requires: 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

StatementId

A unique identifier for the policy statement.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9_-]+$

Minimum: 1

Maximum: 100

Update requires: 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 Ref.