DomainProps Struct
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
accessPoliciesoptionalPolicyStatement[]access_policiesoptionaltyping.List[PolicyStatement]accessPoliciesoptionalList<PolicyStatement>AccessPoliciesoptionalPolicyStatement[]AccessPoliciesoptional*[]PolicyStatementdeprecated#Default: No access policies.
advancedOptionsoptional{ [key: string]: string }advanced_optionsoptionaltyping.Mapping[str, str]advancedOptionsoptionalMap<String, String>AdvancedOptionsoptionalIDictionary<string, string>AdvancedOptionsoptional*map[string]*stringdeprecated#Default: no advanced options are specified
automatedSnapshotStartHouroptionalnumberautomated_snapshot_start_houroptionalint | floatautomatedSnapshotStartHouroptionalNumberAutomatedSnapshotStartHouroptionaldoubleAutomatedSnapshotStartHouroptional*float64deprecated#Default: Hourly automated snapshots not used
Only applies for Elasticsearch versions below 5.3.
capacityoptionalCapacityConfigcapacityoptionalCapacityConfigcapacityoptionalCapacityConfigCapacityoptionalCapacityConfigCapacityoptionalCapacityConfigdeprecated#Default: 1 r5.large.elasticsearch data node; no dedicated master nodes.
cognitoKibanaAuthoptionalCognitoOptionscognito_kibana_authoptionalCognitoOptionscognitoKibanaAuthoptionalCognitoOptionsCognitoKibanaAuthoptionalCognitoOptionsCognitoKibanaAuthoptionalCognitoOptionsdeprecated#Default: Cognito not used for authentication to Kibana.
customEndpointoptionalCustomEndpointOptionscustom_endpointoptionalCustomEndpointOptionscustomEndpointoptionalCustomEndpointOptionsCustomEndpointoptionalCustomEndpointOptionsCustomEndpointoptionalCustomEndpointOptionsdeprecated#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
domainNameoptionalstringdomain_nameoptionalstrdomainNameoptionalStringDomainNameoptionalstringDomainNameoptional*stringdeprecated#Default: A name will be auto-generated.
ebsoptionalEbsOptionsebsoptionalEbsOptionsebsoptionalEbsOptionsEbsoptionalEbsOptionsEbsoptionalEbsOptionsdeprecated#Default: 10 GiB General Purpose (SSD) volumes per node.
notes
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.
enableVersionUpgradeoptionalbooleanenable_version_upgradeoptionalboolenableVersionUpgradeoptionalBooleanEnableVersionUpgradeoptionalboolEnableVersionUpgradeoptional*bool= falsedeprecated#encryptionAtRestoptionalEncryptionAtRestOptionsencryption_at_restoptionalEncryptionAtRestOptionsencryptionAtRestoptionalEncryptionAtRestOptionsEncryptionAtRestoptionalEncryptionAtRestOptionsEncryptionAtRestoptionalEncryptionAtRestOptionsdeprecated#Default: No encryption at rest
enforceHttpsoptionalbooleanenforce_httpsoptionalboolenforceHttpsoptionalBooleanEnforceHttpsoptionalboolEnforceHttpsoptional*bool= falsedeprecated#fineGrainedAccessControloptionalAdvancedSecurityOptionsfine_grained_access_controloptionalAdvancedSecurityOptionsfineGrainedAccessControloptionalAdvancedSecurityOptionsFineGrainedAccessControloptionalAdvancedSecurityOptionsFineGrainedAccessControloptionalAdvancedSecurityOptionsdeprecated#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.
loggingoptionalLoggingOptionsloggingoptionalLoggingOptionsloggingoptionalLoggingOptionsLoggingoptionalLoggingOptionsLoggingoptionalLoggingOptionsdeprecated#Default: No logs are published
nodeToNodeEncryptionoptionalbooleannode_to_node_encryptionoptionalboolnodeToNodeEncryptionoptionalBooleanNodeToNodeEncryptionoptionalboolNodeToNodeEncryptionoptional*booldeprecated#Default: Node to node encryption is not enabled.
Requires Elasticsearch version 6.0 or later.
removalPolicyoptionalRemovalPolicyremoval_policyoptionalRemovalPolicyremovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicy= RemovalPolicy.RETAINdeprecated#securityGroupsoptionalISecurityGroup[]security_groupsoptionaltyping.List[ISecurityGroup]securityGroupsoptionalList<ISecurityGroup>SecurityGroupsoptionalISecurityGroup[]SecurityGroupsoptional*[]ISecurityGroupdeprecated#Default: One new security group is created.
Only used if vpc is specified.
tlsSecurityPolicyoptionalTLSSecurityPolicytls_security_policyoptionalTLSSecurityPolicytlsSecurityPolicyoptionalTLSSecurityPolicyTlsSecurityPolicyoptionalTLSSecurityPolicyTlsSecurityPolicyoptionalTLSSecurityPolicy= TLSSecurityPolicy.TLS_1_0deprecated#useUnsignedBasicAuthoptionalbooleanuse_unsigned_basic_authoptionalbooluseUnsignedBasicAuthoptionalBooleanUseUnsignedBasicAuthoptionalboolUseUnsignedBasicAuthoptional*bool= falsedeprecated#notes
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.
versionElasticsearchVersionversionElasticsearchVersionversionElasticsearchVersionVersionElasticsearchVersionVersionElasticsearchVersionrequireddeprecated#Default: Domain is not placed in a VPC.
vpcSubnetsoptionalSubnetSelection[]vpc_subnetsoptionaltyping.List[SubnetSelection]vpcSubnetsoptionalList<SubnetSelection>VpcSubnetsoptionalSubnetSelection[]VpcSubnetsoptional*[]SubnetSelectiondeprecated#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.
zoneAwarenessoptionalZoneAwarenessConfigzone_awarenessoptionalZoneAwarenessConfigzoneAwarenessoptionalZoneAwarenessConfigZoneAwarenessoptionalZoneAwarenessConfigZoneAwarenessoptionalZoneAwarenessConfigdeprecated#Default: no zone awareness (1 AZ)