interface IDomain ⚠️

Language	Type name
.NET	Amazon.CDK.AWS.Elasticsearch.IDomain
Go	github.com/aws/aws-cdk-go/awscdk/v2/awselasticsearch#IDomain
Java	software.amazon.awscdk.services.elasticsearch.IDomain
Python	aws_cdk.aws_elasticsearch.IDomain
TypeScript (source)	aws-cdk-lib » aws_elasticsearch » IDomain

⚠️ Deprecated: use opensearchservice module instead

Implemented by Domain

Obtainable from Domain.fromDomainAttributes(), Domain.fromDomainEndpoint()

An interface that represents an Elasticsearch domain - either created with the CDK, or an existing one.

Properties

Name	Type	Description
domainArn⚠️	string	Arn of the Elasticsearch domain.
domainEndpoint⚠️	string	Endpoint of the Elasticsearch domain.
domainName⚠️	string	Domain name of the Elasticsearch domain.
env⚠️	ResourceEnvironment	The environment this resource belongs to.
node⚠️	Node	The tree node.
stack⚠️	Stack	The stack in which this resource is defined.

---

domainArn⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: string

Arn of the Elasticsearch domain.

---

domainEndpoint⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: string

Endpoint of the Elasticsearch domain.

---

domainName⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: string

Domain name of the Elasticsearch domain.

---

env⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

node⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: Node

The tree node.

---

stack⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)⚠️	Apply the given removal policy to this resource.
grantIndexRead(index, identity)⚠️	Grant read permissions for an index in this domain to an IAM principal (Role/Group/User).
grantIndexReadWrite(index, identity)⚠️	Grant read/write permissions for an index in this domain to an IAM principal (Role/Group/User).
grantIndexWrite(index, identity)⚠️	Grant write permissions for an index in this domain to an IAM principal (Role/Group/User).
grantPathRead(path, identity)⚠️	Grant read permissions for a specific path in this domain to an IAM principal (Role/Group/User).
grantPathReadWrite(path, identity)⚠️	Grant read/write permissions for a specific path in this domain to an IAM principal (Role/Group/User).
grantPathWrite(path, identity)⚠️	Grant write permissions for a specific path in this domain to an IAM principal (Role/Group/User).
grantRead(identity)⚠️	Grant read permissions for this domain and its contents to an IAM principal (Role/Group/User).
grantReadWrite(identity)⚠️	Grant read/write permissions for this domain and its contents to an IAM principal (Role/Group/User).
grantWrite(identity)⚠️	Grant write permissions for this domain and its contents to an IAM principal (Role/Group/User).
metric(metricName, props?)⚠️	Return the given named metric for this Domain.
metricAutomatedSnapshotFailure(props?)⚠️	Metric for automated snapshot failures.
metricCPUUtilization(props?)⚠️	Metric for CPU utilization.
metricClusterIndexWritesBlocked(props?)⚠️	Metric for the cluster blocking index writes.
metricClusterStatusRed(props?)⚠️	Metric for the time the cluster status is red.
metricClusterStatusYellow(props?)⚠️	Metric for the time the cluster status is yellow.
metricFreeStorageSpace(props?)⚠️	Metric for the storage space of nodes in the cluster.
metricIndexingLatency(props?)⚠️	Metric for indexing latency.
metricJVMMemoryPressure(props?)⚠️	Metric for JVM memory pressure.
metricKMSKeyError(props?)⚠️	Metric for KMS key errors.
metricKMSKeyInaccessible(props?)⚠️	Metric for KMS key being inaccessible.
metricMasterCPUUtilization(props?)⚠️	Metric for master CPU utilization.
metricMasterJVMMemoryPressure(props?)⚠️	Metric for master JVM memory pressure.
metricNodes(props?)⚠️	Metric for the number of nodes.
metricSearchLatency(props?)⚠️	Metric for search latency.
metricSearchableDocuments(props?)⚠️	Metric for number of searchable documents.

---

applyRemovalPolicy(policy)⚠️

public applyRemovalPolicy(policy: RemovalPolicy): void

⚠️ Deprecated: use opensearchservice module instead

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

grantIndexRead(index, identity)⚠️

public grantIndexRead(index: string, identity: IGrantable): Grant

⚠️ Deprecated: use opensearchservice module instead

Parameters

• index string — The index to grant permissions for.
• identity IGrantable — The principal.

Returns

• Grant

Grant read permissions for an index in this domain to an IAM principal (Role/Group/User).

---

grantIndexReadWrite(index, identity)⚠️

public grantIndexReadWrite(index: string, identity: IGrantable): Grant

⚠️ Deprecated: use opensearchservice module instead

Parameters

• index string — The index to grant permissions for.
• identity IGrantable — The principal.

Returns

• Grant

Grant read/write permissions for an index in this domain to an IAM principal (Role/Group/User).

---

grantIndexWrite(index, identity)⚠️

public grantIndexWrite(index: string, identity: IGrantable): Grant

⚠️ Deprecated: use opensearchservice module instead

Parameters

• index string — The index to grant permissions for.
• identity IGrantable — The principal.

Returns

• Grant

Grant write permissions for an index in this domain to an IAM principal (Role/Group/User).

---

grantPathRead(path, identity)⚠️

public grantPathRead(path: string, identity: IGrantable): Grant

⚠️ Deprecated: use opensearchservice module instead

Parameters

• path string — The path to grant permissions for.
• identity IGrantable — The principal.

Returns

• Grant

Grant read permissions for a specific path in this domain to an IAM principal (Role/Group/User).

---

grantPathReadWrite(path, identity)⚠️

public grantPathReadWrite(path: string, identity: IGrantable): Grant

⚠️ Deprecated: use opensearchservice module instead

Parameters

• path string — The path to grant permissions for.
• identity IGrantable — The principal.

Returns

• Grant

Grant read/write permissions for a specific path in this domain to an IAM principal (Role/Group/User).

---

grantPathWrite(path, identity)⚠️

public grantPathWrite(path: string, identity: IGrantable): Grant

⚠️ Deprecated: use opensearchservice module instead

Parameters

• path string — The path to grant permissions for.
• identity IGrantable — The principal.

Returns

• Grant

Grant write permissions for a specific path in this domain to an IAM principal (Role/Group/User).

---

grantRead(identity)⚠️

public grantRead(identity: IGrantable): Grant

⚠️ Deprecated: use opensearchservice module instead

Parameters

• identity IGrantable — The principal.

Returns

• Grant

Grant read permissions for this domain and its contents to an IAM principal (Role/Group/User).

---

grantReadWrite(identity)⚠️

public grantReadWrite(identity: IGrantable): Grant

⚠️ Deprecated: use opensearchservice module instead

Parameters

• identity IGrantable — The principal.

Returns

• Grant

Grant read/write permissions for this domain and its contents to an IAM principal (Role/Group/User).

---

grantWrite(identity)⚠️

public grantWrite(identity: IGrantable): Grant

⚠️ Deprecated: use opensearchservice module instead

Parameters

• identity IGrantable — The principal.

Returns

• Grant

Grant write permissions for this domain and its contents to an IAM principal (Role/Group/User).

---

metric(metricName, props?)⚠️

public metric(metricName: string, props?: MetricOptions): Metric

⚠️ Deprecated: use opensearchservice module instead

Parameters

• metricName string
• props MetricOptions

Returns

• Metric

Return the given named metric for this Domain.

---

metricAutomatedSnapshotFailure(props?)⚠️

public metricAutomatedSnapshotFailure(props?: MetricOptions): Metric

⚠️ Deprecated: use opensearchservice module instead

Parameters

• props MetricOptions

Returns

• Metric

Metric for automated snapshot failures.

---

metricCPUUtilization(props?)⚠️

public metricCPUUtilization(props?: MetricOptions): Metric

⚠️ Deprecated: use opensearchservice module instead

Parameters

• props MetricOptions

Returns

• Metric

Metric for CPU utilization.

---

metricClusterIndexWritesBlocked(props?)⚠️

public metricClusterIndexWritesBlocked(props?: MetricOptions): Metric

⚠️ Deprecated: use opensearchservice module instead

Parameters

• props MetricOptions

Returns

• Metric

Metric for the cluster blocking index writes.

---

metricClusterStatusRed(props?)⚠️

public metricClusterStatusRed(props?: MetricOptions): Metric

⚠️ Deprecated: use opensearchservice module instead

Parameters

• props MetricOptions

Returns

• Metric

Metric for the time the cluster status is red.

---

metricClusterStatusYellow(props?)⚠️

public metricClusterStatusYellow(props?: MetricOptions): Metric

⚠️ Deprecated: use opensearchservice module instead

Parameters

• props MetricOptions

Returns

• Metric

Metric for the time the cluster status is yellow.

---

metricFreeStorageSpace(props?)⚠️

public metricFreeStorageSpace(props?: MetricOptions): Metric

⚠️ Deprecated: use opensearchservice module instead

Parameters

• props MetricOptions

Returns

• Metric

Metric for the storage space of nodes in the cluster.

---

metricIndexingLatency(props?)⚠️

public metricIndexingLatency(props?: MetricOptions): Metric

⚠️ Deprecated: use opensearchservice module instead

Parameters

• props MetricOptions

Returns

• Metric

Metric for indexing latency.

---

metricJVMMemoryPressure(props?)⚠️

public metricJVMMemoryPressure(props?: MetricOptions): Metric

⚠️ Deprecated: use opensearchservice module instead

Parameters

• props MetricOptions

Returns

• Metric

Metric for JVM memory pressure.

---

metricKMSKeyError(props?)⚠️

public metricKMSKeyError(props?: MetricOptions): Metric

⚠️ Deprecated: use opensearchservice module instead

Parameters

• props MetricOptions

Returns

• Metric

Metric for KMS key errors.

---

metricKMSKeyInaccessible(props?)⚠️

public metricKMSKeyInaccessible(props?: MetricOptions): Metric

⚠️ Deprecated: use opensearchservice module instead

Parameters

• props MetricOptions

Returns

• Metric

Metric for KMS key being inaccessible.

---

metricMasterCPUUtilization(props?)⚠️

public metricMasterCPUUtilization(props?: MetricOptions): Metric

⚠️ Deprecated: use opensearchservice module instead

Parameters

• props MetricOptions

Returns

• Metric

Metric for master CPU utilization.

---

metricMasterJVMMemoryPressure(props?)⚠️

public metricMasterJVMMemoryPressure(props?: MetricOptions): Metric

⚠️ Deprecated: use opensearchservice module instead

Parameters

• props MetricOptions

Returns

• Metric

Metric for master JVM memory pressure.

---

metricNodes(props?)⚠️

public metricNodes(props?: MetricOptions): Metric

⚠️ Deprecated: use opensearchservice module instead

Parameters

• props MetricOptions

Returns

• Metric

Metric for the number of nodes.

---

metricSearchLatency(props?)⚠️

public metricSearchLatency(props?: MetricOptions): Metric

⚠️ Deprecated: use opensearchservice module instead

Parameters

• props MetricOptions

Returns

• Metric

Metric for search latency.

---

metricSearchableDocuments(props?)⚠️

public metricSearchableDocuments(props?: MetricOptions): Metric

⚠️ Deprecated: use opensearchservice module instead

Parameters

• props MetricOptions

Returns

• Metric

Metric for number of searchable documents.