Package software.amazon.awscdk.services.opensearchservice

Class CfnDomain

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.opensearchservice.CfnDomain

All Implemented Interfaces:

IInspectable, IEnvironmentAware, IDomainRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-20T23:37:25.876Z")
@Stability(Stable)
public class CfnDomain
extends CfnResource
implements IInspectable, IDomainRef, ITaggable

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.services.opensearchservice.*;
 Object accessPolicies;
 CfnDomain cfnDomain = CfnDomain.Builder.create(this, "MyCfnDomain")
         .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())
                 .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();
 

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	CfnDomain.AdvancedSecurityOptionsInputProperty	Specifies options for fine-grained access control.
static interface	CfnDomain.AIMLOptionsProperty	Example:
static final class	CfnDomain.Builder	A fluent builder for CfnDomain.
static interface	CfnDomain.ClusterConfigProperty	The cluster configuration for the OpenSearch Service domain.
static interface	CfnDomain.CognitoOptionsProperty	Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.
static interface	CfnDomain.ColdStorageOptionsProperty	Container for the parameters required to enable cold storage for an OpenSearch Service domain.
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.EncryptionAtRestOptionsProperty	Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use.
static interface	CfnDomain.IAMFederationOptionsProperty	Example:
static interface	CfnDomain.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	CfnDomain.IdpProperty	The SAML Identity Provider's information.
static interface	CfnDomain.JWTOptionsProperty	Example:
static interface	CfnDomain.LogPublishingOptionProperty	Specifies whether the OpenSearch Service domain publishes application, search slow logs, or index slow logs to Amazon CloudWatch.
static interface	CfnDomain.MasterUserOptionsProperty	Specifies information about the master user.
static interface	CfnDomain.NodeConfigProperty	Configuration options for defining the setup of any node type within the cluster.
static interface	CfnDomain.NodeOptionProperty	Configuration settings for defining the node type within a cluster.
static interface	CfnDomain.NodeToNodeEncryptionOptionsProperty	Specifies options for node-to-node encryption.
static interface	CfnDomain.OffPeakWindowOptionsProperty	Off-peak window settings for the domain.
static interface	CfnDomain.OffPeakWindowProperty	A custom 10-hour, low-traffic window during which OpenSearch Service can perform mandatory configuration changes on the domain.
static interface	CfnDomain.S3VectorsEngineProperty	Example:
static interface	CfnDomain.SAMLOptionsProperty	Container for information about the SAML configuration for OpenSearch Dashboards.
static interface	CfnDomain.ServiceSoftwareOptionsProperty	The current status of the service software for an Amazon OpenSearch Service domain.
static interface	CfnDomain.SnapshotOptionsProperty	DEPRECATED .
static interface	CfnDomain.SoftwareUpdateOptionsProperty	Options for configuring service software updates for a domain.
static interface	CfnDomain.VPCOptionsProperty	The virtual private cloud (VPC) configuration for the OpenSearch Service domain.
static interface	CfnDomain.WindowStartTimeProperty	A custom start time for the off-peak window, in Coordinated Universal Time (UTC).
static interface	CfnDomain.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.IConstruct

software.constructs.IConstruct.Jsii$Default

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

IDomainRef.Jsii$Default, IDomainRef.Jsii$Proxy

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnDomain(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDomain(software.amazon.jsii.JsiiObjectRef objRef)
	CfnDomain(software.constructs.Construct scope, String id)	Create a new AWS::OpenSearchService::Domain.
	CfnDomain(software.constructs.Construct scope, String id, CfnDomainProps props)	Create a new AWS::OpenSearchService::Domain.

Method Summary

Modifier and Type	Method	Description
static String	arnForDomain(IDomainRef resource)
static IDomainRef	fromDomainArn(software.constructs.Construct scope, String id, String arn)	Creates a new IDomainRef from an ARN.
static IDomainRef	fromDomainName(software.constructs.Construct scope, String id, String domainName)	Creates a new IDomainRef from a domainName.
Object	getAccessPolicies()	An AWS Identity and Access Management ( IAM ) policy document that specifies who can access the OpenSearch Service domain and their permissions.
Object	getAdvancedOptions()	Additional options to specify for the OpenSearch Service domain.
Object	getAdvancedSecurityOptions()	Specifies options for fine-grained access control and SAML authentication.
Object	getAimlOptions()	Returns union: either IResolvable or CfnDomain.AIMLOptionsProperty
String	getAttrAdvancedSecurityOptionsAnonymousAuthDisableDate()	Date and time when the migration period will be disabled.
String	getAttrArn()	The Amazon Resource Name (ARN) of the CloudFormation stack.
String	getAttrDomainEndpoint()	The domain-specific endpoint used for requests to the OpenSearch APIs, such as search-mystack-1ab2cdefghij-ab1c2deckoyb3hofw7wpqa3cm.us-west-1.es.amazonaws.com .
IResolvable	getAttrDomainEndpoints()
String	getAttrDomainEndpointV2()	If IPAddressType to set to dualstack , a version 2 domain endpoint is provisioned.
String	getAttrId()	The resource ID.
String	getAttrIdentityCenterOptionsIdentityCenterApplicationArn()	The ARN of the IAM Identity Center application that integrates with Amazon OpenSearch Service.
String	getAttrIdentityCenterOptionsIdentityStoreId()	The identifier of the IAM Identity Store.
IResolvable	getAttrServiceSoftwareOptions()
String	getAttrServiceSoftwareOptionsAutomatedUpdateDate()
IResolvable	getAttrServiceSoftwareOptionsCancellable()
String	getAttrServiceSoftwareOptionsCurrentVersion()
String	getAttrServiceSoftwareOptionsDescription()
String	getAttrServiceSoftwareOptionsNewVersion()
IResolvable	getAttrServiceSoftwareOptionsOptionalDeployment()
IResolvable	getAttrServiceSoftwareOptionsUpdateAvailable()
String	getAttrServiceSoftwareOptionsUpdateStatus()
protected Map<String,Object>	getCfnProperties()
Object	getClusterConfig()	Container for the cluster configuration of a domain.
Object	getCognitoOptions()	Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.
String	getDomainArn()
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.
String	getDomainName()	A name for the OpenSearch Service domain.
DomainReference	getDomainRef()	A reference to a Domain resource.
Object	getEbsOptions()	The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain.
Object	getEncryptionAtRestOptions()	Whether the domain should encrypt data at rest, and if so, the AWS key to use.
String	getEngineVersion()	The version of OpenSearch to use.
Object	getIdentityCenterOptions()	Configuration options for controlling IAM Identity Center integration within a domain.
String	getIpAddressType()	Choose either dual stack or IPv4 as your IP address type.
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.
Object	getNodeToNodeEncryptionOptions()	Specifies whether node-to-node encryption is enabled.
Object	getOffPeakWindowOptions()	Options for a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.
Object	getSkipShardMigrationWait()	Returns union: either Boolean or IResolvable
Object	getSnapshotOptions()	DEPRECATED .
Object	getSoftwareUpdateOptions()	Service software update options for the domain.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain.
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 Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAccessPolicies(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(Map<String,String> value)	Additional options to specify for the OpenSearch Service domain.
void	setAdvancedOptions(IResolvable value)	Additional options to specify for the OpenSearch Service domain.
void	setAdvancedSecurityOptions(IResolvable value)	Specifies options for fine-grained access control and SAML authentication.
void	setAdvancedSecurityOptions(CfnDomain.AdvancedSecurityOptionsInputProperty value)	Specifies options for fine-grained access control and SAML authentication.
void	setAimlOptions(IResolvable value)
void	setAimlOptions(CfnDomain.AIMLOptionsProperty value)
void	setClusterConfig(IResolvable value)	Container for the cluster configuration of a domain.
void	setClusterConfig(CfnDomain.ClusterConfigProperty value)	Container for the cluster configuration of a domain.
void	setCognitoOptions(IResolvable value)	Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.
void	setCognitoOptions(CfnDomain.CognitoOptionsProperty value)	Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.
void	setDomainArn(String value)
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	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	setDomainName(String value)	A name for 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	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	setEncryptionAtRestOptions(IResolvable value)	Whether the domain should encrypt data at rest, and if so, the AWS key to use.
void	setEncryptionAtRestOptions(CfnDomain.EncryptionAtRestOptionsProperty value)	Whether the domain should encrypt data at rest, and if so, the AWS key to use.
void	setEngineVersion(String value)	The version of OpenSearch to use.
void	setIdentityCenterOptions(IResolvable value)	Configuration options for controlling IAM Identity Center integration within a domain.
void	setIdentityCenterOptions(CfnDomain.IdentityCenterOptionsProperty value)	Configuration options for controlling IAM Identity Center integration within a domain.
void	setIpAddressType(String value)	Choose either dual stack or IPv4 as your IP address type.
void	setLogPublishingOptions(Map<String,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	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	setNodeToNodeEncryptionOptions(IResolvable value)	Specifies whether node-to-node encryption is enabled.
void	setNodeToNodeEncryptionOptions(CfnDomain.NodeToNodeEncryptionOptionsProperty value)	Specifies whether node-to-node encryption is enabled.
void	setOffPeakWindowOptions(IResolvable value)	Options for a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.
void	setOffPeakWindowOptions(CfnDomain.OffPeakWindowOptionsProperty value)	Options for a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.
void	setSkipShardMigrationWait(Boolean value)
void	setSkipShardMigrationWait(IResolvable value)
void	setSnapshotOptions(IResolvable value)	DEPRECATED .
void	setSnapshotOptions(CfnDomain.SnapshotOptionsProperty value)	DEPRECATED .
void	setSoftwareUpdateOptions(IResolvable value)	Service software update options for the domain.
void	setSoftwareUpdateOptions(CfnDomain.SoftwareUpdateOptionsProperty value)	Service software update options for the domain.
void	setTagsRaw(List<CfnTag> value)	An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain.
void	setVpcOptions(IResolvable value)	The virtual private cloud (VPC) configuration for the OpenSearch Service domain.
void	setVpcOptions(CfnDomain.VPCOptionsProperty value)	The virtual private cloud (VPC) configuration for the OpenSearch Service domain.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnDomain

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

CfnDomain

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

CfnDomain

@Stability(Stable)
public CfnDomain(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 CfnDomainProps props)

Create a new AWS::OpenSearchService::Domain.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties.

CfnDomain

@Stability(Stable)
public CfnDomain(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Create a new AWS::OpenSearchService::Domain.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Method Details

arnForDomain

@Stability(Stable)
@NotNull
public static String arnForDomain(@NotNull
 IDomainRef resource)

Parameters:

resource - This parameter is required.

fromDomainArn

@Stability(Stable)
@NotNull
public static IDomainRef fromDomainArn(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String arn)

Creates a new IDomainRef from an ARN.

Parameters:

scope - This parameter is required.

id - This parameter is required.

arn - This parameter is required.

fromDomainName

@Stability(Stable)
@NotNull
public static IDomainRef fromDomainName(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String domainName)

Creates a new IDomainRef from a domainName.

Parameters:

scope - This parameter is required.

id - This parameter is required.

domainName - This parameter is required.

inspect

@Stability(Stable)
public void inspect(@NotNull
 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

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrAdvancedSecurityOptionsAnonymousAuthDisableDate

@Stability(Stable)
@NotNull
public String getAttrAdvancedSecurityOptionsAnonymousAuthDisableDate()

Date and time when the migration period will be disabled.

Only necessary when enabling fine-grained access control on an existing domain .

getAttrArn

@Stability(Stable)
@NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the CloudFormation stack.

getAttrDomainEndpoint

@Stability(Stable)
@NotNull
public String getAttrDomainEndpoint()

The domain-specific endpoint used for requests to the OpenSearch APIs, such as search-mystack-1ab2cdefghij-ab1c2deckoyb3hofw7wpqa3cm.us-west-1.es.amazonaws.com .

getAttrDomainEndpoints

@Stability(Stable)
@NotNull
public IResolvable getAttrDomainEndpoints()

getAttrDomainEndpointV2

@Stability(Stable)
@NotNull
public String getAttrDomainEndpointV2()

If IPAddressType to set to dualstack , a version 2 domain endpoint is provisioned.

This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses.

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

The resource ID.

For example, 123456789012/my-domain .

getAttrIdentityCenterOptionsIdentityCenterApplicationArn

@Stability(Stable)
@NotNull
public String getAttrIdentityCenterOptionsIdentityCenterApplicationArn()

The ARN of the IAM Identity Center application that integrates with Amazon OpenSearch Service.

getAttrIdentityCenterOptionsIdentityStoreId

@Stability(Stable)
@NotNull
public String getAttrIdentityCenterOptionsIdentityStoreId()

The identifier of the IAM Identity Store.

getAttrServiceSoftwareOptions

@Stability(Stable)
@NotNull
public IResolvable getAttrServiceSoftwareOptions()

getAttrServiceSoftwareOptionsAutomatedUpdateDate

@Stability(Stable)
@NotNull
public String getAttrServiceSoftwareOptionsAutomatedUpdateDate()

getAttrServiceSoftwareOptionsCancellable

@Stability(Stable)
@NotNull
public IResolvable getAttrServiceSoftwareOptionsCancellable()

getAttrServiceSoftwareOptionsCurrentVersion

@Stability(Stable)
@NotNull
public String getAttrServiceSoftwareOptionsCurrentVersion()

getAttrServiceSoftwareOptionsDescription

@Stability(Stable)
@NotNull
public String getAttrServiceSoftwareOptionsDescription()

getAttrServiceSoftwareOptionsNewVersion

@Stability(Stable)
@NotNull
public String getAttrServiceSoftwareOptionsNewVersion()

getAttrServiceSoftwareOptionsOptionalDeployment

@Stability(Stable)
@NotNull
public IResolvable getAttrServiceSoftwareOptionsOptionalDeployment()

getAttrServiceSoftwareOptionsUpdateAvailable

@Stability(Stable)
@NotNull
public IResolvable getAttrServiceSoftwareOptionsUpdateAvailable()

getAttrServiceSoftwareOptionsUpdateStatus

@Stability(Stable)
@NotNull
public String getAttrServiceSoftwareOptionsUpdateStatus()

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDomainRef

@Stability(Stable)
@NotNull
public DomainReference getDomainRef()

A reference to a Domain resource.

Specified by:

getDomainRef in interface IDomainRef

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getAccessPolicies

@Stability(Stable)
@Nullable
public Object getAccessPolicies()

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

setAccessPolicies

@Stability(Stable)
public void setAccessPolicies(@Nullable
 Object value)

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

getAdvancedOptions

@Stability(Stable)
@Nullable
public Object getAdvancedOptions()

Additional options to specify for the OpenSearch Service domain.

Returns union: either Mapinvalid input: '<'String, String> or IResolvable

setAdvancedOptions

@Stability(Stable)
public void setAdvancedOptions(@Nullable
 Map<String,String> value)

Additional options to specify for the OpenSearch Service domain.

setAdvancedOptions

@Stability(Stable)
public void setAdvancedOptions(@Nullable
 IResolvable value)

Additional options to specify for the OpenSearch Service domain.

getAdvancedSecurityOptions

@Stability(Stable)
@Nullable
public Object getAdvancedSecurityOptions()

Specifies options for fine-grained access control and SAML authentication.

Returns union: either IResolvable or CfnDomain.AdvancedSecurityOptionsInputProperty

setAdvancedSecurityOptions

@Stability(Stable)
public void setAdvancedSecurityOptions(@Nullable
 IResolvable value)

Specifies options for fine-grained access control and SAML authentication.

setAdvancedSecurityOptions

@Stability(Stable)
public void setAdvancedSecurityOptions(@Nullable
 CfnDomain.AdvancedSecurityOptionsInputProperty value)

Specifies options for fine-grained access control and SAML authentication.

getAimlOptions

@Stability(Stable)
@Nullable
public Object getAimlOptions()

Returns union: either IResolvable or CfnDomain.AIMLOptionsProperty

setAimlOptions

@Stability(Stable)
public void setAimlOptions(@Nullable
 IResolvable value)

setAimlOptions

@Stability(Stable)
public void setAimlOptions(@Nullable
 CfnDomain.AIMLOptionsProperty value)

getClusterConfig

@Stability(Stable)
@Nullable
public Object getClusterConfig()

Container for the cluster configuration of a domain.

Returns union: either IResolvable or CfnDomain.ClusterConfigProperty

setClusterConfig

@Stability(Stable)
public void setClusterConfig(@Nullable
 IResolvable value)

Container for the cluster configuration of a domain.

setClusterConfig

@Stability(Stable)
public void setClusterConfig(@Nullable
 CfnDomain.ClusterConfigProperty value)

Container for the cluster configuration of a domain.

getCognitoOptions

@Stability(Stable)
@Nullable
public Object getCognitoOptions()

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

Returns union: either IResolvable or CfnDomain.CognitoOptionsProperty

setCognitoOptions

@Stability(Stable)
public void setCognitoOptions(@Nullable
 IResolvable value)

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

setCognitoOptions

@Stability(Stable)
public void setCognitoOptions(@Nullable
 CfnDomain.CognitoOptionsProperty value)

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

getDomainArn

@Stability(Stable)
@Nullable
public String getDomainArn()

setDomainArn

@Stability(Stable)
public void setDomainArn(@Nullable
 String value)

getDomainEndpointOptions

@Stability(Stable)
@Nullable
public 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

setDomainEndpointOptions

@Stability(Stable)
public void setDomainEndpointOptions(@Nullable
 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

@Stability(Stable)
public void setDomainEndpointOptions(@Nullable
 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

@Stability(Stable)
@Nullable
public String getDomainName()

A name for the OpenSearch Service domain.

setDomainName

@Stability(Stable)
public void setDomainName(@Nullable
 String value)

A name for the OpenSearch Service domain.

getEbsOptions

@Stability(Stable)
@Nullable
public Object getEbsOptions()

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

Returns union: either IResolvable or CfnDomain.EBSOptionsProperty

setEbsOptions

@Stability(Stable)
public void setEbsOptions(@Nullable
 IResolvable value)

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

setEbsOptions

@Stability(Stable)
public void setEbsOptions(@Nullable
 CfnDomain.EBSOptionsProperty value)

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

getEncryptionAtRestOptions

@Stability(Stable)
@Nullable
public Object getEncryptionAtRestOptions()

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

Returns union: either IResolvable or CfnDomain.EncryptionAtRestOptionsProperty

setEncryptionAtRestOptions

@Stability(Stable)
public void setEncryptionAtRestOptions(@Nullable
 IResolvable value)

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

setEncryptionAtRestOptions

@Stability(Stable)
public void setEncryptionAtRestOptions(@Nullable
 CfnDomain.EncryptionAtRestOptionsProperty value)

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

getEngineVersion

@Stability(Stable)
@Nullable
public String getEngineVersion()

The version of OpenSearch to use.

setEngineVersion

@Stability(Stable)
public void setEngineVersion(@Nullable
 String value)

The version of OpenSearch to use.

getIdentityCenterOptions

@Stability(Stable)
@Nullable
public Object getIdentityCenterOptions()

Configuration options for controlling IAM Identity Center integration within a domain.

Returns union: either IResolvable or CfnDomain.IdentityCenterOptionsProperty

setIdentityCenterOptions

@Stability(Stable)
public void setIdentityCenterOptions(@Nullable
 IResolvable value)

Configuration options for controlling IAM Identity Center integration within a domain.

setIdentityCenterOptions

@Stability(Stable)
public void setIdentityCenterOptions(@Nullable
 CfnDomain.IdentityCenterOptionsProperty value)

Configuration options for controlling IAM Identity Center integration within a domain.

getIpAddressType

@Stability(Stable)
@Nullable
public String getIpAddressType()

Choose either dual stack or IPv4 as your IP address type.

setIpAddressType

@Stability(Stable)
public void setIpAddressType(@Nullable
 String value)

Choose either dual stack or IPv4 as your IP address type.

getLogPublishingOptions

@Stability(Stable)
@Nullable
public 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.

Returns union: either IResolvable or Mapinvalid input: '<'String, either IResolvable or CfnDomain.LogPublishingOptionProperty>

setLogPublishingOptions

@Stability(Stable)
public void setLogPublishingOptions(@Nullable
 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.

setLogPublishingOptions

@Stability(Stable)
public void setLogPublishingOptions(@Nullable
 Map<String,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.

getNodeToNodeEncryptionOptions

@Stability(Stable)
@Nullable
public Object getNodeToNodeEncryptionOptions()

Specifies whether node-to-node encryption is enabled.

Returns union: either IResolvable or CfnDomain.NodeToNodeEncryptionOptionsProperty

setNodeToNodeEncryptionOptions

@Stability(Stable)
public void setNodeToNodeEncryptionOptions(@Nullable
 IResolvable value)

Specifies whether node-to-node encryption is enabled.

setNodeToNodeEncryptionOptions

@Stability(Stable)
public void setNodeToNodeEncryptionOptions(@Nullable
 CfnDomain.NodeToNodeEncryptionOptionsProperty value)

Specifies whether node-to-node encryption is enabled.

getOffPeakWindowOptions

@Stability(Stable)
@Nullable
public Object getOffPeakWindowOptions()

Options for a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.

Returns union: either IResolvable or CfnDomain.OffPeakWindowOptionsProperty

setOffPeakWindowOptions

@Stability(Stable)
public void setOffPeakWindowOptions(@Nullable
 IResolvable value)

Options for a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.

setOffPeakWindowOptions

@Stability(Stable)
public void setOffPeakWindowOptions(@Nullable
 CfnDomain.OffPeakWindowOptionsProperty value)

Options for a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.

getSkipShardMigrationWait

@Stability(Stable)
@Nullable
public Object getSkipShardMigrationWait()

Returns union: either Boolean or IResolvable

setSkipShardMigrationWait

@Stability(Stable)
public void setSkipShardMigrationWait(@Nullable
 Boolean value)

setSkipShardMigrationWait

@Stability(Stable)
public void setSkipShardMigrationWait(@Nullable
 IResolvable value)

getSnapshotOptions

@Stability(Stable)
@Nullable
public Object getSnapshotOptions()

DEPRECATED .

Returns union: either IResolvable or CfnDomain.SnapshotOptionsProperty

setSnapshotOptions

@Stability(Stable)
public void setSnapshotOptions(@Nullable
 IResolvable value)

DEPRECATED .

setSnapshotOptions

@Stability(Stable)
public void setSnapshotOptions(@Nullable
 CfnDomain.SnapshotOptionsProperty value)

DEPRECATED .

getSoftwareUpdateOptions

@Stability(Stable)
@Nullable
public Object getSoftwareUpdateOptions()

Service software update options for the domain.

Returns union: either IResolvable or CfnDomain.SoftwareUpdateOptionsProperty

setSoftwareUpdateOptions

@Stability(Stable)
public void setSoftwareUpdateOptions(@Nullable
 IResolvable value)

Service software update options for the domain.

setSoftwareUpdateOptions

@Stability(Stable)
public void setSoftwareUpdateOptions(@Nullable
 CfnDomain.SoftwareUpdateOptionsProperty value)

Service software update options for the domain.

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

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

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

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

getVpcOptions

@Stability(Stable)
@Nullable
public Object getVpcOptions()

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

Returns union: either IResolvable or CfnDomain.VPCOptionsProperty

setVpcOptions

@Stability(Stable)
public void setVpcOptions(@Nullable
 IResolvable value)

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

setVpcOptions

@Stability(Stable)
public void setVpcOptions(@Nullable
 CfnDomain.VPCOptionsProperty value)

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