aws-cdk-lib.aws_appsync.CfnDataSourceProps

CfnDataSourceProps Struct

Properties for defining a CfnDataSource.

CfnDataSourceProps

used as props by

• CfnDataSource

Source

Generated code

Type last changed

v2.234.0 · 8 Jan 2026

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 cfnDataSourceProps: appsync.CfnDataSourceProps = {
  apiId: 'apiId',
  name: 'name',
  type: 'type',

  // the properties below are optional
  description: 'description',
  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',
  },
  metricsConfig: 'metricsConfig',
  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',
    },
  },
  serviceRoleArn: 'serviceRoleArn',
};

Properties

apiIdstringapi_idstrapiIdStringApiIdstringApiId*stringrequired#

Unique AWS AppSync GraphQL API identifier where this data source will be created.

description?optionalstringdescription?optionalstrdescription?optionalStringDescription?optionalstringDescription?optional*string#

The description of the data source.

dynamoDbConfig?optionalIResolvable | CfnDataSource.DynamoDBConfigPropertydynamo_db_config?optionaltyping.Union[IResolvable, DynamoDBConfigProperty]dynamoDbConfig?optionalIResolvableDynamoDbConfig?optionalIResolvableDynamoDbConfig?optionalinterface{}#

AWS Region and TableName for an Amazon DynamoDB table in your account.

elasticsearchConfig?optionalIResolvable | CfnDataSource.ElasticsearchConfigPropertyelasticsearch_config?optionaltyping.Union[IResolvable, ElasticsearchConfigProperty]elasticsearchConfig?optionalIResolvableElasticsearchConfig?optionalIResolvableElasticsearchConfig?optionalinterface{}deprecated#

this property has been deprecated

eventBridgeConfig?optionalIResolvable | CfnDataSource.EventBridgeConfigPropertyevent_bridge_config?optionaltyping.Union[IResolvable, EventBridgeConfigProperty]eventBridgeConfig?optionalIResolvableEventBridgeConfig?optionalIResolvableEventBridgeConfig?optionalinterface{}#

An EventBridge configuration that contains a valid ARN of an event bus.

httpConfig?optionalIResolvable | CfnDataSource.HttpConfigPropertyhttp_config?optionaltyping.Union[IResolvable, HttpConfigProperty]httpConfig?optionalIResolvableHttpConfig?optionalIResolvableHttpConfig?optionalinterface{}#

Endpoints for an HTTP data source.

lambdaConfig?optionalIResolvable | CfnDataSource.LambdaConfigPropertylambda_config?optionaltyping.Union[IResolvable, LambdaConfigProperty]lambdaConfig?optionalIResolvableLambdaConfig?optionalIResolvableLambdaConfig?optionalinterface{}#

An ARN of a Lambda function in valid ARN format.

This can be the ARN of a Lambda function that exists in the current account or in another account.

metricsConfig?optionalstringmetrics_config?optionalstrmetricsConfig?optionalStringMetricsConfig?optionalstringMetricsConfig?optional*string#

Enables or disables enhanced data source metrics for specified data sources.

notes

Note that MetricsConfig won't be used unless the dataSourceLevelMetricsBehavior value is set to PER_DATA_SOURCE_METRICS . If the dataSourceLevelMetricsBehavior is set to FULL_REQUEST_DATA_SOURCE_METRICS instead, MetricsConfig will be ignored. However, you can still set its value.

MetricsConfig can be ENABLED or DISABLED .

namestringnamestrnameStringNamestringName*stringrequired#

Friendly name for you to identify your AppSync data source after creation.

openSearchServiceConfig?optionalIResolvable | CfnDataSource.OpenSearchServiceConfigPropertyopen_search_service_config?optionaltyping.Union[IResolvable, OpenSearchServiceConfigProperty]openSearchServiceConfig?optionalIResolvableOpenSearchServiceConfig?optionalIResolvableOpenSearchServiceConfig?optionalinterface{}#

AWS Region and Endpoints for an Amazon OpenSearch Service domain in your account.

relationalDatabaseConfig?optionalIResolvable | CfnDataSource.RelationalDatabaseConfigPropertyrelational_database_config?optionaltyping.Union[IResolvable, RelationalDatabaseConfigProperty]relationalDatabaseConfig?optionalIResolvableRelationalDatabaseConfig?optionalIResolvableRelationalDatabaseConfig?optionalinterface{}#

Relational Database configuration of the relational database data source.

serviceRoleArn?optionalstring | IRoleRefservice_role_arn?optionaltyping.Union[str, IRoleRef]serviceRoleArn?optionalStringServiceRoleArn?optionalstringServiceRoleArn?optionalinterface{}#

The AWS Identity and Access Management service role ARN for the data source.

notes

The system assumes this role when accessing the data source.

Required if Type is specified as AWS_LAMBDA , AMAZON_DYNAMODB , AMAZON_ELASTICSEARCH , AMAZON_EVENTBRIDGE , AMAZON_OPENSEARCH_SERVICE , RELATIONAL_DATABASE , or AMAZON_BEDROCK_RUNTIME .

typestringtypestrtypeStringTypestringType*stringrequired#

The type of the data source.

notes

• AWS_LAMBDA : The data source is an AWS Lambda function.
• AMAZON_DYNAMODB : The data source is an Amazon DynamoDB table.
• AMAZON_ELASTICSEARCH : The data source is an Amazon OpenSearch Service domain.
• AMAZON_EVENTBRIDGE : The data source is an Amazon EventBridge event bus.
• AMAZON_OPENSEARCH_SERVICE : The data source is an Amazon OpenSearch Service domain.
• AMAZON_BEDROCK_RUNTIME : The data source is the Amazon Bedrock runtime.
• NONE : There is no data source. This type is used when you wish to invoke a GraphQL operation without connecting to a data source, such as performing data transformation with resolvers or triggering a subscription to be invoked from a mutation.
• HTTP : The data source is an HTTP endpoint.
• RELATIONAL_DATABASE : The data source is a relational database.