Class DomainProps

(deprecated) Properties for an AWS Elasticsearch Domain.

Inheritance

object

DomainProps

Implements

IDomainProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Elasticsearch

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class DomainProps : IDomainProps

Syntax (vb)

Public Class DomainProps Implements IDomainProps

Remarks

Stability: Deprecated

ExampleMetadata: infused

Examples

var domain = new Domain(this, "Domain", new DomainProps {
                 Version = ElasticsearchVersion.V7_4,
                 Ebs = new EbsOptions {
                     VolumeSize = 100,
                     VolumeType = EbsDeviceVolumeType.GENERAL_PURPOSE_SSD
                 },
                 NodeToNodeEncryption = true,
                 EncryptionAtRest = new EncryptionAtRestOptions {
                     Enabled = true
                 }
             });

Synopsis

Constructors

DomainProps()

(deprecated) Properties for an AWS Elasticsearch Domain.

Properties

AccessPolicies	(deprecated) Domain Access policies.
AdvancedOptions	(deprecated) Additional options to specify for the Amazon ES domain.
AutomatedSnapshotStartHour	(deprecated) The hour in UTC during which the service takes an automated daily snapshot of the indices in the Amazon ES domain.
Capacity	(deprecated) The cluster capacity configuration for the Amazon ES domain.
CognitoKibanaAuth	(deprecated) Configures Amazon ES to use Amazon Cognito authentication for Kibana.
CustomEndpoint	(deprecated) To configure a custom domain configure these options.
DomainName	(deprecated) Enforces a particular physical domain name.
Ebs	(deprecated) The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the Amazon ES domain.
EnableVersionUpgrade	(deprecated) To upgrade an Amazon ES domain to a new version of Elasticsearch rather than replacing the entire domain resource, use the EnableVersionUpgrade update policy.
EncryptionAtRest	(deprecated) Encryption at rest options for the cluster.
EnforceHttps	(deprecated) True to require that all traffic to the domain arrive over HTTPS.
FineGrainedAccessControl	(deprecated) Specifies options for fine-grained access control.
Logging	(deprecated) Configuration log publishing configuration options.
NodeToNodeEncryption	(deprecated) Specify true to enable node to node encryption.
RemovalPolicy	(deprecated) Policy to apply when the domain is removed from the stack.
SecurityGroups	(deprecated) The list of security groups that are associated with the VPC endpoints for the domain.
TlsSecurityPolicy	(deprecated) The minimum TLS version required for traffic to the domain.
UseUnsignedBasicAuth	(deprecated) Configures the domain so that unsigned basic auth is enabled.
Version	(deprecated) The Elasticsearch version that your domain will leverage.
Vpc	(deprecated) Place the domain inside this VPC.
VpcSubnets	(deprecated) The specific vpc subnets the domain will be placed in.
ZoneAwareness	(deprecated) The cluster zone awareness configuration for the Amazon ES domain.

Constructors

DomainProps()

(deprecated) Properties for an AWS Elasticsearch Domain.

public DomainProps()

Remarks

Stability: Deprecated

ExampleMetadata: infused

Examples

var domain = new Domain(this, "Domain", new DomainProps {
                 Version = ElasticsearchVersion.V7_4,
                 Ebs = new EbsOptions {
                     VolumeSize = 100,
                     VolumeType = EbsDeviceVolumeType.GENERAL_PURPOSE_SSD
                 },
                 NodeToNodeEncryption = true,
                 EncryptionAtRest = new EncryptionAtRestOptions {
                     Enabled = true
                 }
             });

Properties

AccessPolicies

(deprecated) Domain Access policies.

[Obsolete("use opensearchservice module instead")]
public PolicyStatement[]? AccessPolicies { get; set; }

Property Value

PolicyStatement[]

Remarks

Default: - No access policies.

Stability: Deprecated

AdvancedOptions

(deprecated) Additional options to specify for the Amazon ES domain.

[Obsolete("use opensearchservice module instead")]
public IDictionary<string, string>? AdvancedOptions { get; set; }

Property Value

IDictionary<string, string>

Remarks

Default: - no advanced options are specified

Stability: Deprecated

See: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options

AutomatedSnapshotStartHour

(deprecated) The hour in UTC during which the service takes an automated daily snapshot of the indices in the Amazon ES domain.

[Obsolete("use opensearchservice module instead")]
public double? AutomatedSnapshotStartHour { get; set; }

Property Value

double?

Remarks

Only applies for Elasticsearch versions below 5.3.

Default: - Hourly automated snapshots not used

Stability: Deprecated

Capacity

(deprecated) The cluster capacity configuration for the Amazon ES domain.

[Obsolete("use opensearchservice module instead")]
public ICapacityConfig? Capacity { get; set; }

Property Value

ICapacityConfig

Remarks

Default: - 1 r5.large.elasticsearch data node; no dedicated master nodes.

Stability: Deprecated

CognitoKibanaAuth

(deprecated) Configures Amazon ES to use Amazon Cognito authentication for Kibana.

[Obsolete("use opensearchservice module instead")]
public ICognitoOptions? CognitoKibanaAuth { get; set; }

Property Value

ICognitoOptions

Remarks

Default: - Cognito not used for authentication to Kibana.

Stability: Deprecated

CustomEndpoint

(deprecated) To configure a custom domain configure these options.

[Obsolete("use opensearchservice module instead")]
public ICustomEndpointOptions? CustomEndpoint { get; set; }

Property Value

ICustomEndpointOptions

Remarks

If you specify a Route53 hosted zone it will create a CNAME record and use DNS validation for the certificate

Default: - no custom domain endpoint will be configured

Stability: Deprecated

DomainName

(deprecated) Enforces a particular physical domain name.

[Obsolete("use opensearchservice module instead")]
public string? DomainName { get; set; }

Property Value

string

Remarks

Default: - A name will be auto-generated.

Stability: Deprecated

Ebs

(deprecated) The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the Amazon ES domain.

[Obsolete("use opensearchservice module instead")]
public IEbsOptions? Ebs { get; set; }

Property Value

IEbsOptions

Remarks

For more information, see [Configuring EBS-based Storage] (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs) in the Amazon Elasticsearch Service Developer Guide.

Default: - 10 GiB General Purpose (SSD) volumes per node.

Stability: Deprecated

EnableVersionUpgrade

(deprecated) To upgrade an Amazon ES domain to a new version of Elasticsearch rather than replacing the entire domain resource, use the EnableVersionUpgrade update policy.

[Obsolete("use opensearchservice module instead")]
public bool? EnableVersionUpgrade { get; set; }

Property Value

bool?

Remarks

Default: - false

Stability: Deprecated

See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-upgradeelasticsearchdomain

EncryptionAtRest

(deprecated) Encryption at rest options for the cluster.

[Obsolete("use opensearchservice module instead")]
public IEncryptionAtRestOptions? EncryptionAtRest { get; set; }

Property Value

IEncryptionAtRestOptions

Remarks

Default: - No encryption at rest

Stability: Deprecated

EnforceHttps

(deprecated) True to require that all traffic to the domain arrive over HTTPS.

[Obsolete("use opensearchservice module instead")]
public bool? EnforceHttps { get; set; }

Property Value

bool?

Remarks

Default: - false

Stability: Deprecated

FineGrainedAccessControl

(deprecated) Specifies options for fine-grained access control.

[Obsolete("use opensearchservice module instead")]
public IAdvancedSecurityOptions? FineGrainedAccessControl { get; set; }

Property Value

IAdvancedSecurityOptions

Remarks

Requires Elasticsearch version 6.7 or later. Enabling fine-grained access control also requires encryption of data at rest and node-to-node encryption, along with enforced HTTPS.

Default: - fine-grained access control is disabled

Stability: Deprecated

Logging

(deprecated) Configuration log publishing configuration options.

[Obsolete("use opensearchservice module instead")]
public ILoggingOptions? Logging { get; set; }

Property Value

ILoggingOptions

Remarks

Default: - No logs are published

Stability: Deprecated

NodeToNodeEncryption

(deprecated) Specify true to enable node to node encryption.

[Obsolete("use opensearchservice module instead")]
public bool? NodeToNodeEncryption { get; set; }

Property Value

bool?

Remarks

Requires Elasticsearch version 6.0 or later.

Default: - Node to node encryption is not enabled.

Stability: Deprecated

RemovalPolicy

(deprecated) Policy to apply when the domain is removed from the stack.

[Obsolete("use opensearchservice module instead")]
public RemovalPolicy? RemovalPolicy { get; set; }

Property Value

RemovalPolicy?

Remarks

Default: RemovalPolicy.RETAIN

Stability: Deprecated

SecurityGroups

(deprecated) The list of security groups that are associated with the VPC endpoints for the domain.

[Obsolete("use opensearchservice module instead")]
public ISecurityGroup[]? SecurityGroups { get; set; }

Property Value

ISecurityGroup[]

Remarks

Only used if vpc is specified.

Default: - One new security group is created.

Stability: Deprecated

See: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html

TlsSecurityPolicy

(deprecated) The minimum TLS version required for traffic to the domain.

[Obsolete("use opensearchservice module instead")]
public TLSSecurityPolicy? TlsSecurityPolicy { get; set; }

Property Value

TLSSecurityPolicy?

Remarks

Default: - TLSSecurityPolicy.TLS_1_0

Stability: Deprecated

UseUnsignedBasicAuth

(deprecated) Configures the domain so that unsigned basic auth is enabled.

[Obsolete("use opensearchservice module instead")]
public bool? UseUnsignedBasicAuth { get; set; }

Property Value

bool?

Remarks

If no master user is provided a default master user with username admin and a dynamically generated password stored in KMS is created. The password can be retrieved by getting masterUserPassword from the domain instance.

Setting this to true will also add an access policy that allows unsigned access, enable node to node encryption, encryption at rest. If conflicting settings are encountered (like disabling encryption at rest) enabling this setting will cause a failure.

Default: - false

Stability: Deprecated

Version

(deprecated) The Elasticsearch version that your domain will leverage.

[Obsolete("use opensearchservice module instead")]
public ElasticsearchVersion Version { get; set; }

Property Value

ElasticsearchVersion

Remarks

Stability: Deprecated

Vpc

(deprecated) Place the domain inside this VPC.

[Obsolete("use opensearchservice module instead")]
public IVpc? Vpc { get; set; }

Property Value

IVpc

Remarks

Default: - Domain is not placed in a VPC.

Stability: Deprecated

See: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html

VpcSubnets

(deprecated) The specific vpc subnets the domain will be placed in.

[Obsolete("use opensearchservice module instead")]
public ISubnetSelection[]? VpcSubnets { get; set; }

Property Value

ISubnetSelection[]

Remarks

You must provide one subnet for each Availability Zone that your domain uses. For example, you must specify three subnet IDs for a three Availability Zone domain.

Only used if vpc is specified.

Default: - All private subnets.

Stability: Deprecated

See: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html

ZoneAwareness

(deprecated) The cluster zone awareness configuration for the Amazon ES domain.

[Obsolete("use opensearchservice module instead")]
public IZoneAwarenessConfig? ZoneAwareness { get; set; }

Property Value

IZoneAwarenessConfig

Remarks

Default: - no zone awareness (1 AZ)

Stability: Deprecated

Implements

IDomainProps