AWS Fundamentals Logo
AWS Fundamentals
AWS::OpenSearchService::Domain

OpenSearchService Domain

An example resource schema demonstrating some basic constructs and validation rules.

Properties

21 configurable properties. Click a row to see details.

Filter:
PropertyTypeFlags
AccessPolicies
object
AdvancedOptions
object
AdvancedSecurityOptions
AdvancedSecurityOptionsInput
AIMLOptions
AIMLOptions
ClusterConfig
ClusterConfig
CognitoOptions
CognitoOptions
DomainEndpointOptions
DomainEndpointOptions
DomainName
string
Create-only
EBSOptions
EBSOptions
EncryptionAtRestOptions
EncryptionAtRestOptions
EngineVersion
string
IdentityCenterOptions
IdentityCenterOptions
IPAddressType
string
LogPublishingOptions
object
NodeToNodeEncryptionOptions
NodeToNodeEncryptionOptions
OffPeakWindowOptions
OffPeakWindowOptions
SkipShardMigrationWait
boolean
SnapshotOptions
SnapshotOptions
SoftwareUpdateOptions
SoftwareUpdateOptions
Tags
Array<Tag>
VPCOptions
VPCOptions

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
Arnstring-
DomainArnstring-
DomainEndpointstring-
DomainEndpointsobject-
DomainEndpointV2string-
Idstring-
ServiceSoftwareOptionsServiceSoftwareOptions-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::OpenSearchService::Domain

Resources:
  MyResource:
    Type: AWS::OpenSearchService::Domain
    Properties:
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

es:CreateDomaines:DescribeDomaines:AddTagses:ListTagses:DescribeDomainChangeProgress

read

es:DescribeDomaines:ListTags

update

es:UpdateDomaines:UpgradeDomaines:DescribeDomaines:AddTagses:RemoveTagses:ListTagses:DescribeDomainChangeProgress

delete

es:DeleteDomaines:DescribeDomain

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceOpenSearchService
Properties28
Required0
TaggingSupported
Primary IDDomainName

Supported Operations

CreateReadUpdateDelete

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

DomainName

Related Resources

External Links