Package software.amazon.awscdk.services.opensearch

Interface CfnDataSourceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSourceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-02T11:03:14.607Z")
@Stability(Stable)
public interface CfnDataSourceProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDataSource.

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.opensearch.*;
 CfnDataSourceProps cfnDataSourceProps = CfnDataSourceProps.builder()
         .dataSourceType(DataSourceTypeProperty.builder()
                 .s3GlueDataCatalog(S3GlueDataCatalogProperty.builder()
                         .roleArn("roleArn")
                         .build())
                 .build())
         .domainName("domainName")
         .name("name")
         // the properties below are optional
         .description("description")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearch-datasource.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDataSourceProps.Builder	A builder for CfnDataSourceProps
static final class	CfnDataSourceProps.Jsii$Proxy	An implementation for CfnDataSourceProps

Method Summary

Modifier and Type	Method	Description
static CfnDataSourceProps.Builder	builder()
Object	getDataSourceType()	The type of data source.
default String	getDescription()	A description of the data source.
String	getDomainName()	The name of the OpenSearch Service domain.
String	getName()	The name of the data source.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDataSourceType

@Stability(Stable)
@NotNull
Object getDataSourceType()

The type of data source.

Returns union: either IResolvable or CfnDataSource.DataSourceTypeProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearch-datasource.html#cfn-opensearch-datasource-datasourcetype

getDomainName

@Stability(Stable)
@NotNull
String getDomainName()

The name of the OpenSearch Service domain.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearch-datasource.html#cfn-opensearch-datasource-domainname

getName

@Stability(Stable)
@NotNull
String getName()

The name of the data source.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearch-datasource.html#cfn-opensearch-datasource-name

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description of the data source.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearch-datasource.html#cfn-opensearch-datasource-description

builder

@Stability(Stable)
static CfnDataSourceProps.Builder builder()

Returns:

a CfnDataSourceProps.Builder of CfnDataSourceProps