Package software.amazon.awscdk.services.opensearchservice

Interface CfnApplicationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApplicationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:42.843Z")
@Stability(Stable)
public interface CfnApplicationProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnApplication.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.opensearchservice.*;
 CfnApplicationProps cfnApplicationProps = CfnApplicationProps.builder()
         .name("name")
         // the properties below are optional
         .appConfigs(List.of(AppConfigProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .dataSources(List.of(DataSourceProperty.builder()
                 .dataSourceArn("dataSourceArn")
                 // the properties below are optional
                 .dataSourceDescription("dataSourceDescription")
                 .build()))
         .endpoint("endpoint")
         .iamIdentityCenterOptions(IamIdentityCenterOptionsProperty.builder()
                 .enabled(false)
                 .iamIdentityCenterInstanceArn("iamIdentityCenterInstanceArn")
                 .iamRoleForIdentityCenterApplicationArn("iamRoleForIdentityCenterApplicationArn")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-application.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnApplicationProps.Builder	A builder for CfnApplicationProps
static final class	CfnApplicationProps.Jsii$Proxy	An implementation for CfnApplicationProps

Method Summary

Modifier and Type	Method	Description
static CfnApplicationProps.Builder	builder()
default Object	getAppConfigs()	List of application configurations.
default Object	getDataSources()	List of data sources.
default String	getEndpoint()	The endpoint URL of an OpenSearch application.
default Object	getIamIdentityCenterOptions()	Settings container for integrating IAM Identity Center with OpenSearch UI applications, which enables enabling secure user authentication and access control across multiple data sources.
String	getName()	The name of an OpenSearch application.
default List<CfnTag>	getTags()	An arbitrary set of tags (key-value pairs) for this application.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of an OpenSearch application.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-application.html#cfn-opensearchservice-application-name

getAppConfigs

@Stability(Stable)
@Nullable
default Object getAppConfigs()

List of application configurations.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnApplication.AppConfigProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-application.html#cfn-opensearchservice-application-appconfigs

getDataSources

@Stability(Stable)
@Nullable
default Object getDataSources()

List of data sources.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnApplication.DataSourceProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-application.html#cfn-opensearchservice-application-datasources

getEndpoint

@Stability(Stable)
@Nullable
default String getEndpoint()

The endpoint URL of an OpenSearch application.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-application.html#cfn-opensearchservice-application-endpoint

getIamIdentityCenterOptions

@Stability(Stable)
@Nullable
default Object getIamIdentityCenterOptions()

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.

Returns union: either IResolvable or CfnApplication.IamIdentityCenterOptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-application.html#cfn-opensearchservice-application-iamidentitycenteroptions

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

An arbitrary set of tags (key-value pairs) for this application.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-application.html#cfn-opensearchservice-application-tags

builder

@Stability(Stable)
static CfnApplicationProps.Builder builder()

Returns:

a CfnApplicationProps.Builder of CfnApplicationProps