Package software.amazon.awscdk.services.opensearchservice

Class CfnApplication

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.opensearchservice.CfnApplication
All Implemented Interfaces:
IInspectable, ITaggableV2, IApplicationRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:42.841Z") @Stability(Stable) public class CfnApplication extends CfnResource implements IInspectable, IApplicationRef, ITaggableV2
Creates an OpenSearch UI application.

For more information, see Using the OpenSearch user interface in Amazon OpenSearch Service .

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.*;
 CfnApplication cfnApplication = CfnApplication.Builder.create(this, "MyCfnApplication")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnApplication

      protected CfnApplication(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnApplication

      protected CfnApplication(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnApplication

      @Stability(Stable) public CfnApplication(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnApplicationProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getApplicationRef

      @Stability(Stable) @NotNull public ApplicationReference getApplicationRef()
      A reference to a Application resource.
      Specified by:
      getApplicationRef in interface IApplicationRef

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the domain.

      See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The unique identifier of an OpenSearch application.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of an OpenSearch application.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of an OpenSearch application.

    • getAppConfigs

      @Stability(Stable) @Nullable public Object getAppConfigs()
      List of application configurations.

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

    • setAppConfigs

      @Stability(Stable) public void setAppConfigs(@Nullable IResolvable value)
      List of application configurations.

    • setAppConfigs

      @Stability(Stable) public void setAppConfigs(@Nullable List<Object> value)
      List of application configurations.

    • getDataSources

      @Stability(Stable) @Nullable public Object getDataSources()
      List of data sources.

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

    • setDataSources

      @Stability(Stable) public void setDataSources(@Nullable IResolvable value)
      List of data sources.

    • setDataSources

      @Stability(Stable) public void setDataSources(@Nullable List<Object> value)
      List of data sources.

    • getEndpoint

      @Stability(Stable) @Nullable public String getEndpoint()
      The endpoint URL of an OpenSearch application.

    • setEndpoint

      @Stability(Stable) public void setEndpoint(@Nullable String value)
      The endpoint URL of an OpenSearch application.

    • getIamIdentityCenterOptions

      @Stability(Stable) @Nullable public 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.

      Returns union: either IResolvable or CfnApplication.IamIdentityCenterOptionsProperty

    • setIamIdentityCenterOptions

      @Stability(Stable) public void setIamIdentityCenterOptions(@Nullable IResolvable value)
      Settings container for integrating IAM Identity Center with OpenSearch UI applications, which enables enabling secure user authentication and access control across multiple data sources.

    • setIamIdentityCenterOptions

      @Stability(Stable) public void setIamIdentityCenterOptions(@Nullable CfnApplication.IamIdentityCenterOptionsProperty value)
      Settings container for integrating IAM Identity Center with OpenSearch UI applications, which enables enabling secure user authentication and access control across multiple data sources.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An arbitrary set of tags (key-value pairs) for this application.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An arbitrary set of tags (key-value pairs) for this application.