Interface IDomainProps
(deprecated) Properties for an AWS Elasticsearch Domain.
Namespace: Amazon.CDK.AWS.Elasticsearch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IDomainPropsSyntax (vb)
Public Interface IDomainPropsRemarks
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
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. |
Properties
AccessPolicies
(deprecated) Domain Access policies.
virtual PolicyStatement[] AccessPolicies { get; }Property Value
Remarks
Default: - No access policies.
Stability: Deprecated
AdvancedOptions
(deprecated) Additional options to specify for the Amazon ES domain.
virtual IDictionary<string, string> AdvancedOptions { get; }Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
Default: - no advanced options are specified
Stability: Deprecated
AutomatedSnapshotStartHour
(deprecated) The hour in UTC during which the service takes an automated daily snapshot of the indices in the Amazon ES domain.
virtual Nullable<double> AutomatedSnapshotStartHour { get; }Property Value
System.Nullable<System.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.
virtual ICapacityConfig Capacity { get; }Property Value
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.
virtual ICognitoOptions CognitoKibanaAuth { get; }Property Value
Remarks
Default: - Cognito not used for authentication to Kibana.
Stability: Deprecated
CustomEndpoint
(deprecated) To configure a custom domain configure these options.
virtual ICustomEndpointOptions CustomEndpoint { get; }Property Value
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.
virtual string DomainName { get; }Property Value
System.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.
virtual IEbsOptions Ebs { get; }Property Value
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.
virtual Nullable<bool> EnableVersionUpgrade { get; }Property Value
System.Nullable<System.Boolean>
Remarks
Default: - false
Stability: Deprecated
EncryptionAtRest
(deprecated) Encryption at rest options for the cluster.
virtual IEncryptionAtRestOptions EncryptionAtRest { get; }Property Value
Remarks
Default: - No encryption at rest
Stability: Deprecated
EnforceHttps
(deprecated) True to require that all traffic to the domain arrive over HTTPS.
virtual Nullable<bool> EnforceHttps { get; }Property Value
System.Nullable<System.Boolean>
Remarks
Default: - false
Stability: Deprecated
FineGrainedAccessControl
(deprecated) Specifies options for fine-grained access control.
virtual IAdvancedSecurityOptions FineGrainedAccessControl { get; }Property Value
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.
virtual ILoggingOptions Logging { get; }Property Value
Remarks
Default: - No logs are published
Stability: Deprecated
NodeToNodeEncryption
(deprecated) Specify true to enable node to node encryption.
virtual Nullable<bool> NodeToNodeEncryption { get; }Property Value
System.Nullable<System.Boolean>
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.
virtual Nullable<RemovalPolicy> RemovalPolicy { get; }Property Value
System.Nullable<RemovalPolicy>
Remarks
Default: RemovalPolicy.RETAIN
Stability: Deprecated
SecurityGroups
(deprecated) The list of security groups that are associated with the VPC endpoints for the domain.
virtual ISecurityGroup[] SecurityGroups { get; }Property Value
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.
virtual Nullable<TLSSecurityPolicy> TlsSecurityPolicy { get; }Property Value
System.Nullable<TLSSecurityPolicy>
Remarks
Default: - TLSSecurityPolicy.TLS_1_0
Stability: Deprecated
UseUnsignedBasicAuth
(deprecated) Configures the domain so that unsigned basic auth is enabled.
virtual Nullable<bool> UseUnsignedBasicAuth { get; }Property Value
System.Nullable<System.Boolean>
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.
ElasticsearchVersion Version { get; }Property Value
Remarks
Stability: Deprecated
Vpc
(deprecated) Place the domain inside this VPC.
virtual IVpc Vpc { get; }Property Value
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.
virtual ISubnetSelection[] VpcSubnets { get; }Property Value
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.
virtual IZoneAwarenessConfig ZoneAwareness { get; }Property Value
Remarks
Default: - no zone awareness (1 AZ)
Stability: Deprecated