aws-cdk-lib.aws_appsync.ExtendedDataSourceProps

interface ExtendedDataSourceProps

LanguageType name
.NETAmazon.CDK.AWS.AppSync.ExtendedDataSourceProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsappsync#ExtendedDataSourceProps
Javasoftware.amazon.awscdk.services.appsync.ExtendedDataSourceProps
Pythonaws_cdk.aws_appsync.ExtendedDataSourceProps
TypeScript (source)aws-cdk-lib » aws_appsync » ExtendedDataSourceProps

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 { aws_appsync as appsync } from 'aws-cdk-lib';
const extendedDataSourceProps: appsync.ExtendedDataSourceProps = {
  type: 'type',

  // the properties below are optional
  dynamoDbConfig: {
    awsRegion: 'awsRegion',
    tableName: 'tableName',

    // the properties below are optional
    deltaSyncConfig: {
      baseTableTtl: 'baseTableTtl',
      deltaSyncTableName: 'deltaSyncTableName',
      deltaSyncTableTtl: 'deltaSyncTableTtl',
    },
    useCallerCredentials: false,
    versioned: false,
  },
  elasticsearchConfig: {
    awsRegion: 'awsRegion',
    endpoint: 'endpoint',
  },
  eventBridgeConfig: {
    eventBusArn: 'eventBusArn',
  },
  httpConfig: {
    endpoint: 'endpoint',

    // the properties below are optional
    authorizationConfig: {
      authorizationType: 'authorizationType',

      // the properties below are optional
      awsIamConfig: {
        signingRegion: 'signingRegion',
        signingServiceName: 'signingServiceName',
      },
    },
  },
  lambdaConfig: {
    lambdaFunctionArn: 'lambdaFunctionArn',
  },
  openSearchServiceConfig: {
    awsRegion: 'awsRegion',
    endpoint: 'endpoint',
  },
  relationalDatabaseConfig: {
    relationalDatabaseSourceType: 'relationalDatabaseSourceType',

    // the properties below are optional
    rdsHttpEndpointConfig: {
      awsRegion: 'awsRegion',
      awsSecretStoreArn: 'awsSecretStoreArn',
      dbClusterIdentifier: 'dbClusterIdentifier',

      // the properties below are optional
      databaseName: 'databaseName',
      schema: 'schema',
    },
  },
};

Properties

NameTypeDescription
typestringthe type of the AppSync datasource.
dynamoDbConfig?IResolvable | DynamoDBConfigPropertyconfiguration for DynamoDB Datasource.
elasticsearchConfig?⚠️IResolvable | ElasticsearchConfigPropertyconfiguration for Elasticsearch data source.
eventBridgeConfig?IResolvable | EventBridgeConfigPropertyconfiguration for EventBridge Datasource.
httpConfig?IResolvable | HttpConfigPropertyconfiguration for HTTP Datasource.
lambdaConfig?IResolvable | LambdaConfigPropertyconfiguration for Lambda Datasource.
openSearchServiceConfig?IResolvable | OpenSearchServiceConfigPropertyconfiguration for OpenSearch data source.
relationalDatabaseConfig?IResolvable | RelationalDatabaseConfigPropertyconfiguration for RDS Datasource.

type

Type: string

the type of the AppSync datasource.


dynamoDbConfig?

Type: IResolvable | DynamoDBConfigProperty (optional, default: No config)

configuration for DynamoDB Datasource.


elasticsearchConfig?⚠️

⚠️ Deprecated: - use openSearchConfig

Type: IResolvable | ElasticsearchConfigProperty (optional, default: No config)

configuration for Elasticsearch data source.


eventBridgeConfig?

Type: IResolvable | EventBridgeConfigProperty (optional, default: No config)

configuration for EventBridge Datasource.


httpConfig?

Type: IResolvable | HttpConfigProperty (optional, default: No config)

configuration for HTTP Datasource.


lambdaConfig?

Type: IResolvable | LambdaConfigProperty (optional, default: No config)

configuration for Lambda Datasource.


openSearchServiceConfig?

Type: IResolvable | OpenSearchServiceConfigProperty (optional, default: No config)

configuration for OpenSearch data source.


relationalDatabaseConfig?

Type: IResolvable | RelationalDatabaseConfigProperty (optional, default: No config)

configuration for RDS Datasource.