applications

Creates, updates, deletes or gets an application resource or lists applications in a region

Overview

Name	applications
Type	Resource
Description	Definition of AWS::QBusiness::Application Resource Type
Id	aws.qbusiness.applications

Fields

Name	Datatype	Description
application_arn	string
application_id	string
attachments_configuration	object
auto_subscription_configuration	object
client_ids_for_oid_c	array
created_at	string
description	string
display_name	string
encryption_configuration	object
iam_identity_provider_arn	string
identity_center_application_arn	string
identity_center_instance_arn	string
identity_type	string
personalization_configuration	object
q_apps_configuration	object
quick_sight_configuration	object
role_arn	string
status	string
tags	array
updated_at	string
region	string	AWS region.

For more information, see AWS::QBusiness::Application.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	DisplayName, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all applications in a region.

SELECT
region,
application_arn,
application_id,
attachments_configuration,
auto_subscription_configuration,
client_ids_for_oid_c,
created_at,
description,
display_name,
encryption_configuration,
iam_identity_provider_arn,
identity_center_application_arn,
identity_center_instance_arn,
identity_type,
personalization_configuration,
q_apps_configuration,
quick_sight_configuration,
role_arn,
status,
tags,
updated_at
FROM aws.qbusiness.applications
WHERE region = 'us-east-1';

Gets all properties from an individual application.

SELECT
region,
application_arn,
application_id,
attachments_configuration,
auto_subscription_configuration,
client_ids_for_oid_c,
created_at,
description,
display_name,
encryption_configuration,
iam_identity_provider_arn,
identity_center_application_arn,
identity_center_instance_arn,
identity_type,
personalization_configuration,
q_apps_configuration,
quick_sight_configuration,
role_arn,
status,
tags,
updated_at
FROM aws.qbusiness.applications
WHERE region = 'us-east-1' AND data__Identifier = '<ApplicationId>';

INSERT example

Use the following StackQL query and manifest file to create a new application resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.qbusiness.applications (
 DisplayName,
 region
)
SELECT 
'{{ DisplayName }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.qbusiness.applications (
 AttachmentsConfiguration,
 AutoSubscriptionConfiguration,
 ClientIdsForOIDC,
 Description,
 DisplayName,
 EncryptionConfiguration,
 IamIdentityProviderArn,
 IdentityCenterInstanceArn,
 IdentityType,
 PersonalizationConfiguration,
 QAppsConfiguration,
 QuickSightConfiguration,
 RoleArn,
 Tags,
 region
)
SELECT 
 '{{ AttachmentsConfiguration }}',
 '{{ AutoSubscriptionConfiguration }}',
 '{{ ClientIdsForOIDC }}',
 '{{ Description }}',
 '{{ DisplayName }}',
 '{{ EncryptionConfiguration }}',
 '{{ IamIdentityProviderArn }}',
 '{{ IdentityCenterInstanceArn }}',
 '{{ IdentityType }}',
 '{{ PersonalizationConfiguration }}',
 '{{ QAppsConfiguration }}',
 '{{ QuickSightConfiguration }}',
 '{{ RoleArn }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: application
    props:
      - name: AttachmentsConfiguration
        value:
          AttachmentsControlMode: '{{ AttachmentsControlMode }}'
      - name: AutoSubscriptionConfiguration
        value:
          AutoSubscribe: '{{ AutoSubscribe }}'
          DefaultSubscriptionType: '{{ DefaultSubscriptionType }}'
      - name: ClientIdsForOIDC
        value:
          - '{{ ClientIdsForOIDC[0] }}'
      - name: Description
        value: '{{ Description }}'
      - name: DisplayName
        value: '{{ DisplayName }}'
      - name: EncryptionConfiguration
        value:
          KmsKeyId: '{{ KmsKeyId }}'
      - name: IamIdentityProviderArn
        value: '{{ IamIdentityProviderArn }}'
      - name: IdentityCenterInstanceArn
        value: '{{ IdentityCenterInstanceArn }}'
      - name: IdentityType
        value: '{{ IdentityType }}'
      - name: PersonalizationConfiguration
        value:
          PersonalizationControlMode: '{{ PersonalizationControlMode }}'
      - name: QAppsConfiguration
        value:
          QAppsControlMode: '{{ QAppsControlMode }}'
      - name: QuickSightConfiguration
        value:
          ClientNamespace: '{{ ClientNamespace }}'
      - name: RoleArn
        value: '{{ RoleArn }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.qbusiness.applications
WHERE data__Identifier = '<ApplicationId>'
AND region = 'us-east-1';

Permissions

To operate on the applications resource, the following permissions are required:

Create

iam:GetSAMLProvider,
iam:PassRole,
kms:CreateGrant,
kms:DescribeKey,
qbusiness:CreateApplication,
qbusiness:GetApplication,
qbusiness:ListTagsForResource,
qbusiness:TagResource,
qbusiness:UpdateApplication,
quicksight:DescribeAccountSubscription,
quicksight:ListNamespaces,
sso:CreateApplication,
sso:DeleteApplication,
sso:DescribeInstance,
sso:PutApplicationAccessScope,
sso:PutApplicationAuthenticationMethod,
sso:PutApplicationGrant

Read

qbusiness:GetApplication,
qbusiness:ListTagsForResource

Update

iam:PassRole,
qbusiness:GetApplication,
qbusiness:ListTagsForResource,
qbusiness:TagResource,
qbusiness:UntagResource,
qbusiness:UpdateApplication,
sso:CreateApplication,
sso:DeleteApplication,
sso:DescribeInstance,
sso:PutApplicationAccessScope,
sso:PutApplicationAuthenticationMethod,
sso:PutApplicationGrant

Delete

kms:RetireGrant,
qbusiness:DeleteApplication,
qbusiness:GetApplication,
sso:DeleteApplication

List

qbusiness:ListApplications