Provides an Amazon OpenSearch Service domain.

Add policy statements to the domain access policy.

addAccessPolicies

Grant read permissions for an index in this domain to an IAM principal (Role/Group/User).

[disable-awslint:no-grants]

grantIndexRead

Grant read/write permissions for an index in this domain to an IAM principal (Role/Group/User).

[disable-awslint:no-grants]

grantIndexReadWrite

Grant write permissions for an index in this domain to an IAM principal (Role/Group/User).

[disable-awslint:no-grants]

grantIndexWrite

Grant read permissions for a specific path in this domain to an IAM principal (Role/Group/User).

[disable-awslint:no-grants]

grantPathRead

Grant read/write permissions for a specific path in this domain to an IAM principal (Role/Group/User).

[disable-awslint:no-grants]

grantPathReadWrite

Grant write permissions for a specific path in this domain to an IAM principal (Role/Group/User).

[disable-awslint:no-grants]

grantPathWrite

Grant read permissions for this domain and its contents to an IAM principal (Role/Group/User).

[disable-awslint:no-grants]

grantRead

Grant read/write permissions for this domain and its contents to an IAM principal (Role/Group/User).

[disable-awslint:no-grants]

grantReadWrite

Grant write permissions for this domain and its contents to an IAM principal (Role/Group/User).

[disable-awslint:no-grants]

grantWrite

Return the given named metric for this domain.

metric

metricAutomatedSnapshotFailure

Metric for the cluster blocking index writes.

metricClusterIndexWritesBlocked

Metric for the time the cluster status is red.

metricClusterStatusRed

Metric for the time the cluster status is yellow.

metricClusterStatusYellow

metricCPUUtilization

Metric for the storage space of nodes in the cluster.

metricFreeStorageSpace

metricIndexingLatency

metricJVMMemoryPressure

metricKMSKeyError

metricKMSKeyInaccessible

metricMasterCPUUtilization

metricMasterJVMMemoryPressure

metricNodes

Metric for number of searchable documents.

metricSearchableDocuments

metricSearchLatency

Domain

The Elasticsearch/OpenSearch version that your domain will leverage.

version

accessPolicies

Additional options to specify for the Amazon OpenSearch Service domain.

advancedOptions

The hour in UTC during which the service takes an automated daily snapshot of the indices in the Amazon OpenSearch Service domain.

Only applies for Elasticsearch versions
below 5.3.

automatedSnapshotStartHour

The cluster capacity configuration for the Amazon OpenSearch Service domain.

capacity

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

cognitoDashboardsAuth

Whether to enable or disable cold storage on the domain.

You must enable UltraWarm storage to enable cold storage.

coldStorageEnabled

To configure a custom domain configure these options.

If you specify a Route53 hosted zone it will create a CNAME record and use DNS validation for the certificate

customEndpoint

Enforces a particular physical domain name.

domainName

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

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

enableAutoSoftwareUpdate

To upgrade an Amazon OpenSearch Service domain to a new version, rather than replacing the entire domain resource, use the EnableVersionUpgrade update policy.

enableVersionUpgrade

Encryption at rest options for the cluster.

encryptionAtRest

True to require that all traffic to the domain arrive over HTTPS.

enforceHttps

Specifies options for fine-grained access control.

Requires Elasticsearch version 6.7 or later or OpenSearch version 1.0 or later. Enabling fine-grained access control
also requires encryption of data at rest and node-to-node encryption, along with
enforced HTTPS.

fineGrainedAccessControl

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

Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option.

If you set your IP address type to dual stack, you can't change your address type later.

ipAddressType

Configuration log publishing configuration options.

logging

Specify true to enable node to node encryption.

Requires Elasticsearch version 6.0 or later or OpenSearch version 1.0 or later.

nodeToNodeEncryption

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

Off-peak windows were introduced on February 16, 2023.
All domains created before this date have the off-peak window disabled by default.
You must manually enable and configure the off-peak window for these domains.
All domains created after this date will have the off-peak window enabled by default.
You can't disable the off-peak window for a domain after it's enabled.

offPeakWindowEnabled

Start time for the off-peak window, in Coordinated Universal Time (UTC).

The window length will always be 10 hours, so you can't specify an end time.
For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M.

offPeakWindowStart

Policy to apply when the domain is removed from the stack.

removalPolicy

Whether to enable S3 vectors engine.

This feature allows you to offload vector data to Amazon S3 while maintaining sub-second vector search capabilities at low cost.

Requirements:
- OpenSearch version 2.19 or later
- OpenSearch Optimized instance types (OR*, OM*, OI*) for data nodes
- Encryption at rest must be enabled

s3VectorsEngineEnabled

The list of security groups that are associated with the VPC endpoints for the domain.

Only used if `vpc` is specified.

securityGroups

Specify whether to create a CloudWatch Logs resource policy or not.

When logging is enabled for the domain, a CloudWatch Logs resource policy is created by default.
However, CloudWatch Logs supports only 10 resource policies per region.
If you enable logging for several domains, it may hit the quota and cause an error.
By setting this property to true, creating a resource policy is suppressed, allowing you to avoid this problem.

If you set this option to true, you must create a resource policy before deployment.

suppressLogsResourcePolicy

The minimum TLS version required for traffic to the domain.

tlsSecurityPolicy

Configures the domain so that unsigned basic auth is enabled.

If no master user is provided a default master user
with username `admin` and a dynamically generated password stored in KMS is created. The password can be retrieved
by getting `masterUserPassword` from the domain instance.

Setting this to true will also add an access policy that allows unsigned
access, enable node to node encryption, encryption at rest. If conflicting
settings are encountered (like disabling encryption at rest) enabling this
setting will cause a failure.

useUnsignedBasicAuth

The specific vpc subnets the domain will be placed in.

You must provide one subnet for each Availability Zone
that your domain uses. For example, you must specify three subnet IDs for a three Availability Zone
domain.

Only used if `vpc` is specified.

vpcSubnets

The cluster zone awareness configuration for the Amazon OpenSearch Service domain.

zoneAwareness

Creates an OpenSearch UI application.

For more information, see [Using the OpenSearch user interface in Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/application.html) .

CfnApplication

name

appConfigs

dataSources

The endpoint URL of an OpenSearch application.

endpoint

Settings container for integrating IAM Identity Center with OpenSearch UI applications, which enables enabling secure user authentication and access control across multiple data sources.

This setup supports single sign-on (SSO) through IAM Identity Center, allowing centralized user management.

iamIdentityCenterOptions

The ARN of the KMS key used to encrypt the application.

kmsKeyArn

An arbitrary set of tags (key-value pairs) for this application.

CfnDomain

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](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ac.html#ac-creating) in the *Amazon OpenSearch Service Developer Guide* .

Additional options to specify for the OpenSearch Service domain.

For more information, see [AdvancedOptions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_CreateDomain.html#API_CreateDomain_RequestBody) in the OpenSearch Service API reference.

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

If you specify advanced security options, you must also enable node-to-node encryption ( [NodeToNodeEncryptionOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-nodetonodeencryptionoptions.html) ) and encryption at rest ( [EncryptionAtRestOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-encryptionatrestoptions.html) ). You must also enable `EnforceHTTPS` within [DomainEndpointOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-domainendpointoptions.html) , which requires HTTPS for all traffic to the domain.

advancedSecurityOptions

Container for parameters required to enable all machine learning features.

aimlOptions

Container for the cluster configuration of a domain.

clusterConfig

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

cognitoOptions

deploymentStrategyOptions

domainArn

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.

domainEndpointOptions

A name for the OpenSearch Service domain.

The name must have a minimum length of 3 and a maximum length of 28. If you don't specify a name, CloudFormation generates a unique physical ID and uses that ID for the domain name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) .

Required when creating a new domain.

> If you specify a name, you can't 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.

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](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/limits.html#ebsresource) in the *Amazon OpenSearch Service Developer Guide* .

ebsOptions

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

See [Encryption of data at rest for Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/encryption-at-rest.html) .

If no encryption at rest options were initially specified in the template, updating this property by adding it causes no interruption. However, if you change this property after it's already been set within a template, the domain is deleted and recreated in order to modify the property.

encryptionAtRestOptions

The version of OpenSearch to use.

The value must be in the format `OpenSearch_X.Y` or `Elasticsearch_X.Y` . If not specified, the latest version of OpenSearch is used. 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-upgradeopensearchdomain) update policy to `true` , you can update `EngineVersion` without interruption. When `EnableVersionUpgrade` is set to `false` , or is not specified, updating `EngineVersion` results in [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) .

engineVersion

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

identityCenterOptions

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

Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set your IP address type to dual stack, you can't change your address type later.

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. For the full syntax, see the [examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#aws-resource-opensearchservice-domain--examples) .

logPublishingOptions

Specifies whether node-to-node encryption is enabled.

See [Node-to-node encryption for Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ntn.html) .

nodeToNodeEncryptionOptions

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

offPeakWindowOptions

skipShardMigrationWait

*DEPRECATED* .

The automated snapshot configuration for the OpenSearch Service domain indexes.

snapshotOptions

Service software update options for the domain.

softwareUpdateOptions

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

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

For more information, see [Launching your Amazon OpenSearch Service domains within a VPC](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html) in the *Amazon OpenSearch Service Developer Guide* .

If you remove this entity altogether, along with its associated properties, it causes a replacement. You might encounter this scenario if you're updating your security configuration from a VPC to a public endpoint.

Amazon OpenSearch Service

L2 Constructs1

Domain

L1 Constructs2

CfnApplication

CfnDomain

Learn AWS the Practical Way

Quick Facts

Related Links

More Amazon OpenSearch Service deep dives