interface ExtendedDataSourceProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.AppSync.ExtendedDataSourceProps |
Java | software.amazon.awscdk.services.appsync.ExtendedDataSourceProps |
Python | aws_cdk.aws_appsync.ExtendedDataSourceProps |
TypeScript (source) | @aws-cdk/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 * as appsync from '@aws-cdk/aws-appsync';
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',
},
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
Name | Type | Description |
---|---|---|
type | string | the type of the AppSync datasource. |
dynamo | IResolvable | Dynamo | configuration for DynamoDB Datasource. |
elasticsearch | IResolvable | Elasticsearch | configuration for Elasticsearch data source. |
http | IResolvable | Http | configuration for HTTP Datasource. |
lambda | IResolvable | Lambda | configuration for Lambda Datasource. |
open | IResolvable | Open | configuration for OpenSearch data source. |
relational | IResolvable | Relational | configuration for RDS Datasource. |
type
Type:
string
the type of the AppSync datasource.
dynamoDbConfig?
Type:
IResolvable
|
Dynamo
(optional, default: No config)
configuration for DynamoDB Datasource.
elasticsearchConfig?
⚠️ Deprecated: - use openSearchConfig
Type:
IResolvable
|
Elasticsearch
(optional, default: No config)
configuration for Elasticsearch data source.
httpConfig?
Type:
IResolvable
|
Http
(optional, default: No config)
configuration for HTTP Datasource.
lambdaConfig?
Type:
IResolvable
|
Lambda
(optional, default: No config)
configuration for Lambda Datasource.
openSearchServiceConfig?
Type:
IResolvable
|
Open
(optional, default: No config)
configuration for OpenSearch data source.
relationalDatabaseConfig?
Type:
IResolvable
|
Relational
(optional, default: No config)
configuration for RDS Datasource.