Class Domain
Provides an Amazon OpenSearch Service domain.
Inherited Members
Namespace: Amazon.CDK.AWS.OpenSearchService
Assembly: Amazon.CDK.AWS.OpenSearchService.dll
Syntax (csharp)
public class Domain : Resource, IDomain, IResource, IConstruct, IDependable, IConnectable
Syntax (vb)
Public Class Domain
Inherits Resource
Implements IDomain, IResource, IConstruct, IDependable, IConnectable
Remarks
ExampleMetadata: infused
Examples
var domain = new Domain(this, "Domain", new DomainProps {
Version = EngineVersion.OPENSEARCH_1_0,
Ebs = new EbsOptions {
VolumeSize = 100,
VolumeType = EbsDeviceVolumeType.GENERAL_PURPOSE_SSD
},
NodeToNodeEncryption = true,
EncryptionAtRest = new EncryptionAtRestOptions {
Enabled = true
}
});
Synopsis
Constructors
Domain(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
Domain(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Domain(Construct, String, IDomainProps) |
Properties
AppLogGroup | Log group that application logs are logged to. |
AuditLogGroup | Log group that audit logs are logged to. |
Connections | Manages network connections to the domain. |
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. |
MasterUserPassword | Master user password if fine grained access control is configured. |
SlowIndexLogGroup | Log group that slow indices are logged to. |
SlowSearchLogGroup | Log group that slow searches are logged to. |
Methods
AddAccessPolicies(PolicyStatement[]) | Add policy statements to the domain access policy. |
FromDomainAttributes(Construct, String, IDomainAttributes) | Creates a domain construct that represents an external domain. |
FromDomainEndpoint(Construct, String, String) | Creates a domain construct that represents an external domain via domain endpoint. |
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. |
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. |
MetricCPUUtilization(IMetricOptions) | Metric for CPU utilization. |
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. |
MetricSearchableDocuments(IMetricOptions) | Metric for number of searchable documents. |
MetricSearchLatency(IMetricOptions) | Metric for search latency. |
Constructors
Domain(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected Domain(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
Domain(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected Domain(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Domain(Construct, String, IDomainProps)
public Domain(Construct scope, string id, IDomainProps props)
Parameters
- scope Constructs.Construct
- id System.String
- props IDomainProps
Properties
AppLogGroup
Log group that application logs are logged to.
public virtual ILogGroup AppLogGroup { get; }
Property Value
Remarks
Attribute: true
AuditLogGroup
Log group that audit logs are logged to.
public virtual ILogGroup AuditLogGroup { get; }
Property Value
Remarks
Attribute: true
Connections
Manages network connections to the domain.
public virtual Connections_ Connections { get; }
Property Value
Remarks
This will throw an error in case the domain is not placed inside a VPC.
DomainArn
Arn of the Amazon OpenSearch Service domain.
public virtual string DomainArn { get; }
Property Value
System.String
DomainEndpoint
Endpoint of the Amazon OpenSearch Service domain.
public virtual string DomainEndpoint { get; }
Property Value
System.String
DomainId
Identifier of the Amazon OpenSearch Service domain.
public virtual string DomainId { get; }
Property Value
System.String
DomainName
Domain name of the Amazon OpenSearch Service domain.
public virtual string DomainName { get; }
Property Value
System.String
MasterUserPassword
Master user password if fine grained access control is configured.
public virtual SecretValue MasterUserPassword { get; }
Property Value
SlowIndexLogGroup
Log group that slow indices are logged to.
public virtual ILogGroup SlowIndexLogGroup { get; }
Property Value
Remarks
Attribute: true
SlowSearchLogGroup
Log group that slow searches are logged to.
public virtual ILogGroup SlowSearchLogGroup { get; }
Property Value
Remarks
Attribute: true
Methods
AddAccessPolicies(PolicyStatement[])
Add policy statements to the domain access policy.
public virtual void AddAccessPolicies(params PolicyStatement[] accessPolicyStatements)
Parameters
- accessPolicyStatements PolicyStatement[]
FromDomainAttributes(Construct, String, IDomainAttributes)
Creates a domain construct that represents an external domain.
public static IDomain FromDomainAttributes(Construct scope, string id, IDomainAttributes attrs)
Parameters
- scope Constructs.Construct
The parent creating construct (usually
this
).- id System.String
The construct's name.
- attrs IDomainAttributes
A
DomainAttributes
object.
Returns
FromDomainEndpoint(Construct, String, String)
Creates a domain construct that represents an external domain via domain endpoint.
public static IDomain FromDomainEndpoint(Construct scope, string id, string domainEndpoint)
Parameters
- scope Constructs.Construct
The parent creating construct (usually
this
).- id System.String
The construct's name.
- domainEndpoint System.String
The domain's endpoint.
Returns
GrantIndexRead(String, IGrantable)
Grant read permissions for an index in this domain to an IAM principal (Role/Group/User).
public virtual Grant GrantIndexRead(string index, IGrantable identity)
Parameters
- index System.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).
public virtual Grant GrantIndexReadWrite(string index, IGrantable identity)
Parameters
- index System.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).
public virtual Grant GrantIndexWrite(string index, IGrantable identity)
Parameters
- index System.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).
public virtual Grant GrantPathRead(string path, IGrantable identity)
Parameters
- path System.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).
public virtual Grant GrantPathReadWrite(string path, IGrantable identity)
Parameters
- path System.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).
public virtual Grant GrantPathWrite(string path, IGrantable identity)
Parameters
- path System.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).
public virtual 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).
public virtual 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).
public virtual Grant GrantWrite(IGrantable identity)
Parameters
- identity IGrantable
The principal.
Returns
Metric(String, IMetricOptions)
Return the given named metric for this domain.
public virtual Metric Metric(string metricName, IMetricOptions props = null)
Parameters
- metricName System.String
- props IMetricOptions
Returns
MetricAutomatedSnapshotFailure(IMetricOptions)
Metric for automated snapshot failures.
public virtual Metric MetricAutomatedSnapshotFailure(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Default: maximum over 5 minutes
MetricClusterIndexWritesBlocked(IMetricOptions)
Metric for the cluster blocking index writes.
public virtual 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.
public virtual 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.
public virtual Metric MetricClusterStatusYellow(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Default: maximum over 5 minutes
MetricCPUUtilization(IMetricOptions)
Metric for CPU utilization.
public virtual Metric MetricCPUUtilization(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.
public virtual Metric MetricFreeStorageSpace(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Default: minimum over 5 minutes
MetricIndexingLatency(IMetricOptions)
Metric for indexing latency.
public virtual Metric MetricIndexingLatency(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Default: p99 over 5 minutes
MetricJVMMemoryPressure(IMetricOptions)
Metric for JVM memory pressure.
public virtual Metric MetricJVMMemoryPressure(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Default: maximum over 5 minutes
MetricKMSKeyError(IMetricOptions)
Metric for KMS key errors.
public virtual Metric MetricKMSKeyError(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Default: maximum over 5 minutes
MetricKMSKeyInaccessible(IMetricOptions)
Metric for KMS key being inaccessible.
public virtual Metric MetricKMSKeyInaccessible(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Default: maximum over 5 minutes
MetricMasterCPUUtilization(IMetricOptions)
Metric for master CPU utilization.
public virtual Metric MetricMasterCPUUtilization(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Default: maximum over 5 minutes
MetricMasterJVMMemoryPressure(IMetricOptions)
Metric for master JVM memory pressure.
public virtual Metric MetricMasterJVMMemoryPressure(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Default: maximum over 5 minutes
MetricNodes(IMetricOptions)
Metric for the number of nodes.
public virtual Metric MetricNodes(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Default: minimum over 1 hour
MetricSearchableDocuments(IMetricOptions)
Metric for number of searchable documents.
public virtual Metric MetricSearchableDocuments(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Default: maximum over 5 minutes
MetricSearchLatency(IMetricOptions)
Metric for search latency.
public virtual Metric MetricSearchLatency(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Default: p99 over 5 minutes