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