RdsDataSourcePropsV2 Struct
Properties for an AppSync RDS datasource Aurora Serverless V2.
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';
import { aws_iam as iam } from 'aws-cdk-lib';
import { aws_rds as rds } from 'aws-cdk-lib';
import { aws_secretsmanager as secretsmanager } from 'aws-cdk-lib';
import { aws_appsync as interfaces_appsync } from 'aws-cdk-lib/interfaces';
declare const databaseCluster: rds.DatabaseCluster;
declare const graphQLApiRef: interfaces_appsync.IGraphQLApiRef;
declare const role: iam.Role;
declare const secret: secretsmanager.Secret;
const rdsDataSourcePropsV2: appsync.RdsDataSourcePropsV2 = {
api: graphQLApiRef,
secretStore: secret,
serverlessCluster: databaseCluster,
// the properties below are optional
databaseName: 'databaseName',
description: 'description',
metricsConfig: appsync.DataSourceMetricsConfig.ENABLED,
name: 'name',
serviceRole: role,
};
Properties
The API to attach this data source to.
The name of the database to use within the cluster.
the description of the data source.
metricsConfigDataSourceMetricsConfigmetrics_configDataSourceMetricsConfigmetricsConfigDataSourceMetricsConfigMetricsConfigDataSourceMetricsConfigMetricsConfigDataSourceMetricsConfig= no metrics configuration#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`.
The name of the data source.
secretStoreISecretsecret_storeISecretsecretStoreISecretSecretStoreISecretSecretStoreISecretrequired#The secret containing the credentials for the database.
serverlessClusterIDatabaseClusterserverless_clusterIDatabaseClusterserverlessClusterIDatabaseClusterServerlessClusterIDatabaseClusterServerlessClusterIDatabaseClusterrequired#The serverless cluster to call to interact with this data source.