Interface IExtendedDataSourceProps

props used by implementations of BaseDataSource to provide configuration.

Namespace: Amazon.CDK.AWS.AppSync

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IExtendedDataSourceProps

Syntax (vb)

Public Interface IExtendedDataSourceProps

Remarks

Should not be used directly.

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.AppSync;

             var extendedDataSourceProps = new ExtendedDataSourceProps {
                 Type = "type",

                 // the properties below are optional
                 DynamoDbConfig = new DynamoDBConfigProperty {
                     AwsRegion = "awsRegion",
                     TableName = "tableName",

                     // the properties below are optional
                     DeltaSyncConfig = new DeltaSyncConfigProperty {
                         BaseTableTtl = "baseTableTtl",
                         DeltaSyncTableName = "deltaSyncTableName",
                         DeltaSyncTableTtl = "deltaSyncTableTtl"
                     },
                     UseCallerCredentials = false,
                     Versioned = false
                 },
                 ElasticsearchConfig = new ElasticsearchConfigProperty {
                     AwsRegion = "awsRegion",
                     Endpoint = "endpoint"
                 },
                 EventBridgeConfig = new EventBridgeConfigProperty {
                     EventBusArn = "eventBusArn"
                 },
                 HttpConfig = new HttpConfigProperty {
                     Endpoint = "endpoint",

                     // the properties below are optional
                     AuthorizationConfig = new AuthorizationConfigProperty {
                         AuthorizationType = "authorizationType",

                         // the properties below are optional
                         AwsIamConfig = new AwsIamConfigProperty {
                             SigningRegion = "signingRegion",
                             SigningServiceName = "signingServiceName"
                         }
                     }
                 },
                 LambdaConfig = new LambdaConfigProperty {
                     LambdaFunctionArn = "lambdaFunctionArn"
                 },
                 OpenSearchServiceConfig = new OpenSearchServiceConfigProperty {
                     AwsRegion = "awsRegion",
                     Endpoint = "endpoint"
                 },
                 RelationalDatabaseConfig = new RelationalDatabaseConfigProperty {
                     RelationalDatabaseSourceType = "relationalDatabaseSourceType",

                     // the properties below are optional
                     RdsHttpEndpointConfig = new RdsHttpEndpointConfigProperty {
                         AwsRegion = "awsRegion",
                         AwsSecretStoreArn = "awsSecretStoreArn",
                         DbClusterIdentifier = "dbClusterIdentifier",

                         // the properties below are optional
                         DatabaseName = "databaseName",
                         Schema = "schema"
                     }
                 }
             };

Synopsis

Properties

DynamoDbConfig	configuration for DynamoDB Datasource.
ElasticsearchConfig	(deprecated) configuration for Elasticsearch data source.
EventBridgeConfig	configuration for EventBridge Datasource.
HttpConfig	configuration for HTTP Datasource.
LambdaConfig	configuration for Lambda Datasource.
OpenSearchServiceConfig	configuration for OpenSearch data source.
RelationalDatabaseConfig	configuration for RDS Datasource.
Type	the type of the AppSync datasource.

Properties

DynamoDbConfig

configuration for DynamoDB Datasource.

object? DynamoDbConfig { get; }

Property Value

object

Remarks

Default: - No config

Type union: either IResolvable or CfnDataSource.IDynamoDBConfigProperty

ElasticsearchConfig

(deprecated) configuration for Elasticsearch data source.

[Obsolete("- use `openSearchConfig`")]
object? ElasticsearchConfig { get; }

Property Value

object

Remarks

Default: - No config

Stability: Deprecated

Type union: either IResolvable or CfnDataSource.IElasticsearchConfigProperty

EventBridgeConfig

configuration for EventBridge Datasource.

object? EventBridgeConfig { get; }

Property Value

object

Remarks

Default: - No config

Type union: either IResolvable or CfnDataSource.IEventBridgeConfigProperty

HttpConfig

configuration for HTTP Datasource.

object? HttpConfig { get; }

Property Value

object

Remarks

Default: - No config

Type union: either IResolvable or CfnDataSource.IHttpConfigProperty

LambdaConfig

configuration for Lambda Datasource.

object? LambdaConfig { get; }

Property Value

object

Remarks

Default: - No config

Type union: either IResolvable or CfnDataSource.ILambdaConfigProperty

OpenSearchServiceConfig

configuration for OpenSearch data source.

object? OpenSearchServiceConfig { get; }

Property Value

object

Remarks

Default: - No config

Type union: either IResolvable or CfnDataSource.IOpenSearchServiceConfigProperty

RelationalDatabaseConfig

configuration for RDS Datasource.

object? RelationalDatabaseConfig { get; }

Property Value

object

Remarks

Default: - No config

Type union: either IResolvable or CfnDataSource.IRelationalDatabaseConfigProperty

Type

the type of the AppSync datasource.

string Type { get; }

Property Value

string

Remarks

Should not be used directly.

ExampleMetadata: fixture=_generated