aws-cdk-lib.aws_opensearch.CfnDataSourceProps

CfnDataSourceProps Struct

Properties for defining a CfnDataSource.

CfnDataSourceProps

used as props by

• CfnDataSource

Source

Generated code

Type last changed

v2.268.0 · 2 Sep 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_opensearch as opensearch } from 'aws-cdk-lib';
const cfnDataSourceProps: opensearch.CfnDataSourceProps = {
  dataSourceType: {
    s3GlueDataCatalog: {
      roleArn: 'roleArn',
    },
  },
  domainName: 'domainName',
  name: 'name',

  // the properties below are optional
  description: 'description',
};

Properties

dataSourceTypeIResolvable | CfnDataSource.DataSourceTypePropertydata_source_typetyping.Union[IResolvable, DataSourceTypeProperty]dataSourceTypeIResolvableDataSourceTypeIResolvableDataSourceTypeinterface{}required#

The type of data source.

description?optionalstringdescription?optionalstrdescription?optionalStringDescription?optionalstringDescription?optional*string#

A description of the data source.

domainNamestringdomain_namestrdomainNameStringDomainNamestringDomainName*stringrequired#

The name of the OpenSearch Service domain.

namestringnamestrnameStringNamestringName*stringrequired#

The name of the data source.