Interface IDomain
An interface that represents an Amazon OpenSearch Service domain - either created with the CDK, or an existing one.
Inherited Members
Namespace: Amazon.CDK.AWS.OpenSearchService
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IDomain : IResource, IDomainRef, IConstruct, IDependable, IEnvironmentAwareSyntax (vb)
Public Interface IDomain Inherits IResource, IDomainRef, IConstruct, IDependable, IEnvironmentAwareSynopsis
Properties
| DomainArn | Arn of the Amazon OpenSearch Service domain. |
| DomainEndpoint | Endpoint of the Amazon OpenSearch Service domain. |
| DomainId | Identifier of the Amazon OpenSearch Service domain. |
| DomainName | Domain name of the Amazon OpenSearch Service domain. |
Methods
| GrantIndexRead(string, IGrantable) | Grant read permissions for an index in this domain to an IAM principal (Role/Group/User). |
| GrantIndexReadWrite(string, IGrantable) | Grant read/write permissions for an index in this domain to an IAM principal (Role/Group/User). |
| GrantIndexWrite(string, IGrantable) | Grant write permissions for an index in this domain to an IAM principal (Role/Group/User). |
| GrantPathRead(string, IGrantable) | Grant read permissions for a specific path in this domain to an IAM principal (Role/Group/User). |
| GrantPathReadWrite(string, IGrantable) | Grant read/write permissions for a specific path in this domain to an IAM principal (Role/Group/User). |
| GrantPathWrite(string, IGrantable) | Grant write permissions for a specific path in this domain to an IAM principal (Role/Group/User). |
| GrantRead(IGrantable) | Grant read permissions for this domain and its contents to an IAM principal (Role/Group/User). |
| GrantReadWrite(IGrantable) | Grant read/write permissions for this domain and its contents to an IAM principal (Role/Group/User). |
| GrantWrite(IGrantable) | Grant write permissions for this domain and its contents to an IAM principal (Role/Group/User). |
| Metric(string, IMetricOptions?) | Return the given named metric for this domain. |
| MetricAutomatedSnapshotFailure(IMetricOptions?) | Metric for automated snapshot failures. |
| MetricCPUUtilization(IMetricOptions?) | Metric for CPU utilization. |
| MetricClusterIndexWritesBlocked(IMetricOptions?) | Metric for the cluster blocking index writes. |
| MetricClusterStatusRed(IMetricOptions?) | Metric for the time the cluster status is red. |
| MetricClusterStatusYellow(IMetricOptions?) | Metric for the time the cluster status is yellow. |
| MetricFreeStorageSpace(IMetricOptions?) | Metric for the storage space of nodes in the cluster. |
| MetricIndexingLatency(IMetricOptions?) | Metric for indexing latency. |
| MetricJVMMemoryPressure(IMetricOptions?) | Metric for JVM memory pressure. |
| MetricKMSKeyError(IMetricOptions?) | Metric for KMS key errors. |
| MetricKMSKeyInaccessible(IMetricOptions?) | Metric for KMS key being inaccessible. |
| MetricMasterCPUUtilization(IMetricOptions?) | Metric for master CPU utilization. |
| MetricMasterJVMMemoryPressure(IMetricOptions?) | Metric for master JVM memory pressure. |
| MetricNodes(IMetricOptions?) | Metric for the number of nodes. |
| MetricSearchLatency(IMetricOptions?) | Metric for search latency. |
| MetricSearchableDocuments(IMetricOptions?) | Metric for number of searchable documents. |
Properties
DomainArn
Arn of the Amazon OpenSearch Service domain.
string DomainArn { get; }Property Value
Remarks
Attribute: true
DomainEndpoint
Endpoint of the Amazon OpenSearch Service domain.
string DomainEndpoint { get; }Property Value
Remarks
Attribute: true
DomainId
Identifier of the Amazon OpenSearch Service domain.
string DomainId { get; }Property Value
Remarks
Attribute: true
DomainName
Domain name of the Amazon OpenSearch Service domain.
string DomainName { get; }Property Value
Remarks
Attribute: true
Methods
GrantIndexRead(string, IGrantable)
Grant read permissions for an index in this domain to an IAM principal (Role/Group/User).
Grant GrantIndexRead(string index, IGrantable identity)Parameters
- index string
The index to grant permissions for.
- identity IGrantable
The principal.
Returns
GrantIndexReadWrite(string, IGrantable)
Grant read/write permissions for an index in this domain to an IAM principal (Role/Group/User).
Grant GrantIndexReadWrite(string index, IGrantable identity)Parameters
- index string
The index to grant permissions for.
- identity IGrantable
The principal.
Returns
GrantIndexWrite(string, IGrantable)
Grant write permissions for an index in this domain to an IAM principal (Role/Group/User).
Grant GrantIndexWrite(string index, IGrantable identity)Parameters
- index string
The index to grant permissions for.
- identity IGrantable
The principal.
Returns
GrantPathRead(string, IGrantable)
Grant read permissions for a specific path in this domain to an IAM principal (Role/Group/User).
Grant GrantPathRead(string path, IGrantable identity)Parameters
- path string
The path to grant permissions for.
- identity IGrantable
The principal.
Returns
GrantPathReadWrite(string, IGrantable)
Grant read/write permissions for a specific path in this domain to an IAM principal (Role/Group/User).
Grant GrantPathReadWrite(string path, IGrantable identity)Parameters
- path string
The path to grant permissions for.
- identity IGrantable
The principal.
Returns
GrantPathWrite(string, IGrantable)
Grant write permissions for a specific path in this domain to an IAM principal (Role/Group/User).
Grant GrantPathWrite(string path, IGrantable identity)Parameters
- path string
The path to grant permissions for.
- identity IGrantable
The principal.
Returns
GrantRead(IGrantable)
Grant read permissions for this domain and its contents to an IAM principal (Role/Group/User).
Grant GrantRead(IGrantable identity)Parameters
- identity IGrantable
The principal.
Returns
GrantReadWrite(IGrantable)
Grant read/write permissions for this domain and its contents to an IAM principal (Role/Group/User).
Grant GrantReadWrite(IGrantable identity)Parameters
- identity IGrantable
The principal.
Returns
GrantWrite(IGrantable)
Grant write permissions for this domain and its contents to an IAM principal (Role/Group/User).
Grant GrantWrite(IGrantable identity)Parameters
- identity IGrantable
The principal.
Returns
Metric(string, IMetricOptions?)
Return the given named metric for this domain.
Metric Metric(string metricName, IMetricOptions? props = null)Parameters
- metricName string
- props IMetricOptions
Returns
MetricAutomatedSnapshotFailure(IMetricOptions?)
Metric for automated snapshot failures.
Metric MetricAutomatedSnapshotFailure(IMetricOptions? props = null)Parameters
- props IMetricOptions
Returns
Remarks
Default: maximum over 5 minutes
MetricCPUUtilization(IMetricOptions?)
Metric for CPU utilization.
Metric MetricCPUUtilization(IMetricOptions? props = null)Parameters
- props IMetricOptions
Returns
Remarks
Default: maximum over 5 minutes
MetricClusterIndexWritesBlocked(IMetricOptions?)
Metric for the cluster blocking index writes.
Metric MetricClusterIndexWritesBlocked(IMetricOptions? props = null)Parameters
- props IMetricOptions
Returns
Remarks
Default: maximum over 1 minute
MetricClusterStatusRed(IMetricOptions?)
Metric for the time the cluster status is red.
Metric MetricClusterStatusRed(IMetricOptions? props = null)Parameters
- props IMetricOptions
Returns
Remarks
Default: maximum over 5 minutes
MetricClusterStatusYellow(IMetricOptions?)
Metric for the time the cluster status is yellow.
Metric MetricClusterStatusYellow(IMetricOptions? props = null)Parameters
- props IMetricOptions
Returns
Remarks
Default: maximum over 5 minutes
MetricFreeStorageSpace(IMetricOptions?)
Metric for the storage space of nodes in the cluster.
Metric MetricFreeStorageSpace(IMetricOptions? props = null)Parameters
- props IMetricOptions
Returns
Remarks
Default: minimum over 5 minutes
MetricIndexingLatency(IMetricOptions?)
Metric for indexing latency.
Metric MetricIndexingLatency(IMetricOptions? props = null)Parameters
- props IMetricOptions
Returns
Remarks
Default: p99 over 5 minutes
MetricJVMMemoryPressure(IMetricOptions?)
Metric for JVM memory pressure.
Metric MetricJVMMemoryPressure(IMetricOptions? props = null)Parameters
- props IMetricOptions
Returns
Remarks
Default: maximum over 5 minutes
MetricKMSKeyError(IMetricOptions?)
Metric for KMS key errors.
Metric MetricKMSKeyError(IMetricOptions? props = null)Parameters
- props IMetricOptions
Returns
Remarks
Default: maximum over 5 minutes
MetricKMSKeyInaccessible(IMetricOptions?)
Metric for KMS key being inaccessible.
Metric MetricKMSKeyInaccessible(IMetricOptions? props = null)Parameters
- props IMetricOptions
Returns
Remarks
Default: maximum over 5 minutes
MetricMasterCPUUtilization(IMetricOptions?)
Metric for master CPU utilization.
Metric MetricMasterCPUUtilization(IMetricOptions? props = null)Parameters
- props IMetricOptions
Returns
Remarks
Default: maximum over 5 minutes
MetricMasterJVMMemoryPressure(IMetricOptions?)
Metric for master JVM memory pressure.
Metric MetricMasterJVMMemoryPressure(IMetricOptions? props = null)Parameters
- props IMetricOptions
Returns
Remarks
Default: maximum over 5 minutes
MetricNodes(IMetricOptions?)
Metric for the number of nodes.
Metric MetricNodes(IMetricOptions? props = null)Parameters
- props IMetricOptions
Returns
Remarks
Default: minimum over 1 hour
MetricSearchLatency(IMetricOptions?)
Metric for search latency.
Metric MetricSearchLatency(IMetricOptions? props = null)Parameters
- props IMetricOptions
Returns
Remarks
Default: p99 over 5 minutes
MetricSearchableDocuments(IMetricOptions?)
Metric for number of searchable documents.
Metric MetricSearchableDocuments(IMetricOptions? props = null)Parameters
- props IMetricOptions
Returns
Remarks
Default: maximum over 5 minutes