Package software.amazon.awscdk.services.elasticsearch

Class Domain

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.elasticsearch.Domain
All Implemented Interfaces:
IResource, IConnectable, IDomain, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-12-17T21:37:31.242Z") @Stability(Deprecated) @Deprecated public class Domain extends Resource implements IDomain, IConnectable
Deprecated.
use opensearchservice module instead
(deprecated) Provides an Elasticsearch domain.

Example: 

 Domain domain = Domain.Builder.create(this, "Domain")
         .version(ElasticsearchVersion.V7_4)
         .ebs(EbsOptions.builder()
                 .volumeSize(100)
                 .volumeType(EbsDeviceVolumeType.GENERAL_PURPOSE_SSD)
                 .build())
         .nodeToNodeEncryption(true)
         .encryptionAtRest(EncryptionAtRestOptions.builder()
                 .enabled(true)
                 .build())
         .build();

  • Constructor Details

    • Domain

      protected Domain(software.amazon.jsii.JsiiObjectRef objRef)
      Deprecated.

    • Domain

      protected Domain(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
      Deprecated.

    • Domain

      @Stability(Deprecated) @Deprecated public Domain(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull DomainProps props)
      Deprecated.
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.

  • Method Details

    • fromDomainAttributes

      @Stability(Deprecated) @Deprecated @NotNull public static IDomain fromDomainAttributes(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull DomainAttributes attrs)
      Deprecated.
      use opensearchservice module instead
      (deprecated) Creates a Domain construct that represents an external domain.

      Parameters:
      scope - The parent creating construct (usually this). This parameter is required.
      id - The construct's name. This parameter is required.
      attrs - A DomainAttributes object. This parameter is required.

    • fromDomainEndpoint

      @Stability(Deprecated) @Deprecated @NotNull public static IDomain fromDomainEndpoint(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String domainEndpoint)
      Deprecated.
      use opensearchservice module instead
      (deprecated) Creates a Domain construct that represents an external domain via domain endpoint.

      Parameters:
      scope - The parent creating construct (usually this). This parameter is required.
      id - The construct's name. This parameter is required.
      domainEndpoint - The domain's endpoint. This parameter is required.

    • addAccessPolicies

      @Stability(Deprecated) @Deprecated public void addAccessPolicies(@NotNull @NotNull PolicyStatement... accessPolicyStatements)
      Deprecated.
      use opensearchservice module instead
      (deprecated) Add policy statements to the domain access policy.

      Parameters:
      accessPolicyStatements - This parameter is required.

    • grantIndexRead

      @Stability(Deprecated) @Deprecated @NotNull public 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).

      Specified by:
      grantIndexRead in interface IDomain
      Parameters:
      index - The index to grant permissions for. This parameter is required.
      identity - The principal. This parameter is required.

    • grantIndexReadWrite

      @Stability(Deprecated) @Deprecated @NotNull public 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).

      Specified by:
      grantIndexReadWrite in interface IDomain
      Parameters:
      index - The index to grant permissions for. This parameter is required.
      identity - The principal. This parameter is required.

    • grantIndexWrite

      @Stability(Deprecated) @Deprecated @NotNull public 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).

      Specified by:
      grantIndexWrite in interface IDomain
      Parameters:
      index - The index to grant permissions for. This parameter is required.
      identity - The principal. This parameter is required.

    • grantPathRead

      @Stability(Deprecated) @Deprecated @NotNull public 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).

      Specified by:
      grantPathRead in interface IDomain
      Parameters:
      path - The path to grant permissions for. This parameter is required.
      identity - The principal. This parameter is required.

    • grantPathReadWrite

      @Stability(Deprecated) @Deprecated @NotNull public 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).

      Specified by:
      grantPathReadWrite in interface IDomain
      Parameters:
      path - The path to grant permissions for. This parameter is required.
      identity - The principal. This parameter is required.

    • grantPathWrite

      @Stability(Deprecated) @Deprecated @NotNull public 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).

      Specified by:
      grantPathWrite in interface IDomain
      Parameters:
      path - The path to grant permissions for. This parameter is required.
      identity - The principal. This parameter is required.

    • grantRead

      @Stability(Deprecated) @Deprecated @NotNull public 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).

      Specified by:
      grantRead in interface IDomain
      Parameters:
      identity - The principal. This parameter is required.

    • grantReadWrite

      @Stability(Deprecated) @Deprecated @NotNull public 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).

      Specified by:
      grantReadWrite in interface IDomain
      Parameters:
      identity - The principal. This parameter is required.

    • grantWrite

      @Stability(Deprecated) @Deprecated @NotNull public 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).

      Specified by:
      grantWrite in interface IDomain
      Parameters:
      identity - The principal. This parameter is required.

    • metric

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

      Specified by:
      metric in interface IDomain
      Parameters:
      metricName - This parameter is required.
      props -

    • metric

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

      Specified by:
      metric in interface IDomain
      Parameters:
      metricName - This parameter is required.

    • metricAutomatedSnapshotFailure

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

      Default: maximum over 5 minutes

      Specified by:
      metricAutomatedSnapshotFailure in interface IDomain
      Parameters:
      props -

    • metricAutomatedSnapshotFailure

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

      Default: maximum over 5 minutes

      Specified by:
      metricAutomatedSnapshotFailure in interface IDomain

    • metricClusterIndexWritesBlocked

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

      Default: maximum over 1 minute

      Specified by:
      metricClusterIndexWritesBlocked in interface IDomain
      Parameters:
      props -

    • metricClusterIndexWritesBlocked

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

      Default: maximum over 1 minute

      Specified by:
      metricClusterIndexWritesBlocked in interface IDomain

    • metricClusterStatusRed

      @Stability(Deprecated) @Deprecated @NotNull public 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

      Specified by:
      metricClusterStatusRed in interface IDomain
      Parameters:
      props -

    • metricClusterStatusRed

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

      Default: maximum over 5 minutes

      Specified by:
      metricClusterStatusRed in interface IDomain

    • metricClusterStatusYellow

      @Stability(Deprecated) @Deprecated @NotNull public 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

      Specified by:
      metricClusterStatusYellow in interface IDomain
      Parameters:
      props -

    • metricClusterStatusYellow

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

      Default: maximum over 5 minutes

      Specified by:
      metricClusterStatusYellow in interface IDomain

    • metricCPUUtilization

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

      Default: maximum over 5 minutes

      Specified by:
      metricCPUUtilization in interface IDomain
      Parameters:
      props -

    • metricCPUUtilization

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

      Default: maximum over 5 minutes

      Specified by:
      metricCPUUtilization in interface IDomain

    • metricFreeStorageSpace

      @Stability(Deprecated) @Deprecated @NotNull public 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

      Specified by:
      metricFreeStorageSpace in interface IDomain
      Parameters:
      props -

    • metricFreeStorageSpace

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

      Default: minimum over 5 minutes

      Specified by:
      metricFreeStorageSpace in interface IDomain

    • metricIndexingLatency

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

      Default: p99 over 5 minutes

      Specified by:
      metricIndexingLatency in interface IDomain
      Parameters:
      props -

    • metricIndexingLatency

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

      Default: p99 over 5 minutes

      Specified by:
      metricIndexingLatency in interface IDomain

    • metricJVMMemoryPressure

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

      Default: maximum over 5 minutes

      Specified by:
      metricJVMMemoryPressure in interface IDomain
      Parameters:
      props -

    • metricJVMMemoryPressure

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

      Default: maximum over 5 minutes

      Specified by:
      metricJVMMemoryPressure in interface IDomain

    • metricKMSKeyError

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

      Default: maximum over 5 minutes

      Specified by:
      metricKMSKeyError in interface IDomain
      Parameters:
      props -

    • metricKMSKeyError

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

      Default: maximum over 5 minutes

      Specified by:
      metricKMSKeyError in interface IDomain

    • metricKMSKeyInaccessible

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

      Default: maximum over 5 minutes

      Specified by:
      metricKMSKeyInaccessible in interface IDomain
      Parameters:
      props -

    • metricKMSKeyInaccessible

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

      Default: maximum over 5 minutes

      Specified by:
      metricKMSKeyInaccessible in interface IDomain

    • metricMasterCPUUtilization

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

      Default: maximum over 5 minutes

      Specified by:
      metricMasterCPUUtilization in interface IDomain
      Parameters:
      props -

    • metricMasterCPUUtilization

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

      Default: maximum over 5 minutes

      Specified by:
      metricMasterCPUUtilization in interface IDomain

    • metricMasterJVMMemoryPressure

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

      Default: maximum over 5 minutes

      Specified by:
      metricMasterJVMMemoryPressure in interface IDomain
      Parameters:
      props -

    • metricMasterJVMMemoryPressure

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

      Default: maximum over 5 minutes

      Specified by:
      metricMasterJVMMemoryPressure in interface IDomain

    • metricNodes

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

      Default: minimum over 1 hour

      Specified by:
      metricNodes in interface IDomain
      Parameters:
      props -

    • metricNodes

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

      Default: minimum over 1 hour

      Specified by:
      metricNodes in interface IDomain

    • metricSearchableDocuments

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

      Default: maximum over 5 minutes

      Specified by:
      metricSearchableDocuments in interface IDomain
      Parameters:
      props -

    • metricSearchableDocuments

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

      Default: maximum over 5 minutes

      Specified by:
      metricSearchableDocuments in interface IDomain

    • metricSearchLatency

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

      Default: p99 over 5 minutes

      Specified by:
      metricSearchLatency in interface IDomain
      Parameters:
      props -

    • metricSearchLatency

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

      Default: p99 over 5 minutes

      Specified by:
      metricSearchLatency in interface IDomain

    • getConnections

      @Stability(Deprecated) @Deprecated @NotNull public Connections getConnections()
      Deprecated.
      use opensearchservice module instead
      (deprecated) Manages network connections to the domain.

      This will throw an error in case the domain is not placed inside a VPC.

      Specified by:
      getConnections in interface IConnectable

    • getDomainArn

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

      Specified by:
      getDomainArn in interface IDomain

    • getDomainEndpoint

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

      Specified by:
      getDomainEndpoint in interface IDomain

    • getDomainName

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

      Specified by:
      getDomainName in interface IDomain

    • getAppLogGroup

      @Stability(Deprecated) @Deprecated @Nullable public ILogGroup getAppLogGroup()
      Deprecated.
      use opensearchservice module instead
      (deprecated) Log group that application logs are logged to.

    • getAuditLogGroup

      @Stability(Deprecated) @Deprecated @Nullable public ILogGroup getAuditLogGroup()
      Deprecated.
      use opensearchservice module instead
      (deprecated) Log group that audit logs are logged to.

    • getMasterUserPassword

      @Stability(Deprecated) @Deprecated @Nullable public SecretValue getMasterUserPassword()
      Deprecated.
      use opensearchservice module instead
      (deprecated) Master user password if fine grained access control is configured.

    • getSlowIndexLogGroup

      @Stability(Deprecated) @Deprecated @Nullable public ILogGroup getSlowIndexLogGroup()
      Deprecated.
      use opensearchservice module instead
      (deprecated) Log group that slow indices are logged to.

    • getSlowSearchLogGroup

      @Stability(Deprecated) @Deprecated @Nullable public ILogGroup getSlowSearchLogGroup()
      Deprecated.
      use opensearchservice module instead
      (deprecated) Log group that slow searches are logged to.