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 AWS:AppIntegrations::Application
Id	awscc.appintegrations.applications

Fields

get (all properties)

Name	Datatype	Description
name	string	The name of the application.
id	string	The id of the application.
namespace	string	The namespace of the application.
description	string	The application description.
application_arn	string	The Amazon Resource Name (ARN) of the application.
▶application_source_config	object	Application source config
permissions	array	The configuration of events or requests that the application has access to.
▶tags	array	The tags (keys and values) associated with the application.
is_service	boolean	Indicates if the application is a service
initialization_timeout	integer	The initialization timeout in milliseconds. Required when IsService is true.
▶application_config	object	The application configuration. Cannot be used when IsService is true.
▶iframe_config	object	The iframe configuration
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
application_arn	string	The Amazon Resource Name (ARN) of the application.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	applications	INSERT	Name, Namespace, Description, ApplicationSourceConfig, 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,
  id,
  namespace,
  description,
  application_arn,
  application_source_config,
  permissions,
  tags,
  is_service,
  initialization_timeout,
  application_config,
  iframe_config
FROM awscc.appintegrations.applications
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ application_arn }}';

list (identifiers only)

Lists all applications in a region.

SELECT
  region,
  application_arn
FROM awscc.appintegrations.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.appintegrations.applications (
  Name,
  Namespace,
  Description,
  ApplicationSourceConfig,
  region
)
SELECT
  '{{ name }}',
  '{{ namespace }}',
  '{{ description }}',
  '{{ application_source_config }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.appintegrations.applications (
  Name,
  Namespace,
  Description,
  ApplicationSourceConfig,
  Permissions,
  Tags,
  IsService,
  InitializationTimeout,
  ApplicationConfig,
  IframeConfig,
  region
)
SELECT
  '{{ name }}',
  '{{ namespace }}',
  '{{ description }}',
  '{{ application_source_config }}',
  '{{ permissions }}',
  '{{ tags }}',
  '{{ is_service }}',
  '{{ initialization_timeout }}',
  '{{ application_config }}',
  '{{ iframe_config }}',
  '{{ 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: namespace
      value: '{{ namespace }}'
    - name: description
      value: '{{ description }}'
    - name: application_source_config
      value:
        external_url_config:
          access_url: '{{ access_url }}'
          approved_origins:
            - '{{ approved_origins[0] }}'
    - name: permissions
      value:
        - '{{ permissions[0] }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'
    - name: is_service
      value: '{{ is_service }}'
    - name: initialization_timeout
      value: '{{ initialization_timeout }}'
    - name: application_config
      value:
        contact_handling:
          scope: '{{ scope }}'
    - name: iframe_config
      value:
        allow:
          - '{{ allow[0] }}'
        sandbox:
          - '{{ sandbox[0] }}'

UPDATE example

Use the following StackQL query and manifest file to update a application resource, using stack-deploy.

/*+ update */
UPDATE awscc.appintegrations.applications
SET PatchDocument = string('{{ {
    "Name": name,
    "Namespace": namespace,
    "Description": description,
    "ApplicationSourceConfig": application_source_config,
    "Permissions": permissions,
    "Tags": tags,
    "IsService": is_service,
    "InitializationTimeout": initialization_timeout,
    "ApplicationConfig": application_config,
    "IframeConfig": iframe_config
} | 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.appintegrations.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

app-integrations:CreateApplication,
app-integrations:TagResource

Read

app-integrations:GetApplication

List

app-integrations:ListApplications,
app-integrations:ListTagsForResource

Update

app-integrations:GetApplication,
app-integrations:UpdateApplication,
app-integrations:TagResource,
app-integrations:UntagResource

Delete

app-integrations:DeleteApplication