application_instances

Creates, updates, deletes or gets an application_instance resource or lists application_instances in a region

Overview

Name	application_instances
Type	Resource
Description	Schema for ApplicationInstance CloudFormation Resource
Id	aws.panorama.application_instances

Fields

Name	Datatype	Description
default_runtime_context_device_name	string
status	string
default_runtime_context_device	string
description	string
application_instance_id_to_replace	string
created_time	integer
health_status	string
manifest_overrides_payload	object
last_updated_time	integer
runtime_role_arn	string
name	string
application_instance_id	string
status_description	string
manifest_payload	object
arn	string
tags	array
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ManifestPayload, DefaultRuntimeContextDevice, 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 application_instances in a region.

SELECT
region,
default_runtime_context_device_name,
status,
default_runtime_context_device,
description,
application_instance_id_to_replace,
created_time,
health_status,
manifest_overrides_payload,
last_updated_time,
runtime_role_arn,
name,
application_instance_id,
status_description,
manifest_payload,
arn,
tags
FROM aws.panorama.application_instances
WHERE region = 'us-east-1';

Gets all properties from an individual application_instance.

SELECT
region,
default_runtime_context_device_name,
status,
default_runtime_context_device,
description,
application_instance_id_to_replace,
created_time,
health_status,
manifest_overrides_payload,
last_updated_time,
runtime_role_arn,
name,
application_instance_id,
status_description,
manifest_payload,
arn,
tags
FROM aws.panorama.application_instances
WHERE region = 'us-east-1' AND data__Identifier = '<ApplicationInstanceId>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.panorama.application_instances (
 DefaultRuntimeContextDevice,
 ManifestPayload,
 region
)
SELECT 
'{{ DefaultRuntimeContextDevice }}',
 '{{ ManifestPayload }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.panorama.application_instances (
 DefaultRuntimeContextDevice,
 Description,
 ApplicationInstanceIdToReplace,
 ManifestOverridesPayload,
 RuntimeRoleArn,
 Name,
 ManifestPayload,
 Tags,
 region
)
SELECT 
 '{{ DefaultRuntimeContextDevice }}',
 '{{ Description }}',
 '{{ ApplicationInstanceIdToReplace }}',
 '{{ ManifestOverridesPayload }}',
 '{{ RuntimeRoleArn }}',
 '{{ Name }}',
 '{{ ManifestPayload }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: application_instance
    props:
      - name: DefaultRuntimeContextDevice
        value: '{{ DefaultRuntimeContextDevice }}'
      - name: Description
        value: '{{ Description }}'
      - name: ApplicationInstanceIdToReplace
        value: '{{ ApplicationInstanceIdToReplace }}'
      - name: ManifestOverridesPayload
        value:
          PayloadData: '{{ PayloadData }}'
      - name: RuntimeRoleArn
        value: '{{ RuntimeRoleArn }}'
      - name: Name
        value: '{{ Name }}'
      - name: ManifestPayload
        value:
          PayloadData: '{{ PayloadData }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.panorama.application_instances
WHERE data__Identifier = '<ApplicationInstanceId>'
AND region = 'us-east-1';

Permissions

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

Read

panorama:DescribeApplicationInstance,
panorama:DescribeApplicationInstanceDetails,
panorama:ListTagsForResource,
s3:ListObjects,
s3:GetObject,
s3:GetObjectVersion

Create

panorama:CreateApplicationInstance,
panorama:ListTagsForResource,
panorama:TagResource,
panorama:DescribeApplicationInstance,
panorama:DescribeApplicationInstanceDetails,
iam:PassRole,
s3:ListBucket,
s3:PutObject,
s3:GetObject,
s3:GetObjectVersion

Update

panorama:ListTagsForResource,
panorama:TagResource,
panorama:UntagResource,
panorama:DescribeApplicationInstance,
panorama:DescribeApplicationInstanceDetails,
s3:ListObjects,
s3:GetObject,
s3:GetObjectVersion

List

panorama:ListApplicationInstances,
s3:ListBucket,
s3:GetObject,
s3:GetObjectVersion

Delete

panorama:RemoveApplicationInstance,
panorama:DescribeApplicationInstance,
panorama:DescribeApplicationInstanceDetails,
s3:DeleteObject,
s3:DeleteObjectVersion,
s3:DeleteObjectVersionTagging,
s3:ListObjects,
s3:GetObject,
s3:GetObjectVersion