AWS Fundamentals Logo
AWS Fundamentals
L2 Construct

RdsDataSource

An AppSync datasource backed by RDS.

Import

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

Or use the module namespace:

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

Properties

Configuration passed to the constructor as RdsDataSourceProps.

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 BackedDataSourceProps
serviceRoleOptionalinherited from BackedDataSourceProps
IRole

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

Default: - Create a new role

4 properties inherited from BaseDataSourceProps
apiRequiredinherited from BaseDataSourceProps
IGraphQLApiRef

The API to attach this data source to.

descriptionOptionalinherited from BaseDataSourceProps
string

the description of the data source.

Default: - None

metricsConfigOptionalinherited from BaseDataSourceProps
DataSourceMetricsConfig

Whether to enable enhanced metrics of the data source Value will be ignored, if `enhancedMetricsConfig.dataSourceLevelMetricsBehavior` on AppSync GraphqlApi construct is set to `FULL_REQUEST_DATA_SOURCE_METRICS`.

Default: - no metrics configuration

nameOptionalinherited from BaseDataSourceProps
string

The name of the data source.

Default: - id of data source

Get the AWS AppSync Cheat Sheet

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

Download Free Infographic

Quick Facts

LevelL2 (Higher-level)
Moduleaws-appsync
Properties8

Related Constructs

Explore This Service

External Links