applications

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

Overview

Name	applications
Type	Resource
Description	Amazon OpenSearchService application resource
Id	aws.opensearchservice.applications

Fields

Name	Datatype	Description
iam_identity_center_options	object	Options for configuring IAM Identity Center
arn	string	Amazon Resource Name (ARN) format.
id	string	The identifier of the application.
name	string	The name of the application.
endpoint	string	The endpoint for the application.
app_configs	array	List of application configurations.
data_sources	array	List of data sources.
tags	array	An arbitrary set of tags (key-value pairs) for this application.
region	string	AWS region.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, 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,
iam_identity_center_options,
arn,
id,
name,
endpoint,
app_configs,
data_sources,
tags
FROM aws.opensearchservice.applications
WHERE region = 'us-east-1';

Gets all properties from an individual application.

SELECT
region,
iam_identity_center_options,
arn,
id,
name,
endpoint,
app_configs,
data_sources,
tags
FROM aws.opensearchservice.applications
WHERE region = 'us-east-1' AND data__Identifier = '<Name>';

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.opensearchservice.applications (
 Name,
 region
)
SELECT 
'{{ Name }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.opensearchservice.applications (
 IamIdentityCenterOptions,
 Name,
 Endpoint,
 AppConfigs,
 DataSources,
 Tags,
 region
)
SELECT 
 '{{ IamIdentityCenterOptions }}',
 '{{ Name }}',
 '{{ Endpoint }}',
 '{{ AppConfigs }}',
 '{{ DataSources }}',
 '{{ 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: IamIdentityCenterOptions
        value:
          Enabled: '{{ Enabled }}'
          IamIdentityCenterInstanceArn: '{{ IamIdentityCenterInstanceArn }}'
          IamRoleForIdentityCenterApplicationArn: '{{ IamRoleForIdentityCenterApplicationArn }}'
      - name: Name
        value: '{{ Name }}'
      - name: Endpoint
        value: '{{ Endpoint }}'
      - name: AppConfigs
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: DataSources
        value:
          - DataSourceArn: '{{ DataSourceArn }}'
            DataSourceDescription: '{{ DataSourceDescription }}'
      - name: Tags
        value:
          - Value: '{{ Value }}'
            Key: '{{ Key }}'

DELETE example

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

Permissions

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

Create

es:CreateApplication,
es:GetApplication,
es:AddTags,
es:ListTags,
iam:CreateServiceLinkedRole

Read

es:GetApplication,
es:ListTags

Update

es:UpdateApplication,
es:GetApplication,
es:AddTags,
es:RemoveTags,
es:ListTags

Delete

es:GetApplication,
es:DeleteApplication

List

es:ListApplications