# DomainProps

Properties for an AWS Elasticsearch Domain.

Extends: DomainProps
Used as props by: Domain

- Source: [`aws-elasticsearch/lib/domain.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-elasticsearch/lib/domain.ts#L502)
- Type last changed: v2.17.0 · 17 Mar 2022

## Example

```ts
const domain = new es.Domain(this, 'Domain', {
  version: es.ElasticsearchVersion.V7_4,
  ebs: {
    volumeSize: 100,
    volumeType: ec2.EbsDeviceVolumeType.GENERAL_PURPOSE_SSD,
  },
  nodeToNodeEncryption: true,
  encryptionAtRest: {
    enabled: true,
  },
});
```

## Properties

- `accessPolicies`: [PolicyStatement](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.PolicyStatement.html)[] — use opensearchservice module instead

  **Default:** No access policies.

- `advancedOptions`: { [key: string]: string } — use opensearchservice module instead

  **Default:** no advanced options are specified

- `automatedSnapshotStartHour`: number — use opensearchservice module instead

  **Default:** Hourly automated snapshots not used

  Only applies for Elasticsearch
  versions below 5.3.

- `capacity`: [CapacityConfig](/cdk/api/v2/docs/aws-cdk-lib.aws_elasticsearch.CapacityConfig.html) — use opensearchservice module instead

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

- `cognitoKibanaAuth`: [CognitoOptions](/cdk/api/v2/docs/aws-cdk-lib.aws_elasticsearch.CognitoOptions.html) — use opensearchservice module instead

  **Default:** Cognito not used for authentication to Kibana.

- `customEndpoint`: [CustomEndpointOptions](/cdk/api/v2/docs/aws-cdk-lib.aws_elasticsearch.CustomEndpointOptions.html) — use opensearchservice module instead

  **Default:** no custom domain endpoint will be configured

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

- `domainName`: string — use opensearchservice module instead

  **Default:** A name will be auto-generated.

- `ebs`: [EbsOptions](/cdk/api/v2/docs/aws-cdk-lib.aws_elasticsearch.EbsOptions.html) — use opensearchservice module instead

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

  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.

- `enableVersionUpgrade`: boolean = false — use opensearchservice module instead

- `encryptionAtRest`: [EncryptionAtRestOptions](/cdk/api/v2/docs/aws-cdk-lib.aws_elasticsearch.EncryptionAtRestOptions.html) — use opensearchservice module instead

  **Default:** No encryption at rest

- `enforceHttps`: boolean = false — use opensearchservice module instead

- `fineGrainedAccessControl`: [AdvancedSecurityOptions](/cdk/api/v2/docs/aws-cdk-lib.aws_elasticsearch.AdvancedSecurityOptions.html) — use opensearchservice module instead

  **Default:** fine-grained access control is disabled

  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.

- `logging`: [LoggingOptions](/cdk/api/v2/docs/aws-cdk-lib.aws_elasticsearch.LoggingOptions.html) — use opensearchservice module instead

  **Default:** No logs are published

- `nodeToNodeEncryption`: boolean — use opensearchservice module instead

  **Default:** Node to node encryption is not enabled.

  Requires Elasticsearch version 6.0 or later.

- `removalPolicy`: [RemovalPolicy](/cdk/api/v2/docs/aws-cdk-lib.RemovalPolicy.html) = RemovalPolicy.RETAIN — use opensearchservice module instead

- `securityGroups`: [ISecurityGroup](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.ISecurityGroup.html)[] — use opensearchservice module instead

  **Default:** One new security group is created.

  Only used if `vpc` is specified.

- `tlsSecurityPolicy`: [TLSSecurityPolicy](/cdk/api/v2/docs/aws-cdk-lib.aws_elasticsearch.TLSSecurityPolicy.html) = TLSSecurityPolicy.TLS_1_0 — use opensearchservice module instead

- `useUnsignedBasicAuth`: boolean = false — use opensearchservice module instead

  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.

- `version`: [ElasticsearchVersion](/cdk/api/v2/docs/aws-cdk-lib.aws_elasticsearch.ElasticsearchVersion.html) (required) — use opensearchservice module instead

- `vpc`: [IVpc](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html) — use opensearchservice module instead

  **Default:** Domain is not placed in a VPC.

- `vpcSubnets`: [SubnetSelection](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.SubnetSelection.html)[] — use opensearchservice module instead

  **Default:** All private subnets.

  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.

- `zoneAwareness`: [ZoneAwarenessConfig](/cdk/api/v2/docs/aws-cdk-lib.aws_elasticsearch.ZoneAwarenessConfig.html) — use opensearchservice module instead

  **Default:** no zone awareness (1 AZ)