AWS::OpenSearch::DataSource

OpenSearch DataSource

Creates a data source for an Amazon OpenSearch Service domain.

Properties

4 configurable properties. 3 required. Click a row to see details.

Filter:
PropertyTypeFlags
DataSourceType
DataSourceType
Required
DomainName
string
RequiredCreate-only
Name
string
RequiredCreate-only
Description
string

Return Values

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

AttributeTypeDescription
ArnstringThe Amazon Resource Name (ARN) of the data source.
StatusstringThe status of the data source.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::OpenSearch::DataSource

Resources:
  MyResource:
    Type: AWS::OpenSearch::DataSource
    Properties:
      DomainName: "my-domainname"
      Name: "my-name"
      DataSourceType: "value"
      Description: !Ref "AWS::StackName"

Required IAM Permissions

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

create

es:AddDataSourcees:GetDataSourceiam:PassRole

read

es:GetDataSource

update

es:UpdateDataSourcees:GetDataSourceiam:PassRole

delete

es:DeleteDataSourcees:GetDataSource

list

es:ListDataSources

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

ServiceOpenSearch
Properties6
Required3
TaggingNot supported
Primary IDArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

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

DomainNameName

External Links