DomainProps

All Known Implementing Classes:: DomainProps.Jsii$Proxy

Deprecated.

use opensearchservice module instead

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:47.236Z")
 @Deprecated
public interface DomainProps

(deprecated) Properties for an AWS Elasticsearch Domain.

Example:

 Domain domain = Domain.Builder.create(this, "Domain")
         .version(ElasticsearchVersion.V7_4)
         .ebs(EbsOptions.builder()
                 .volumeSize(100)
                 .volumeType(EbsDeviceVolumeType.GENERAL_PURPOSE_SSD)
                 .build())
         .nodeToNodeEncryption(true)
         .encryptionAtRest(EncryptionAtRestOptions.builder()
                 .enabled(true)
                 .build())
         .build();

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class DomainProps.Builder
Deprecated.

static class DomainProps.Jsii$Proxy
Deprecated.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`DomainProps.Builder` Deprecated.
`static class`	`DomainProps.Jsii$Proxy` Deprecated.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`static DomainProps.Builder`	`builder()` Deprecated.
`default java.util.List<PolicyStatement>`	`getAccessPolicies()` Deprecated. use opensearchservice module instead
`default java.util.Map<java.lang.String,java.lang.String>`	`getAdvancedOptions()` Deprecated. use opensearchservice module instead
`default java.lang.Number`	`getAutomatedSnapshotStartHour()` Deprecated. use opensearchservice module instead
`default CapacityConfig`	`getCapacity()` Deprecated. use opensearchservice module instead
`default CognitoOptions`	`getCognitoKibanaAuth()` Deprecated. use opensearchservice module instead
`default CustomEndpointOptions`	`getCustomEndpoint()` Deprecated. use opensearchservice module instead
`default java.lang.String`	`getDomainName()` Deprecated. use opensearchservice module instead
`default EbsOptions`	`getEbs()` Deprecated. use opensearchservice module instead
`default java.lang.Boolean`	`getEnableVersionUpgrade()` Deprecated. use opensearchservice module instead
`default EncryptionAtRestOptions`	`getEncryptionAtRest()` Deprecated. use opensearchservice module instead
`default java.lang.Boolean`	`getEnforceHttps()` Deprecated. use opensearchservice module instead
`default AdvancedSecurityOptions`	`getFineGrainedAccessControl()` Deprecated. use opensearchservice module instead
`default LoggingOptions`	`getLogging()` Deprecated. use opensearchservice module instead
`default java.lang.Boolean`	`getNodeToNodeEncryption()` Deprecated. use opensearchservice module instead
`default RemovalPolicy`	`getRemovalPolicy()` Deprecated. use opensearchservice module instead
`default java.util.List<ISecurityGroup>`	`getSecurityGroups()` Deprecated. use opensearchservice module instead
`default TLSSecurityPolicy`	`getTlsSecurityPolicy()` Deprecated. use opensearchservice module instead
`default java.lang.Boolean`	`getUseUnsignedBasicAuth()` Deprecated. use opensearchservice module instead
`ElasticsearchVersion`	`getVersion()` Deprecated. use opensearchservice module instead
`default IVpc`	`getVpc()` Deprecated. use opensearchservice module instead
`default java.util.List<SubnetSelection>`	`getVpcSubnets()` Deprecated. use opensearchservice module instead
`default ZoneAwarenessConfig`	`getZoneAwareness()` Deprecated. use opensearchservice module instead

- Method Detail
  - getVersion
```
@Deprecated
ElasticsearchVersion getVersion()
```
    Deprecated. use opensearchservice module instead
    
    (deprecated) The Elasticsearch version that your domain will leverage.
  - getAccessPolicies
```
@Deprecated
default java.util.List<PolicyStatement> getAccessPolicies()
```
    Deprecated. use opensearchservice module instead
    
    (deprecated) Domain Access policies.
    Default: - No access policies.
  - getAdvancedOptions
```
@Deprecated
default java.util.Map<java.lang.String,java.lang.String> getAdvancedOptions()
```
    Deprecated. use opensearchservice module instead
    
    (deprecated) Additional options to specify for the Amazon ES domain.
    Default: - no advanced options are specified
    
    See Also:
    
    https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options
  - getAutomatedSnapshotStartHour
```
@Deprecated
default java.lang.Number getAutomatedSnapshotStartHour()
```
    Deprecated. use opensearchservice module instead
    
    (deprecated) 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.
    Default: - Hourly automated snapshots not used
  - getCapacity
```
@Deprecated
default CapacityConfig getCapacity()
```
    Deprecated. use opensearchservice module instead
    
    (deprecated) The cluster capacity configuration for the Amazon ES domain.
    Default: - 1 r5.large.elasticsearch data node; no dedicated master nodes.
  - getCognitoKibanaAuth
```
@Deprecated
default CognitoOptions getCognitoKibanaAuth()
```
    Deprecated. use opensearchservice module instead
    
    (deprecated) Configures Amazon ES to use Amazon Cognito authentication for Kibana.
    Default: - Cognito not used for authentication to Kibana.
  - getCustomEndpoint
```
@Deprecated
default CustomEndpointOptions getCustomEndpoint()
```
    Deprecated. use opensearchservice module instead
    
    (deprecated) 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
    Default: - no custom domain endpoint will be configured
  - getDomainName
```
@Deprecated
default java.lang.String getDomainName()
```
    Deprecated. use opensearchservice module instead
    
    (deprecated) Enforces a particular physical domain name.
    Default: - A name will be auto-generated.
  - getEbs
```
@Deprecated
default EbsOptions getEbs()
```
    Deprecated. use opensearchservice module instead
    
    (deprecated) 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.
    Default: - 10 GiB General Purpose (SSD) volumes per node.
  - getEnableVersionUpgrade
```
@Deprecated
default java.lang.Boolean getEnableVersionUpgrade()
```
    Deprecated. use opensearchservice module instead
    
    (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.
    Default: - false
    
    See Also:
    
    https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-upgradeelasticsearchdomain
  - getEncryptionAtRest
```
@Deprecated
default EncryptionAtRestOptions getEncryptionAtRest()
```
    Deprecated. use opensearchservice module instead
    
    (deprecated) Encryption at rest options for the cluster.
    Default: - No encryption at rest
  - getEnforceHttps
```
@Deprecated
default java.lang.Boolean getEnforceHttps()
```
    Deprecated. use opensearchservice module instead
    
    (deprecated) True to require that all traffic to the domain arrive over HTTPS.
    Default: - false
  - getFineGrainedAccessControl
```
@Deprecated
default AdvancedSecurityOptions getFineGrainedAccessControl()
```
    Deprecated. use opensearchservice module instead
    
    (deprecated) 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.
    Default: - fine-grained access control is disabled
  - getLogging
```
@Deprecated
default LoggingOptions getLogging()
```
    Deprecated. use opensearchservice module instead
    
    (deprecated) Configuration log publishing configuration options.
    Default: - No logs are published
  - getNodeToNodeEncryption
```
@Deprecated
default java.lang.Boolean getNodeToNodeEncryption()
```
    Deprecated. use opensearchservice module instead
    
    (deprecated) Specify true to enable node to node encryption.
    Requires Elasticsearch version 6.0 or later.
    Default: - Node to node encryption is not enabled.
  - getRemovalPolicy
```
@Deprecated
default RemovalPolicy getRemovalPolicy()
```
    Deprecated. use opensearchservice module instead
    
    (deprecated) Policy to apply when the domain is removed from the stack.
    Default: RemovalPolicy.RETAIN
  - getSecurityGroups
```
@Deprecated
default java.util.List<ISecurityGroup> getSecurityGroups()
```
    Deprecated. use opensearchservice module instead
    
    (deprecated) The list of security groups that are associated with the VPC endpoints for the domain.
    Only used if vpc is specified.
    Default: - One new security group is created.
    
    See Also:
    
    https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html
  - getTlsSecurityPolicy
```
@Deprecated
default TLSSecurityPolicy getTlsSecurityPolicy()
```
    Deprecated. use opensearchservice module instead
    
    (deprecated) The minimum TLS version required for traffic to the domain.
    Default: - TLSSecurityPolicy.TLS_1_0
  - getUseUnsignedBasicAuth
```
@Deprecated
default java.lang.Boolean getUseUnsignedBasicAuth()
```
    Deprecated. use opensearchservice module instead
    
    (deprecated) 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.
    Default: - false
  - getVpc
```
@Deprecated
default IVpc getVpc()
```
    Deprecated. use opensearchservice module instead
    
    (deprecated) Place the domain inside this VPC.
    Default: - Domain is not placed in a VPC.
    
    See Also:
    
    https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html
  - getVpcSubnets
```
@Deprecated
default java.util.List<SubnetSelection> getVpcSubnets()
```
    Deprecated. use opensearchservice module instead
    
    (deprecated) 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.
    Default: - All private subnets.
    
    See Also:
    
    https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html
  - getZoneAwareness
```
@Deprecated
default ZoneAwarenessConfig getZoneAwareness()
```
    Deprecated. use opensearchservice module instead
    
    (deprecated) The cluster zone awareness configuration for the Amazon ES domain.
    Default: - no zone awareness (1 AZ)
  - builder
```
@Deprecated
static DomainProps.Builder builder()
```
    Deprecated.
    
    Returns:
    
    a DomainProps.Builder of DomainProps

Interface DomainProps

Nested Class Summary

Method Summary

Method Detail

getVersion

getAccessPolicies

getAdvancedOptions

getAutomatedSnapshotStartHour

getCapacity

getCognitoKibanaAuth

getCustomEndpoint

getDomainName

getEbs

getEnableVersionUpgrade

getEncryptionAtRest

getEnforceHttps

getFineGrainedAccessControl

getLogging

getNodeToNodeEncryption

getRemovalPolicy

getSecurityGroups

getTlsSecurityPolicy

getUseUnsignedBasicAuth

getVpc

getVpcSubnets

getZoneAwareness

builder