Class 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
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default, IConstruct.Jsii$ProxyNested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.core.IDependable
IDependable.Jsii$Default, IDependable.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.services.opensearchservice.IDomain
IDomain.Jsii$Default, IDomain.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.core.IResource
IResource.Jsii$Default, IResource.Jsii$Proxy -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal voidapplyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.final StringArn of the Amazon OpenSearch Service domain.final StringEndpoint of the Amazon OpenSearch Service domain.final StringIdentifier of the Amazon OpenSearch Service domain.final StringDomain name of the Amazon OpenSearch Service domain.final ResourceEnvironmentgetEnv()The environment this resource belongs to.final ConstructNodegetNode()The construct tree node for this construct.final StackgetStack()The stack in which this resource is defined.final GrantgrantIndexRead(String index, IGrantable identity) Grant read permissions for an index in this domain to an IAM principal (Role/Group/User).final GrantgrantIndexReadWrite(String index, IGrantable identity) Grant read/write permissions for an index in this domain to an IAM principal (Role/Group/User).final GrantgrantIndexWrite(String index, IGrantable identity) Grant write permissions for an index in this domain to an IAM principal (Role/Group/User).final GrantgrantPathRead(String path, IGrantable identity) Grant read permissions for a specific path in this domain to an IAM principal (Role/Group/User).final GrantgrantPathReadWrite(String path, IGrantable identity) Grant read/write permissions for a specific path in this domain to an IAM principal (Role/Group/User).final GrantgrantPathWrite(String path, IGrantable identity) Grant write permissions for a specific path in this domain to an IAM principal (Role/Group/User).final GrantgrantRead(IGrantable identity) Grant read permissions for this domain and its contents to an IAM principal (Role/Group/User).final GrantgrantReadWrite(IGrantable identity) Grant read/write permissions for this domain and its contents to an IAM principal (Role/Group/User).final GrantgrantWrite(IGrantable identity) Grant write permissions for this domain and its contents to an IAM principal (Role/Group/User).final MetricReturn the given named metric for this domain.final Metricmetric(String metricName, MetricOptions props) Return the given named metric for this domain.final MetricMetric for automated snapshot failures.final MetricMetric for automated snapshot failures.final MetricMetric for the cluster blocking index writes.final MetricMetric for the cluster blocking index writes.final MetricMetric for the time the cluster status is red.final MetricMetric for the time the cluster status is red.final MetricMetric for the time the cluster status is yellow.final MetricMetric for the time the cluster status is yellow.final MetricMetric for CPU utilization.final MetricMetric for CPU utilization.final MetricMetric for the storage space of nodes in the cluster.final MetricMetric for the storage space of nodes in the cluster.final MetricMetric for indexing latency.final MetricMetric for indexing latency.final MetricMetric for JVM memory pressure.final MetricMetric for JVM memory pressure.final MetricMetric for KMS key errors.final MetricmetricKMSKeyError(MetricOptions props) Metric for KMS key errors.final MetricMetric for KMS key being inaccessible.final MetricMetric for KMS key being inaccessible.final MetricMetric for master CPU utilization.final MetricMetric for master CPU utilization.final MetricMetric for master JVM memory pressure.final MetricMetric for master JVM memory pressure.final MetricMetric for the number of nodes.final MetricmetricNodes(MetricOptions props) Metric for the number of nodes.final MetricMetric for number of searchable documents.final MetricMetric for number of searchable documents.final MetricMetric for search latency.final MetricmetricSearchLatency(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, jsiiStaticSetMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
-
-
Method Details
-
getNode
The construct tree node for this construct.- Specified by:
getNodein interfaceIConstruct- Specified by:
getNodein interfaceIConstruct.Jsii$Default- Specified by:
getNodein interfaceIDomain.Jsii$Default- Specified by:
getNodein interfaceIResource.Jsii$Default
-
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:
getEnvin interfaceIDomain.Jsii$Default- Specified by:
getEnvin interfaceIResource- Specified by:
getEnvin interfaceIResource.Jsii$Default
-
getStack
The stack in which this resource is defined.- Specified by:
getStackin interfaceIDomain.Jsii$Default- Specified by:
getStackin interfaceIResource- Specified by:
getStackin interfaceIResource.Jsii$Default
-
getDomainArn
Arn of the Amazon OpenSearch Service domain.- Specified by:
getDomainArnin interfaceIDomain- Specified by:
getDomainArnin interfaceIDomain.Jsii$Default
-
getDomainEndpoint
Endpoint of the Amazon OpenSearch Service domain.- Specified by:
getDomainEndpointin interfaceIDomain- Specified by:
getDomainEndpointin interfaceIDomain.Jsii$Default
-
getDomainId
Identifier of the Amazon OpenSearch Service domain.- Specified by:
getDomainIdin interfaceIDomain- Specified by:
getDomainIdin interfaceIDomain.Jsii$Default
-
getDomainName
Domain name of the Amazon OpenSearch Service domain.- Specified by:
getDomainNamein interfaceIDomain- Specified by:
getDomainNamein interfaceIDomain.Jsii$Default
-
applyRemovalPolicy
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:
applyRemovalPolicyin interfaceIDomain.Jsii$Default- Specified by:
applyRemovalPolicyin interfaceIResource- Specified by:
applyRemovalPolicyin interfaceIResource.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:
grantIndexReadin interfaceIDomain- Specified by:
grantIndexReadin interfaceIDomain.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:
grantIndexReadWritein interfaceIDomain- Specified by:
grantIndexReadWritein interfaceIDomain.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:
grantIndexWritein interfaceIDomain- Specified by:
grantIndexWritein interfaceIDomain.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:
grantPathReadin interfaceIDomain- Specified by:
grantPathReadin interfaceIDomain.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:
grantPathReadWritein interfaceIDomain- Specified by:
grantPathReadWritein interfaceIDomain.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:
grantPathWritein interfaceIDomain- Specified by:
grantPathWritein interfaceIDomain.Jsii$Default- Parameters:
path- The path to grant permissions for. This parameter is required.identity- The principal. This parameter is required.
-
grantRead
Grant read permissions for this domain and its contents to an IAM principal (Role/Group/User).- Specified by:
grantReadin interfaceIDomain- Specified by:
grantReadin interfaceIDomain.Jsii$Default- Parameters:
identity- The principal. This parameter is required.
-
grantReadWrite
Grant read/write permissions for this domain and its contents to an IAM principal (Role/Group/User).- Specified by:
grantReadWritein interfaceIDomain- Specified by:
grantReadWritein interfaceIDomain.Jsii$Default- Parameters:
identity- The principal. This parameter is required.
-
grantWrite
Grant write permissions for this domain and its contents to an IAM principal (Role/Group/User).- Specified by:
grantWritein interfaceIDomain- Specified by:
grantWritein interfaceIDomain.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:
metricin interfaceIDomain- Specified by:
metricin interfaceIDomain.Jsii$Default- Parameters:
metricName- This parameter is required.props-
-
metric
Return the given named metric for this domain. -
metricAutomatedSnapshotFailure
@Stability(Stable) @NotNull public final Metric metricAutomatedSnapshotFailure(@Nullable MetricOptions props) Metric for automated snapshot failures.Default: maximum over 5 minutes
- Specified by:
metricAutomatedSnapshotFailurein interfaceIDomain- Specified by:
metricAutomatedSnapshotFailurein interfaceIDomain.Jsii$Default- Parameters:
props-
-
metricAutomatedSnapshotFailure
Metric for automated snapshot failures.Default: maximum over 5 minutes
- Specified by:
metricAutomatedSnapshotFailurein interfaceIDomain
-
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:
metricClusterIndexWritesBlockedin interfaceIDomain- Specified by:
metricClusterIndexWritesBlockedin interfaceIDomain.Jsii$Default- Parameters:
props-
-
metricClusterIndexWritesBlocked
Metric for the cluster blocking index writes.Default: maximum over 1 minute
- Specified by:
metricClusterIndexWritesBlockedin interfaceIDomain
-
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:
metricClusterStatusRedin interfaceIDomain- Specified by:
metricClusterStatusRedin interfaceIDomain.Jsii$Default- Parameters:
props-
-
metricClusterStatusRed
Metric for the time the cluster status is red.Default: maximum over 5 minutes
- Specified by:
metricClusterStatusRedin interfaceIDomain
-
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:
metricClusterStatusYellowin interfaceIDomain- Specified by:
metricClusterStatusYellowin interfaceIDomain.Jsii$Default- Parameters:
props-
-
metricClusterStatusYellow
Metric for the time the cluster status is yellow.Default: maximum over 5 minutes
- Specified by:
metricClusterStatusYellowin interfaceIDomain
-
metricCPUUtilization
Metric for CPU utilization.Default: maximum over 5 minutes
- Specified by:
metricCPUUtilizationin interfaceIDomain- Specified by:
metricCPUUtilizationin interfaceIDomain.Jsii$Default- Parameters:
props-
-
metricCPUUtilization
Metric for CPU utilization.Default: maximum over 5 minutes
- Specified by:
metricCPUUtilizationin interfaceIDomain
-
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:
metricFreeStorageSpacein interfaceIDomain- Specified by:
metricFreeStorageSpacein interfaceIDomain.Jsii$Default- Parameters:
props-
-
metricFreeStorageSpace
Metric for the storage space of nodes in the cluster.Default: minimum over 5 minutes
- Specified by:
metricFreeStorageSpacein interfaceIDomain
-
metricIndexingLatency
@Stability(Stable) @NotNull public final Metric metricIndexingLatency(@Nullable MetricOptions props) Metric for indexing latency.Default: p99 over 5 minutes
- Specified by:
metricIndexingLatencyin interfaceIDomain- Specified by:
metricIndexingLatencyin interfaceIDomain.Jsii$Default- Parameters:
props-
-
metricIndexingLatency
Metric for indexing latency.Default: p99 over 5 minutes
- Specified by:
metricIndexingLatencyin interfaceIDomain
-
metricJVMMemoryPressure
@Stability(Stable) @NotNull public final Metric metricJVMMemoryPressure(@Nullable MetricOptions props) Metric for JVM memory pressure.Default: maximum over 5 minutes
- Specified by:
metricJVMMemoryPressurein interfaceIDomain- Specified by:
metricJVMMemoryPressurein interfaceIDomain.Jsii$Default- Parameters:
props-
-
metricJVMMemoryPressure
Metric for JVM memory pressure.Default: maximum over 5 minutes
- Specified by:
metricJVMMemoryPressurein interfaceIDomain
-
metricKMSKeyError
Metric for KMS key errors.Default: maximum over 5 minutes
- Specified by:
metricKMSKeyErrorin interfaceIDomain- Specified by:
metricKMSKeyErrorin interfaceIDomain.Jsii$Default- Parameters:
props-
-
metricKMSKeyError
Metric for KMS key errors.Default: maximum over 5 minutes
- Specified by:
metricKMSKeyErrorin interfaceIDomain
-
metricKMSKeyInaccessible
@Stability(Stable) @NotNull public final Metric metricKMSKeyInaccessible(@Nullable MetricOptions props) Metric for KMS key being inaccessible.Default: maximum over 5 minutes
- Specified by:
metricKMSKeyInaccessiblein interfaceIDomain- Specified by:
metricKMSKeyInaccessiblein interfaceIDomain.Jsii$Default- Parameters:
props-
-
metricKMSKeyInaccessible
Metric for KMS key being inaccessible.Default: maximum over 5 minutes
- Specified by:
metricKMSKeyInaccessiblein interfaceIDomain
-
metricMasterCPUUtilization
@Stability(Stable) @NotNull public final Metric metricMasterCPUUtilization(@Nullable MetricOptions props) Metric for master CPU utilization.Default: maximum over 5 minutes
- Specified by:
metricMasterCPUUtilizationin interfaceIDomain- Specified by:
metricMasterCPUUtilizationin interfaceIDomain.Jsii$Default- Parameters:
props-
-
metricMasterCPUUtilization
Metric for master CPU utilization.Default: maximum over 5 minutes
- Specified by:
metricMasterCPUUtilizationin interfaceIDomain
-
metricMasterJVMMemoryPressure
@Stability(Stable) @NotNull public final Metric metricMasterJVMMemoryPressure(@Nullable MetricOptions props) Metric for master JVM memory pressure.Default: maximum over 5 minutes
- Specified by:
metricMasterJVMMemoryPressurein interfaceIDomain- Specified by:
metricMasterJVMMemoryPressurein interfaceIDomain.Jsii$Default- Parameters:
props-
-
metricMasterJVMMemoryPressure
Metric for master JVM memory pressure.Default: maximum over 5 minutes
- Specified by:
metricMasterJVMMemoryPressurein interfaceIDomain
-
metricNodes
Metric for the number of nodes.Default: minimum over 1 hour
- Specified by:
metricNodesin interfaceIDomain- Specified by:
metricNodesin interfaceIDomain.Jsii$Default- Parameters:
props-
-
metricNodes
Metric for the number of nodes.Default: minimum over 1 hour
- Specified by:
metricNodesin interfaceIDomain
-
metricSearchableDocuments
@Stability(Stable) @NotNull public final Metric metricSearchableDocuments(@Nullable MetricOptions props) Metric for number of searchable documents.Default: maximum over 5 minutes
- Specified by:
metricSearchableDocumentsin interfaceIDomain- Specified by:
metricSearchableDocumentsin interfaceIDomain.Jsii$Default- Parameters:
props-
-
metricSearchableDocuments
Metric for number of searchable documents.Default: maximum over 5 minutes
- Specified by:
metricSearchableDocumentsin interfaceIDomain
-
metricSearchLatency
Metric for search latency.Default: p99 over 5 minutes
- Specified by:
metricSearchLatencyin interfaceIDomain- Specified by:
metricSearchLatencyin interfaceIDomain.Jsii$Default- Parameters:
props-
-
metricSearchLatency
Metric for search latency.Default: p99 over 5 minutes
- Specified by:
metricSearchLatencyin interfaceIDomain
-