IDomain.Jsii$Proxy

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.amazon.awscdk.services.opensearchservice.IDomain.Jsii$Proxy

All Implemented Interfaces:

IConstruct, IConstruct.Jsii$Default, IDependable, IDependable.Jsii$Default, IResource, IResource.Jsii$Default, IDomain, IDomain.Jsii$Default

Enclosing interface:

IDomain
```
public static final class IDomain.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements IDomain.Jsii$Default
```
A proxy class which represents a concrete javascript instance of this type.

Nested Class Summary
- Nested classes/interfaces inherited from interface software.amazon.awscdk.services.opensearchservice.IDomain
  IDomain.Jsii$Default, IDomain.Jsii$Proxy

Constructor Summary

Constructors
Modifier Constructor and Description

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructors
Modifier	Constructor and Description
`protected`	`Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`applyRemovalPolicy(RemovalPolicy policy)` Apply the given removal policy to this resource.
`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.
`ResourceEnvironment`	`getEnv()` The environment this resource belongs to.
`ConstructNode`	`getNode()` The construct tree node for this construct.
`Stack`	`getStack()` The stack in which this resource is defined.
`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 class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Jsii$Proxy
```
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
```
- Method Detail
  - getNode
```
public final ConstructNode getNode()
```
    The construct tree node for this construct.
    
    Specified by:
    
    getNode in interface IConstruct
    
    Specified by:
    
    getNode in interface IConstruct.Jsii$Default
    
    Specified by:
    
    getNode in interface IResource.Jsii$Default
    
    Specified by:
    
    getNode in interface IDomain.Jsii$Default
  - getEnv
```
public final ResourceEnvironment getEnv()
```
    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.
    
    Specified by:
    
    getEnv in interface IResource
    
    Specified by:
    
    getEnv in interface IResource.Jsii$Default
    
    Specified by:
    
    getEnv in interface IDomain.Jsii$Default
  - getStack
```
public final Stack getStack()
```
    The stack in which this resource is defined.
    
    Specified by:
    
    getStack in interface IResource
    
    Specified by:
    
    getStack in interface IResource.Jsii$Default
    
    Specified by:
    
    getStack in interface IDomain.Jsii$Default
  - getDomainArn
```
public final java.lang.String getDomainArn()
```
    Arn of the Amazon OpenSearch Service domain.
    
    Specified by:
    
    getDomainArn in interface IDomain
    
    Specified by:
    
    getDomainArn in interface IDomain.Jsii$Default
  - getDomainEndpoint
```
public final java.lang.String getDomainEndpoint()
```
    Endpoint of the Amazon OpenSearch Service domain.
    
    Specified by:
    
    getDomainEndpoint in interface IDomain
    
    Specified by:
    
    getDomainEndpoint in interface IDomain.Jsii$Default
  - getDomainId
```
public final java.lang.String getDomainId()
```
    Identifier of the Amazon OpenSearch Service domain.
    
    Specified by:
    
    getDomainId in interface IDomain
    
    Specified by:
    
    getDomainId in interface IDomain.Jsii$Default
  - getDomainName
```
public final java.lang.String getDomainName()
```
    Domain name of the Amazon OpenSearch Service domain.
    
    Specified by:
    
    getDomainName in interface IDomain
    
    Specified by:
    
    getDomainName in interface IDomain.Jsii$Default
  - applyRemovalPolicy
```
public final void applyRemovalPolicy(RemovalPolicy policy)
```
    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).
    
    Specified by:
    
    applyRemovalPolicy in interface IResource
    
    Specified by:
    
    applyRemovalPolicy in interface IResource.Jsii$Default
    
    Specified by:
    
    applyRemovalPolicy in interface IDomain.Jsii$Default
    
    Parameters:
    
    policy - This parameter is required.
  - grantIndexRead
```
public final Grant grantIndexRead(java.lang.String index,
                                  IGrantable identity)
```
    Grant read permissions for an index in this domain to an IAM principal (Role/Group/User).
    
    Specified by:
    
    grantIndexRead in interface IDomain
    
    Specified by:
    
    grantIndexRead in interface IDomain.Jsii$Default
    
    Parameters:
    
    index - The index to grant permissions for. This parameter is required.
    
    identity - The principal. This parameter is required.
  - grantIndexReadWrite
```
public final 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).
    
    Specified by:
    
    grantIndexReadWrite in interface IDomain
    
    Specified by:
    
    grantIndexReadWrite in interface IDomain.Jsii$Default
    
    Parameters:
    
    index - The index to grant permissions for. This parameter is required.
    
    identity - The principal. This parameter is required.
  - grantIndexWrite
```
public final Grant grantIndexWrite(java.lang.String index,
                                   IGrantable identity)
```
    Grant write permissions for an index in this domain to an IAM principal (Role/Group/User).
    
    Specified by:
    
    grantIndexWrite in interface IDomain
    
    Specified by:
    
    grantIndexWrite in interface IDomain.Jsii$Default
    
    Parameters:
    
    index - The index to grant permissions for. This parameter is required.
    
    identity - The principal. This parameter is required.
  - grantPathRead
```
public final 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).
    
    Specified by:
    
    grantPathRead in interface IDomain
    
    Specified by:
    
    grantPathRead in interface IDomain.Jsii$Default
    
    Parameters:
    
    path - The path to grant permissions for. This parameter is required.
    
    identity - The principal. This parameter is required.
  - grantPathReadWrite
```
public final 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).
    
    Specified by:
    
    grantPathReadWrite in interface IDomain
    
    Specified by:
    
    grantPathReadWrite in interface IDomain.Jsii$Default
    
    Parameters:
    
    path - The path to grant permissions for. This parameter is required.
    
    identity - The principal. This parameter is required.
  - grantPathWrite
```
public final 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).
    
    Specified by:
    
    grantPathWrite in interface IDomain
    
    Specified by:
    
    grantPathWrite in interface IDomain.Jsii$Default
    
    Parameters:
    
    path - The path to grant permissions for. This parameter is required.
    
    identity - The principal. This parameter is required.
  - grantRead
```
public final Grant grantRead(IGrantable identity)
```
    Grant read permissions for this domain and its contents to an IAM principal (Role/Group/User).
    
    Specified by:
    
    grantRead in interface IDomain
    
    Specified by:
    
    grantRead in interface IDomain.Jsii$Default
    
    Parameters:
    
    identity - The principal. This parameter is required.
  - grantReadWrite
```
public final Grant grantReadWrite(IGrantable identity)
```
    Grant read/write permissions for this domain and its contents to an IAM principal (Role/Group/User).
    
    Specified by:
    
    grantReadWrite in interface IDomain
    
    Specified by:
    
    grantReadWrite in interface IDomain.Jsii$Default
    
    Parameters:
    
    identity - The principal. This parameter is required.
  - grantWrite
```
public final Grant grantWrite(IGrantable identity)
```
    Grant write permissions for this domain and its contents to an IAM principal (Role/Group/User).
    
    Specified by:
    
    grantWrite in interface IDomain
    
    Specified by:
    
    grantWrite in interface IDomain.Jsii$Default
    
    Parameters:
    
    identity - The principal. This parameter is required.
  - metric
```
public final Metric metric(java.lang.String metricName,
                           MetricOptions props)
```
    Return the given named metric for this domain.
    
    Specified by:
    
    metric in interface IDomain
    
    Specified by:
    
    metric in interface IDomain.Jsii$Default
    
    Parameters:
    
    metricName - This parameter is required.
    
    props -
  - metric
```
public final Metric metric(java.lang.String metricName)
```
    Return the given named metric for this domain.
    
    Specified by:
    
    metric in interface IDomain
    
    Parameters:
    
    metricName - This parameter is required.
  - metricAutomatedSnapshotFailure
```
public final Metric metricAutomatedSnapshotFailure(MetricOptions props)
```
    Metric for automated snapshot failures.
    Default: maximum over 5 minutes
    
    Specified by:
    
    metricAutomatedSnapshotFailure in interface IDomain
    
    Specified by:
    
    metricAutomatedSnapshotFailure in interface IDomain.Jsii$Default
    
    Parameters:
    
    props -
  - metricAutomatedSnapshotFailure
```
public final Metric metricAutomatedSnapshotFailure()
```
    Metric for automated snapshot failures.
    Default: maximum over 5 minutes
    
    Specified by:
    
    metricAutomatedSnapshotFailure in interface IDomain
  - metricClusterIndexWritesBlocked
```
public final Metric metricClusterIndexWritesBlocked(MetricOptions props)
```
    Metric for the cluster blocking index writes.
    Default: maximum over 1 minute
    
    Specified by:
    
    metricClusterIndexWritesBlocked in interface IDomain
    
    Specified by:
    
    metricClusterIndexWritesBlocked in interface IDomain.Jsii$Default
    
    Parameters:
    
    props -
  - metricClusterIndexWritesBlocked
```
public final Metric metricClusterIndexWritesBlocked()
```
    Metric for the cluster blocking index writes.
    Default: maximum over 1 minute
    
    Specified by:
    
    metricClusterIndexWritesBlocked in interface IDomain
  - metricClusterStatusRed
```
public final Metric metricClusterStatusRed(MetricOptions props)
```
    Metric for the time the cluster status is red.
    Default: maximum over 5 minutes
    
    Specified by:
    
    metricClusterStatusRed in interface IDomain
    
    Specified by:
    
    metricClusterStatusRed in interface IDomain.Jsii$Default
    
    Parameters:
    
    props -
  - metricClusterStatusRed
```
public final Metric metricClusterStatusRed()
```
    Metric for the time the cluster status is red.
    Default: maximum over 5 minutes
    
    Specified by:
    
    metricClusterStatusRed in interface IDomain
  - metricClusterStatusYellow
```
public final Metric metricClusterStatusYellow(MetricOptions props)
```
    Metric for the time the cluster status is yellow.
    Default: maximum over 5 minutes
    
    Specified by:
    
    metricClusterStatusYellow in interface IDomain
    
    Specified by:
    
    metricClusterStatusYellow in interface IDomain.Jsii$Default
    
    Parameters:
    
    props -
  - metricClusterStatusYellow
```
public final Metric metricClusterStatusYellow()
```
    Metric for the time the cluster status is yellow.
    Default: maximum over 5 minutes
    
    Specified by:
    
    metricClusterStatusYellow in interface IDomain
  - metricCPUUtilization
```
public final Metric metricCPUUtilization(MetricOptions props)
```
    Metric for CPU utilization.
    Default: maximum over 5 minutes
    
    Specified by:
    
    metricCPUUtilization in interface IDomain
    
    Specified by:
    
    metricCPUUtilization in interface IDomain.Jsii$Default
    
    Parameters:
    
    props -
  - metricCPUUtilization
```
public final Metric metricCPUUtilization()
```
    Metric for CPU utilization.
    Default: maximum over 5 minutes
    
    Specified by:
    
    metricCPUUtilization in interface IDomain
  - metricFreeStorageSpace
```
public final Metric metricFreeStorageSpace(MetricOptions props)
```
    Metric for the storage space of nodes in the cluster.
    Default: minimum over 5 minutes
    
    Specified by:
    
    metricFreeStorageSpace in interface IDomain
    
    Specified by:
    
    metricFreeStorageSpace in interface IDomain.Jsii$Default
    
    Parameters:
    
    props -
  - metricFreeStorageSpace
```
public final Metric metricFreeStorageSpace()
```
    Metric for the storage space of nodes in the cluster.
    Default: minimum over 5 minutes
    
    Specified by:
    
    metricFreeStorageSpace in interface IDomain
  - metricIndexingLatency
```
public final Metric metricIndexingLatency(MetricOptions props)
```
    Metric for indexing latency.
    Default: p99 over 5 minutes
    
    Specified by:
    
    metricIndexingLatency in interface IDomain
    
    Specified by:
    
    metricIndexingLatency in interface IDomain.Jsii$Default
    
    Parameters:
    
    props -
  - metricIndexingLatency
```
public final Metric metricIndexingLatency()
```
    Metric for indexing latency.
    Default: p99 over 5 minutes
    
    Specified by:
    
    metricIndexingLatency in interface IDomain
  - metricJVMMemoryPressure
```
public final Metric metricJVMMemoryPressure(MetricOptions props)
```
    Metric for JVM memory pressure.
    Default: maximum over 5 minutes
    
    Specified by:
    
    metricJVMMemoryPressure in interface IDomain
    
    Specified by:
    
    metricJVMMemoryPressure in interface IDomain.Jsii$Default
    
    Parameters:
    
    props -
  - metricJVMMemoryPressure
```
public final Metric metricJVMMemoryPressure()
```
    Metric for JVM memory pressure.
    Default: maximum over 5 minutes
    
    Specified by:
    
    metricJVMMemoryPressure in interface IDomain
  - metricKMSKeyError
```
public final Metric metricKMSKeyError(MetricOptions props)
```
    Metric for KMS key errors.
    Default: maximum over 5 minutes
    
    Specified by:
    
    metricKMSKeyError in interface IDomain
    
    Specified by:
    
    metricKMSKeyError in interface IDomain.Jsii$Default
    
    Parameters:
    
    props -
  - metricKMSKeyError
```
public final Metric metricKMSKeyError()
```
    Metric for KMS key errors.
    Default: maximum over 5 minutes
    
    Specified by:
    
    metricKMSKeyError in interface IDomain
  - metricKMSKeyInaccessible
```
public final Metric metricKMSKeyInaccessible(MetricOptions props)
```
    Metric for KMS key being inaccessible.
    Default: maximum over 5 minutes
    
    Specified by:
    
    metricKMSKeyInaccessible in interface IDomain
    
    Specified by:
    
    metricKMSKeyInaccessible in interface IDomain.Jsii$Default
    
    Parameters:
    
    props -
  - metricKMSKeyInaccessible
```
public final Metric metricKMSKeyInaccessible()
```
    Metric for KMS key being inaccessible.
    Default: maximum over 5 minutes
    
    Specified by:
    
    metricKMSKeyInaccessible in interface IDomain
  - metricMasterCPUUtilization
```
public final Metric metricMasterCPUUtilization(MetricOptions props)
```
    Metric for master CPU utilization.
    Default: maximum over 5 minutes
    
    Specified by:
    
    metricMasterCPUUtilization in interface IDomain
    
    Specified by:
    
    metricMasterCPUUtilization in interface IDomain.Jsii$Default
    
    Parameters:
    
    props -
  - metricMasterCPUUtilization
```
public final Metric metricMasterCPUUtilization()
```
    Metric for master CPU utilization.
    Default: maximum over 5 minutes
    
    Specified by:
    
    metricMasterCPUUtilization in interface IDomain
  - metricMasterJVMMemoryPressure
```
public final Metric metricMasterJVMMemoryPressure(MetricOptions props)
```
    Metric for master JVM memory pressure.
    Default: maximum over 5 minutes
    
    Specified by:
    
    metricMasterJVMMemoryPressure in interface IDomain
    
    Specified by:
    
    metricMasterJVMMemoryPressure in interface IDomain.Jsii$Default
    
    Parameters:
    
    props -
  - metricMasterJVMMemoryPressure
```
public final Metric metricMasterJVMMemoryPressure()
```
    Metric for master JVM memory pressure.
    Default: maximum over 5 minutes
    
    Specified by:
    
    metricMasterJVMMemoryPressure in interface IDomain
  - metricNodes
```
public final Metric metricNodes(MetricOptions props)
```
    Metric for the number of nodes.
    Default: minimum over 1 hour
    
    Specified by:
    
    metricNodes in interface IDomain
    
    Specified by:
    
    metricNodes in interface IDomain.Jsii$Default
    
    Parameters:
    
    props -
  - metricNodes
```
public final Metric metricNodes()
```
    Metric for the number of nodes.
    Default: minimum over 1 hour
    
    Specified by:
    
    metricNodes in interface IDomain
  - metricSearchableDocuments
```
public final Metric metricSearchableDocuments(MetricOptions props)
```
    Metric for number of searchable documents.
    Default: maximum over 5 minutes
    
    Specified by:
    
    metricSearchableDocuments in interface IDomain
    
    Specified by:
    
    metricSearchableDocuments in interface IDomain.Jsii$Default
    
    Parameters:
    
    props -
  - metricSearchableDocuments
```
public final Metric metricSearchableDocuments()
```
    Metric for number of searchable documents.
    Default: maximum over 5 minutes
    
    Specified by:
    
    metricSearchableDocuments in interface IDomain
  - metricSearchLatency
```
public final Metric metricSearchLatency(MetricOptions props)
```
    Metric for search latency.
    Default: p99 over 5 minutes
    
    Specified by:
    
    metricSearchLatency in interface IDomain
    
    Specified by:
    
    metricSearchLatency in interface IDomain.Jsii$Default
    
    Parameters:
    
    props -
  - metricSearchLatency
```
public final Metric metricSearchLatency()
```
    Metric for search latency.
    Default: p99 over 5 minutes
    
    Specified by:
    
    metricSearchLatency in interface IDomain

Class IDomain.Jsii$Proxy

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.opensearchservice.IDomain

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Jsii$Proxy

Method Detail

getNode

getEnv

getStack

getDomainArn

getDomainEndpoint

getDomainId

getDomainName

applyRemovalPolicy

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