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	awscc.opensearchservice.applications

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
name	string	The name of the application.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	applications	INSERT	Name, 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,
  iam_identity_center_options,
  arn,
  id,
  name,
  endpoint,
  app_configs,
  data_sources,
  tags
FROM awscc.opensearchservice.applications
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}';

list (identifiers only)

Lists all applications in a region.

SELECT
  region,
  name
FROM awscc.opensearchservice.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.opensearchservice.applications (
  Name,
  region
)
SELECT
  '{{ name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.opensearchservice.applications (
  IamIdentityCenterOptions,
  Name,
  Endpoint,
  AppConfigs,
  DataSources,
  Tags,
  region
)
SELECT
  '{{ iam_identity_center_options }}',
  '{{ name }}',
  '{{ endpoint }}',
  '{{ app_configs }}',
  '{{ data_sources }}',
  '{{ tags }}',
  '{{ 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: iam_identity_center_options
      value:
        enabled: '{{ enabled }}'
        iam_identity_center_instance_arn: '{{ iam_identity_center_instance_arn }}'
        iam_role_for_identity_center_application_arn: '{{ iam_role_for_identity_center_application_arn }}'
    - name: name
      value: '{{ name }}'
    - name: endpoint
      value: '{{ endpoint }}'
    - name: app_configs
      value:
        - key: '{{ key }}'
          value: '{{ value }}'
    - name: data_sources
      value:
        - data_source_arn: '{{ data_source_arn }}'
          data_source_description: '{{ data_source_description }}'
    - name: tags
      value:
        - value: '{{ value }}'
          key: '{{ key }}'

UPDATE example

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

/*+ update */
UPDATE awscc.opensearchservice.applications
SET PatchDocument = string('{{ {
    "IamIdentityCenterOptions": iam_identity_center_options,
    "Endpoint": endpoint,
    "AppConfigs": app_configs,
    "DataSources": data_sources,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.opensearchservice.applications
WHERE
  Identifier = '{{ name }}' 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

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