create-application¶

Description¶

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

Synopsis¶

  create-application
[--client-token <value>]
--name <value>
[--data-sources <value>]
[--iam-identity-center-options <value>]
[--app-configs <value>]
[--tag-list <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--client-token (string)

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

--name (string)

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

--data-sources (list)

The data sources to link to the OpenSearch application.

(structure)

Data sources that are associated with an OpenSearch Application.

dataSourceArn -> (string)

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

dataSourceDescription -> (string)

Detailed description of a data source.

Shorthand Syntax:

dataSourceArn=string,dataSourceDescription=string ...

JSON Syntax:

[
  {
    "dataSourceArn": "string",
    "dataSourceDescription": "string"
  }
  ...
]

--iam-identity-center-options (structure)

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

enabled -> (boolean)

Specifies whether IAM Identity Center is enabled or disabled.

iamIdentityCenterInstanceArn -> (string)

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

iamRoleForIdentityCenterApplicationArn -> (string)

The ARN of the IAM role associated with the IAM Identity Center application.

Shorthand Syntax:

enabled=boolean,iamIdentityCenterInstanceArn=string,iamRoleForIdentityCenterApplicationArn=string

JSON Syntax:

{
  "enabled": true|false,
  "iamIdentityCenterInstanceArn": "string",
  "iamRoleForIdentityCenterApplicationArn": "string"
}

--app-configs (list)

Configuration settings for the OpenSearch application, including administrative options.

(structure)

Configuration settings for an OpenSearch application. For more information, see see Using the OpenSearch user interface in Amazon OpenSearch Service .

key -> (string)

The configuration item to set, such as the admin role for the OpenSearch application.

value -> (string)

The value assigned to the configuration key, such as an IAM user ARN.

Shorthand Syntax:

key=string,value=string ...

JSON Syntax:

[
  {
    "key": "opensearchDashboards.dashboardAdmin.users"|"opensearchDashboards.dashboardAdmin.groups",
    "value": "string"
  }
  ...
]

--tag-list (list)

A list of tags attached to a domain.

(structure)

A tag (key-value pair) for an Amazon OpenSearch Service resource.

Key -> (string)

The tag key. Tag keys must be unique for the domain to which they are attached.

Value -> (string)

The value assigned to the corresponding tag key. Tag values can be null and don’t have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output¶

id -> (string)

The unique identifier assigned to the OpenSearch application.

name -> (string)

The name of the OpenSearch application.

arn -> (string)

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

dataSources -> (list)

The data sources linked to the OpenSearch application.

(structure)

Data sources that are associated with an OpenSearch Application.

dataSourceArn -> (string)

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

dataSourceDescription -> (string)

Detailed description of a data source.

iamIdentityCenterOptions -> (structure)

The IAM Identity Center settings configured for the OpenSearch application.

enabled -> (boolean)

Indicates whether IAM Identity Center is enabled for the OpenSearch Application.

iamIdentityCenterInstanceArn -> (string)

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

iamRoleForIdentityCenterApplicationArn -> (string)

The Amazon Resource Name (ARN) of the IAM role assigned to the IAM Identity Center application for the OpenSearch Application.

iamIdentityCenterApplicationArn -> (string)

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

appConfigs -> (list)

Configuration settings for the OpenSearch application, including administrative options.

(structure)

Configuration settings for an OpenSearch application. For more information, see see Using the OpenSearch user interface in Amazon OpenSearch Service .

key -> (string)

The configuration item to set, such as the admin role for the OpenSearch application.

value -> (string)

The value assigned to the configuration key, such as an IAM user ARN.

tagList -> (list)

A list of tags attached to a domain.

(structure)

A tag (key-value pair) for an Amazon OpenSearch Service resource.

Key -> (string)

The tag key. Tag keys must be unique for the domain to which they are attached.

Value -> (string)

The value assigned to the corresponding tag key. Tag values can be null and don’t have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity

createdAt -> (timestamp)

The timestamp indicating when the OpenSearch application was created.

Table of Contents

Feedback

User Guide

create-application¶

Description¶

Synopsis¶

Options¶

Global Options¶

Output¶