applications

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

Overview

Name	applications
Type	Resource
Description	Resource schema for AWS::IoTFleetHub::Application
Id	aws.iotfleethub.applications

Fields

Name	Datatype	Description
application_id	string	The ID of the application.
application_arn	string	The ARN of the application.
application_name	string	Application Name, should be between 1 and 256 characters.
application_description	string	Application Description, should be between 1 and 2048 characters.
application_url	string	The URL of the application.
application_state	string	The current state of the application.
application_creation_date	integer	When the Application was created
application_last_update_date	integer	When the Application was last updated
role_arn	string	The ARN of the role that the web application assumes when it interacts with AWS IoT Core. For more info on configuring this attribute, see https://docs.aws.amazon.com/iot/latest/apireference/API_iotfleethub_CreateApplication.html#API_iotfleethub_CreateApplication_RequestSyntax
sso_client_id	string	The AWS SSO application generated client ID (used with AWS SSO APIs).
error_message	string	A message indicating why Create or Delete Application failed.
tags	array	A list of key-value pairs that contain metadata for the application.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ApplicationName, RoleArn, 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_id,
application_arn,
application_name,
application_description,
application_url,
application_state,
application_creation_date,
application_last_update_date,
role_arn,
sso_client_id,
error_message,
tags
FROM aws.iotfleethub.applications
WHERE region = 'us-east-1';

Gets all properties from an individual application.

SELECT
region,
application_id,
application_arn,
application_name,
application_description,
application_url,
application_state,
application_creation_date,
application_last_update_date,
role_arn,
sso_client_id,
error_message,
tags
FROM aws.iotfleethub.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.iotfleethub.applications (
 ApplicationName,
 RoleArn,
 region
)
SELECT 
'{{ ApplicationName }}',
 '{{ RoleArn }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.iotfleethub.applications (
 ApplicationName,
 ApplicationDescription,
 RoleArn,
 Tags,
 region
)
SELECT 
 '{{ ApplicationName }}',
 '{{ ApplicationDescription }}',
 '{{ 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: ApplicationName
        value: '{{ ApplicationName }}'
      - name: ApplicationDescription
        value: '{{ ApplicationDescription }}'
      - name: RoleArn
        value: '{{ RoleArn }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

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

Permissions

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

Create

iotfleethub:CreateApplication,
iotfleethub:TagResource,
iam:PassRole,
sso:CreateManagedApplicationInstance,
sso:DescribeRegisteredRegions

Read

iotfleethub:DescribeApplication

Update

iotfleethub:UpdateApplication,
iotfleethub:DescribeApplication,
iotfleethub:TagResource,
iotfleethub:UntagResource

Delete

iotfleethub:DeleteApplication,
iotfleethub:DescribeApplication,
sso:DeleteManagedApplicationInstance

List

iotfleethub:ListApplications