aws-cdk-lib.aws_elasticsearch.DomainProps

interface DomainProps ⚠️

LanguageType name
.NETAmazon.CDK.AWS.Elasticsearch.DomainProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awselasticsearch#DomainProps
Javasoftware.amazon.awscdk.services.elasticsearch.DomainProps
Pythonaws_cdk.aws_elasticsearch.DomainProps
TypeScript (source)aws-cdk-lib » aws_elasticsearch » DomainProps

⚠️ Deprecated: use opensearchservice module instead

Properties for an AWS Elasticsearch Domain.

Example

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

NameTypeDescription
version⚠️ElasticsearchVersionThe Elasticsearch version that your domain will leverage.
accessPolicies?⚠️PolicyStatement[]Domain Access policies.
advancedOptions?⚠️{ [string]: string }Additional options to specify for the Amazon ES domain.
automatedSnapshotStartHour?⚠️numberThe hour in UTC during which the service takes an automated daily snapshot of the indices in the Amazon ES domain.
capacity?⚠️CapacityConfigThe cluster capacity configuration for the Amazon ES domain.
cognitoKibanaAuth?⚠️CognitoOptionsConfigures Amazon ES to use Amazon Cognito authentication for Kibana.
customEndpoint?⚠️CustomEndpointOptionsTo configure a custom domain configure these options.
domainName?⚠️stringEnforces a particular physical domain name.
ebs?⚠️EbsOptionsThe configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the Amazon ES domain.
enableVersionUpgrade?⚠️booleanTo upgrade an Amazon ES domain to a new version of Elasticsearch rather than replacing the entire domain resource, use the EnableVersionUpgrade update policy.
encryptionAtRest?⚠️EncryptionAtRestOptionsEncryption at rest options for the cluster.
enforceHttps?⚠️booleanTrue to require that all traffic to the domain arrive over HTTPS.
fineGrainedAccessControl?⚠️AdvancedSecurityOptionsSpecifies options for fine-grained access control.
logging?⚠️LoggingOptionsConfiguration log publishing configuration options.
nodeToNodeEncryption?⚠️booleanSpecify true to enable node to node encryption.
removalPolicy?⚠️RemovalPolicyPolicy to apply when the domain is removed from the stack.
securityGroups?⚠️ISecurityGroup[]The list of security groups that are associated with the VPC endpoints for the domain.
tlsSecurityPolicy?⚠️TLSSecurityPolicyThe minimum TLS version required for traffic to the domain.
useUnsignedBasicAuth?⚠️booleanConfigures the domain so that unsigned basic auth is enabled.
vpc?⚠️IVpcPlace the domain inside this VPC.
vpcSubnets?⚠️SubnetSelection[]The specific vpc subnets the domain will be placed in.
zoneAwareness?⚠️ZoneAwarenessConfigThe cluster zone awareness configuration for the Amazon ES domain.

version⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: ElasticsearchVersion

The Elasticsearch version that your domain will leverage.


accessPolicies?⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: PolicyStatement[] (optional, default: No access policies.)

Domain Access policies.


advancedOptions?⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: { [string]: string } (optional, default: no advanced options are specified)

Additional options to specify for the Amazon ES domain.

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


automatedSnapshotStartHour?⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: number (optional, default: Hourly automated snapshots not used)

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

Only applies for Elasticsearch versions below 5.3.


capacity?⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: CapacityConfig (optional, default: 1 r5.large.elasticsearch data node; no dedicated master nodes.)

The cluster capacity configuration for the Amazon ES domain.


cognitoKibanaAuth?⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: CognitoOptions (optional, default: Cognito not used for authentication to Kibana.)

Configures Amazon ES to use Amazon Cognito authentication for Kibana.


customEndpoint?⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: CustomEndpointOptions (optional, default: no custom domain endpoint will be configured)

To configure a custom domain configure these options.

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


domainName?⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: string (optional, default: A name will be auto-generated.)

Enforces a particular physical domain name.


ebs?⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: EbsOptions (optional, default: 10 GiB General Purpose (SSD) volumes per node.)

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

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?⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: boolean (optional, default: false)

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

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


encryptionAtRest?⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: EncryptionAtRestOptions (optional, default: No encryption at rest)

Encryption at rest options for the cluster.


enforceHttps?⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: boolean (optional, default: false)

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


fineGrainedAccessControl?⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: AdvancedSecurityOptions (optional, default: fine-grained access control is disabled)

Specifies options for fine-grained access control.

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?⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: LoggingOptions (optional, default: No logs are published)

Configuration log publishing configuration options.


nodeToNodeEncryption?⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: boolean (optional, default: Node to node encryption is not enabled.)

Specify true to enable node to node encryption.

Requires Elasticsearch version 6.0 or later.


removalPolicy?⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: RemovalPolicy (optional, default: RemovalPolicy.RETAIN)

Policy to apply when the domain is removed from the stack.


securityGroups?⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: ISecurityGroup[] (optional, default: One new security group is created.)

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

Only used if vpc is specified.

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


tlsSecurityPolicy?⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: TLSSecurityPolicy (optional, default: TLSSecurityPolicy.TLS_1_0)

The minimum TLS version required for traffic to the domain.


useUnsignedBasicAuth?⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: boolean (optional, default: false)

Configures the domain so that unsigned basic auth is enabled.

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.


vpc?⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: IVpc (optional, default: Domain is not placed in a VPC.)

Place the domain inside this VPC.

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


vpcSubnets?⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: SubnetSelection[] (optional, default: All private subnets.)

The specific vpc subnets the domain will be placed in.

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.

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


zoneAwareness?⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: ZoneAwarenessConfig (optional, default: no zone awareness (1 AZ))

The cluster zone awareness configuration for the Amazon ES domain.