AppSyncRdsDataSourcePropsV2 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 apiRef: interfaces_appsync.IApiRef;
declare const databaseCluster: rds.DatabaseCluster;
declare const role: iam.Role;
declare const secret: secretsmanager.Secret;
const appSyncRdsDataSourcePropsV2: appsync.AppSyncRdsDataSourcePropsV2 = {
api: apiRef,
secretStore: secret,
serverlessCluster: databaseCluster,
// the properties below are optional
databaseName: 'databaseName',
description: 'description',
name: 'name',
serviceRole: role,
};
Properties
databaseNameoptionalstringdatabase_nameoptionalstrdatabaseNameoptionalStringDatabaseNameoptionalstringDatabaseNameoptional*string= None#The name of the database to use within the cluster.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string= None#The description of the data source.
The name of the data source.
Default: id of data source
The only allowed pattern is: {[_A-Za-z][_0-9A-Za-z]*}. Any invalid characters will be automatically removed.
secretStoreISecretsecret_storeISecretsecretStoreISecretSecretStoreISecretSecretStoreISecretrequired#The secret containing the credentials for the database.
serverlessClusterIDatabaseClusterserverless_clusterIDatabaseClusterserverlessClusterIDatabaseClusterServerlessClusterIDatabaseClusterServerlessClusterIDatabaseClusterrequired#The serverless cluster to call to interact with this data source.