Package software.amazon.awscdk.services.opensearchservice

Class DomainProps.Jsii$Proxy

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 Boolean	getColdStorageEnabled()	Whether to enable or disable cold storage on the domain.
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	getEnableAutoSoftwareUpdate()	Specifies whether automatic service software updates are enabled for the 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 IpAddressType	getIpAddressType()	Specify either dual stack or IPv4 as your IP address type.
final LoggingOptions	getLogging()	Configuration log publishing configuration options.
final Boolean	getNodeToNodeEncryption()	Specify true to enable node to node encryption.
final Boolean	getOffPeakWindowEnabled()	Options for enabling a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.
final WindowStartTime	getOffPeakWindowStart()	Start time for the off-peak window, in Coordinated Universal Time (UTC).
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 Boolean	getSuppressLogsResourcePolicy()	Specify whether to create a CloudWatch Logs resource policy or not.
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

getColdStorageEnabled

public final Boolean getColdStorageEnabled()

Description copied from interface: DomainProps

Whether to enable or disable cold storage on the domain.

You must enable UltraWarm storage to enable cold storage.

Default: - undefined

Specified by:

getColdStorageEnabled in interface DomainProps

See Also:

• https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cold-storage.html

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

getEnableAutoSoftwareUpdate

public final Boolean getEnableAutoSoftwareUpdate()

Description copied from interface: DomainProps

Specifies whether automatic service software updates are enabled for the domain.

Default: - false

Specified by:

getEnableAutoSoftwareUpdate in interface DomainProps

See Also:

• https://docs.aws.amazon.com/it_it/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-softwareupdateoptions.html

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

getIpAddressType

public final IpAddressType getIpAddressType()

Description copied from interface: DomainProps

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

Specified by:

getIpAddressType 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

getOffPeakWindowEnabled

public final Boolean getOffPeakWindowEnabled()

Description copied from interface: DomainProps

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.

Specified by:

getOffPeakWindowEnabled in interface DomainProps

See Also:

• https://docs.aws.amazon.com/it_it/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-offpeakwindow.html

getOffPeakWindowStart

public final WindowStartTime getOffPeakWindowStart()

Description copied from interface: DomainProps

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

Specified by:

getOffPeakWindowStart 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

getSuppressLogsResourcePolicy

public final Boolean getSuppressLogsResourcePolicy()

Description copied from interface: DomainProps

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

Specified by:

getSuppressLogsResourcePolicy in interface DomainProps

See Also:

• https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createdomain-configure-slow-logs.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_2

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