Interface ExtendedDataSourceProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
ExtendedDataSourceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.99.0 (build 8f757e4)", date="2024-06-13T18:49:14.649Z") @Stability(Stable) public interface ExtendedDataSourceProps extends software.amazon.jsii.JsiiSerializable
props used by implementations of BaseDataSource to provide configuration.

Should not be used directly.

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.*;
 ExtendedDataSourceProps extendedDataSourceProps = ExtendedDataSourceProps.builder()
         .type("type")
         // the properties below are optional
         .dynamoDbConfig(DynamoDBConfigProperty.builder()
                 .awsRegion("awsRegion")
                 .tableName("tableName")
                 // the properties below are optional
                 .deltaSyncConfig(DeltaSyncConfigProperty.builder()
                         .baseTableTtl("baseTableTtl")
                         .deltaSyncTableName("deltaSyncTableName")
                         .deltaSyncTableTtl("deltaSyncTableTtl")
                         .build())
                 .useCallerCredentials(false)
                 .versioned(false)
                 .build())
         .elasticsearchConfig(ElasticsearchConfigProperty.builder()
                 .awsRegion("awsRegion")
                 .endpoint("endpoint")
                 .build())
         .eventBridgeConfig(EventBridgeConfigProperty.builder()
                 .eventBusArn("eventBusArn")
                 .build())
         .httpConfig(HttpConfigProperty.builder()
                 .endpoint("endpoint")
                 // the properties below are optional
                 .authorizationConfig(AuthorizationConfigProperty.builder()
                         .authorizationType("authorizationType")
                         // the properties below are optional
                         .awsIamConfig(AwsIamConfigProperty.builder()
                                 .signingRegion("signingRegion")
                                 .signingServiceName("signingServiceName")
                                 .build())
                         .build())
                 .build())
         .lambdaConfig(LambdaConfigProperty.builder()
                 .lambdaFunctionArn("lambdaFunctionArn")
                 .build())
         .openSearchServiceConfig(OpenSearchServiceConfigProperty.builder()
                 .awsRegion("awsRegion")
                 .endpoint("endpoint")
                 .build())
         .relationalDatabaseConfig(RelationalDatabaseConfigProperty.builder()
                 .relationalDatabaseSourceType("relationalDatabaseSourceType")
                 // the properties below are optional
                 .rdsHttpEndpointConfig(RdsHttpEndpointConfigProperty.builder()
                         .awsRegion("awsRegion")
                         .awsSecretStoreArn("awsSecretStoreArn")
                         .dbClusterIdentifier("dbClusterIdentifier")
                         // the properties below are optional
                         .databaseName("databaseName")
                         .schema("schema")
                         .build())
                 .build())
         .build();
 
  • Method Details

    • getType

      @Stability(Stable) @NotNull String getType()
      the type of the AppSync datasource.
    • getDynamoDbConfig

      @Stability(Stable) @Nullable default Object getDynamoDbConfig()
      configuration for DynamoDB Datasource.

      Default: - No config

    • getElasticsearchConfig

      @Stability(Deprecated) @Deprecated @Nullable default Object getElasticsearchConfig()
      Deprecated.
      • use openSearchConfig
      (deprecated) configuration for Elasticsearch data source.

      Default: - No config

    • getEventBridgeConfig

      @Stability(Stable) @Nullable default Object getEventBridgeConfig()
      configuration for EventBridge Datasource.

      Default: - No config

    • getHttpConfig

      @Stability(Stable) @Nullable default Object getHttpConfig()
      configuration for HTTP Datasource.

      Default: - No config

    • getLambdaConfig

      @Stability(Stable) @Nullable default Object getLambdaConfig()
      configuration for Lambda Datasource.

      Default: - No config

    • getOpenSearchServiceConfig

      @Stability(Stable) @Nullable default Object getOpenSearchServiceConfig()
      configuration for OpenSearch data source.

      Default: - No config

    • getRelationalDatabaseConfig

      @Stability(Stable) @Nullable default Object getRelationalDatabaseConfig()
      configuration for RDS Datasource.

      Default: - No config

    • builder

      @Stability(Stable) static ExtendedDataSourceProps.Builder builder()
      Returns:
      a ExtendedDataSourceProps.Builder of ExtendedDataSourceProps