Package software.amazon.awscdk.services.appsync

Interface BaseDataSourceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

BackedDataSourceProps, DynamoDbDataSourceProps, ElasticsearchDataSourceProps, EventBridgeDataSourceProps, HttpDataSourceProps, LambdaDataSourceProps, NoneDataSourceProps, OpenSearchDataSourceProps, RdsDataSourceProps, RdsDataSourcePropsV2

All Known Implementing Classes:

BackedDataSourceProps.Jsii$Proxy, BaseDataSourceProps.Jsii$Proxy, DynamoDbDataSourceProps.Jsii$Proxy, ElasticsearchDataSourceProps.Jsii$Proxy, EventBridgeDataSourceProps.Jsii$Proxy, HttpDataSourceProps.Jsii$Proxy, LambdaDataSourceProps.Jsii$Proxy, NoneDataSourceProps.Jsii$Proxy, OpenSearchDataSourceProps.Jsii$Proxy, RdsDataSourceProps.Jsii$Proxy, RdsDataSourcePropsV2.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:38.270Z")
@Stability(Stable)
public interface BaseDataSourceProps
extends software.amazon.jsii.JsiiSerializable

Base properties for an AppSync datasource.

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.appsync.*;
 import software.amazon.awscdk.interfaces.appsync.*;
 IGraphQLApiRef graphQLApiRef;
 BaseDataSourceProps baseDataSourceProps = BaseDataSourceProps.builder()
         .api(graphQLApiRef)
         // the properties below are optional
         .description("description")
         .metricsConfig(DataSourceMetricsConfig.ENABLED)
         .name("name")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static BaseDataSourceProps.Builder	builder()
IGraphQLApiRef	getApi()	The API to attach this data source to.
default String	getDescription()	the description of the data source.
default DataSourceMetricsConfig	getMetricsConfig()	Whether to enable enhanced metrics of the data source Value will be ignored, if enhancedMetricsConfig.dataSourceLevelMetricsBehavior on AppSync GraphqlApi construct is set to FULL_REQUEST_DATA_SOURCE_METRICS.
default String	getName()	The name of the data source.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApi

@Stability(Stable)
@NotNull
IGraphQLApiRef getApi()

The API to attach this data source to.

getDescription

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

the description of the data source.

Default: - None

getMetricsConfig

@Stability(Stable)
@Nullable
default DataSourceMetricsConfig getMetricsConfig()

Whether to enable enhanced metrics of the data source Value will be ignored, if enhancedMetricsConfig.dataSourceLevelMetricsBehavior on AppSync GraphqlApi construct is set to FULL_REQUEST_DATA_SOURCE_METRICS.

Default: - no metrics configuration

getName

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

The name of the data source.

Default: - id of data source

builder

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

Returns:

a BaseDataSourceProps.Builder of BaseDataSourceProps