AWS::OpenSearchService::Application

Creates an OpenSearch UI application. For more information, see Using the OpenSearch user interface in Amazon OpenSearch Service.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::OpenSearchService::Application",
  "Properties" : {
      "AppConfigs" : [ AppConfig, ... ],
      "DataSources" : [ DataSource, ... ],
      "Endpoint" : String,
      "IamIdentityCenterOptions" : IamIdentityCenterOptions,
      "Name" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::OpenSearchService::Application
Properties:
  AppConfigs: 
    - AppConfig
  DataSources: 
    - DataSource
  Endpoint: String
  IamIdentityCenterOptions: 
    IamIdentityCenterOptions
  Name: String
  Tags: 
    - Tag

Properties

AppConfigs

Property description not available.

Required: No

Type: Array of AppConfig

Update requires: No interruption

DataSources

Property description not available.

Required: No

Type: Array of DataSource

Update requires: No interruption

Endpoint

The endpoint URL of an OpenSearch application.

Required: No

Type: String

Update requires: No interruption

IamIdentityCenterOptions

Settings container for integrating IAM Identity Center with OpenSearch UI applications, which enables enabling secure user authentication and access control across multiple data sources. This setup supports single sign-on (SSO) through IAM Identity Center, allowing centralized user management.

Required: No

Type: IamIdentityCenterOptions

Update requires: No interruption

Name

The name of an OpenSearch application.

Required: Yes

Type: String

Pattern: [a-z][a-z0-9\-]+

Minimum: 3

Maximum: 40

Update requires: Replacement

Tags

Property description not available.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

Fn::GetAtt

Arn

The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

Id

The unique identifier of an OpenSearch application.