applications

Creates, updates, deletes, gets or lists an applications resource.

Overview

Name	applications
Type	Resource
Id	aws.securityagent.applications

Fields

The following fields are returned by SELECT queries:

get_application

Name	Datatype	Description
application_id	string	Application identifier.
application_name	string	The name of the application.
default_kms_key_id	string	Identifier of a KMS key. Can be a key ID, key ARN, alias name, or alias ARN.
domain	string	The domain associated with the application.
idc_configuration	object	The IAM Identity Center configuration for the application.
role_arn	string	ARN of the IAM role that the application uses to access AWS resources on your behalf.

list_applications

Name	Datatype	Description
application_id	string	Application identifier.
application_name	string	The name of the application.
default_kms_key_id	string	Identifier of a KMS key. Can be a key ID, key ARN, alias name, or alias ARN.
domain	string	The domain associated with the application.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_application	select	region		Retrieves information about an application.
list_applications	select	region		Returns a paginated list of application summaries in your account.
create_application	insert	region		Creates a new application. An application is the top-level organizational unit that supports IAM Identity Center integration.
update_application	update	region, applicationId		Updates the configuration of an existing application, including the IAM role and default KMS key.
delete_application	delete	region		Deletes an application and its associated configuration, including IAM Identity Center settings.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_application

Retrieves information about an application.

SELECT
application_id,
application_name,
default_kms_key_id,
domain,
idc_configuration,
role_arn
FROM aws.securityagent.applications
WHERE region = '{{ region }}' -- required
;

list_applications

Returns a paginated list of application summaries in your account.

SELECT
application_id,
application_name,
default_kms_key_id,
domain
FROM aws.securityagent.applications
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_application

Creates a new application. An application is the top-level organizational unit that supports IAM Identity Center integration.

INSERT INTO aws.securityagent.applications (
idcInstanceArn,
roleArn,
defaultKmsKeyId,
tags,
region
)
SELECT 
'{{ idcInstanceArn }}',
'{{ roleArn }}',
'{{ defaultKmsKeyId }}',
'{{ tags }}',
'{{ region }}'
RETURNING
application_id
;

Manifest

# Description fields are for documentation purposes
- name: applications
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the applications resource.
  - name: idcInstanceArn
    value: "{{ idcInstanceArn }}"
    description: |
      ARN of the IAM Identity Center instance used for user authentication.
  - name: roleArn
    value: "{{ roleArn }}"
    description: |
      ARN of the IAM role that the application uses to access AWS resources on your behalf.
  - name: defaultKmsKeyId
    value: "{{ defaultKmsKeyId }}"
    description: |
      Identifier of a KMS key. Can be a key ID, key ARN, alias name, or alias ARN.
  - name: tags
    value: "{{ tags }}"
    description: |
      Map of tags for a resource.

UPDATE examples

update_application

Updates the configuration of an existing application, including the IAM role and default KMS key.

UPDATE aws.securityagent.applications
SET 
applicationId = '{{ applicationId }}',
roleArn = '{{ roleArn }}',
defaultKmsKeyId = '{{ defaultKmsKeyId }}'
WHERE 
region = '{{ region }}' --required
AND applicationId = '{{ applicationId }}' --required
RETURNING
application_id;

DELETE examples

delete_application

Deletes an application and its associated configuration, including IAM Identity Center settings.

DELETE FROM aws.securityagent.applications
WHERE region = '{{ region }}' --required
;