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	awscc.qbusiness.applications

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
application_id	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	applications	INSERT	DisplayName, region
delete_resource	applications	DELETE	Identifier, region
update_resource	applications	UPDATE	Identifier, PatchDocument, region
list_resources	applications_list_only	SELECT	region
get_resource	applications	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.qbusiness.applications
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ application_id }}';

list (identifiers only)

Lists all applications in a region.

SELECT
  region,
  application_id
FROM awscc.qbusiness.applications_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.qbusiness.applications (
  DisplayName,
  region
)
SELECT
  '{{ display_name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.qbusiness.applications (
  AttachmentsConfiguration,
  AutoSubscriptionConfiguration,
  ClientIdsForOIDC,
  Description,
  DisplayName,
  EncryptionConfiguration,
  IamIdentityProviderArn,
  IdentityCenterInstanceArn,
  IdentityType,
  PersonalizationConfiguration,
  QAppsConfiguration,
  QuickSightConfiguration,
  RoleArn,
  Tags,
  region
)
SELECT
  '{{ attachments_configuration }}',
  '{{ auto_subscription_configuration }}',
  '{{ client_ids_for_oid_c }}',
  '{{ description }}',
  '{{ display_name }}',
  '{{ encryption_configuration }}',
  '{{ iam_identity_provider_arn }}',
  '{{ identity_center_instance_arn }}',
  '{{ identity_type }}',
  '{{ personalization_configuration }}',
  '{{ q_apps_configuration }}',
  '{{ quick_sight_configuration }}',
  '{{ role_arn }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: application
  props:
    - name: attachments_configuration
      value:
        attachments_control_mode: '{{ attachments_control_mode }}'
    - name: auto_subscription_configuration
      value:
        auto_subscribe: '{{ auto_subscribe }}'
        default_subscription_type: '{{ default_subscription_type }}'
    - name: client_ids_for_oid_c
      value:
        - '{{ client_ids_for_oid_c[0] }}'
    - name: description
      value: '{{ description }}'
    - name: display_name
      value: '{{ display_name }}'
    - name: encryption_configuration
      value:
        kms_key_id: '{{ kms_key_id }}'
    - name: iam_identity_provider_arn
      value: '{{ iam_identity_provider_arn }}'
    - name: identity_center_instance_arn
      value: '{{ identity_center_instance_arn }}'
    - name: identity_type
      value: '{{ identity_type }}'
    - name: personalization_configuration
      value:
        personalization_control_mode: '{{ personalization_control_mode }}'
    - name: q_apps_configuration
      value:
        q_apps_control_mode: '{{ q_apps_control_mode }}'
    - name: quick_sight_configuration
      value:
        client_namespace: '{{ client_namespace }}'
    - name: role_arn
      value: '{{ role_arn }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.qbusiness.applications
SET PatchDocument = string('{{ {
    "AttachmentsConfiguration": attachments_configuration,
    "AutoSubscriptionConfiguration": auto_subscription_configuration,
    "Description": description,
    "DisplayName": display_name,
    "IdentityCenterInstanceArn": identity_center_instance_arn,
    "PersonalizationConfiguration": personalization_configuration,
    "QAppsConfiguration": q_apps_configuration,
    "RoleArn": role_arn,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ application_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.qbusiness.applications
WHERE
  Identifier = '{{ application_id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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