Skip to content

Creates an OpenSearch UI application

Description

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

Usage

opensearchservice_create_application(clientToken, name, dataSources,
  iamIdentityCenterOptions, appConfigs, tagList, kmsKeyArn)

Arguments

  • clientToken

    Unique, case-sensitive identifier to ensure idempotency of the request.

  • name

    [required] The unique name of the OpenSearch application. Names must be unique within an Amazon Web Services Region for each account.

  • dataSources

    The data sources to link to the OpenSearch application.

  • iamIdentityCenterOptions

    Configuration settings for integrating Amazon Web Services IAM Identity Center with the OpenSearch application.

  • appConfigs

    Configuration settings for the OpenSearch application, including administrative options.

  • tagList

    A list of tags attached to a domain.

  • kmsKeyArn

    The Amazon Resource Name (ARN) of the KMS key used to encrypt the application's data at rest. If provided, the application uses your customer-managed key for encryption. If omitted, the application uses an AWS-managed key. The KMS key must be in the same region as the application.

Value

A list with the following syntax:

list(
  id = "string",
  name = "string",
  arn = "string",
  dataSources = list(
    list(
      dataSourceArn = "string",
      dataSourceDescription = "string",
      iamRoleForDataSourceArn = "string"
    )
  ),
  iamIdentityCenterOptions = list(
    enabled = TRUE|FALSE,
    iamIdentityCenterInstanceArn = "string",
    iamRoleForIdentityCenterApplicationArn = "string",
    iamIdentityCenterApplicationArn = "string"
  ),
  appConfigs = list(
    list(
      key = "opensearchDashboards.dashboardAdmin.users"|"opensearchDashboards.dashboardAdmin.groups",
      value = "string"
    )
  ),
  tagList = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  createdAt = as.POSIXct(
    "2015-01-01"
  ),
  kmsKeyArn = "string"
)

Request syntax

svc$create_application(
  clientToken = "string",
  name = "string",
  dataSources = list(
    list(
      dataSourceArn = "string",
      dataSourceDescription = "string",
      iamRoleForDataSourceArn = "string"
    )
  ),
  iamIdentityCenterOptions = list(
    enabled = TRUE|FALSE,
    iamIdentityCenterInstanceArn = "string",
    iamRoleForIdentityCenterApplicationArn = "string"
  ),
  appConfigs = list(
    list(
      key = "opensearchDashboards.dashboardAdmin.users"|"opensearchDashboards.dashboardAdmin.groups",
      value = "string"
    )
  ),
  tagList = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  kmsKeyArn = "string"
)