Package software.amazon.awscdk.cfnpropertymixins.services.opensearchservice

Class CfnDomainPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.opensearchservice.CfnDomainPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:02.052Z")
@Stability(Stable)
public class CfnDomainPropsMixin
extends Mixin
implements software.constructs.IMixin

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.opensearchservice.*;
 import software.amazon.awscdk.*;
 Object accessPolicies;
 IMergeStrategy mergeStrategy;
 CfnDomainPropsMixin cfnDomainPropsMixin = CfnDomainPropsMixin.Builder.create(CfnDomainMixinProps.builder()
         .accessPolicies(accessPolicies)
         .advancedOptions(Map.of(
                 "advancedOptionsKey", "advancedOptions"))
         .advancedSecurityOptions(AdvancedSecurityOptionsInputProperty.builder()
                 .anonymousAuthDisableDate("anonymousAuthDisableDate")
                 .anonymousAuthEnabled(false)
                 .enabled(false)
                 .iamFederationOptions(Map.of(
                         "enabled", false,
                         "rolesKey", "rolesKey",
                         "subjectKey", "subjectKey"))
                 .internalUserDatabaseEnabled(false)
                 .jwtOptions(JWTOptionsProperty.builder()
                         .enabled(false)
                         .publicKey("publicKey")
                         .rolesKey("rolesKey")
                         .subjectKey("subjectKey")
                         .build())
                 .masterUserOptions(MasterUserOptionsProperty.builder()
                         .masterUserArn("masterUserArn")
                         .masterUserName("masterUserName")
                         .masterUserPassword("masterUserPassword")
                         .build())
                 .samlOptions(SAMLOptionsProperty.builder()
                         .enabled(false)
                         .idp(IdpProperty.builder()
                                 .entityId("entityId")
                                 .metadataContent("metadataContent")
                                 .build())
                         .masterBackendRole("masterBackendRole")
                         .masterUserName("masterUserName")
                         .rolesKey("rolesKey")
                         .sessionTimeoutMinutes(123)
                         .subjectKey("subjectKey")
                         .build())
                 .build())
         .aimlOptions(AIMLOptionsProperty.builder()
                 .s3VectorsEngine(S3VectorsEngineProperty.builder()
                         .enabled(false)
                         .build())
                 .serverlessVectorAcceleration(ServerlessVectorAccelerationProperty.builder()
                         .enabled(false)
                         .build())
                 .build())
         .clusterConfig(ClusterConfigProperty.builder()
                 .coldStorageOptions(ColdStorageOptionsProperty.builder()
                         .enabled(false)
                         .build())
                 .dedicatedMasterCount(123)
                 .dedicatedMasterEnabled(false)
                 .dedicatedMasterType("dedicatedMasterType")
                 .instanceCount(123)
                 .instanceType("instanceType")
                 .multiAzWithStandbyEnabled(false)
                 .nodeOptions(List.of(NodeOptionProperty.builder()
                         .nodeConfig(NodeConfigProperty.builder()
                                 .count(123)
                                 .enabled(false)
                                 .type("type")
                                 .build())
                         .nodeType("nodeType")
                         .build()))
                 .warmCount(123)
                 .warmEnabled(false)
                 .warmType("warmType")
                 .zoneAwarenessConfig(ZoneAwarenessConfigProperty.builder()
                         .availabilityZoneCount(123)
                         .build())
                 .zoneAwarenessEnabled(false)
                 .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)
                 .throughput(123)
                 .volumeSize(123)
                 .volumeType("volumeType")
                 .build())
         .encryptionAtRestOptions(EncryptionAtRestOptionsProperty.builder()
                 .enabled(false)
                 .kmsKeyId("kmsKeyId")
                 .build())
         .engineVersion("engineVersion")
         .identityCenterOptions(IdentityCenterOptionsProperty.builder()
                 .enabledApiAccess(false)
                 .identityCenterApplicationArn("identityCenterApplicationArn")
                 .identityCenterInstanceArn("identityCenterInstanceArn")
                 .identityStoreId("identityStoreId")
                 .rolesKey("rolesKey")
                 .subjectKey("subjectKey")
                 .build())
         .ipAddressType("ipAddressType")
         .logPublishingOptions(Map.of(
                 "logPublishingOptionsKey", LogPublishingOptionProperty.builder()
                         .cloudWatchLogsLogGroupArn("cloudWatchLogsLogGroupArn")
                         .enabled(false)
                         .build()))
         .nodeToNodeEncryptionOptions(NodeToNodeEncryptionOptionsProperty.builder()
                 .enabled(false)
                 .build())
         .offPeakWindowOptions(OffPeakWindowOptionsProperty.builder()
                 .enabled(false)
                 .offPeakWindow(OffPeakWindowProperty.builder()
                         .windowStartTime(WindowStartTimeProperty.builder()
                                 .hours(123)
                                 .minutes(123)
                                 .build())
                         .build())
                 .build())
         .skipShardMigrationWait(false)
         .snapshotOptions(SnapshotOptionsProperty.builder()
                 .automatedSnapshotStartHour(123)
                 .build())
         .softwareUpdateOptions(SoftwareUpdateOptionsProperty.builder()
                 .autoSoftwareUpdateEnabled(false)
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vpcOptions(VPCOptionsProperty.builder()
                 .securityGroupIds(List.of("securityGroupIds"))
                 .subnetIds(List.of("subnetIds"))
                 .build())
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnDomainPropsMixin.AdvancedSecurityOptionsInputProperty	Specifies options for fine-grained access control.
static interface	CfnDomainPropsMixin.AIMLOptionsProperty	Example:
static final class	CfnDomainPropsMixin.Builder	A fluent builder for CfnDomainPropsMixin.
static interface	CfnDomainPropsMixin.ClusterConfigProperty	The cluster configuration for the OpenSearch Service domain.
static interface	CfnDomainPropsMixin.CognitoOptionsProperty	Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.
static interface	CfnDomainPropsMixin.ColdStorageOptionsProperty	Container for the parameters required to enable cold storage for an OpenSearch Service domain.
static interface	CfnDomainPropsMixin.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	CfnDomainPropsMixin.EBSOptionsProperty	The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain.
static interface	CfnDomainPropsMixin.EncryptionAtRestOptionsProperty	Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use.
static interface	CfnDomainPropsMixin.IAMFederationOptionsProperty	Example:
static interface	CfnDomainPropsMixin.IdentityCenterOptionsProperty	Settings container for integrating IAM Identity Center with OpenSearch UI applications, which enables enabling secure user authentication and access control across multiple data sources.
static interface	CfnDomainPropsMixin.IdpProperty	The SAML Identity Provider's information.
static interface	CfnDomainPropsMixin.JWTOptionsProperty	Example:
static interface	CfnDomainPropsMixin.LogPublishingOptionProperty	Specifies whether the OpenSearch Service domain publishes application, search slow logs, or index slow logs to Amazon CloudWatch.
static interface	CfnDomainPropsMixin.MasterUserOptionsProperty	Specifies information about the master user.
static interface	CfnDomainPropsMixin.NodeConfigProperty	Configuration options for defining the setup of any node type within the cluster.
static interface	CfnDomainPropsMixin.NodeOptionProperty	Configuration settings for defining the node type within a cluster.
static interface	CfnDomainPropsMixin.NodeToNodeEncryptionOptionsProperty	Specifies options for node-to-node encryption.
static interface	CfnDomainPropsMixin.OffPeakWindowOptionsProperty	Off-peak window settings for the domain.
static interface	CfnDomainPropsMixin.OffPeakWindowProperty	A custom 10-hour, low-traffic window during which OpenSearch Service can perform mandatory configuration changes on the domain.
static interface	CfnDomainPropsMixin.S3VectorsEngineProperty	Options for enabling S3 vectors engine features on the specified domain.
static interface	CfnDomainPropsMixin.SAMLOptionsProperty	Container for information about the SAML configuration for OpenSearch Dashboards.
static interface	CfnDomainPropsMixin.ServerlessVectorAccelerationProperty	Example:
static interface	CfnDomainPropsMixin.ServiceSoftwareOptionsProperty	The current status of the service software for an Amazon OpenSearch Service domain.
static interface	CfnDomainPropsMixin.SnapshotOptionsProperty	DEPRECATED .
static interface	CfnDomainPropsMixin.SoftwareUpdateOptionsProperty	Options for configuring service software updates for a domain.
static interface	CfnDomainPropsMixin.VPCOptionsProperty	The virtual private cloud (VPC) configuration for the OpenSearch Service domain.
static interface	CfnDomainPropsMixin.WindowStartTimeProperty	A custom start time for the off-peak window, in Coordinated Universal Time (UTC).
static interface	CfnDomainPropsMixin.ZoneAwarenessConfigProperty	Specifies zone awareness configuration options.

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnDomainPropsMixin(CfnDomainMixinProps props)	Create a mixin to apply properties to AWS::OpenSearchService::Domain.
	CfnDomainPropsMixin(CfnDomainMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::OpenSearchService::Domain.
protected	CfnDomainPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDomainPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnDomainMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnDomainPropsMixin

protected CfnDomainPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnDomainPropsMixin

protected CfnDomainPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDomainPropsMixin

@Stability(Stable)
public CfnDomainPropsMixin(@NotNull
 CfnDomainMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::OpenSearchService::Domain.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnDomainPropsMixin

@Stability(Stable)
public CfnDomainPropsMixin(@NotNull
 CfnDomainMixinProps props)

Create a mixin to apply properties to AWS::OpenSearchService::Domain.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnDomainMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()