aws-cdk-lib.aws_appsync.RdsDataSourceProps

interface RdsDataSourceProps

LanguageType name
.NETAmazon.CDK.AWS.AppSync.RdsDataSourceProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsappsync#RdsDataSourceProps
Javasoftware.amazon.awscdk.services.appsync.RdsDataSourceProps
Pythonaws_cdk.aws_appsync.RdsDataSourceProps
TypeScript (source)aws-cdk-lib » aws_appsync » RdsDataSourceProps

Properties for an AppSync RDS datasource.

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';
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';

declare const graphqlApi: appsync.GraphqlApi;
declare const role: iam.Role;
declare const secret: secretsmanager.Secret;
declare const serverlessCluster: rds.ServerlessCluster;
const rdsDataSourceProps: appsync.RdsDataSourceProps = {
  api: graphqlApi,
  secretStore: secret,
  serverlessCluster: serverlessCluster,

  // the properties below are optional
  databaseName: 'databaseName',
  description: 'description',
  name: 'name',
  serviceRole: role,
};

Properties

NameTypeDescription
apiIGraphqlApiThe API to attach this data source to.
secretStoreISecretThe secret containing the credentials for the database.
serverlessClusterIServerlessClusterThe serverless cluster to call to interact with this data source.
databaseName?stringThe name of the database to use within the cluster.
description?stringthe description of the data source.
name?stringThe name of the data source.
serviceRole?IRoleThe IAM service role to be assumed by AppSync to interact with the data source.

api

Type: IGraphqlApi

The API to attach this data source to.


secretStore

Type: ISecret

The secret containing the credentials for the database.


serverlessCluster

Type: IServerlessCluster

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


databaseName?

Type: string (optional, default: None)

The name of the database to use within the cluster.


description?

Type: string (optional, default: None)

the description of the data source.


name?

Type: string (optional, default: id of data source)

The name of the data source.


serviceRole?

Type: IRole (optional, default: Create a new role)

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