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.98.0 (build 00b106d)", date="2024-05-24T02:42:33.951Z") @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.*;
 GraphqlApi graphqlApi;
 BaseDataSourceProps baseDataSourceProps = BaseDataSourceProps.builder()
         .api(graphqlApi)
         // the properties below are optional
         .description("description")
         .name("name")
         .build();
 
  • Method Details

    • getApi

      @Stability(Stable) @NotNull IGraphqlApi getApi()
      The API to attach this data source to.
    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      the description of the data source.

      Default: - None

    • 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