IDomain

All Superinterfaces:

IConstruct, IDependable, IResource

All Known Subinterfaces:

IDomain.Jsii$Default

All Known Implementing Classes:

Domain, IDomain.Jsii$Proxy
```
@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:33.051Z")
public interface IDomain
extends IResource
```
An interface that represents an Amazon OpenSearch Service domain - either created with the CDK, or an existing one.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`IDomain.Jsii$Default` Internal default implementation for `IDomain`.
`static class`	`IDomain.Jsii$Proxy` A proxy class which represents a concrete javascript instance of this type.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.String`	`getDomainArn()` Arn of the Amazon OpenSearch Service domain.
`java.lang.String`	`getDomainEndpoint()` Endpoint of the Amazon OpenSearch Service domain.
`java.lang.String`	`getDomainId()` Identifier of the Amazon OpenSearch Service domain.
`java.lang.String`	`getDomainName()` Domain name of the Amazon OpenSearch Service domain.
`Grant`	`grantIndexRead(java.lang.String index, IGrantable identity)` Grant read permissions for an index in this domain to an IAM principal (Role/Group/User).
`Grant`	`grantIndexReadWrite(java.lang.String index, IGrantable identity)` Grant read/write permissions for an index in this domain to an IAM principal (Role/Group/User).
`Grant`	`grantIndexWrite(java.lang.String index, IGrantable identity)` Grant write permissions for an index in this domain to an IAM principal (Role/Group/User).
`Grant`	`grantPathRead(java.lang.String path, IGrantable identity)` Grant read permissions for a specific path in this domain to an IAM principal (Role/Group/User).
`Grant`	`grantPathReadWrite(java.lang.String path, IGrantable identity)` Grant read/write permissions for a specific path in this domain to an IAM principal (Role/Group/User).
`Grant`	`grantPathWrite(java.lang.String path, IGrantable identity)` Grant write permissions for a specific path in this domain to an IAM principal (Role/Group/User).
`Grant`	`grantRead(IGrantable identity)` Grant read permissions for this domain and its contents to an IAM principal (Role/Group/User).
`Grant`	`grantReadWrite(IGrantable identity)` Grant read/write permissions for this domain and its contents to an IAM principal (Role/Group/User).
`Grant`	`grantWrite(IGrantable identity)` Grant write permissions for this domain and its contents to an IAM principal (Role/Group/User).
`Metric`	`metric(java.lang.String metricName)` Return the given named metric for this domain.
`Metric`	`metric(java.lang.String metricName, MetricOptions props)` Return the given named metric for this domain.
`Metric`	`metricAutomatedSnapshotFailure()` Metric for automated snapshot failures.
`Metric`	`metricAutomatedSnapshotFailure(MetricOptions props)` Metric for automated snapshot failures.
`Metric`	`metricClusterIndexWritesBlocked()` Metric for the cluster blocking index writes.
`Metric`	`metricClusterIndexWritesBlocked(MetricOptions props)` Metric for the cluster blocking index writes.
`Metric`	`metricClusterStatusRed()` Metric for the time the cluster status is red.
`Metric`	`metricClusterStatusRed(MetricOptions props)` Metric for the time the cluster status is red.
`Metric`	`metricClusterStatusYellow()` Metric for the time the cluster status is yellow.
`Metric`	`metricClusterStatusYellow(MetricOptions props)` Metric for the time the cluster status is yellow.
`Metric`	`metricCPUUtilization()` Metric for CPU utilization.
`Metric`	`metricCPUUtilization(MetricOptions props)` Metric for CPU utilization.
`Metric`	`metricFreeStorageSpace()` Metric for the storage space of nodes in the cluster.
`Metric`	`metricFreeStorageSpace(MetricOptions props)` Metric for the storage space of nodes in the cluster.
`Metric`	`metricIndexingLatency()` Metric for indexing latency.
`Metric`	`metricIndexingLatency(MetricOptions props)` Metric for indexing latency.
`Metric`	`metricJVMMemoryPressure()` Metric for JVM memory pressure.
`Metric`	`metricJVMMemoryPressure(MetricOptions props)` Metric for JVM memory pressure.
`Metric`	`metricKMSKeyError()` Metric for KMS key errors.
`Metric`	`metricKMSKeyError(MetricOptions props)` Metric for KMS key errors.
`Metric`	`metricKMSKeyInaccessible()` Metric for KMS key being inaccessible.
`Metric`	`metricKMSKeyInaccessible(MetricOptions props)` Metric for KMS key being inaccessible.
`Metric`	`metricMasterCPUUtilization()` Metric for master CPU utilization.
`Metric`	`metricMasterCPUUtilization(MetricOptions props)` Metric for master CPU utilization.
`Metric`	`metricMasterJVMMemoryPressure()` Metric for master JVM memory pressure.
`Metric`	`metricMasterJVMMemoryPressure(MetricOptions props)` Metric for master JVM memory pressure.
`Metric`	`metricNodes()` Metric for the number of nodes.
`Metric`	`metricNodes(MetricOptions props)` Metric for the number of nodes.
`Metric`	`metricSearchableDocuments()` Metric for number of searchable documents.
`Metric`	`metricSearchableDocuments(MetricOptions props)` Metric for number of searchable documents.
`Metric`	`metricSearchLatency()` Metric for search latency.
`Metric`	`metricSearchLatency(MetricOptions props)` Metric for search latency.

Methods inherited from interface software.amazon.awscdk.core.IResource
applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct
getNode

- Method Detail
  - getDomainArn
```
java.lang.String getDomainArn()
```
    Arn of the Amazon OpenSearch Service domain.
  - getDomainEndpoint
```
java.lang.String getDomainEndpoint()
```
    Endpoint of the Amazon OpenSearch Service domain.
  - getDomainId
```
java.lang.String getDomainId()
```
    Identifier of the Amazon OpenSearch Service domain.
  - getDomainName
```
java.lang.String getDomainName()
```
    Domain name of the Amazon OpenSearch Service domain.
  - grantIndexRead
```
Grant grantIndexRead(java.lang.String index,
                     IGrantable identity)
```
    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
```
Grant grantIndexReadWrite(java.lang.String index,
                          IGrantable identity)
```
    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
```
Grant grantIndexWrite(java.lang.String index,
                      IGrantable identity)
```
    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
```
Grant grantPathRead(java.lang.String path,
                    IGrantable identity)
```
    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
```
Grant grantPathReadWrite(java.lang.String path,
                         IGrantable identity)
```
    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
```
Grant grantPathWrite(java.lang.String path,
                     IGrantable identity)
```
    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
```
Grant grantRead(IGrantable identity)
```
    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
```
Grant grantReadWrite(IGrantable identity)
```
    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
```
Grant grantWrite(IGrantable identity)
```
    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
```
Metric metric(java.lang.String metricName,
              MetricOptions props)
```
    Return the given named metric for this domain.
    
    Parameters:
    
    metricName - This parameter is required.
    
    props -
  - metric
```
Metric metric(java.lang.String metricName)
```
    Return the given named metric for this domain.
    
    Parameters:
    
    metricName - This parameter is required.
  - metricAutomatedSnapshotFailure
```
Metric metricAutomatedSnapshotFailure(MetricOptions props)
```
    Metric for automated snapshot failures.
    Default: maximum over 5 minutes
    
    Parameters:
    
    props -
  - metricAutomatedSnapshotFailure
```
Metric metricAutomatedSnapshotFailure()
```
    Metric for automated snapshot failures.
    Default: maximum over 5 minutes
  - metricClusterIndexWritesBlocked
```
Metric metricClusterIndexWritesBlocked(MetricOptions props)
```
    Metric for the cluster blocking index writes.
    Default: maximum over 1 minute
    
    Parameters:
    
    props -
  - metricClusterIndexWritesBlocked
```
Metric metricClusterIndexWritesBlocked()
```
    Metric for the cluster blocking index writes.
    Default: maximum over 1 minute
  - metricClusterStatusRed
```
Metric metricClusterStatusRed(MetricOptions props)
```
    Metric for the time the cluster status is red.
    Default: maximum over 5 minutes
    
    Parameters:
    
    props -
  - metricClusterStatusRed
```
Metric metricClusterStatusRed()
```
    Metric for the time the cluster status is red.
    Default: maximum over 5 minutes
  - metricClusterStatusYellow
```
Metric metricClusterStatusYellow(MetricOptions props)
```
    Metric for the time the cluster status is yellow.
    Default: maximum over 5 minutes
    
    Parameters:
    
    props -
  - metricClusterStatusYellow
```
Metric metricClusterStatusYellow()
```
    Metric for the time the cluster status is yellow.
    Default: maximum over 5 minutes
  - metricCPUUtilization
```
Metric metricCPUUtilization(MetricOptions props)
```
    Metric for CPU utilization.
    Default: maximum over 5 minutes
    
    Parameters:
    
    props -
  - metricCPUUtilization
```
Metric metricCPUUtilization()
```
    Metric for CPU utilization.
    Default: maximum over 5 minutes
  - metricFreeStorageSpace
```
Metric metricFreeStorageSpace(MetricOptions props)
```
    Metric for the storage space of nodes in the cluster.
    Default: minimum over 5 minutes
    
    Parameters:
    
    props -
  - metricFreeStorageSpace
```
Metric metricFreeStorageSpace()
```
    Metric for the storage space of nodes in the cluster.
    Default: minimum over 5 minutes
  - metricIndexingLatency
```
Metric metricIndexingLatency(MetricOptions props)
```
    Metric for indexing latency.
    Default: p99 over 5 minutes
    
    Parameters:
    
    props -
  - metricIndexingLatency
```
Metric metricIndexingLatency()
```
    Metric for indexing latency.
    Default: p99 over 5 minutes
  - metricJVMMemoryPressure
```
Metric metricJVMMemoryPressure(MetricOptions props)
```
    Metric for JVM memory pressure.
    Default: maximum over 5 minutes
    
    Parameters:
    
    props -
  - metricJVMMemoryPressure
```
Metric metricJVMMemoryPressure()
```
    Metric for JVM memory pressure.
    Default: maximum over 5 minutes
  - metricKMSKeyError
```
Metric metricKMSKeyError(MetricOptions props)
```
    Metric for KMS key errors.
    Default: maximum over 5 minutes
    
    Parameters:
    
    props -
  - metricKMSKeyError
```
Metric metricKMSKeyError()
```
    Metric for KMS key errors.
    Default: maximum over 5 minutes
  - metricKMSKeyInaccessible
```
Metric metricKMSKeyInaccessible(MetricOptions props)
```
    Metric for KMS key being inaccessible.
    Default: maximum over 5 minutes
    
    Parameters:
    
    props -
  - metricKMSKeyInaccessible
```
Metric metricKMSKeyInaccessible()
```
    Metric for KMS key being inaccessible.
    Default: maximum over 5 minutes
  - metricMasterCPUUtilization
```
Metric metricMasterCPUUtilization(MetricOptions props)
```
    Metric for master CPU utilization.
    Default: maximum over 5 minutes
    
    Parameters:
    
    props -
  - metricMasterCPUUtilization
```
Metric metricMasterCPUUtilization()
```
    Metric for master CPU utilization.
    Default: maximum over 5 minutes
  - metricMasterJVMMemoryPressure
```
Metric metricMasterJVMMemoryPressure(MetricOptions props)
```
    Metric for master JVM memory pressure.
    Default: maximum over 5 minutes
    
    Parameters:
    
    props -
  - metricMasterJVMMemoryPressure
```
Metric metricMasterJVMMemoryPressure()
```
    Metric for master JVM memory pressure.
    Default: maximum over 5 minutes
  - metricNodes
```
Metric metricNodes(MetricOptions props)
```
    Metric for the number of nodes.
    Default: minimum over 1 hour
    
    Parameters:
    
    props -
  - metricNodes
```
Metric metricNodes()
```
    Metric for the number of nodes.
    Default: minimum over 1 hour
  - metricSearchableDocuments
```
Metric metricSearchableDocuments(MetricOptions props)
```
    Metric for number of searchable documents.
    Default: maximum over 5 minutes
    
    Parameters:
    
    props -
  - metricSearchableDocuments
```
Metric metricSearchableDocuments()
```
    Metric for number of searchable documents.
    Default: maximum over 5 minutes
  - metricSearchLatency
```
Metric metricSearchLatency(MetricOptions props)
```
    Metric for search latency.
    Default: p99 over 5 minutes
    
    Parameters:
    
    props -
  - metricSearchLatency
```
Metric metricSearchLatency()
```
    Metric for search latency.
    Default: p99 over 5 minutes

Interface IDomain

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.awscdk.core.IResource

Methods inherited from interface software.amazon.awscdk.core.IConstruct

Method Detail

getDomainArn

getDomainEndpoint

getDomainId

getDomainName

grantIndexRead

grantIndexReadWrite

grantIndexWrite

grantPathRead

grantPathReadWrite

grantPathWrite

grantRead

grantReadWrite

grantWrite

metric

metric

metricAutomatedSnapshotFailure

metricAutomatedSnapshotFailure

metricClusterIndexWritesBlocked

metricClusterIndexWritesBlocked

metricClusterStatusRed

metricClusterStatusRed

metricClusterStatusYellow

metricClusterStatusYellow

metricCPUUtilization

metricCPUUtilization

metricFreeStorageSpace

metricFreeStorageSpace

metricIndexingLatency

metricIndexingLatency

metricJVMMemoryPressure

metricJVMMemoryPressure

metricKMSKeyError

metricKMSKeyError

metricKMSKeyInaccessible

metricKMSKeyInaccessible

metricMasterCPUUtilization

metricMasterCPUUtilization

metricMasterJVMMemoryPressure

metricMasterJVMMemoryPressure

metricNodes

metricNodes

metricSearchableDocuments

metricSearchableDocuments

metricSearchLatency

metricSearchLatency