CfnDomain

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.elasticsearch.CfnDomain

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-09T19:16:41.652Z")
public class CfnDomain
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Elasticsearch::Domain`.

The AWS::Elasticsearch::Domain resource creates an Amazon OpenSearch Service domain.

The AWS::Elasticsearch::Domain resource is being replaced by the AWS::OpenSearchService::Domain resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and legacy Elasticsearch. For instructions to upgrade domains defined within CloudFormation from Elasticsearch to OpenSearch, see Remarks .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.elasticsearch.*;
 Object accessPolicies;
 CfnDomain cfnDomain = CfnDomain.Builder.create(this, "MyCfnDomain")
         .accessPolicies(accessPolicies)
         .advancedOptions(Map.of(
                 "advancedOptionsKey", "advancedOptions"))
         .advancedSecurityOptions(AdvancedSecurityOptionsInputProperty.builder()
                 .anonymousAuthEnabled(false)
                 .enabled(false)
                 .internalUserDatabaseEnabled(false)
                 .masterUserOptions(MasterUserOptionsProperty.builder()
                         .masterUserArn("masterUserArn")
                         .masterUserName("masterUserName")
                         .masterUserPassword("masterUserPassword")
                         .build())
                 .build())
         .cognitoOptions(CognitoOptionsProperty.builder()
                 .enabled(false)
                 .identityPoolId("identityPoolId")
                 .roleArn("roleArn")
                 .userPoolId("userPoolId")
                 .build())
         .domainEndpointOptions(DomainEndpointOptionsProperty.builder()
                 .customEndpoint("customEndpoint")
                 .customEndpointCertificateArn("customEndpointCertificateArn")
                 .customEndpointEnabled(false)
                 .enforceHttps(false)
                 .tlsSecurityPolicy("tlsSecurityPolicy")
                 .build())
         .domainName("domainName")
         .ebsOptions(EBSOptionsProperty.builder()
                 .ebsEnabled(false)
                 .iops(123)
                 .volumeSize(123)
                 .volumeType("volumeType")
                 .build())
         .elasticsearchClusterConfig(ElasticsearchClusterConfigProperty.builder()
                 .coldStorageOptions(ColdStorageOptionsProperty.builder()
                         .enabled(false)
                         .build())
                 .dedicatedMasterCount(123)
                 .dedicatedMasterEnabled(false)
                 .dedicatedMasterType("dedicatedMasterType")
                 .instanceCount(123)
                 .instanceType("instanceType")
                 .warmCount(123)
                 .warmEnabled(false)
                 .warmType("warmType")
                 .zoneAwarenessConfig(ZoneAwarenessConfigProperty.builder()
                         .availabilityZoneCount(123)
                         .build())
                 .zoneAwarenessEnabled(false)
                 .build())
         .elasticsearchVersion("elasticsearchVersion")
         .encryptionAtRestOptions(EncryptionAtRestOptionsProperty.builder()
                 .enabled(false)
                 .kmsKeyId("kmsKeyId")
                 .build())
         .logPublishingOptions(Map.of(
                 "logPublishingOptionsKey", LogPublishingOptionProperty.builder()
                         .cloudWatchLogsLogGroupArn("cloudWatchLogsLogGroupArn")
                         .enabled(false)
                         .build()))
         .nodeToNodeEncryptionOptions(NodeToNodeEncryptionOptionsProperty.builder()
                 .enabled(false)
                 .build())
         .snapshotOptions(SnapshotOptionsProperty.builder()
                 .automatedSnapshotStartHour(123)
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vpcOptions(VPCOptionsProperty.builder()
                 .securityGroupIds(List.of("securityGroupIds"))
                 .subnetIds(List.of("subnetIds"))
                 .build())
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CfnDomain.AdvancedSecurityOptionsInputProperty` Specifies options for fine-grained access control.
`static class`	`CfnDomain.Builder` A fluent builder for `CfnDomain`.
`static interface`	`CfnDomain.CognitoOptionsProperty` Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.
`static interface`	`CfnDomain.ColdStorageOptionsProperty` Specifies options for cold storage.
`static interface`	`CfnDomain.DomainEndpointOptionsProperty` Specifies additional options for the domain endpoint, such as whether to require HTTPS for all traffic or whether to use a custom endpoint rather than the default endpoint.
`static interface`	`CfnDomain.EBSOptionsProperty` The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain.
`static interface`	`CfnDomain.ElasticsearchClusterConfigProperty` The cluster configuration for the OpenSearch Service domain.
`static interface`	`CfnDomain.EncryptionAtRestOptionsProperty` Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use.
`static interface`	`CfnDomain.LogPublishingOptionProperty` > The `AWS::Elasticsearch::Domain` resource is being replaced by the [AWS::OpenSearchService::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html) resource.
`static interface`	`CfnDomain.MasterUserOptionsProperty` Specifies information about the master user.
`static interface`	`CfnDomain.NodeToNodeEncryptionOptionsProperty` Specifies whether node-to-node encryption is enabled.
`static interface`	`CfnDomain.SnapshotOptionsProperty` > The `AWS::Elasticsearch::Domain` resource is being replaced by the [AWS::OpenSearchService::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html) resource.
`static interface`	`CfnDomain.VPCOptionsProperty` The virtual private cloud (VPC) configuration for the OpenSearch Service domain.
`static interface`	`CfnDomain.ZoneAwarenessConfigProperty` Specifies zone awareness configuration options.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnDomain(Construct scope, java.lang.String id)` Create a new `AWS::Elasticsearch::Domain`.
	`CfnDomain(Construct scope, java.lang.String id, CfnDomainProps props)` Create a new `AWS::Elasticsearch::Domain`.
`protected`	`CfnDomain(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnDomain(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`getAccessPolicies()` An AWS Identity and Access Management ( IAM ) policy document that specifies who can access the OpenSearch Service domain and their permissions.
`java.lang.Object`	`getAdvancedOptions()` Additional options to specify for the OpenSearch Service domain.
`java.lang.Object`	`getAdvancedSecurityOptions()` Specifies options for fine-grained access control.
`java.lang.String`	`getAttrArn()` The Amazon Resource Name (ARN) of the domain, such as `arn:aws:es:us-west-2:123456789012:domain/mystack-elasti-1ab2cdefghij` .
`java.lang.String`	`getAttrDomainEndpoint()` The domain-specific endpoint that's used for requests to the OpenSearch APIs, such as `search-mystack-elasti-1ab2cdefghij-ab1c2deckoyb3hofw7wpqa3cm.us-west-1.es.amazonaws.com` .
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.Object`	`getCognitoOptions()` Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.
`java.lang.Object`	`getDomainEndpointOptions()` Specifies additional options for the domain endpoint, such as whether to require HTTPS for all traffic or whether to use a custom endpoint rather than the default endpoint.
`java.lang.String`	`getDomainName()` A name for the OpenSearch Service domain.
`java.lang.Object`	`getEbsOptions()` The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain.
`java.lang.Object`	`getElasticsearchClusterConfig()` ElasticsearchClusterConfig is a property of the AWS::Elasticsearch::Domain resource that configures the cluster of an Amazon OpenSearch Service domain.
`java.lang.String`	`getElasticsearchVersion()` The version of Elasticsearch to use, such as 2.3.
`java.lang.Object`	`getEncryptionAtRestOptions()` Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use.
`java.lang.Object`	`getLogPublishingOptions()` An object with one or more of the following keys: `SEARCH_SLOW_LOGS` , `ES_APPLICATION_LOGS` , `INDEX_SLOW_LOGS` , `AUDIT_LOGS` , depending on the types of logs you want to publish.
`java.lang.Object`	`getNodeToNodeEncryptionOptions()` Specifies whether node-to-node encryption is enabled.
`java.lang.Object`	`getSnapshotOptions()` DEPRECATED .
`TagManager`	`getTags()` An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain.
`java.lang.Object`	`getVpcOptions()` The virtual private cloud (VPC) configuration for the OpenSearch Service domain.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setAccessPolicies(java.lang.Object value)` An AWS Identity and Access Management ( IAM ) policy document that specifies who can access the OpenSearch Service domain and their permissions.
`void`	`setAdvancedOptions(IResolvable value)` Additional options to specify for the OpenSearch Service domain.
`void`	`setAdvancedOptions(java.util.Map<java.lang.String,java.lang.String> value)` Additional options to specify for the OpenSearch Service domain.
`void`	`setAdvancedSecurityOptions(CfnDomain.AdvancedSecurityOptionsInputProperty value)` Specifies options for fine-grained access control.
`void`	`setAdvancedSecurityOptions(IResolvable value)` Specifies options for fine-grained access control.
`void`	`setCognitoOptions(CfnDomain.CognitoOptionsProperty value)` Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.
`void`	`setCognitoOptions(IResolvable value)` Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.
`void`	`setDomainEndpointOptions(CfnDomain.DomainEndpointOptionsProperty value)` Specifies additional options for the domain endpoint, such as whether to require HTTPS for all traffic or whether to use a custom endpoint rather than the default endpoint.
`void`	`setDomainEndpointOptions(IResolvable value)` Specifies additional options for the domain endpoint, such as whether to require HTTPS for all traffic or whether to use a custom endpoint rather than the default endpoint.
`void`	`setDomainName(java.lang.String value)` A name for the OpenSearch Service domain.
`void`	`setEbsOptions(CfnDomain.EBSOptionsProperty value)` The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain.
`void`	`setEbsOptions(IResolvable value)` The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain.
`void`	`setElasticsearchClusterConfig(CfnDomain.ElasticsearchClusterConfigProperty value)` ElasticsearchClusterConfig is a property of the AWS::Elasticsearch::Domain resource that configures the cluster of an Amazon OpenSearch Service domain.
`void`	`setElasticsearchClusterConfig(IResolvable value)` ElasticsearchClusterConfig is a property of the AWS::Elasticsearch::Domain resource that configures the cluster of an Amazon OpenSearch Service domain.
`void`	`setElasticsearchVersion(java.lang.String value)` The version of Elasticsearch to use, such as 2.3.
`void`	`setEncryptionAtRestOptions(CfnDomain.EncryptionAtRestOptionsProperty value)` Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use.
`void`	`setEncryptionAtRestOptions(IResolvable value)` Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use.
`void`	`setLogPublishingOptions(IResolvable value)` An object with one or more of the following keys: `SEARCH_SLOW_LOGS` , `ES_APPLICATION_LOGS` , `INDEX_SLOW_LOGS` , `AUDIT_LOGS` , depending on the types of logs you want to publish.
`void`	`setLogPublishingOptions(java.util.Map<java.lang.String,java.lang.Object> value)` An object with one or more of the following keys: `SEARCH_SLOW_LOGS` , `ES_APPLICATION_LOGS` , `INDEX_SLOW_LOGS` , `AUDIT_LOGS` , depending on the types of logs you want to publish.
`void`	`setNodeToNodeEncryptionOptions(CfnDomain.NodeToNodeEncryptionOptionsProperty value)` Specifies whether node-to-node encryption is enabled.
`void`	`setNodeToNodeEncryptionOptions(IResolvable value)` Specifies whether node-to-node encryption is enabled.
`void`	`setSnapshotOptions(CfnDomain.SnapshotOptionsProperty value)` DEPRECATED .
`void`	`setSnapshotOptions(IResolvable value)` DEPRECATED .
`void`	`setVpcOptions(CfnDomain.VPCOptionsProperty value)` The virtual private cloud (VPC) configuration for the OpenSearch Service domain.
`void`	`setVpcOptions(IResolvable value)` The virtual private cloud (VPC) configuration for the OpenSearch Service domain.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

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

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnDomain
```
protected CfnDomain(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnDomain
```
protected CfnDomain(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnDomain
```
public CfnDomain(Construct scope,
                 java.lang.String id,
                 CfnDomainProps props)
```
    Create a new `AWS::Elasticsearch::Domain`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    props - - resource properties.
  - CfnDomain
```
public CfnDomain(Construct scope,
                 java.lang.String id)
```
    Create a new `AWS::Elasticsearch::Domain`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
- Method Detail
  - inspect
```
public void inspect(TreeInspector inspector)
```
    Examines the CloudFormation resource and discloses attributes.
    
    Specified by:
    
    inspect in interface IInspectable
    
    Parameters:
    
    inspector - - tree inspector to collect and process attributes. This parameter is required.
  - renderProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrArn
```
public java.lang.String getAttrArn()
```
    The Amazon Resource Name (ARN) of the domain, such as `arn:aws:es:us-west-2:123456789012:domain/mystack-elasti-1ab2cdefghij` .
    This returned value is the same as the one returned by AWS::Elasticsearch::Domain.DomainArn .
  - getAttrDomainEndpoint
```
public java.lang.String getAttrDomainEndpoint()
```
    The domain-specific endpoint that's used for requests to the OpenSearch APIs, such as `search-mystack-elasti-1ab2cdefghij-ab1c2deckoyb3hofw7wpqa3cm.us-west-1.es.amazonaws.com` .
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain.
  - getAccessPolicies
```
public java.lang.Object getAccessPolicies()
```
    An AWS Identity and Access Management ( IAM ) policy document that specifies who can access the OpenSearch Service domain and their permissions.
    For more information, see Configuring access policies in the Amazon OpenSearch Service Developer Guid e.
  - setAccessPolicies
```
public void setAccessPolicies(java.lang.Object value)
```
    An AWS Identity and Access Management ( IAM ) policy document that specifies who can access the OpenSearch Service domain and their permissions.
    For more information, see Configuring access policies in the Amazon OpenSearch Service Developer Guid e.
  - getAdvancedOptions
```
public java.lang.Object getAdvancedOptions()
```
    Additional options to specify for the OpenSearch Service domain.
    For more information, see Advanced cluster parameters in the Amazon OpenSearch Service Developer Guide .
  - setAdvancedOptions
```
public void setAdvancedOptions(IResolvable value)
```
    Additional options to specify for the OpenSearch Service domain.
    For more information, see Advanced cluster parameters in the Amazon OpenSearch Service Developer Guide .
  - setAdvancedOptions
```
public void setAdvancedOptions(java.util.Map<java.lang.String,java.lang.String> value)
```
    Additional options to specify for the OpenSearch Service domain.
    For more information, see Advanced cluster parameters in the Amazon OpenSearch Service Developer Guide .
  - getAdvancedSecurityOptions
```
public java.lang.Object getAdvancedSecurityOptions()
```
    Specifies options for fine-grained access control.
  - setAdvancedSecurityOptions
```
public void setAdvancedSecurityOptions(IResolvable value)
```
    Specifies options for fine-grained access control.
  - setAdvancedSecurityOptions
```
public void setAdvancedSecurityOptions(CfnDomain.AdvancedSecurityOptionsInputProperty value)
```
    Specifies options for fine-grained access control.
  - getCognitoOptions
```
public java.lang.Object getCognitoOptions()
```
    Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.
  - setCognitoOptions
```
public void setCognitoOptions(IResolvable value)
```
    Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.
  - setCognitoOptions
```
public void setCognitoOptions(CfnDomain.CognitoOptionsProperty value)
```
    Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.
  - getDomainEndpointOptions
```
public java.lang.Object getDomainEndpointOptions()
```
    Specifies additional options for the domain endpoint, such as whether to require HTTPS for all traffic or whether to use a custom endpoint rather than the default endpoint.
  - setDomainEndpointOptions
```
public void setDomainEndpointOptions(IResolvable value)
```
    Specifies additional options for the domain endpoint, such as whether to require HTTPS for all traffic or whether to use a custom endpoint rather than the default endpoint.
  - setDomainEndpointOptions
```
public void setDomainEndpointOptions(CfnDomain.DomainEndpointOptionsProperty value)
```
    Specifies additional options for the domain endpoint, such as whether to require HTTPS for all traffic or whether to use a custom endpoint rather than the default endpoint.
  - getDomainName
```
public java.lang.String getDomainName()
```
    A name for the OpenSearch Service domain.
    For valid values, see the DomainName data type in the Amazon OpenSearch Service Developer Guide . If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the domain name. For more information, see Name Type .
    
    If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
  - setDomainName
```
public void setDomainName(java.lang.String value)
```
    A name for the OpenSearch Service domain.
    For valid values, see the DomainName data type in the Amazon OpenSearch Service Developer Guide . If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the domain name. For more information, see Name Type .
    
    If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
  - getEbsOptions
```
public java.lang.Object getEbsOptions()
```
    The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain.
    For more information, see EBS volume size limits in the Amazon OpenSearch Service Developer Guide .
  - setEbsOptions
```
public void setEbsOptions(IResolvable value)
```
    The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain.
    For more information, see EBS volume size limits in the Amazon OpenSearch Service Developer Guide .
  - setEbsOptions
```
public void setEbsOptions(CfnDomain.EBSOptionsProperty value)
```
    The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain.
    For more information, see EBS volume size limits in the Amazon OpenSearch Service Developer Guide .
  - getElasticsearchClusterConfig
```
public java.lang.Object getElasticsearchClusterConfig()
```
    ElasticsearchClusterConfig is a property of the AWS::Elasticsearch::Domain resource that configures the cluster of an Amazon OpenSearch Service domain.
  - setElasticsearchClusterConfig
```
public void setElasticsearchClusterConfig(IResolvable value)
```
    ElasticsearchClusterConfig is a property of the AWS::Elasticsearch::Domain resource that configures the cluster of an Amazon OpenSearch Service domain.
  - setElasticsearchClusterConfig
```
public void setElasticsearchClusterConfig(CfnDomain.ElasticsearchClusterConfigProperty value)
```
    ElasticsearchClusterConfig is a property of the AWS::Elasticsearch::Domain resource that configures the cluster of an Amazon OpenSearch Service domain.
  - getElasticsearchVersion
```
public java.lang.String getElasticsearchVersion()
```
    The version of Elasticsearch to use, such as 2.3. If not specified, 1.5 is used as the default. For information about the versions that OpenSearch Service supports, see [Supported versions of OpenSearch and Elasticsearch](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/what-is.html#choosing-version) in the *Amazon OpenSearch Service Developer Guide* .
    If you set the EnableVersionUpgrade update policy to true , you can update ElasticsearchVersion without interruption. When EnableVersionUpgrade is set to false , or is not specified, updating ElasticsearchVersion results in replacement .
  - setElasticsearchVersion
```
public void setElasticsearchVersion(java.lang.String value)
```
    The version of Elasticsearch to use, such as 2.3. If not specified, 1.5 is used as the default. For information about the versions that OpenSearch Service supports, see [Supported versions of OpenSearch and Elasticsearch](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/what-is.html#choosing-version) in the *Amazon OpenSearch Service Developer Guide* .
    If you set the EnableVersionUpgrade update policy to true , you can update ElasticsearchVersion without interruption. When EnableVersionUpgrade is set to false , or is not specified, updating ElasticsearchVersion results in replacement .
  - getEncryptionAtRestOptions
```
public java.lang.Object getEncryptionAtRestOptions()
```
    Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use.
    See Encryption of data at rest for Amazon OpenSearch Service .
  - setEncryptionAtRestOptions
```
public void setEncryptionAtRestOptions(IResolvable value)
```
    Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use.
    See Encryption of data at rest for Amazon OpenSearch Service .
  - setEncryptionAtRestOptions
```
public void setEncryptionAtRestOptions(CfnDomain.EncryptionAtRestOptionsProperty value)
```
    Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use.
    See Encryption of data at rest for Amazon OpenSearch Service .
  - getLogPublishingOptions
```
public java.lang.Object getLogPublishingOptions()
```
    An object with one or more of the following keys: `SEARCH_SLOW_LOGS` , `ES_APPLICATION_LOGS` , `INDEX_SLOW_LOGS` , `AUDIT_LOGS` , depending on the types of logs you want to publish.
    Each key needs a valid LogPublishingOption value.
  - setLogPublishingOptions
```
public void setLogPublishingOptions(IResolvable value)
```
    An object with one or more of the following keys: `SEARCH_SLOW_LOGS` , `ES_APPLICATION_LOGS` , `INDEX_SLOW_LOGS` , `AUDIT_LOGS` , depending on the types of logs you want to publish.
    Each key needs a valid LogPublishingOption value.
  - setLogPublishingOptions
```
public void setLogPublishingOptions(java.util.Map<java.lang.String,java.lang.Object> value)
```
    An object with one or more of the following keys: `SEARCH_SLOW_LOGS` , `ES_APPLICATION_LOGS` , `INDEX_SLOW_LOGS` , `AUDIT_LOGS` , depending on the types of logs you want to publish.
    Each key needs a valid LogPublishingOption value.
  - getNodeToNodeEncryptionOptions
```
public java.lang.Object getNodeToNodeEncryptionOptions()
```
    Specifies whether node-to-node encryption is enabled.
    See Node-to-node encryption for Amazon OpenSearch Service .
  - setNodeToNodeEncryptionOptions
```
public void setNodeToNodeEncryptionOptions(IResolvable value)
```
    Specifies whether node-to-node encryption is enabled.
    See Node-to-node encryption for Amazon OpenSearch Service .
  - setNodeToNodeEncryptionOptions
```
public void setNodeToNodeEncryptionOptions(CfnDomain.NodeToNodeEncryptionOptionsProperty value)
```
    Specifies whether node-to-node encryption is enabled.
    See Node-to-node encryption for Amazon OpenSearch Service .
  - getSnapshotOptions
```
public java.lang.Object getSnapshotOptions()
```
    *DEPRECATED* .
    The automated snapshot configuration for the OpenSearch Service domain indices.
  - setSnapshotOptions
```
public void setSnapshotOptions(IResolvable value)
```
    *DEPRECATED* .
    The automated snapshot configuration for the OpenSearch Service domain indices.
  - setSnapshotOptions
```
public void setSnapshotOptions(CfnDomain.SnapshotOptionsProperty value)
```
    *DEPRECATED* .
    The automated snapshot configuration for the OpenSearch Service domain indices.
  - getVpcOptions
```
public java.lang.Object getVpcOptions()
```
    The virtual private cloud (VPC) configuration for the OpenSearch Service domain.
    For more information, see Launching your Amazon OpenSearch Service domains within a VPC in the Amazon OpenSearch Service Developer Guide .
  - setVpcOptions
```
public void setVpcOptions(IResolvable value)
```
    The virtual private cloud (VPC) configuration for the OpenSearch Service domain.
    For more information, see Launching your Amazon OpenSearch Service domains within a VPC in the Amazon OpenSearch Service Developer Guide .
  - setVpcOptions
```
public void setVpcOptions(CfnDomain.VPCOptionsProperty value)
```
    The virtual private cloud (VPC) configuration for the OpenSearch Service domain.
    For more information, see Launching your Amazon OpenSearch Service domains within a VPC in the Amazon OpenSearch Service Developer Guide .

Class CfnDomain

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnDomain

CfnDomain

CfnDomain

CfnDomain

Method Detail

inspect

renderProperties

getAttrArn

getAttrDomainEndpoint

getCfnProperties

getTags

getAccessPolicies

setAccessPolicies

getAdvancedOptions

setAdvancedOptions

setAdvancedOptions

getAdvancedSecurityOptions

setAdvancedSecurityOptions

setAdvancedSecurityOptions

getCognitoOptions

setCognitoOptions

setCognitoOptions

getDomainEndpointOptions

setDomainEndpointOptions

setDomainEndpointOptions

getDomainName

setDomainName

getEbsOptions

setEbsOptions

setEbsOptions

getElasticsearchClusterConfig

setElasticsearchClusterConfig

setElasticsearchClusterConfig

getElasticsearchVersion

setElasticsearchVersion

getEncryptionAtRestOptions

setEncryptionAtRestOptions

setEncryptionAtRestOptions

getLogPublishingOptions

setLogPublishingOptions

setLogPublishingOptions

getNodeToNodeEncryptionOptions

setNodeToNodeEncryptionOptions

setNodeToNodeEncryptionOptions

getSnapshotOptions

setSnapshotOptions

setSnapshotOptions

getVpcOptions

setVpcOptions

setVpcOptions