All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnDomainProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-13T16:10:05.604Z") @Stability(Stable) public interface CfnDomainProps extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDomain.

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;
 CfnDomainProps cfnDomainProps = CfnDomainProps.builder()
         .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())
         .domainArn("domainArn")
         .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();

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

CfnDomainProps.Builder

A builder for CfnDomainProps

static final class

CfnDomainProps.Jsii$Proxy

An implementation for CfnDomainProps
Method Summary

Modifier and Type

Method

Description

static CfnDomainProps.Builder

builder()

default Object

getAccessPolicies()

An AWS Identity and Access Management ( IAM ) policy document that specifies who can access the OpenSearch Service domain and their permissions.

default Object

getAdvancedOptions()

Additional options to specify for the OpenSearch Service domain.

default Object

getAdvancedSecurityOptions()

Specifies options for fine-grained access control.

default Object

getCognitoOptions()

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

default String

getDomainArn()

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

default String

getDomainName()

A name for the OpenSearch Service domain.

default Object

getEbsOptions()

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

default Object

getElasticsearchClusterConfig()

ElasticsearchClusterConfig is a property of the AWS::Elasticsearch::Domain resource that configures the cluster of an Amazon OpenSearch Service domain.

default String

getElasticsearchVersion()

The version of Elasticsearch to use, such as 2.3.

default Object

getEncryptionAtRestOptions()

Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use.

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

default Object

getNodeToNodeEncryptionOptions()

Specifies whether node-to-node encryption is enabled.

default Object

getSnapshotOptions()

DEPRECATED .

default List<CfnTag>

getTags()

An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain.

default Object

getVpcOptions()

The virtual private cloud (VPC) configuration for the OpenSearch Service domain.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Method Details
- getAccessPolicies
  
  @Stability(Stable) @Nullable default 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.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-accesspolicies
- getAdvancedOptions
  
  @Stability(Stable) @Nullable default 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 .
  Returns union: either Mapinvalid input: '<'String, String> or IResolvable
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-advancedoptions
- getAdvancedSecurityOptions
  
  @Stability(Stable) @Nullable default Object getAdvancedSecurityOptions()
  
  Specifies options for fine-grained access control.
  Returns union: either IResolvable or CfnDomain.AdvancedSecurityOptionsInputProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-advancedsecurityoptions
- getCognitoOptions
  
  @Stability(Stable) @Nullable default Object getCognitoOptions()
  
  Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.
  Returns union: either IResolvable or CfnDomain.CognitoOptionsProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-cognitooptions
- getDomainArn
  
  @Stability(Stable) @Nullable default String getDomainArn()
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-domainarn
- getDomainEndpointOptions
  
  @Stability(Stable) @Nullable default 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.
  Returns union: either IResolvable or CfnDomain.DomainEndpointOptionsProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-domainendpointoptions
- getDomainName
  
  @Stability(Stable) @Nullable default 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.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-domainname
- getEbsOptions
  
  @Stability(Stable) @Nullable default 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 .
  Returns union: either IResolvable or CfnDomain.EBSOptionsProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-ebsoptions
- getElasticsearchClusterConfig
  
  @Stability(Stable) @Nullable default Object getElasticsearchClusterConfig()
  
  ElasticsearchClusterConfig is a property of the AWS::Elasticsearch::Domain resource that configures the cluster of an Amazon OpenSearch Service domain.
  Returns union: either IResolvable or CfnDomain.ElasticsearchClusterConfigProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-elasticsearchclusterconfig
- getElasticsearchVersion
  
  @Stability(Stable) @Nullable default 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 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 .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-elasticsearchversion
- getEncryptionAtRestOptions
  
  @Stability(Stable) @Nullable default 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 .
  Returns union: either IResolvable or CfnDomain.EncryptionAtRestOptionsProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-encryptionatrestoptions
- getLogPublishingOptions
  
  @Stability(Stable) @Nullable default 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.
  Returns union: either IResolvable or Mapinvalid input: '<'String, either IResolvable or CfnDomain.LogPublishingOptionProperty>
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-logpublishingoptions
- getNodeToNodeEncryptionOptions
  
  @Stability(Stable) @Nullable default Object getNodeToNodeEncryptionOptions()
  
  Specifies whether node-to-node encryption is enabled.
  See Node-to-node encryption for Amazon OpenSearch Service .
  Returns union: either IResolvable or CfnDomain.NodeToNodeEncryptionOptionsProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-nodetonodeencryptionoptions
- getSnapshotOptions
  
  @Stability(Stable) @Nullable default Object getSnapshotOptions()
  
  DEPRECATED .
  The automated snapshot configuration for the OpenSearch Service domain indices.
  Returns union: either IResolvable or CfnDomain.SnapshotOptionsProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-snapshotoptions
- getTags
  
  @Stability(Stable) @Nullable default List<CfnTag> getTags()
  
  An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-tags
- getVpcOptions
  
  @Stability(Stable) @Nullable default 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 .
  Returns union: either IResolvable or CfnDomain.VPCOptionsProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-vpcoptions
- builder
  
  @Stability(Stable) static CfnDomainProps.Builder builder()
  
  Returns:
  
  a CfnDomainProps.Builder of CfnDomainProps

Interface CfnDomainProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getAccessPolicies

getAdvancedOptions

getAdvancedSecurityOptions

getCognitoOptions

getDomainArn

getDomainEndpointOptions

getDomainName

getEbsOptions

getElasticsearchClusterConfig

getElasticsearchVersion

getEncryptionAtRestOptions

getLogPublishingOptions

getNodeToNodeEncryptionOptions

getSnapshotOptions

getTags

getVpcOptions

builder