Package software.amazon.awscdk.services.opensearchservice

Class 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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default

Enclosing interface:

IDomain

@Internal
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default, IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IDependable

IDependable.Jsii$Default, IDependable.Jsii$Proxy

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

IDomain.Jsii$Default, IDomain.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IResource

IResource.Jsii$Default, IResource.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
final void	applyRemovalPolicy(RemovalPolicy policy)	Apply the given removal policy to this resource.
final String	getDomainArn()	Arn of the Amazon OpenSearch Service domain.
final String	getDomainEndpoint()	Endpoint of the Amazon OpenSearch Service domain.
final String	getDomainId()	Identifier of the Amazon OpenSearch Service domain.
final String	getDomainName()	Domain name of the Amazon OpenSearch Service domain.
final ResourceEnvironment	getEnv()	The environment this resource belongs to.
final ConstructNode	getNode()	The construct tree node for this construct.
final Stack	getStack()	The stack in which this resource is defined.
final Grant	grantIndexRead(String index, IGrantable identity)	Grant read permissions for an index in this domain to an IAM principal (Role/Group/User).
final Grant	grantIndexReadWrite(String index, IGrantable identity)	Grant read/write permissions for an index in this domain to an IAM principal (Role/Group/User).
final Grant	grantIndexWrite(String index, IGrantable identity)	Grant write permissions for an index in this domain to an IAM principal (Role/Group/User).
final Grant	grantPathRead(String path, IGrantable identity)	Grant read permissions for a specific path in this domain to an IAM principal (Role/Group/User).
final Grant	grantPathReadWrite(String path, IGrantable identity)	Grant read/write permissions for a specific path in this domain to an IAM principal (Role/Group/User).
final Grant	grantPathWrite(String path, IGrantable identity)	Grant write permissions for a specific path in this domain to an IAM principal (Role/Group/User).
final Grant	grantRead(IGrantable identity)	Grant read permissions for this domain and its contents to an IAM principal (Role/Group/User).
final Grant	grantReadWrite(IGrantable identity)	Grant read/write permissions for this domain and its contents to an IAM principal (Role/Group/User).
final Grant	grantWrite(IGrantable identity)	Grant write permissions for this domain and its contents to an IAM principal (Role/Group/User).
final Metric	metric(String metricName)	Return the given named metric for this domain.
final Metric	metric(String metricName, MetricOptions props)	Return the given named metric for this domain.
final Metric	metricAutomatedSnapshotFailure()	Metric for automated snapshot failures.
final Metric	metricAutomatedSnapshotFailure(MetricOptions props)	Metric for automated snapshot failures.
final Metric	metricClusterIndexWritesBlocked()	Metric for the cluster blocking index writes.
final Metric	metricClusterIndexWritesBlocked(MetricOptions props)	Metric for the cluster blocking index writes.
final Metric	metricClusterStatusRed()	Metric for the time the cluster status is red.
final Metric	metricClusterStatusRed(MetricOptions props)	Metric for the time the cluster status is red.
final Metric	metricClusterStatusYellow()	Metric for the time the cluster status is yellow.
final Metric	metricClusterStatusYellow(MetricOptions props)	Metric for the time the cluster status is yellow.
final Metric	metricCPUUtilization()	Metric for CPU utilization.
final Metric	metricCPUUtilization(MetricOptions props)	Metric for CPU utilization.
final Metric	metricFreeStorageSpace()	Metric for the storage space of nodes in the cluster.
final Metric	metricFreeStorageSpace(MetricOptions props)	Metric for the storage space of nodes in the cluster.
final Metric	metricIndexingLatency()	Metric for indexing latency.
final Metric	metricIndexingLatency(MetricOptions props)	Metric for indexing latency.
final Metric	metricJVMMemoryPressure()	Metric for JVM memory pressure.
final Metric	metricJVMMemoryPressure(MetricOptions props)	Metric for JVM memory pressure.
final Metric	metricKMSKeyError()	Metric for KMS key errors.
final Metric	metricKMSKeyError(MetricOptions props)	Metric for KMS key errors.
final Metric	metricKMSKeyInaccessible()	Metric for KMS key being inaccessible.
final Metric	metricKMSKeyInaccessible(MetricOptions props)	Metric for KMS key being inaccessible.
final Metric	metricMasterCPUUtilization()	Metric for master CPU utilization.
final Metric	metricMasterCPUUtilization(MetricOptions props)	Metric for master CPU utilization.
final Metric	metricMasterJVMMemoryPressure()	Metric for master JVM memory pressure.
final Metric	metricMasterJVMMemoryPressure(MetricOptions props)	Metric for master JVM memory pressure.
final Metric	metricNodes()	Metric for the number of nodes.
final Metric	metricNodes(MetricOptions props)	Metric for the number of nodes.
final Metric	metricSearchableDocuments()	Metric for number of searchable documents.
final Metric	metricSearchableDocuments(MetricOptions props)	Metric for number of searchable documents.
final Metric	metricSearchLatency()	Metric for search latency.
final Metric	metricSearchLatency(MetricOptions props)	Metric for search latency.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

Jsii$Proxy

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

Method Details

getNode

@Stability(Stable)
@NotNull
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 IDomain.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(Stable)
@NotNull
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 IDomain.Jsii$Default

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

@Stability(Stable)
@NotNull
public final Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IDomain.Jsii$Default

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getDomainArn

@Stability(Stable)
@NotNull
public final String getDomainArn()

Arn of the Amazon OpenSearch Service domain.

Specified by:

getDomainArn in interface IDomain

Specified by:

getDomainArn in interface IDomain.Jsii$Default

getDomainEndpoint

@Stability(Stable)
@NotNull
public final String getDomainEndpoint()

Endpoint of the Amazon OpenSearch Service domain.

Specified by:

getDomainEndpoint in interface IDomain

Specified by:

getDomainEndpoint in interface IDomain.Jsii$Default

getDomainId

@Stability(Stable)
@NotNull
public final String getDomainId()

Identifier of the Amazon OpenSearch Service domain.

Specified by:

getDomainId in interface IDomain

Specified by:

getDomainId in interface IDomain.Jsii$Default

getDomainName

@Stability(Stable)
@NotNull
public final 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

@Stability(Stable)
public final void applyRemovalPolicy(@NotNull
 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 IDomain.Jsii$Default

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Parameters:

policy - This parameter is required.

grantIndexRead

@Stability(Stable)
@NotNull
public final Grant grantIndexRead(@NotNull
 String index,
 @NotNull
 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

@Stability(Stable)
@NotNull
public final Grant grantIndexReadWrite(@NotNull
 String index,
 @NotNull
 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

@Stability(Stable)
@NotNull
public final Grant grantIndexWrite(@NotNull
 String index,
 @NotNull
 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

@Stability(Stable)
@NotNull
public final Grant grantPathRead(@NotNull
 String path,
 @NotNull
 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

@Stability(Stable)
@NotNull
public final Grant grantPathReadWrite(@NotNull
 String path,
 @NotNull
 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

@Stability(Stable)
@NotNull
public final Grant grantPathWrite(@NotNull
 String path,
 @NotNull
 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

@Stability(Stable)
@NotNull
public final Grant grantRead(@NotNull
 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

@Stability(Stable)
@NotNull
public final Grant grantReadWrite(@NotNull
 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

@Stability(Stable)
@NotNull
public final Grant grantWrite(@NotNull
 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

@Stability(Stable)
@NotNull
public final Metric metric(@NotNull
 String metricName,
 @Nullable
 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

@Stability(Stable)
@NotNull
public final Metric metric(@NotNull
 String metricName)

Return the given named metric for this domain.

Specified by:

metric in interface IDomain

Parameters:

metricName - This parameter is required.

metricAutomatedSnapshotFailure

@Stability(Stable)
@NotNull
public final Metric metricAutomatedSnapshotFailure(@Nullable
 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

@Stability(Stable)
@NotNull
public final Metric metricAutomatedSnapshotFailure()

Metric for automated snapshot failures.

Default: maximum over 5 minutes

Specified by:

metricAutomatedSnapshotFailure in interface IDomain

metricClusterIndexWritesBlocked

@Stability(Stable)
@NotNull
public final Metric metricClusterIndexWritesBlocked(@Nullable
 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

@Stability(Stable)
@NotNull
public final Metric metricClusterIndexWritesBlocked()

Metric for the cluster blocking index writes.

Default: maximum over 1 minute

Specified by:

metricClusterIndexWritesBlocked in interface IDomain

metricClusterStatusRed

@Stability(Stable)
@NotNull
public final Metric metricClusterStatusRed(@Nullable
 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

@Stability(Stable)
@NotNull
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

@Stability(Stable)
@NotNull
public final Metric metricClusterStatusYellow(@Nullable
 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

@Stability(Stable)
@NotNull
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

@Stability(Stable)
@NotNull
public final Metric metricCPUUtilization(@Nullable
 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

@Stability(Stable)
@NotNull
public final Metric metricCPUUtilization()

Metric for CPU utilization.

Default: maximum over 5 minutes

Specified by:

metricCPUUtilization in interface IDomain

metricFreeStorageSpace

@Stability(Stable)
@NotNull
public final Metric metricFreeStorageSpace(@Nullable
 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

@Stability(Stable)
@NotNull
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

@Stability(Stable)
@NotNull
public final Metric metricIndexingLatency(@Nullable
 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

@Stability(Stable)
@NotNull
public final Metric metricIndexingLatency()

Metric for indexing latency.

Default: p99 over 5 minutes

Specified by:

metricIndexingLatency in interface IDomain

metricJVMMemoryPressure

@Stability(Stable)
@NotNull
public final Metric metricJVMMemoryPressure(@Nullable
 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

@Stability(Stable)
@NotNull
public final Metric metricJVMMemoryPressure()

Metric for JVM memory pressure.

Default: maximum over 5 minutes

Specified by:

metricJVMMemoryPressure in interface IDomain

metricKMSKeyError

@Stability(Stable)
@NotNull
public final Metric metricKMSKeyError(@Nullable
 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

@Stability(Stable)
@NotNull
public final Metric metricKMSKeyError()

Metric for KMS key errors.

Default: maximum over 5 minutes

Specified by:

metricKMSKeyError in interface IDomain

metricKMSKeyInaccessible

@Stability(Stable)
@NotNull
public final Metric metricKMSKeyInaccessible(@Nullable
 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

@Stability(Stable)
@NotNull
public final Metric metricKMSKeyInaccessible()

Metric for KMS key being inaccessible.

Default: maximum over 5 minutes

Specified by:

metricKMSKeyInaccessible in interface IDomain

metricMasterCPUUtilization

@Stability(Stable)
@NotNull
public final Metric metricMasterCPUUtilization(@Nullable
 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

@Stability(Stable)
@NotNull
public final Metric metricMasterCPUUtilization()

Metric for master CPU utilization.

Default: maximum over 5 minutes

Specified by:

metricMasterCPUUtilization in interface IDomain

metricMasterJVMMemoryPressure

@Stability(Stable)
@NotNull
public final Metric metricMasterJVMMemoryPressure(@Nullable
 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

@Stability(Stable)
@NotNull
public final Metric metricMasterJVMMemoryPressure()

Metric for master JVM memory pressure.

Default: maximum over 5 minutes

Specified by:

metricMasterJVMMemoryPressure in interface IDomain

metricNodes

@Stability(Stable)
@NotNull
public final Metric metricNodes(@Nullable
 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

@Stability(Stable)
@NotNull
public final Metric metricNodes()

Metric for the number of nodes.

Default: minimum over 1 hour

Specified by:

metricNodes in interface IDomain

metricSearchableDocuments

@Stability(Stable)
@NotNull
public final Metric metricSearchableDocuments(@Nullable
 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

@Stability(Stable)
@NotNull
public final Metric metricSearchableDocuments()

Metric for number of searchable documents.

Default: maximum over 5 minutes

Specified by:

metricSearchableDocuments in interface IDomain

metricSearchLatency

@Stability(Stable)
@NotNull
public final Metric metricSearchLatency(@Nullable
 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

@Stability(Stable)
@NotNull
public final Metric metricSearchLatency()

Metric for search latency.

Default: p99 over 5 minutes

Specified by:

metricSearchLatency in interface IDomain