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

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
application_arn	string	The Application ARN that is returned upon creation of the Identity Center (SSO) Application
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	applications	INSERT	Name, InstanceArn, ApplicationProviderArn, 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,
  name,
  description,
  instance_arn,
  application_arn,
  application_provider_arn,
  status,
  portal_options,
  tags
FROM awscc.sso.applications
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ application_arn }}';

list (identifiers only)

Lists all applications in a region.

SELECT
  region,
  application_arn
FROM awscc.sso.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.sso.applications (
  Name,
  InstanceArn,
  ApplicationProviderArn,
  region
)
SELECT
  '{{ name }}',
  '{{ instance_arn }}',
  '{{ application_provider_arn }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.sso.applications (
  Name,
  Description,
  InstanceArn,
  ApplicationProviderArn,
  Status,
  PortalOptions,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ description }}',
  '{{ instance_arn }}',
  '{{ application_provider_arn }}',
  '{{ status }}',
  '{{ portal_options }}',
  '{{ 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: name
      value: '{{ name }}'
    - name: description
      value: '{{ description }}'
    - name: instance_arn
      value: '{{ instance_arn }}'
    - name: application_provider_arn
      value: '{{ application_provider_arn }}'
    - name: status
      value: '{{ status }}'
    - name: portal_options
      value:
        visibility: '{{ visibility }}'
        sign_in_options:
          origin: '{{ origin }}'
          application_url: '{{ application_url }}'
    - 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.sso.applications
SET PatchDocument = string('{{ {
    "Name": name,
    "Description": description,
    "Status": status,
    "PortalOptions": portal_options,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ application_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.sso.applications
WHERE
  Identifier = '{{ application_arn }}' 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

sso:CreateApplication,
sso:DescribeApplication,
sso:TagResource,
sso:ListTagsForResource

Read

sso:DescribeApplication,
sso:ListTagsForResource

Update

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

Delete

sso:DeleteApplication

List

sso:ListApplications,
sso:ListTagsForResource