Class Domain

Provides an Elasticsearch domain.

Inheritance

System.Object

Construct

Resource

Domain

Implements

IDomain

IResource

IConstruct

Constructs.IConstruct

IDependable

IConnectable

Inherited Members

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(String, IArnComponents)

Resource.GetResourceNameAttribute(String)

Resource.Env

Resource.PhysicalName

Resource.Stack

Construct.IsConstruct(Object)

Construct.OnPrepare()

Construct.OnSynthesize(ISynthesisSession)

Construct.OnValidate()

Construct.Prepare()

Construct.Synthesize(ISynthesisSession)

Construct.Validate()

Construct.Node

Namespace: Amazon.CDK.AWS.Elasticsearch

Assembly: Amazon.CDK.AWS.Elasticsearch.dll

Syntax (csharp)

public class Domain : Resource, IDomain, IResource, IConstruct, IConstruct, IDependable, IConnectable

Syntax (vb)

Public Class Domain
    Inherits Resource
    Implements IDomain, IResource, IConstruct, IConstruct, IDependable, IConnectable

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 Elasticsearch domain.
DomainEndpoint	Endpoint of the Elasticsearch domain.
DomainName	Domain name of the Elasticsearch 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

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

ILogGroup

Remarks

Attribute: true

AuditLogGroup

Log group that audit logs are logged to.

public virtual ILogGroup AuditLogGroup { get; }

Property Value

ILogGroup

Remarks

Attribute: true

Connections

Manages network connections to the domain.

public virtual Connections_ Connections { get; }

Property Value

Connections_

Remarks

This will throw an error in case the domain is not placed inside a VPC.

DomainArn

Arn of the Elasticsearch domain.

public virtual string DomainArn { get; }

Property Value

System.String

DomainEndpoint

Endpoint of the Elasticsearch domain.

public virtual string DomainEndpoint { get; }

Property Value

System.String

DomainName

Domain name of the Elasticsearch 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

SecretValue

SlowIndexLogGroup

Log group that slow indices are logged to.

public virtual ILogGroup SlowIndexLogGroup { get; }

Property Value

ILogGroup

Remarks

Attribute: true

SlowSearchLogGroup

Log group that slow searches are logged to.

public virtual ILogGroup SlowSearchLogGroup { get; }

Property Value

ILogGroup

Remarks

Attribute: true

Methods

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

IDomain

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

IDomain

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

Grant

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

Grant

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

Grant

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

Grant

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

Grant

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

Grant

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

Grant

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

Grant

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

Grant

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

Metric

MetricAutomatedSnapshotFailure(IMetricOptions)

Metric for automated snapshot failures.

public virtual Metric MetricAutomatedSnapshotFailure(IMetricOptions props = null)

Parameters

props IMetricOptions

Returns

Metric

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

Metric

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

Metric

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

Metric

Remarks

Default: maximum over 5 minutes

MetricCPUUtilization(IMetricOptions)

Metric for CPU utilization.

public virtual Metric MetricCPUUtilization(IMetricOptions props = null)

Parameters

props IMetricOptions

Returns

Metric

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

Metric

Remarks

Default: minimum over 5 minutes

MetricIndexingLatency(IMetricOptions)

Metric for indexing latency.

public virtual Metric MetricIndexingLatency(IMetricOptions props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Default: p99 over 5 minutes

MetricJVMMemoryPressure(IMetricOptions)

Metric for JVM memory pressure.

public virtual Metric MetricJVMMemoryPressure(IMetricOptions props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Default: maximum over 5 minutes

MetricKMSKeyError(IMetricOptions)

Metric for KMS key errors.

public virtual Metric MetricKMSKeyError(IMetricOptions props = null)

Parameters

props IMetricOptions

Returns

Metric

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

Metric

Remarks

Default: maximum over 5 minutes

MetricMasterCPUUtilization(IMetricOptions)

Metric for master CPU utilization.

public virtual Metric MetricMasterCPUUtilization(IMetricOptions props = null)

Parameters

props IMetricOptions

Returns

Metric

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

Metric

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

Metric

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

Metric

Remarks

Default: maximum over 5 minutes

MetricSearchLatency(IMetricOptions)

Metric for search latency.

public virtual Metric MetricSearchLatency(IMetricOptions props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Default: p99 over 5 minutes

Implements

IDomain

IResource

IConstruct

Constructs.IConstruct

IDependable

IConnectable