applications

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

Overview

Name	applications
Type	Resource
Description	Resource Type definition for Identity Center (SSO) Application
Id	aws.sso.applications

Fields

Name	Datatype	Description
name	string	The name you want to assign to this Identity Center (SSO) Application
description	string	The description information for the Identity Center (SSO) Application
instance_arn	string	The ARN of the instance of IAM Identity Center under which the operation will run
application_arn	string	The Application ARN that is returned upon creation of the Identity Center (SSO) Application
application_provider_arn	string	The ARN of the application provider under which the operation will run
status	string	Specifies whether the application is enabled or disabled
portal_options	object	A structure that describes the options for the portal associated with an application
tags	array
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, InstanceArn, ApplicationProviderArn, 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,
name,
description,
instance_arn,
application_arn,
application_provider_arn,
status,
portal_options,
tags
FROM aws.sso.applications
WHERE region = 'us-east-1';

Gets all properties from an individual application.

SELECT
region,
name,
description,
instance_arn,
application_arn,
application_provider_arn,
status,
portal_options,
tags
FROM aws.sso.applications
WHERE region = 'us-east-1' AND data__Identifier = '<ApplicationArn>';

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.sso.applications (
 Name,
 InstanceArn,
 ApplicationProviderArn,
 region
)
SELECT 
'{{ Name }}',
 '{{ InstanceArn }}',
 '{{ ApplicationProviderArn }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.sso.applications (
 Name,
 Description,
 InstanceArn,
 ApplicationProviderArn,
 Status,
 PortalOptions,
 Tags,
 region
)
SELECT 
 '{{ Name }}',
 '{{ Description }}',
 '{{ InstanceArn }}',
 '{{ ApplicationProviderArn }}',
 '{{ Status }}',
 '{{ PortalOptions }}',
 '{{ 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: Name
        value: '{{ Name }}'
      - name: Description
        value: '{{ Description }}'
      - name: InstanceArn
        value: '{{ InstanceArn }}'
      - name: ApplicationProviderArn
        value: '{{ ApplicationProviderArn }}'
      - name: Status
        value: '{{ Status }}'
      - name: PortalOptions
        value:
          Visibility: '{{ Visibility }}'
          SignInOptions:
            Origin: '{{ Origin }}'
            ApplicationUrl: '{{ ApplicationUrl }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

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

Permissions

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

Create

sso:CreateApplication,
sso:DescribeApplication,
sso:TagResource

Read

sso:DescribeApplication,
sso:ListTagsForResource

Update

sso:UpdateApplication,
sso:TagResource,
sso:UntagResource,
sso:ListTagsForResource,
sso:DescribeApplication

Delete

sso:DeleteApplication

List

sso:ListApplications