Package software.amazon.awscdk.services.elasticsearch

Interface IDomain

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IDependable, IDomainRef, IEnvironmentAware, IResource, software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
IDomain.Jsii$Default
All Known Implementing Classes:
Domain, IDomain.Jsii$Proxy
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:10.441Z") @Stability(Deprecated) @Deprecated public interface IDomain extends software.amazon.jsii.JsiiSerializable, IResource, IDomainRef
Deprecated.
use opensearchservice module instead
(deprecated) An interface that represents an Elasticsearch domain - either created with the CDK, or an existing one.

  • Method Details

    • getDomainArn

      @Stability(Deprecated) @Deprecated @NotNull String getDomainArn()
      Deprecated.
      use opensearchservice module instead
      (deprecated) Arn of the Elasticsearch domain.

    • getDomainEndpoint

      @Stability(Deprecated) @Deprecated @NotNull String getDomainEndpoint()
      Deprecated.
      use opensearchservice module instead
      (deprecated) Endpoint of the Elasticsearch domain.

    • getDomainName

      @Stability(Deprecated) @Deprecated @NotNull String getDomainName()
      Deprecated.
      use opensearchservice module instead
      (deprecated) Domain name of the Elasticsearch domain.

    • grantIndexRead

      @Stability(Deprecated) @Deprecated @NotNull Grant grantIndexRead(@NotNull String index, @NotNull IGrantable identity)
      Deprecated.
      use opensearchservice module instead
      (deprecated) Grant read permissions for an index in this domain to an IAM principal (Role/Group/User).

      Parameters:
      index - The index to grant permissions for. This parameter is required.
      identity - The principal. This parameter is required.

    • grantIndexReadWrite

      @Stability(Deprecated) @Deprecated @NotNull Grant grantIndexReadWrite(@NotNull String index, @NotNull IGrantable identity)
      Deprecated.
      use opensearchservice module instead
      (deprecated) Grant read/write permissions for an index in this domain to an IAM principal (Role/Group/User).

      Parameters:
      index - The index to grant permissions for. This parameter is required.
      identity - The principal. This parameter is required.

    • grantIndexWrite

      @Stability(Deprecated) @Deprecated @NotNull Grant grantIndexWrite(@NotNull String index, @NotNull IGrantable identity)
      Deprecated.
      use opensearchservice module instead
      (deprecated) Grant write permissions for an index in this domain to an IAM principal (Role/Group/User).

      Parameters:
      index - The index to grant permissions for. This parameter is required.
      identity - The principal. This parameter is required.

    • grantPathRead

      @Stability(Deprecated) @Deprecated @NotNull Grant grantPathRead(@NotNull String path, @NotNull IGrantable identity)
      Deprecated.
      use opensearchservice module instead
      (deprecated) Grant read permissions for a specific path in this domain to an IAM principal (Role/Group/User).

      Parameters:
      path - The path to grant permissions for. This parameter is required.
      identity - The principal. This parameter is required.

    • grantPathReadWrite

      @Stability(Deprecated) @Deprecated @NotNull Grant grantPathReadWrite(@NotNull String path, @NotNull IGrantable identity)
      Deprecated.
      use opensearchservice module instead
      (deprecated) Grant read/write permissions for a specific path in this domain to an IAM principal (Role/Group/User).

      Parameters:
      path - The path to grant permissions for. This parameter is required.
      identity - The principal. This parameter is required.

    • grantPathWrite

      @Stability(Deprecated) @Deprecated @NotNull Grant grantPathWrite(@NotNull String path, @NotNull IGrantable identity)
      Deprecated.
      use opensearchservice module instead
      (deprecated) Grant write permissions for a specific path in this domain to an IAM principal (Role/Group/User).

      Parameters:
      path - The path to grant permissions for. This parameter is required.
      identity - The principal. This parameter is required.

    • grantRead

      @Stability(Deprecated) @Deprecated @NotNull Grant grantRead(@NotNull IGrantable identity)
      Deprecated.
      use opensearchservice module instead
      (deprecated) Grant read permissions for this domain and its contents to an IAM principal (Role/Group/User).

      Parameters:
      identity - The principal. This parameter is required.

    • grantReadWrite

      @Stability(Deprecated) @Deprecated @NotNull Grant grantReadWrite(@NotNull IGrantable identity)
      Deprecated.
      use opensearchservice module instead
      (deprecated) Grant read/write permissions for this domain and its contents to an IAM principal (Role/Group/User).

      Parameters:
      identity - The principal. This parameter is required.

    • grantWrite

      @Stability(Deprecated) @Deprecated @NotNull Grant grantWrite(@NotNull IGrantable identity)
      Deprecated.
      use opensearchservice module instead
      (deprecated) Grant write permissions for this domain and its contents to an IAM principal (Role/Group/User).

      Parameters:
      identity - The principal. This parameter is required.

    • metric

      @Stability(Deprecated) @Deprecated @NotNull Metric metric(@NotNull String metricName, @Nullable MetricOptions props)
      Deprecated.
      use opensearchservice module instead
      (deprecated) Return the given named metric for this Domain.

      Parameters:
      metricName - This parameter is required.
      props -

    • metric

      @Stability(Deprecated) @Deprecated @NotNull Metric metric(@NotNull String metricName)
      Deprecated.
      use opensearchservice module instead
      (deprecated) Return the given named metric for this Domain.

      Parameters:
      metricName - This parameter is required.

    • metricAutomatedSnapshotFailure

      @Stability(Deprecated) @Deprecated @NotNull Metric metricAutomatedSnapshotFailure(@Nullable MetricOptions props)
      Deprecated.
      use opensearchservice module instead
      (deprecated) Metric for automated snapshot failures.

      Default: maximum over 5 minutes

      Parameters:
      props -

    • metricAutomatedSnapshotFailure

      @Stability(Deprecated) @Deprecated @NotNull Metric metricAutomatedSnapshotFailure()
      Deprecated.
      use opensearchservice module instead
      (deprecated) Metric for automated snapshot failures.

      Default: maximum over 5 minutes

    • metricClusterIndexWritesBlocked

      @Stability(Deprecated) @Deprecated @NotNull Metric metricClusterIndexWritesBlocked(@Nullable MetricOptions props)
      Deprecated.
      use opensearchservice module instead
      (deprecated) Metric for the cluster blocking index writes.

      Default: maximum over 1 minute

      Parameters:
      props -

    • metricClusterIndexWritesBlocked

      @Stability(Deprecated) @Deprecated @NotNull Metric metricClusterIndexWritesBlocked()
      Deprecated.
      use opensearchservice module instead
      (deprecated) Metric for the cluster blocking index writes.

      Default: maximum over 1 minute

    • metricClusterStatusRed

      @Stability(Deprecated) @Deprecated @NotNull Metric metricClusterStatusRed(@Nullable MetricOptions props)
      Deprecated.
      use opensearchservice module instead
      (deprecated) Metric for the time the cluster status is red.

      Default: maximum over 5 minutes

      Parameters:
      props -

    • metricClusterStatusRed

      @Stability(Deprecated) @Deprecated @NotNull Metric metricClusterStatusRed()
      Deprecated.
      use opensearchservice module instead
      (deprecated) Metric for the time the cluster status is red.

      Default: maximum over 5 minutes

    • metricClusterStatusYellow

      @Stability(Deprecated) @Deprecated @NotNull Metric metricClusterStatusYellow(@Nullable MetricOptions props)
      Deprecated.
      use opensearchservice module instead
      (deprecated) Metric for the time the cluster status is yellow.

      Default: maximum over 5 minutes

      Parameters:
      props -

    • metricClusterStatusYellow

      @Stability(Deprecated) @Deprecated @NotNull Metric metricClusterStatusYellow()
      Deprecated.
      use opensearchservice module instead
      (deprecated) Metric for the time the cluster status is yellow.

      Default: maximum over 5 minutes

    • metricCPUUtilization

      @Stability(Deprecated) @Deprecated @NotNull Metric metricCPUUtilization(@Nullable MetricOptions props)
      Deprecated.
      use opensearchservice module instead
      (deprecated) Metric for CPU utilization.

      Default: maximum over 5 minutes

      Parameters:
      props -

    • metricCPUUtilization

      @Stability(Deprecated) @Deprecated @NotNull Metric metricCPUUtilization()
      Deprecated.
      use opensearchservice module instead
      (deprecated) Metric for CPU utilization.

      Default: maximum over 5 minutes

    • metricFreeStorageSpace

      @Stability(Deprecated) @Deprecated @NotNull Metric metricFreeStorageSpace(@Nullable MetricOptions props)
      Deprecated.
      use opensearchservice module instead
      (deprecated) Metric for the storage space of nodes in the cluster.

      Default: minimum over 5 minutes

      Parameters:
      props -

    • metricFreeStorageSpace

      @Stability(Deprecated) @Deprecated @NotNull Metric metricFreeStorageSpace()
      Deprecated.
      use opensearchservice module instead
      (deprecated) Metric for the storage space of nodes in the cluster.

      Default: minimum over 5 minutes

    • metricIndexingLatency

      @Stability(Deprecated) @Deprecated @NotNull Metric metricIndexingLatency(@Nullable MetricOptions props)
      Deprecated.
      use opensearchservice module instead
      (deprecated) Metric for indexing latency.

      Default: p99 over 5 minutes

      Parameters:
      props -

    • metricIndexingLatency

      @Stability(Deprecated) @Deprecated @NotNull Metric metricIndexingLatency()
      Deprecated.
      use opensearchservice module instead
      (deprecated) Metric for indexing latency.

      Default: p99 over 5 minutes

    • metricJVMMemoryPressure

      @Stability(Deprecated) @Deprecated @NotNull Metric metricJVMMemoryPressure(@Nullable MetricOptions props)
      Deprecated.
      use opensearchservice module instead
      (deprecated) Metric for JVM memory pressure.

      Default: maximum over 5 minutes

      Parameters:
      props -

    • metricJVMMemoryPressure

      @Stability(Deprecated) @Deprecated @NotNull Metric metricJVMMemoryPressure()
      Deprecated.
      use opensearchservice module instead
      (deprecated) Metric for JVM memory pressure.

      Default: maximum over 5 minutes

    • metricKMSKeyError

      @Stability(Deprecated) @Deprecated @NotNull Metric metricKMSKeyError(@Nullable MetricOptions props)
      Deprecated.
      use opensearchservice module instead
      (deprecated) Metric for KMS key errors.

      Default: maximum over 5 minutes

      Parameters:
      props -

    • metricKMSKeyError

      @Stability(Deprecated) @Deprecated @NotNull Metric metricKMSKeyError()
      Deprecated.
      use opensearchservice module instead
      (deprecated) Metric for KMS key errors.

      Default: maximum over 5 minutes

    • metricKMSKeyInaccessible

      @Stability(Deprecated) @Deprecated @NotNull Metric metricKMSKeyInaccessible(@Nullable MetricOptions props)
      Deprecated.
      use opensearchservice module instead
      (deprecated) Metric for KMS key being inaccessible.

      Default: maximum over 5 minutes

      Parameters:
      props -

    • metricKMSKeyInaccessible

      @Stability(Deprecated) @Deprecated @NotNull Metric metricKMSKeyInaccessible()
      Deprecated.
      use opensearchservice module instead
      (deprecated) Metric for KMS key being inaccessible.

      Default: maximum over 5 minutes

    • metricMasterCPUUtilization

      @Stability(Deprecated) @Deprecated @NotNull Metric metricMasterCPUUtilization(@Nullable MetricOptions props)
      Deprecated.
      use opensearchservice module instead
      (deprecated) Metric for master CPU utilization.

      Default: maximum over 5 minutes

      Parameters:
      props -

    • metricMasterCPUUtilization

      @Stability(Deprecated) @Deprecated @NotNull Metric metricMasterCPUUtilization()
      Deprecated.
      use opensearchservice module instead
      (deprecated) Metric for master CPU utilization.

      Default: maximum over 5 minutes

    • metricMasterJVMMemoryPressure

      @Stability(Deprecated) @Deprecated @NotNull Metric metricMasterJVMMemoryPressure(@Nullable MetricOptions props)
      Deprecated.
      use opensearchservice module instead
      (deprecated) Metric for master JVM memory pressure.

      Default: maximum over 5 minutes

      Parameters:
      props -

    • metricMasterJVMMemoryPressure

      @Stability(Deprecated) @Deprecated @NotNull Metric metricMasterJVMMemoryPressure()
      Deprecated.
      use opensearchservice module instead
      (deprecated) Metric for master JVM memory pressure.

      Default: maximum over 5 minutes

    • metricNodes

      @Stability(Deprecated) @Deprecated @NotNull Metric metricNodes(@Nullable MetricOptions props)
      Deprecated.
      use opensearchservice module instead
      (deprecated) Metric for the number of nodes.

      Default: minimum over 1 hour

      Parameters:
      props -

    • metricNodes

      @Stability(Deprecated) @Deprecated @NotNull Metric metricNodes()
      Deprecated.
      use opensearchservice module instead
      (deprecated) Metric for the number of nodes.

      Default: minimum over 1 hour

    • metricSearchableDocuments

      @Stability(Deprecated) @Deprecated @NotNull Metric metricSearchableDocuments(@Nullable MetricOptions props)
      Deprecated.
      use opensearchservice module instead
      (deprecated) Metric for number of searchable documents.

      Default: maximum over 5 minutes

      Parameters:
      props -

    • metricSearchableDocuments

      @Stability(Deprecated) @Deprecated @NotNull Metric metricSearchableDocuments()
      Deprecated.
      use opensearchservice module instead
      (deprecated) Metric for number of searchable documents.

      Default: maximum over 5 minutes

    • metricSearchLatency

      @Stability(Deprecated) @Deprecated @NotNull Metric metricSearchLatency(@Nullable MetricOptions props)
      Deprecated.
      use opensearchservice module instead
      (deprecated) Metric for search latency.

      Default: p99 over 5 minutes

      Parameters:
      props -

    • metricSearchLatency

      @Stability(Deprecated) @Deprecated @NotNull Metric metricSearchLatency()
      Deprecated.
      use opensearchservice module instead
      (deprecated) Metric for search latency.

      Default: p99 over 5 minutes

    • getNode

      @Stability(Stable) @NotNull software.constructs.Node getNode()
      Deprecated.
      The tree node.
      Specified by:
      getNode in interface software.constructs.IConstruct

    • getEnv

      @Stability(Stable) @NotNull ResourceEnvironment getEnv()
      Deprecated.
      The environment this resource belongs to.

      For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

      For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

      Specified by:
      getEnv in interface IEnvironmentAware