java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.opensearchservice.DomainProps.Jsii$Proxy

All Implemented Interfaces:: DomainProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:: DomainProps

@Stability(Stable) @Internal public static final class DomainProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements DomainProps

An implementation for DomainProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.opensearchservice.DomainProps
DomainProps.Builder, DomainProps.Jsii$Proxy
Constructor Summary

Constructors

Modifier

Constructor

Description

protected

Jsii$Proxy(DomainProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the DomainProps.Builder.

protected

Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.
Method Summary

Modifier and Type

Method

Description

com.fasterxml.jackson.databind.JsonNode

$jsii$toJson()

final boolean

equals(Object o)

final List<PolicyStatement>

getAccessPolicies()

Domain access policies.

final Map<String,String>

getAdvancedOptions()

Additional options to specify for the Amazon OpenSearch Service domain.

final Number

getAutomatedSnapshotStartHour()

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

final CapacityConfig

getCapacity()

The cluster capacity configuration for the Amazon OpenSearch Service domain.

final CognitoOptions

getCognitoDashboardsAuth()

Configures Amazon OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.

final CustomEndpointOptions

getCustomEndpoint()

To configure a custom domain configure these options.

final String

getDomainName()

Enforces a particular physical domain name.

final EbsOptions

getEbs()

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

final 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.

final EncryptionAtRestOptions

getEncryptionAtRest()

Encryption at rest options for the cluster.

final Boolean

getEnforceHttps()

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

final AdvancedSecurityOptions

getFineGrainedAccessControl()

Specifies options for fine-grained access control.

final LoggingOptions

getLogging()

Configuration log publishing configuration options.

final Boolean

getNodeToNodeEncryption()

Specify true to enable node to node encryption.

final RemovalPolicy

getRemovalPolicy()

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

final List<ISecurityGroup>

getSecurityGroups()

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

final TLSSecurityPolicy

getTlsSecurityPolicy()

The minimum TLS version required for traffic to the domain.

final Boolean

getUseUnsignedBasicAuth()

Configures the domain so that unsigned basic auth is enabled.

final EngineVersion

getVersion()

The Elasticsearch/OpenSearch version that your domain will leverage.

final IVpc

getVpc()

Place the domain inside this VPC.

final List<SubnetSelection>

getVpcSubnets()

The specific vpc subnets the domain will be placed in.

final ZoneAwarenessConfig

getZoneAwareness()

The cluster zone awareness configuration for the Amazon OpenSearch Service domain.

final int

hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- Jsii$Proxy
  
  protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
  
  Constructor that initializes the object based on values retrieved from the JsiiObject.
  
  Parameters:
  
  objRef - Reference to the JSII managed object.
- Jsii$Proxy
  
  protected Jsii$Proxy(DomainProps.Builder builder)
  
  Constructor that initializes the object based on literal property values passed by the DomainProps.Builder.
Method Details
- getVersion
  
  public final EngineVersion getVersion()
  
  Description copied from interface: DomainProps
  
  The Elasticsearch/OpenSearch version that your domain will leverage.
  
  Specified by:
  
  getVersion in interface DomainProps
- getAccessPolicies
  
  public final List<PolicyStatement> getAccessPolicies()
  
  Description copied from interface: DomainProps
  
  Domain access policies.
  Default: - No access policies.
  
  Specified by:
  
  getAccessPolicies in interface DomainProps
- getAdvancedOptions
  
  public final Map<String,String> getAdvancedOptions()
  
  Description copied from interface: DomainProps
  
  Additional options to specify for the Amazon OpenSearch Service domain.
  Default: - no advanced options are specified
  Specified by:
  
  getAdvancedOptions in interface DomainProps
  
  See Also:
  
  https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options
- getAutomatedSnapshotStartHour
  
  public final Number getAutomatedSnapshotStartHour()
  
  Description copied from interface: DomainProps
  
  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
  
  Specified by:
  
  getAutomatedSnapshotStartHour in interface DomainProps
- getCapacity
  
  public final CapacityConfig getCapacity()
  
  Description copied from interface: DomainProps
  
  The cluster capacity configuration for the Amazon OpenSearch Service domain.
  Default: - 1 r5.large.search data node; no dedicated master nodes.
  
  Specified by:
  
  getCapacity in interface DomainProps
- getCognitoDashboardsAuth
  
  public final CognitoOptions getCognitoDashboardsAuth()
  
  Description copied from interface: DomainProps
  
  Configures Amazon OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.
  Default: - Cognito not used for authentication to OpenSearch Dashboards.
  
  Specified by:
  
  getCognitoDashboardsAuth in interface DomainProps
- getCustomEndpoint
  
  public final CustomEndpointOptions getCustomEndpoint()
  
  Description copied from interface: DomainProps
  
  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
  
  Specified by:
  
  getCustomEndpoint in interface DomainProps
- getDomainName
  
  public final String getDomainName()
  
  Description copied from interface: DomainProps
  
  Enforces a particular physical domain name.
  Default: - A name will be auto-generated.
  
  Specified by:
  
  getDomainName in interface DomainProps
- getEbs
  
  public final EbsOptions getEbs()
  
  Description copied from interface: DomainProps
  
  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.
  
  Specified by:
  
  getEbs in interface DomainProps
- getEnableVersionUpgrade
  
  public final Boolean getEnableVersionUpgrade()
  
  Description copied from interface: DomainProps
  
  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
  Specified by:
  
  getEnableVersionUpgrade in interface DomainProps
  
  See Also:
  
  https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-upgradeopensearchdomain
- getEncryptionAtRest
  
  public final EncryptionAtRestOptions getEncryptionAtRest()
  
  Description copied from interface: DomainProps
  
  Encryption at rest options for the cluster.
  Default: - No encryption at rest
  
  Specified by:
  
  getEncryptionAtRest in interface DomainProps
- getEnforceHttps
  
  public final Boolean getEnforceHttps()
  
  Description copied from interface: DomainProps
  
  True to require that all traffic to the domain arrive over HTTPS.
  Default: - false
  
  Specified by:
  
  getEnforceHttps in interface DomainProps
- getFineGrainedAccessControl
  
  public final AdvancedSecurityOptions getFineGrainedAccessControl()
  
  Description copied from interface: DomainProps
  
  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
  
  Specified by:
  
  getFineGrainedAccessControl in interface DomainProps
- getLogging
  
  public final LoggingOptions getLogging()
  
  Description copied from interface: DomainProps
  
  Configuration log publishing configuration options.
  Default: - No logs are published
  
  Specified by:
  
  getLogging in interface DomainProps
- getNodeToNodeEncryption
  
  public final Boolean getNodeToNodeEncryption()
  
  Description copied from interface: DomainProps
  
  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.
  
  Specified by:
  
  getNodeToNodeEncryption in interface DomainProps
- getRemovalPolicy
  
  public final RemovalPolicy getRemovalPolicy()
  
  Description copied from interface: DomainProps
  
  Policy to apply when the domain is removed from the stack.
  Default: RemovalPolicy.RETAIN
  
  Specified by:
  
  getRemovalPolicy in interface DomainProps
- getSecurityGroups
  
  public final List<ISecurityGroup> getSecurityGroups()
  
  Description copied from interface: DomainProps
  
  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.
  Specified by:
  
  getSecurityGroups in interface DomainProps
  
  See Also:
  
  https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html
- getTlsSecurityPolicy
  
  public final TLSSecurityPolicy getTlsSecurityPolicy()
  
  Description copied from interface: DomainProps
  
  The minimum TLS version required for traffic to the domain.
  Default: - TLSSecurityPolicy.TLS_1_0
  
  Specified by:
  
  getTlsSecurityPolicy in interface DomainProps
- getUseUnsignedBasicAuth
  
  public final Boolean getUseUnsignedBasicAuth()
  
  Description copied from interface: DomainProps
  
  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
  
  Specified by:
  
  getUseUnsignedBasicAuth in interface DomainProps
- getVpc
  
  public final IVpc getVpc()
  
  Description copied from interface: DomainProps
  
  Place the domain inside this VPC.
  Default: - Domain is not placed in a VPC.
  Specified by:
  
  getVpc in interface DomainProps
  
  See Also:
  
  https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html
- getVpcSubnets
  
  public final List<SubnetSelection> getVpcSubnets()
  
  Description copied from interface: DomainProps
  
  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.
  Specified by:
  
  getVpcSubnets in interface DomainProps
  
  See Also:
  
  https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html
- getZoneAwareness
  
  public final ZoneAwarenessConfig getZoneAwareness()
  
  Description copied from interface: DomainProps
  
  The cluster zone awareness configuration for the Amazon OpenSearch Service domain.
  Default: - no zone awareness (1 AZ)
  
  Specified by:
  
  getZoneAwareness in interface DomainProps
- $jsii$toJson
  
  @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
  
  Specified by:
  
  $jsii$toJson in interface software.amazon.jsii.JsiiSerializable
- equals
  
  public final boolean equals(Object o)
  
  Overrides:
  
  equals in class Object
- hashCode
  
  public final int hashCode()
  
  Overrides:
  
  hashCode in class Object

Class DomainProps.Jsii$Proxy

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.opensearchservice.DomainProps

Constructor Summary

Method Summary

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Constructor Details

Jsii$Proxy

Jsii$Proxy

Method Details

getVersion

getAccessPolicies

getAdvancedOptions

getAutomatedSnapshotStartHour

getCapacity

getCognitoDashboardsAuth

getCustomEndpoint

getDomainName

getEbs

getEnableVersionUpgrade

getEncryptionAtRest

getEnforceHttps

getFineGrainedAccessControl

getLogging

getNodeToNodeEncryption

getRemovalPolicy

getSecurityGroups

getTlsSecurityPolicy

getUseUnsignedBasicAuth

getVpc

getVpcSubnets

getZoneAwareness

$jsii$toJson

equals

hashCode