This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::OpenSearchService::Application
<a name="aws-resource-opensearchservice-application"></a>

Creates an OpenSearch UI application. For more information, see [Using the OpenSearch user interface in Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/application.html).

## Syntax
<a name="aws-resource-opensearchservice-application-syntax"></a>

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

### JSON
<a name="aws-resource-opensearchservice-application-syntax.json"></a>

```
{
  "Type" : "AWS::OpenSearchService::Application",
  "Properties" : {
      "[AppConfigs](#cfn-opensearchservice-application-appconfigs)" : [ AppConfig, ... ],
      "[DataSources](#cfn-opensearchservice-application-datasources)" : [ DataSource, ... ],
      "[Endpoint](#cfn-opensearchservice-application-endpoint)" : String,
      "[IamIdentityCenterOptions](#cfn-opensearchservice-application-iamidentitycenteroptions)" : IamIdentityCenterOptions,
      "[Name](#cfn-opensearchservice-application-name)" : String,
      "[Tags](#cfn-opensearchservice-application-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-opensearchservice-application-syntax.yaml"></a>

```
Type: AWS::OpenSearchService::Application
Properties:
  [AppConfigs](#cfn-opensearchservice-application-appconfigs): 
    - AppConfig
  [DataSources](#cfn-opensearchservice-application-datasources): 
    - DataSource
  [Endpoint](#cfn-opensearchservice-application-endpoint): String
  [IamIdentityCenterOptions](#cfn-opensearchservice-application-iamidentitycenteroptions): 
    IamIdentityCenterOptions
  [Name](#cfn-opensearchservice-application-name): String
  [Tags](#cfn-opensearchservice-application-tags): 
    - Tag
```

## Properties
<a name="aws-resource-opensearchservice-application-properties"></a>

`AppConfigs`  <a name="cfn-opensearchservice-application-appconfigs"></a>
Property description not available.  
*Required*: No  
*Type*: Array of [AppConfig](aws-properties-opensearchservice-application-appconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DataSources`  <a name="cfn-opensearchservice-application-datasources"></a>
Property description not available.  
*Required*: No  
*Type*: Array of [DataSource](aws-properties-opensearchservice-application-datasource.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Endpoint`  <a name="cfn-opensearchservice-application-endpoint"></a>
The endpoint URL of an OpenSearch application.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IamIdentityCenterOptions`  <a name="cfn-opensearchservice-application-iamidentitycenteroptions"></a>
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](aws-properties-opensearchservice-application-iamidentitycenteroptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-opensearchservice-application-name"></a>
The name of an OpenSearch application.  
*Required*: Yes  
*Type*: String  
*Pattern*: `[a-z][a-z0-9\-]+`  
*Minimum*: `3`  
*Maximum*: `40`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-opensearchservice-application-tags"></a>
Property description not available.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-opensearchservice-application-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-opensearchservice-application-return-values"></a>

### Ref
<a name="aws-resource-opensearchservice-application-return-values-ref"></a>

### Fn::GetAtt
<a name="aws-resource-opensearchservice-application-return-values-fn--getatt"></a>

#### 
<a name="aws-resource-opensearchservice-application-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the domain. See [Identifiers for IAM Entities ](https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html) in *Using AWS Identity and Access Management* for more information. 

`Id`  <a name="Id-fn::getatt"></a>
The unique identifier of an OpenSearch application.

# AWS::OpenSearchService::Application AppConfig
<a name="aws-properties-opensearchservice-application-appconfig"></a>

Configuration settings for an OpenSearch application. For more information, see [Using the OpenSearch user interface in Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/application.html).

## Syntax
<a name="aws-properties-opensearchservice-application-appconfig-syntax"></a>

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

### JSON
<a name="aws-properties-opensearchservice-application-appconfig-syntax.json"></a>

```
{
  "[Key](#cfn-opensearchservice-application-appconfig-key)" : String,
  "[Value](#cfn-opensearchservice-application-appconfig-value)" : String
}
```

### YAML
<a name="aws-properties-opensearchservice-application-appconfig-syntax.yaml"></a>

```
  [Key](#cfn-opensearchservice-application-appconfig-key): String
  [Value](#cfn-opensearchservice-application-appconfig-value): String
```

## Properties
<a name="aws-properties-opensearchservice-application-appconfig-properties"></a>

`Key`  <a name="cfn-opensearchservice-application-appconfig-key"></a>
The configuration item to set, such as the admin role for the OpenSearch application.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `opensearchDashboards.dashboardAdmin.users | opensearchDashboards.dashboardAdmin.groups`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-opensearchservice-application-appconfig-value"></a>
The value assigned to the configuration key, such as an IAM user ARN.  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::OpenSearchService::Application DataSource
<a name="aws-properties-opensearchservice-application-datasource"></a>

Data sources that are associated with an OpenSearch application. 

## Syntax
<a name="aws-properties-opensearchservice-application-datasource-syntax"></a>

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

### JSON
<a name="aws-properties-opensearchservice-application-datasource-syntax.json"></a>

```
{
  "[DataSourceArn](#cfn-opensearchservice-application-datasource-datasourcearn)" : String,
  "[DataSourceDescription](#cfn-opensearchservice-application-datasource-datasourcedescription)" : String
}
```

### YAML
<a name="aws-properties-opensearchservice-application-datasource-syntax.yaml"></a>

```
  [DataSourceArn](#cfn-opensearchservice-application-datasource-datasourcearn): String
  [DataSourceDescription](#cfn-opensearchservice-application-datasource-datasourcedescription): String
```

## Properties
<a name="aws-properties-opensearchservice-application-datasource-properties"></a>

`DataSourceArn`  <a name="cfn-opensearchservice-application-datasource-datasourcearn"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DataSourceDescription`  <a name="cfn-opensearchservice-application-datasource-datasourcedescription"></a>
Detailed description of a data source.  
*Required*: No  
*Type*: String  
*Pattern*: `^([a-zA-Z0-9_])*[\\a-zA-Z0-9_@#%*+=:?./!\s-]*$`  
*Maximum*: `1000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::OpenSearchService::Application IamIdentityCenterOptions
<a name="aws-properties-opensearchservice-application-iamidentitycenteroptions"></a>

Configuration settings for IAM Identity Center in an OpenSearch application.

## Syntax
<a name="aws-properties-opensearchservice-application-iamidentitycenteroptions-syntax"></a>

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

### JSON
<a name="aws-properties-opensearchservice-application-iamidentitycenteroptions-syntax.json"></a>

```
{
  "[Enabled](#cfn-opensearchservice-application-iamidentitycenteroptions-enabled)" : Boolean,
  "[IamIdentityCenterInstanceArn](#cfn-opensearchservice-application-iamidentitycenteroptions-iamidentitycenterinstancearn)" : String,
  "[IamRoleForIdentityCenterApplicationArn](#cfn-opensearchservice-application-iamidentitycenteroptions-iamroleforidentitycenterapplicationarn)" : String
}
```

### YAML
<a name="aws-properties-opensearchservice-application-iamidentitycenteroptions-syntax.yaml"></a>

```
  [Enabled](#cfn-opensearchservice-application-iamidentitycenteroptions-enabled): Boolean
  [IamIdentityCenterInstanceArn](#cfn-opensearchservice-application-iamidentitycenteroptions-iamidentitycenterinstancearn): String
  [IamRoleForIdentityCenterApplicationArn](#cfn-opensearchservice-application-iamidentitycenteroptions-iamroleforidentitycenterapplicationarn): String
```

## Properties
<a name="aws-properties-opensearchservice-application-iamidentitycenteroptions-properties"></a>

`Enabled`  <a name="cfn-opensearchservice-application-iamidentitycenteroptions-enabled"></a>
Indicates whether IAM Identity Center is enabled for the OpenSearch application.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IamIdentityCenterInstanceArn`  <a name="cfn-opensearchservice-application-iamidentitycenteroptions-iamidentitycenterinstancearn"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IamRoleForIdentityCenterApplicationArn`  <a name="cfn-opensearchservice-application-iamidentitycenteroptions-iamroleforidentitycenterapplicationarn"></a>
The Amazon Resource Name (ARN) of the IAM role assigned to the IAM Identity Center application for the OpenSearch application.  
*Required*: No  
*Type*: String  
*Pattern*: `arn:(aws|aws\-cn|aws\-us\-gov|aws\-iso|aws\-iso\-b):iam::[0-9]+:role\/.*`  
*Minimum*: `20`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::OpenSearchService::Application Tag
<a name="aws-properties-opensearchservice-application-tag"></a>

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

## Syntax
<a name="aws-properties-opensearchservice-application-tag-syntax"></a>

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

### JSON
<a name="aws-properties-opensearchservice-application-tag-syntax.json"></a>

```
{
  "[Key](#cfn-opensearchservice-application-tag-key)" : String,
  "[Value](#cfn-opensearchservice-application-tag-value)" : String
}
```

### YAML
<a name="aws-properties-opensearchservice-application-tag-syntax.yaml"></a>

```
  [Key](#cfn-opensearchservice-application-tag-key): String
  [Value](#cfn-opensearchservice-application-tag-value): String
```

## Properties
<a name="aws-properties-opensearchservice-application-tag-properties"></a>

`Key`  <a name="cfn-opensearchservice-application-tag-key"></a>
The tag key. Tag keys must be unique for the domain to which they are attached.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-opensearchservice-application-tag-value"></a>
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`  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)