Skip to content
v2.277.0

ExtendedDataSourceProps Struct ​

props used by implementations of BaseDataSource to provide configuration.

Should not be used directly.

Example ​

ts
// 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',
    },
  },
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_appsync as appsync

extended_data_source_props = appsync.ExtendedDataSourceProps(
    type="type",

    # the properties below are optional
    dynamo_db_config=appsync.CfnDataSource.DynamoDBConfigProperty(
        aws_region="awsRegion",
        table_name="tableName",

        # the properties below are optional
        delta_sync_config=appsync.CfnDataSource.DeltaSyncConfigProperty(
            base_table_ttl="baseTableTtl",
            delta_sync_table_name="deltaSyncTableName",
            delta_sync_table_ttl="deltaSyncTableTtl"
        ),
        use_caller_credentials=False,
        versioned=False
    ),
    elasticsearch_config=appsync.CfnDataSource.ElasticsearchConfigProperty(
        aws_region="awsRegion",
        endpoint="endpoint"
    ),
    event_bridge_config=appsync.CfnDataSource.EventBridgeConfigProperty(
        event_bus_arn="eventBusArn"
    ),
    http_config=appsync.CfnDataSource.HttpConfigProperty(
        endpoint="endpoint",

        # the properties below are optional
        authorization_config=appsync.CfnDataSource.AuthorizationConfigProperty(
            authorization_type="authorizationType",

            # the properties below are optional
            aws_iam_config=appsync.CfnDataSource.AwsIamConfigProperty(
                signing_region="signingRegion",
                signing_service_name="signingServiceName"
            )
        )
    ),
    lambda_config=appsync.CfnDataSource.LambdaConfigProperty(
        lambda_function_arn="lambdaFunctionArn"
    ),
    open_search_service_config=appsync.CfnDataSource.OpenSearchServiceConfigProperty(
        aws_region="awsRegion",
        endpoint="endpoint"
    ),
    relational_database_config=appsync.CfnDataSource.RelationalDatabaseConfigProperty(
        relational_database_source_type="relationalDatabaseSourceType",

        # the properties below are optional
        rds_http_endpoint_config=appsync.CfnDataSource.RdsHttpEndpointConfigProperty(
            aws_region="awsRegion",
            aws_secret_store_arn="awsSecretStoreArn",
            db_cluster_identifier="dbClusterIdentifier",

            # the properties below are optional
            database_name="databaseName",
            schema="schema"
        )
    )
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// 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"
        }
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

extendedDataSourceProps := &ExtendedDataSourceProps{
	Type: jsii.String("type"),

	// the properties below are optional
	DynamoDbConfig: &DynamoDBConfigProperty{
		AwsRegion: jsii.String("awsRegion"),
		TableName: jsii.String("tableName"),

		// the properties below are optional
		DeltaSyncConfig: &DeltaSyncConfigProperty{
			BaseTableTtl: jsii.String("baseTableTtl"),
			DeltaSyncTableName: jsii.String("deltaSyncTableName"),
			DeltaSyncTableTtl: jsii.String("deltaSyncTableTtl"),
		},
		UseCallerCredentials: jsii.Boolean(false),
		Versioned: jsii.Boolean(false),
	},
	ElasticsearchConfig: &ElasticsearchConfigProperty{
		AwsRegion: jsii.String("awsRegion"),
		Endpoint: jsii.String("endpoint"),
	},
	EventBridgeConfig: &EventBridgeConfigProperty{
		EventBusArn: jsii.String("eventBusArn"),
	},
	HttpConfig: &HttpConfigProperty{
		Endpoint: jsii.String("endpoint"),

		// the properties below are optional
		AuthorizationConfig: &AuthorizationConfigProperty{
			AuthorizationType: jsii.String("authorizationType"),

			// the properties below are optional
			AwsIamConfig: &AwsIamConfigProperty{
				SigningRegion: jsii.String("signingRegion"),
				SigningServiceName: jsii.String("signingServiceName"),
			},
		},
	},
	LambdaConfig: &LambdaConfigProperty{
		LambdaFunctionArn: jsii.String("lambdaFunctionArn"),
	},
	OpenSearchServiceConfig: &OpenSearchServiceConfigProperty{
		AwsRegion: jsii.String("awsRegion"),
		Endpoint: jsii.String("endpoint"),
	},
	RelationalDatabaseConfig: &RelationalDatabaseConfigProperty{
		RelationalDatabaseSourceType: jsii.String("relationalDatabaseSourceType"),

		// the properties below are optional
		RdsHttpEndpointConfig: &RdsHttpEndpointConfigProperty{
			AwsRegion: jsii.String("awsRegion"),
			AwsSecretStoreArn: jsii.String("awsSecretStoreArn"),
			DbClusterIdentifier: jsii.String("dbClusterIdentifier"),

			// the properties below are optional
			DatabaseName: jsii.String("databaseName"),
			Schema: jsii.String("schema"),
		},
	},
}

Properties ​

dynamoDbConfigoptionalIResolvable | CfnDataSource.DynamoDBConfigPropertydynamo_db_configoptionaltyping.Union[IResolvable, DynamoDBConfigProperty]dynamoDbConfigoptionalIResolvableDynamoDbConfigoptionalIResolvableDynamoDbConfigoptionalinterface{}#
configuration for DynamoDB Datasource.

Default: No config

elasticsearchConfigoptionalIResolvable | CfnDataSource.ElasticsearchConfigPropertyelasticsearch_configoptionaltyping.Union[IResolvable, ElasticsearchConfigProperty]elasticsearchConfigoptionalIResolvableElasticsearchConfigoptionalIResolvableElasticsearchConfigoptionalinterface{}deprecated#
- use `openSearchConfig`

Default: No config

eventBridgeConfigoptionalIResolvable | CfnDataSource.EventBridgeConfigPropertyevent_bridge_configoptionaltyping.Union[IResolvable, EventBridgeConfigProperty]eventBridgeConfigoptionalIResolvableEventBridgeConfigoptionalIResolvableEventBridgeConfigoptionalinterface{}#
configuration for EventBridge Datasource.

Default: No config

httpConfigoptionalIResolvable | CfnDataSource.HttpConfigPropertyhttp_configoptionaltyping.Union[IResolvable, HttpConfigProperty]httpConfigoptionalIResolvableHttpConfigoptionalIResolvableHttpConfigoptionalinterface{}#
configuration for HTTP Datasource.

Default: No config

lambdaConfigoptionalIResolvable | CfnDataSource.LambdaConfigPropertylambda_configoptionaltyping.Union[IResolvable, LambdaConfigProperty]lambdaConfigoptionalIResolvableLambdaConfigoptionalIResolvableLambdaConfigoptionalinterface{}#
configuration for Lambda Datasource.

Default: No config

openSearchServiceConfigoptionalIResolvable | CfnDataSource.OpenSearchServiceConfigPropertyopen_search_service_configoptionaltyping.Union[IResolvable, OpenSearchServiceConfigProperty]openSearchServiceConfigoptionalIResolvableOpenSearchServiceConfigoptionalIResolvableOpenSearchServiceConfigoptionalinterface{}#
configuration for OpenSearch data source.

Default: No config

relationalDatabaseConfigoptionalIResolvable | CfnDataSource.RelationalDatabaseConfigPropertyrelational_database_configoptionaltyping.Union[IResolvable, RelationalDatabaseConfigProperty]relationalDatabaseConfigoptionalIResolvableRelationalDatabaseConfigoptionalIResolvableRelationalDatabaseConfigoptionalinterface{}#
configuration for RDS Datasource.

Default: No config

typestringtypestrtypeStringTypestringType*stringrequired#
the type of the AppSync datasource.