Package software.amazon.awscdk.services.opensearchservice

Interface DomainProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
DomainProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-10-25T14:21:18.885Z") @Stability(Stable) public interface DomainProps extends software.amazon.jsii.JsiiSerializable
Properties for an Amazon OpenSearch Service domain.

Example: 

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

  • Method Details

    • getVersion

      @Stability(Stable) @NotNull EngineVersion getVersion()
      The Elasticsearch/OpenSearch version that your domain will leverage.

    • getAccessPolicies

      @Stability(Stable) @Nullable default List<PolicyStatement> getAccessPolicies()
      Domain access policies.

      Default: - No access policies.

    • getAdvancedOptions

      @Stability(Stable) @Nullable default Map<String,String> getAdvancedOptions()
      Additional options to specify for the Amazon OpenSearch Service domain.

      Default: - no advanced options are specified

      See Also:

    • getAutomatedSnapshotStartHour

      @Stability(Stable) @Nullable default Number getAutomatedSnapshotStartHour()
      The hour in UTC during which the service takes an automated daily snapshot of the indices in the Amazon OpenSearch Service domain.

      Only applies for Elasticsearch versions below 5.3.

      Default: - Hourly automated snapshots not used

    • getCapacity

      @Stability(Stable) @Nullable default CapacityConfig getCapacity()
      The cluster capacity configuration for the Amazon OpenSearch Service domain.

      Default: - 1 r5.large.search data node; no dedicated master nodes.

    • getCognitoDashboardsAuth

      @Stability(Stable) @Nullable default CognitoOptions getCognitoDashboardsAuth()
      Configures Amazon OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.

      Default: - Cognito not used for authentication to OpenSearch Dashboards.

    • getColdStorageEnabled

      @Stability(Stable) @Nullable default Boolean getColdStorageEnabled()
      Whether to enable or disable cold storage on the domain.

      You must enable UltraWarm storage to enable cold storage.

      Default: - undefined

      See Also:

    • getCustomEndpoint

      @Stability(Stable) @Nullable default CustomEndpointOptions getCustomEndpoint()
      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

      @Stability(Stable) @Nullable default String getDomainName()
      Enforces a particular physical domain name.

      Default: - A name will be auto-generated.

    • getEbs

      @Stability(Stable) @Nullable default EbsOptions getEbs()
      The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the Amazon OpenSearch Service domain.

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

    • getEnableAutoSoftwareUpdate

      @Stability(Stable) @Nullable default Boolean getEnableAutoSoftwareUpdate()
      Specifies whether automatic service software updates are enabled for the domain.

      Default: - false

      See Also:

    • getEnableVersionUpgrade

      @Stability(Stable) @Nullable default Boolean getEnableVersionUpgrade()
      To upgrade an Amazon OpenSearch Service domain to a new version, rather than replacing the entire domain resource, use the EnableVersionUpgrade update policy.

      Default: - false

      See Also:

    • getEncryptionAtRest

      @Stability(Stable) @Nullable default EncryptionAtRestOptions getEncryptionAtRest()
      Encryption at rest options for the cluster.

      Default: - No encryption at rest

    • getEnforceHttps

      @Stability(Stable) @Nullable default Boolean getEnforceHttps()
      True to require that all traffic to the domain arrive over HTTPS.

      Default: - false

    • getFineGrainedAccessControl

      @Stability(Stable) @Nullable default AdvancedSecurityOptions getFineGrainedAccessControl()
      Specifies options for fine-grained access control.

      Requires Elasticsearch version 6.7 or later or OpenSearch version 1.0 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

    • getIpAddressType

      @Stability(Stable) @Nullable default IpAddressType getIpAddressType()
      Specify either dual stack or IPv4 as your IP address type.

      Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option.

      If you set your IP address type to dual stack, you can't change your address type later.

      Default: - IpAddressType.IPV4

    • getLogging

      @Stability(Stable) @Nullable default LoggingOptions getLogging()
      Configuration log publishing configuration options.

      Default: - No logs are published

    • getNodeToNodeEncryption

      @Stability(Stable) @Nullable default Boolean getNodeToNodeEncryption()
      Specify true to enable node to node encryption.

      Requires Elasticsearch version 6.0 or later or OpenSearch version 1.0 or later.

      Default: - Node to node encryption is not enabled.

    • getOffPeakWindowEnabled

      @Stability(Stable) @Nullable default Boolean getOffPeakWindowEnabled()
      Options for enabling a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.

      Off-peak windows were introduced on February 16, 2023. All domains created before this date have the off-peak window disabled by default. You must manually enable and configure the off-peak window for these domains. All domains created after this date will have the off-peak window enabled by default. You can't disable the off-peak window for a domain after it's enabled.

      Default: - Disabled for domains created before February 16, 2023. Enabled for domains created after. Enabled if `offPeakWindowStart` is set.

      See Also:

    • getOffPeakWindowStart

      @Stability(Stable) @Nullable default WindowStartTime getOffPeakWindowStart()
      Start time for the off-peak window, in Coordinated Universal Time (UTC).

      The window length will always be 10 hours, so you can't specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M.

      Default: - 10:00 P.M. local time

    • getRemovalPolicy

      @Stability(Stable) @Nullable default RemovalPolicy getRemovalPolicy()
      Policy to apply when the domain is removed from the stack.

      Default: RemovalPolicy.RETAIN

    • getSecurityGroups

      @Stability(Stable) @Nullable default List<ISecurityGroup> getSecurityGroups()
      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:

    • getSuppressLogsResourcePolicy

      @Stability(Stable) @Nullable default Boolean getSuppressLogsResourcePolicy()
      Specify whether to create a CloudWatch Logs resource policy or not.

      When logging is enabled for the domain, a CloudWatch Logs resource policy is created by default. However, CloudWatch Logs supports only 10 resource policies per region. If you enable logging for several domains, it may hit the quota and cause an error. By setting this property to true, creating a resource policy is suppressed, allowing you to avoid this problem.

      If you set this option to true, you must create a resource policy before deployment.

      Default: - false

      See Also:

    • getTlsSecurityPolicy

      @Stability(Stable) @Nullable default TLSSecurityPolicy getTlsSecurityPolicy()
      The minimum TLS version required for traffic to the domain.

      Default: - TLSSecurityPolicy.TLS_1_0

    • getUseUnsignedBasicAuth

      @Stability(Stable) @Nullable default Boolean getUseUnsignedBasicAuth()
      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

      @Stability(Stable) @Nullable default IVpc getVpc()
      Place the domain inside this VPC.

      Default: - Domain is not placed in a VPC.

      See Also:

    • getVpcSubnets

      @Stability(Stable) @Nullable default List<SubnetSelection> getVpcSubnets()
      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:

    • getZoneAwareness

      @Stability(Stable) @Nullable default ZoneAwarenessConfig getZoneAwareness()
      The cluster zone awareness configuration for the Amazon OpenSearch Service domain.

      Default: - no zone awareness (1 AZ)

    • builder

      @Stability(Stable) static DomainProps.Builder builder()
      Returns:
      a DomainProps.Builder of DomainProps