@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-14T16:25:33.051Z") public interface IDomain extends IResource
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.
|
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.
|
applyRemovalPolicy, getEnv, getStack
getNode
java.lang.String getDomainArn()
java.lang.String getDomainEndpoint()
java.lang.String getDomainId()
java.lang.String getDomainName()
Grant grantIndexRead(java.lang.String index, IGrantable identity)
index
- The index to grant permissions for. This parameter is required.identity
- The principal. This parameter is required.Grant grantIndexReadWrite(java.lang.String index, IGrantable identity)
index
- The index to grant permissions for. This parameter is required.identity
- The principal. This parameter is required.Grant grantIndexWrite(java.lang.String index, IGrantable identity)
index
- The index to grant permissions for. This parameter is required.identity
- The principal. This parameter is required.Grant grantPathRead(java.lang.String path, IGrantable identity)
path
- The path to grant permissions for. This parameter is required.identity
- The principal. This parameter is required.Grant grantPathReadWrite(java.lang.String path, IGrantable identity)
path
- The path to grant permissions for. This parameter is required.identity
- The principal. This parameter is required.Grant grantPathWrite(java.lang.String path, IGrantable identity)
path
- The path to grant permissions for. This parameter is required.identity
- The principal. This parameter is required.Grant grantRead(IGrantable identity)
identity
- The principal. This parameter is required.Grant grantReadWrite(IGrantable identity)
identity
- The principal. This parameter is required.Grant grantWrite(IGrantable identity)
identity
- The principal. This parameter is required.Metric metric(java.lang.String metricName, MetricOptions props)
metricName
- This parameter is required.props
- Metric metric(java.lang.String metricName)
metricName
- This parameter is required.Metric metricAutomatedSnapshotFailure(MetricOptions props)
Default: maximum over 5 minutes
props
- Metric metricAutomatedSnapshotFailure()
Default: maximum over 5 minutes
Metric metricClusterIndexWritesBlocked(MetricOptions props)
Default: maximum over 1 minute
props
- Metric metricClusterIndexWritesBlocked()
Default: maximum over 1 minute
Metric metricClusterStatusRed(MetricOptions props)
Default: maximum over 5 minutes
props
- Metric metricClusterStatusRed()
Default: maximum over 5 minutes
Metric metricClusterStatusYellow(MetricOptions props)
Default: maximum over 5 minutes
props
- Metric metricClusterStatusYellow()
Default: maximum over 5 minutes
Metric metricCPUUtilization(MetricOptions props)
Default: maximum over 5 minutes
props
- Metric metricCPUUtilization()
Default: maximum over 5 minutes
Metric metricFreeStorageSpace(MetricOptions props)
Default: minimum over 5 minutes
props
- Metric metricFreeStorageSpace()
Default: minimum over 5 minutes
Metric metricIndexingLatency(MetricOptions props)
Default: p99 over 5 minutes
props
- Metric metricIndexingLatency()
Default: p99 over 5 minutes
Metric metricJVMMemoryPressure(MetricOptions props)
Default: maximum over 5 minutes
props
- Metric metricJVMMemoryPressure()
Default: maximum over 5 minutes
Metric metricKMSKeyError(MetricOptions props)
Default: maximum over 5 minutes
props
- Metric metricKMSKeyError()
Default: maximum over 5 minutes
Metric metricKMSKeyInaccessible(MetricOptions props)
Default: maximum over 5 minutes
props
- Metric metricKMSKeyInaccessible()
Default: maximum over 5 minutes
Metric metricMasterCPUUtilization(MetricOptions props)
Default: maximum over 5 minutes
props
- Metric metricMasterCPUUtilization()
Default: maximum over 5 minutes
Metric metricMasterJVMMemoryPressure(MetricOptions props)
Default: maximum over 5 minutes
props
- Metric metricMasterJVMMemoryPressure()
Default: maximum over 5 minutes
Metric metricNodes(MetricOptions props)
Default: minimum over 1 hour
props
- Metric metricNodes()
Default: minimum over 1 hour
Metric metricSearchableDocuments(MetricOptions props)
Default: maximum over 5 minutes
props
- Metric metricSearchableDocuments()
Default: maximum over 5 minutes
Metric metricSearchLatency(MetricOptions props)
Default: p99 over 5 minutes
props
- Metric metricSearchLatency()
Default: p99 over 5 minutes