L2 Construct

AppSyncRdsDataSource

An AppSync datasource backed by RDS.

Import

import { AppSyncRdsDataSource } from 'aws-cdk-lib/aws-appsync';

Or use the module namespace:

import * as appsync from 'aws-cdk-lib/aws-appsync';
// appsync.AppSyncRdsDataSource

Configuration passed to the constructor as AppSyncRdsDataSourceProps.

secretStoreRequired

ISecret

The secret containing the credentials for the database.

serverlessClusterRequired

IServerlessCluster

The serverless cluster to call to interact with this data source.

databaseNameOptional

string

The name of the database to use within the cluster.

Default: - None

1 property inherited from AppSyncBackedDataSourceProps

serviceRoleOptionalinherited from AppSyncBackedDataSourceProps

IRole

The IAM service role to be assumed by AppSync to interact with the data source.

Default: - Create a new role

3 properties inherited from AppSyncBaseDataSourceProps

apiRequiredinherited from AppSyncBaseDataSourceProps

IApiRef

The API to attach this data source to.

descriptionOptionalinherited from AppSyncBaseDataSourceProps

string

The description of the data source.

Default: - None

nameOptionalinherited from AppSyncBaseDataSourceProps

string

The name of the data source. The only allowed pattern is: {[_A-Za-z][_0-9A-Za-z]*}. Any invalid characters will be automatically removed.

Default: - id of data source

Everything you need to know about AWS AppSync on one page. HD quality, print-friendly.

LevelL2 (Higher-level)

Moduleaws-appsync

Properties7