AWS::QBusiness::DataAccessor - AWS CloudFormation

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 AWS CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::QBusiness::DataAccessor", "Properties" : { "ActionConfigurations" : [ ActionConfiguration, ... ], "ApplicationId" : String, "DisplayName" : String, "Principal" : String, "Tags" : [ Tag, ... ] } }

YAML

Type: AWS::QBusiness::DataAccessor Properties: ActionConfigurations: - ActionConfiguration ApplicationId: String DisplayName: String Principal: String Tags: - Tag

Properties

ActionConfigurations

A list of action configurations specifying the allowed actions and any associated filters.

Required: Yes

Type: Array of ActionConfiguration

Minimum: 1

Maximum: 10

Update requires: No interruption

ApplicationId

The unique identifier of the Amazon Q Business application.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$

Minimum: 36

Maximum: 36

Update requires: Replacement

DisplayName

The friendly name of the data accessor.

Required: Yes

Type: String

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

Minimum: 1

Maximum: 1000

Update requires: No interruption

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/.+

Minimum: 1

Maximum: 1284

Update requires: Replacement

Tags

The tags to associate with the data accessor.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 200

Update requires: No interruption

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

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 Fn::GetAtt.

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.